REST API Method: POST /rest/tasks/initialsetup

This resource is a unique one-time-only resource used to create an initial configuration for the node. This resource is posted without credentials, and it establishes login credentials required for any further interaction with the device. Thus, it should be invoked immediately upon the node becoming reachable on the network. Once the initial configuration is established, this resource is unavailable, and any further interaction with the device requires appropriate credentials.

URL:

https://192.168.0.111/rest/tasks/initialsetup

HTTP Method

POST

Requires Authentication:

true

initialsetup - REST API Methods

Parameters

Parameter Name Required Service Affecting Data Type Default Value Possible Values Description
ifIpAddrAssignMethodNoNoEnum0Possible values:
  • 0 - static
  • 1 - dynamic
Determines whether specific node-level settings are configured dynamically (via DHCP) or statically.
hostNameNoNostringnone64 - Max Length Specifies a hostname for the SBC. The combination of the host and domain names is the FQDN, which must not exceed 255 characters. If this is not provided then the default 'hostname' will be the node serial number.
domainNameNoNostringnone255 - Max Length Specifies a domain name for the SBC - only used if IP addressing is static. The combination of the host and domain names is the FQDN, which must not exceed 255 characters.
applicationIPV4AddressNoNostringnone15 - Max Length Sets the Ethernet 1 IP address. This field is inapplicable if the ifIpAddrAssignMethod attribute is set to dynamic. For static addressing, this field must be provided as a valid IPv4 address.
applicationIPV4NetmaskNoNostringnone15 - Max Length Sets the Ethernet 1 IP subnet. This field is inapplicable if the ifIpAddrAssignMethod attribute is set to dynamic. For static addressing, this field must be provided as a valid IPv4 subnet.
gatewayAddressNoNostringnone15 - Max Length Sets the gateway address for the default static route. This field is inapplicable if the ifIpAddrAssignMethod attribute is set to dynamic. For static addressing, this field must be provided, must not be empty, and must be within the same subnet but not the same address as the applicationIPV4Address.
asmDHCPEnabledNoNoBOOLEAN_TYPE Determines whether DHCP is enabled on the Application Solution Module. This field is inapplicable if the node does not have an ASM or if the ifIpAddrAssignMethod attribute is set to dynamic.
asmIPV4AddressNoNostringnone15 - Max Length Sets the ASM's IPV4 address. This field is inapplicable if the node does not have an ASM, or if asmDHCPEnabled is set to true.
timeZoneGeoNameNoNostringUTC128 - Max Length Sets the system's time zone.
primaryDNSServerIPNoNostringnone15 - Max Length Sets the IP address (IPv4 format) of the primary DNS server. This field is inapplicable if the ifIpAddrAssignMethod attribute is set to dynamic. Setting this field to empty (with static addressing) will disable DNS.
secondaryDNSServerIPNoNostringnone15 - Max Length Sets the IP address (IPv4 format) of the secondary DNS server. This field is inapplicable if the ifIpAddrAssignMethod attribute is set to dynamic. Setting this field to empty (with static addressing) will disable secondary DNS server.
adminUserNameYesNostringnone32 - Max Length Specifies an administrative username to be used in subsequent logins
adminUserPasswordYesNostringnone128 - Max Length Specifies an administrative user password to be used in subsequent logins
restUserNameNoNostringnone32 - Max Length Specifies a REST username to be used in subsequent authentications. If this attribute, and restUserPassword, are empty or not provided then the node will not be set up for REST access until a REST user is created from the UI.
restUserPasswordNoNostringnone128 - Max Length Specifies a REST user password to be used in subsequent authentications. If this attribute, and restUserName, are empty or not provided then the node will not be set up for REST access until a REST user is created from the UI.
PasswordRecoveryNoNoEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
Specifies whether password recovery is enabled. (Used when all administrator user passwords are forgotten).
ServerAddressNoNo Specifies the IP address or FQDN of the Syslog server where log entries will be sent. Leaving this field empty will not add a Syslog server.
DefaultLevelNoNoEnum4Possible values:
  • 0 - llDefault
  • 1 - llTrace
  • 2 - llDebug
  • 3 - llInfo
  • 4 - llWarn
  • 5 - llError
  • 6 - llFatal
  • 7 - llOff
Controls the default minimum severity level of messages sent to this server. This default value can be overridden on a per-system basis via the Subsystems Configuration. Informational will produce the most output, and Fatal will produce the least. The more output generated, the more of an impact this feature has on system performance.

Valid values for the DefaultLevel are:

  • 3
    - Informational
  • 4
    - Warning
  • 5
    - Error
  • 6
    - Fatal

SyslogFacilityYesNoEnum9Possible values:
  • 0 - sfUser
  • 1 - sfKern
  • 2 - sfMail
  • 3 - sfDaemon
  • 4 - sfAuth
  • 5 - sfLpr
  • 6 - sfNews
  • 7 - sfUucp
  • 8 - sfCron
  • 9 - sfLocal0
  • 10 - sfLocal1
  • 11 - sfLocal2
  • 12 - sfLocal3
  • 13 - sfLocal4
  • 14 - sfLocal5
  • 15 - sfLocal6
  • 16 - sfLocal7
Controls which Syslog Facility will be used when sending log entries. This can be used to facilitate the sorting of messages from different nodes on a central Syslog server.
ServerPortYesNoint514Possible values:
  • 514 - Minimum
  • 65534 - Maximum
Specifies the Syslog server port number where log entries will be sent.
ServerTransportYesNoEnum0Possible values:
  • 0 - stUDP
  • 1 - stTCP
  • 2 - stTLS
Specifies the protocol to be used for sending log entries to the Syslog server.

Helpful Tip

The POST can contain either only the attributes that are being updated, or the full set of attributes for the resource

  • No labels