Skip to end of metadata
Go to start of metadata

REST API Method: POST /rest/system

Modifies the system's identity in the network and a few other system-level miscellaneous settings.

URL:

https://192.168.0.111/rest/system

HTTP Method

POST

Requires Authentication:

true

Parameters

Parameter Name Required Service Affecting Data Type Default Value Possible Values Description
NodeNameNoYesstringnone64 - Max Length Sets the DNS host name for the system
DomainNameNoYesstringnone255 - Max Length Sets the DNS domain name for the system. Note that this value is only used when useDynamicNetSettings is set to false. If useDynamicNetSettings is true, the configured domain name can be found in the runtime attribute rt_DomainName.
PrimaryDNSServerNoYesstringnone45 - Max Length Sets the IP or IPv6 address of the primary DNS server. It is required only if the primary DNS is enabled above. Note that this value is only used when useDynamicNetSettings is set to false. If useDynamicNetSettings is true, the configured primary DNS server can be found in the runtime attribute rt_DNSServer1IP.
SecondaryDNSServerNoYesstringnone45 - Max Length Sets the IP or IPv6 address of the secondary DNS server. It is required only if the secondary DNS is enabled above. Note that this value is only used when useDynamicNetSettings is set to false. If useDynamicNetSettings is true, the configured secondary DNS server can be found in the runtime attribute rt_DNSServer2IP.
TimeZoneGeoNameNoNostringUTC128 - Max Length Sets the system's time zone.
IsNtp1EnabledNoNoEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
Enables or disables the use of NTP to synchronize the system's calendar time. Note that this attribute is only used when useDynamicNetSettings is set to false.
Ntp1ServerNameNoNostringnone255 - Max Length Configures the host name, IP or IPv6 address of the first NTP server. If the hostname is supplied, the system will use DNS to connect to the NTP server. Note that this value is only used when useDynamicNetSettings is set to false. If useDynamicNetSettings is true, the first configured NTP server can be found in the runtime attribute rt_NTPServer1.
IsNtp1AuthEnabledNoNoEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
Enables or disables authentication of the first NTP server. Note that this attribute is only used when useDynamicNetSettings is set to false.
Ntp1ServerKeyIdNoNoint0Possible values:
  • 0 - Minimum
  • 2147483647 - Maximum
Configures the MD5 Key ID to be used in authenticating the first NTP server 0, indicates system default when NTP is not configured otherwise value must be more than 0. Note that this attribute is only used when useDynamicNetSettings is set to false.
Ntp1ServerKeyNoNostringnone64 - Max Length Configures the MD5 key to be used in authenticating the first NTP server. Note that this attribute is only used when useDynamicNetSettings is set to false.
IsNtp2EnabledNoNoEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
Enables the use of another NTP Server to synchronize the system's calendar time. Note that this attribute is only used when useDynamicNetSettings is set to false.
Ntp2ServerNameNoNostringnone255 - Max Length Configures the host name, IP, or IPv6 address of the second NTP server. If the hostname is supplied, the system will use DNS to connect to the NTP server. Note that this value is only used when useDynamicNetSettings is set to false. If useDynamicNetSettings is true, the second configured NTP server can be found in the runtime attribute rt_NTPServer2.
IsNtp2AuthEnabledNoNoEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
Enables or disables authentication of the second NTP server. Note that this value is only used when useDynamicNetSettings is set to false.
Ntp2ServerKeyIdNoNoint0Possible values:
  • 0 - Minimum
  • 2147483647 - Maximum
Configures the MD5 Key ID to be used in authenticating the second NTP server. 0, indicates system default when NTP is not configured otherwise value must be more than 0. Note that this value is only used when useDynamicNetSettings is set to false.
Ntp2ServerKeyNoNostringnone64 - Max Length Configures the MD5 key to be used in authenticating the second NTP server. Note that this value is only used when useDynamicNetSettings is set to false.
sysContactNoNostringnone255 - Max Length Sets the SNMP attribute 'sysContact' in the System-Group MIB. Operator may use this field to record the contact person for this system and information about how to contact this person.
sysLocationNoNostringnone255 - Max Length Sets the SNMP attribute 'sysLocation' in the System-Group MIB. Operator may use this field to record the physical location of the system.
sysDescriptionNoNostringnone255 - Max Length Sets the SNMP attribute 'sysDescription' in the System-Group MIB. Operator may use this field to record a short description of the system. By convention, this field should include the full name and the hardware type.
IsDHCPServerEnabledNoYesEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
Enables or disables the DHCP Server.
useDynamicNetSettingsNoYesEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
Determines whether specific node-level settings are configured dynamically or statically. These fields include Domain Name, NTP Servers, and DNS Servers. False - these fields are statically configured by the user. True - these fields are dynamically configured via DHCP. Can only be configured dynamically if DHCP is configured on one or more of the logical interfaces. Note this field is automatically configured under the following circumstances: 1) It is set to true when a logical interface is configured to dynamically acquire an address, and it is the first interface to be configured to do so. 2) It is set to false when a logical interface is configured to statically acquire an address, and there are no other interfaces using dynamic addressing.
LocatorLEDNoNoEnum0Possible values:
  • 0 - eLEDState_on
  • 1 - eLEDState_off
  • 2 - eLEDState_blink
Set the Node Locator LED to on, off or blinking.
IsDNSForwardingEnabledNoYesEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
When enabled, the SBC will accept DNS requests and either serve them locally or forward them as necessary.

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