System management objects
The object model describing this resource contains the following objects.
bootDetails
Attribute | JSON Type | Data Type | Description |
bootReason | string | string | Reason why the node last restarted. |
bootTime | string | string | Local time the node booted. |
nodeId | number | integer | Node ID of the device. |
uptime | string | string | Textural representation of the node uptime. |
uptimeInSeconds | number | uint64 | Node uptime, in seconds. |
banner
Attribute | JSON Type | Data Type | Description |
bannerContent | string | string | Contents of the login banner that is presented to a user when they connect to various management interfaces of the system. This field can contain additional text formatting characters, such as new line and tab characters. |
enabled | boolean | boolean | True if the login banner is enabled. |
accessConfig
Attribute | JSON Type | Data Type | Description |
allowedHosts | array | string | A list of hosts allowed to access the management service, if host access is restricted. |
isEnabled | boolean | boolean | True if management service is enabled. |
isEvsIpAddressAllowed | boolean | boolean | True if the management service can be accessed via file serving IP addresses in addition to the specific management addresses. |
maxAllowedConnections | number | integer | Number of allowed simultaneous connections. |
maxSupportedConnections | number | integer | Maximum number of supported connections that can be configured. |
port | number | integer | Port that the management service listens on. |
restrictHosts | boolean | boolean | True to restrict access to only the hosts in the allowedHosts list. |
type | string | string | Type of management service. Possible values are:
|
snmpConfig
Attribute | JSON Type | Data Type | Description |
allowSnmpV1 | boolean | boolean | True if SNMPv1 requests are accepted. |
allowSnmpV2 | boolean | boolean | True if SNMPv2c requests are accepted. |
allowSnmpV3 | boolean | boolean | True if SNMPv3 requests are accepted. |
allowedCommunities | array | string | A list of community strings that can be used to access the SNMP agent. |
allowedHosts | array | string | A list of hosts allowed to access the SNMP agent, if host access is restricted. |
isEnabled | boolean | boolean | True if the SNMP agent is enabled. |
port | number | integer | UDP port that the SNMP agent is listening on. |
restrictHosts | boolean | boolean | True to restrict access to only the hosts in the allowedHosts list. |
sendAuthFailureTraps | boolean | boolean | True to send SNMP authentication failure traps to configured SNMP trap hosts. |
managementUser
Attribute | JSON Type | Data Type | Description |
accessLevel | string | string | Access level allowed for the user. Possible values are:
|
isDeletable | boolean | boolean | True if the user can be deleted from the system. |
isPasswordModifiable | boolean | boolean | True if the password can be updated via the API. |
lastLogin | string | string | Date and time of last login. |
objectId | string | string | Unique identifier of the user. |
type | string | string | Type of user. Possible values are:
|
userName | string | string | User name. |
accessLevel
Attribute | JSON Type | Data Type | Description |
accessLevel | string | string |
Access level allowed for the user current user. If accessType is USER, possible values are:
If accessType is APIKEY, possible values are a combination of any of the following values:
|
accessType | string | string | Authentication type being used. Possible values are:
|