Page History
| Excerpt |
|---|
Defines The System resource that controls node-level configuration settings on the SBC. |
REST API Methods for this Resource
- GET system
- POST system
- POST system - action setdatetime
- POST system - action backup
- POST system - action restore
- POST system - action reboot
- POST system - action factorydefault
- POST system - action factorydefaultpartial
- POST system - action importconfig
- POST system - action ipsecrestartservice
- POST system - action exportconfig
- POST system - action runsystemvitalsscript
- POST system - action exporttranstable
- POST system - action importtranstable
- GET system historicalstatistics
- GET system historicalstatistics id
Resource Schema
Configuration
| Parameter Name | Required | Service Affecting | Data Type | Default Value | Possible Values | Description |
|---|---|---|---|---|---|---|
| NodeName | No | Yes | string | none | 64 - Max Length | Sets the DNS host name for the system |
| DomainName | No | Yes | string | none | 255 - 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. |
| PrimaryDNSServer | No | Yes | string | none | 45 - 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. |
| SecondaryDNSServer | No | Yes | string | none | 45 - 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. |
| PrimaryDNSServerSource | No | Yes | string | none | 45 - Max Length | Sets the interface whose IP address to be used as source IP address in the primary DNS server query. It is required only if the primary DNS is enabled above. |
| SecondaryDNSServerSource | No | Yes | string | none | 45 - Max Length | Sets the interface whose IP address to be used as source IP address in the secondary DNS server query. It is required only if the secondary DNS is enabled above. |
| TimeZoneGeoName | No | No | string | UTC | 128 - Max Length | Sets the system's time zone. |
| IsNtp1Enabled | No | No | Enum | 0 | Possible values:
| 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. |
| Ntp1ServerName | No | No | string | none | 255 - 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. |
| IsNtp1AuthEnabled | No | No | Enum | 0 | Possible values:
| Enables or disables authentication of the first NTP server. Note that this attribute is only used when useDynamicNetSettings is set to false. |
| Ntp1ServerKeyId | No | No | int | 0 | Possible values:
| 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. |
| Ntp1ServerKey | No | No | string | none | 64 - 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. |
| IsNtp2Enabled | No | No | Enum | 0 | Possible values:
| 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. |
| Ntp2ServerName | No | No | string | none | 255 - 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. |
| IsNtp2AuthEnabled | No | No | Enum | 0 | Possible values:
| Enables or disables authentication of the second NTP server. Note that this value is only used when useDynamicNetSettings is set to false. |
| Ntp2ServerKeyId | No | No | int | 0 | Possible values:
| 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. |
| Ntp2ServerKey | No | No | string | none | 64 - 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. |
| sysContact | No | No | string | none | 255 - 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. |
| sysLocation | No | No | string | none | 255 - 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. |
| sysDescription | No | No | string | none | 255 - 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. |
| IsDHCPServerEnabled | No | Yes | Enum | 0 | Possible values:
| Enables or disables the DHCP Server. |
| useDynamicNetSettings | No | Yes | Enum | 0 | Possible values:
| 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. |
| LocatorLED | No | No | Enum | 0 | Possible values:
| Set the Node Locator LED to on, off or blinking. |
| IsDNSForwardingEnabled | No | Yes | Enum | 0 | Possible values:
| When enabled, the SBC will accept DNS requests and either serve them locally or forward them as necessary. |
| CountryCode | No | No | string | 0 | 3 - Max Length | The Country in which the SBC resides in.This is a numeric telephone Country Code. |
Runtime
| Parameter Name | Description | Data Type | Possible Values |
|---|---|---|---|
| rt_DNSServer1IP | The IP or IPv6 address of the first DNS server currently in use. | string | |
| rt_DNSServer2IP | The IP or IPv6 address of the second DNS server currently in use. | string | |
| rt_NTPServer1 | The name, IP or IPv6 address of the first NTP server currently in use. | string | |
| rt_NTPServer2 | The name, IP, IPv6 address of the second NTP server currently in use. | string | |
| rt_DomainName | The domain name currently in use. | string | |
| rt_Hypervisor_Environment | Indicates Hypervisor Enviornment for SBC SWe Edge. eHwr will be returned in case SBC 1000 and SBC 2000. | Enum | Possible values:
|
| rt_model | Indicates current platform type. | Enum | Possible values:
|
| rt_Software_Update_Stage | Indicates the stage (1-5) in which the upgrade process is currently in. It can be any of the following:
| Enum | Possible values:
|
| rt_Software_Start_Time | Indicates the start time persisted in the server for the upgrade process. It is defined in epoch secs. This is set only after the file is uploaded to the server. | int | |
| rt_Software_Update_TotalWork | Indicates the total number of chunks of work to be done for the upgrade. This is valid for stages 3 and 4. Default value is 0 when no upgrade is being performed. | int | |
| rt_Software_Update_WorkDone | Indicates the amount of work completed. This is valid for stages 3 and 4 only. Default value is 0 when no upgrade is being performed. | int | |
| rt_Software_Base_Version | Base Software version is usually displayed in x.y.z format where
| string | |
| rt_Software_Base_BuildNumber | Build Numer identifies exact build machine, time and date .It should be reported whenever reporting any bug or crash related to current software. | string | |
| rt_Software_Patch_Version | Patches are add on software module modifications to the base software version. They are used to deliver custom features or bugfixes thats are not covered by base software. | string | |
| rt_Partition_Type | Indication of type of partition which are boot partition, application partition 1 and application partition 2. | Enum | Possible values:
|
Inventory
| Parameter Name | Description | Data Type | Possible Values |
|---|---|---|---|
| Vendor | The vendor who provided the hardware module. | string | |
| PartNumber | The hardware module's part number. | string | |
| VersionNumber | The hardware module's version number. | string | |
| MfgWeek | The week that the hardware module was manufactured, as a two-digit string between 01 and 52. | string | |
| MfgYear | The year that the hardware module was manufactured, as a two-digit string (e.g.: 2013 is returned as "13") | string | |
| SerialNumber | The hardware module's serial number. | string | |
| LineCardLicenseType | The type of line card license - Non-Licensed card will not require TDM port licenses, Licensed card will require TDM port licenses for additional ports to be activated. This is applicable only for the SBC 1000/2000 platforms. | Enum | Possible values:
|
| LineCardNumLicensedPorts | The number of ports licensed for the TDM line card type. This is dependent on LineCardLicenseType. If the card is Licensed, the number of ports is equal to number of licenses, otherwise it is the maximum for that card type. This is applicable only for the SBC 1000/2000 platforms. | int | |
| AsmOsLicenseType | The version of ASM Operating System that is licensed by the factory. Additional license can be purchased, activated and reviewed through Ribbon licensing and license resource. This is applicable only for the SBC 1000/2000 platforms. | Enum | Possible values:
|
| Status | Indicates the hardware initialization state for this card. | Enum | Possible values:
|
| TotalSystemMemory | Indicates the amount of RAM available in the system in MB. | string |
Overview
Content Tools