/mgmt/status/default/DomainStatus GET

Use the HTTP GET method with the /mgmt/status/default/DomainStatus resource to request the status of the default domain.

Resource URL

https://host:port/mgmt/status/default/DomainStatus
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 the domain status for the appliance. Each object contains the following fields:
Domain
String.
The name of the domain. Only the default domain is available on the IBM MQ Appliance.
SaveNeeded
String.
Indicates whether the domain contains unsaved changes.
TraceEnabled
String.
Indicates whether the XML File Capture utility is enabled. This utility can only be enabled in the default domain.
DebugEnabled
String.
Indicates whether the domain is employing debug logging level. At this level many messages are written to the log, which impacts performance.
ProbeEnabled
String.
Indicates whether a service in the domain has the probe enabled.
DiagEnabled
String.
Indicates whether diagnostic tracing is enabled.
CurrentCommand
String.
Provides a list of commands that are currently running on the domain. Use this column to confirm whether long-running commands have completed. Possible values are:
  • no value - there are no commands running on the domain.
  • no domain - an Application Domain object is being deleted.
  • restart domain - the domain is being restored to a state defined in a saved configuration file.
  • reset domain - objects in the domain configuration are being deleted.
  • write memswitch - the configuration is being saved.
  • import-execute - importing an Import Package object.
  • exec - a configuration script is running.
  • domain - the domain is being created.
  • backup - an archive of configuration data is being generated.
  • save chkpoint - a checkpoint configuration file is being generated.
  • test schema - an XML file is being tested against a schema.
  • umount - a file system is being unmounted.
  • configuring - the domain is being configured.
  • secure-backup - the domain is being securely backed up.
  • secure-restore - the domain is being restored from a secure backup.
QuiesceState
String.
This setting does not apply to the default domain.
InterfaceState
String.
Indicates the state of the networking interfaces of the appliance. The value gives an indication as to which networking objects require attention. Possible values are:
  • Appliance OK

    Indicates that all networking is up on the appliance.

  • Link errors

    Indicates that one or more ethernet links are misconfigured on the appliance.

  • VLAN errors

    Indicates that one or more VLANs are misconfigured on the appliance.

  • Aggregation errors

    Indicates that one or more Aggregations are misconfigured on the appliance.

  • Link/VLAN errors

    Indicates that one or more ethernet links and VLANs are misconfigured on the appliance.

  • Link/Aggregation errors

    Indicates that one or more ethernet links and Aggregations are misconfigured on the appliance.

  • VLAN/Aggregation errors

    Indicates that one or more VLANs and Aggregations are misconfigured on the appliance.

  • All errors

    Indicates that one or more ethernet links, VLANs, and Aggregations are misconfigured on the appliance.

FailsafeMode
String.
Indicates the failsafe startup mode of the appliance. Failsafe modes are entered after the appliance unexpectedly restarts one or more times. Until you correct the problem, the appliance cannot accept and process client requests. Contact IBM support. Possible values are:
  • none

    The appliance is not in a failsafe mode and is operating normally.

  • management

    Only the default domain and configured Telnet, SSH and web management interfaces are available.

  • console

    Only the default domain and a serial console interface are available.

Examples

The following example requests the status of the default domain on the appliance.

The following URL is used with the HTTP GET method:
https://localhost:5554/mgmt/status/default/DomainStatus
The following listing shows the received response:
{
  "_links": {
    "self": {
      "href": "/mgmt/status/default/DomainStatus"
    },
    "doc": {
      "href": "/mgmt/docs/status/DomainStatus"
    }
  },
  "DomainStatus": {
    "Domain": "default",
    "SaveNeeded": "off",
    "TraceEnabled": "off",
    "DebugEnabled": "off",
    "ProbeEnabled": "off",
    "DiagEnabled": "off",
    "CurrentCommand": "",
    "QuiesceState": "",
    "InterfaceState": "ok",
    "FailsafeMode": "none"
  }
}