/mgmt/status/default/ObjectStatus GET

Use the HTTP GET method with the /mgmt/status/default/ObjectStatus resource to request status information about the configuration objects on the appliance.

Resource URL

https://host:port/mgmt/status/default/ObjectStatus
Where port is 5554 by default.

Request headers

The following header must be sent with the request:
Authorization
This header must be sent to perform authentication.

Request body format

None.

Security requirements

The caller must be authenticated as an appliance user with sufficient authority. For more information about security, see Types of user and how they are authenticated and User authorization, credential mapping, and access profiles.

Response status codes

200
Status information retrieved successfully.
400
Invalid data provided.
401
Not authenticated.
The caller must be authenticated as an appliance user. See Types of user and how they are authenticated for more information.
403
Not authorized.
The caller is authenticated but does not the authority to perform this action. See User authorization, credential mapping, and access profiles for more information.

Response headers

Content-Type
This header is returned with a value of application/json.

Response body format

The response is in JSON format. The response includes information about configuration objects on the appliance. Each object contains the following fields:
Class
String.
The type of configuration object.
OpState
String.
The operational state of the object. Can be up or down.
AdminState
String.
The administrative state of the configuration object. Can be enabled or disabled.
Name
String.
The name of the configuration object.
EventCode
String.
The event code associated with the object.
ErrorCode
String.
Any text that is associated with the EventCode.
ConfigState
String.
The configuration status. Can be one of the following:
  • Invalid Invalid configuration.
  • Saved Persisted configuration.
  • New New configuration.
  • Modified Modified configuration.
  • Deleted Deleted configuration.
  • External External configuration.

Examples

The following example requests information about configuration objects.

The following URL is used with the HTTP GET method:
https://localhost:5554/mgmt/status/default/ObjectStatus
The following listing shows an example received response:
{
  "_links": {
    "self": {
      "href": "/mgmt/status/default/ObjectStatus"
    },
    "doc": {
      "href": "/mgmt/docs/status/ObjectStatus"
    }
  },
  "ObjectStatus": [
    {
      "Class": "DNSNameService",
      "OpState": "up",
      "AdminState": "enabled",
      "Name": "dns",
      "EventCode": "0x00000000",
      "ErrorCode": "",
      "ConfigState": "saved"
    },
    {
      "Class": "EthernetInterface",
      "OpState": "down",
      "AdminState": "disabled",
      "Name": "eth10",
      "EventCode": "0x0034000d",
      "ErrorCode": "Object is disabled",
      "ConfigState": "saved"
    },
    {
      "Class": "EthernetInterface",
      "OpState": "down",
      "AdminState": "disabled",
      "Name": "eth11",
      "EventCode": "0x0034000d",
      "ErrorCode": "Object is disabled",
      "ConfigState": "saved"
    },
...
    {
      "Class": "AuditLog",
      "OpState": "up",
      "AdminState": "enabled",
      "Name": "audit-log-settings",
      "EventCode": "0x00000000",
      "ErrorCode": "",
      "ConfigState": "saved"
    },
    {
      "Class": "RestMgmtInterface",
      "OpState": "up",
      "AdminState": "enabled",
      "Name": "rest-mgmt",
      "EventCode": "0x00000000",
      "ErrorCode": "",
      "ConfigState": "saved"
    },
    {
      "Class": "SSHServerProfile",
      "OpState": "up",
      "AdminState": "enabled",
      "Name": "sshserverprofile",
      "EventCode": "0x00000000",
      "ErrorCode": "",
      "ConfigState": "saved"
    }
  ]
}