OpenManage Enterprise Version 3.4 and OpenManage Enterprise - Modular Edition Version 1.20.00 RESTful API Guide

PDF

GET method for Domains

This method returns the role of this chassis domain, details of the backup-lead chassis compatibility, and health of the data synchronization.

The chassis domain role is as follows:

Chassis domain part of MCM group—LEAD or MEMBER
Chassis domain not part of an MCM group—STANDALONE

If you run this API on the LEAD, one domain representing each MEMBER in the group and one domain representing the LEAD is returned. For example, a group with 10 chassis (1 Lead and 9 members) returns information for 10 domains.

If you run this API on a MEMBER, one domain representing the MEMBER (itself) and one domain representing the LEAD, and another representing the BACKUP is returned.

If you run this API on a BACKUP, one domain representing the BACKUP (itself) and one domain representing LEAD is returned.

Description

Returns the role of this chassis domain.

Part of MCM—LEAD or MEMBER
Not part of MCM—STANDALONE

Privilege

VIEW

HTTP response codes

200

Example request body

N/A

Example response body

Output — Lead chassis:
{
    "@odata.context": "/api/$metadata#Collection(ManagementDomainService.Domain)",
    "@odata.count": 3,
    "value": [
        {
            "@odata.type": "#ManagementDomainService.Domain",
            "@odata.id": "/api/ManagementDomainService/Domains(10071)",
            "Id": 10071,
            "DeviceId": 10054,
            "PublicAddress": [
                "100.69.115.203"
            ],
            "Name": "MX-C4WM1S2",
            "Description": "PowerEdge MX7000",
            "Identifier": "C4WM1S2",
            "DomainTypeId": 4000,
            "DomainTypeValue": "MSM",
            "DomainRoleTypeId": 3000,
            "DomainRoleTypeValue": "LEAD",
            "Version": "1.20.00",
            "Local": true,
            "GroupId": "28bf881c-f736-440d-b327-2fb0b2d7fd55",
            "GroupName": "test",
            "BackupLead": false,
            "Capabilities": [],
            "BackupLeadHealth": 2000
        },
        {
            "@odata.type": "#ManagementDomainService.Domain",
            "@odata.id": "/api/ManagementDomainService/Domains(10238)",
            "Id": 10238,
            "DeviceId": 10240,
            "PublicAddress": [
                "100.69.115.194"
            ],
            "Name": "MX-C4XF1S2",
            "Description": "PowerEdge MX7000",
            "Identifier": "C4XF1S2",
            "DomainTypeId": 4000,
            "DomainTypeValue": "MSM",
            "DomainRoleTypeId": 3001,
            "DomainRoleTypeValue": "MEMBER",
            "Version": "1.20.00",
            "Local": false,
            "GroupId": "28bf881c-f736-440d-b327-2fb0b2d7fd55",
            "GroupName": "test",
            "BackupLead": false,
            "Capabilities": [
                "LEADBACKUPCOMPATIBLE"
            ],
            "BackupLeadHealth": 2000
        },
        {
            "@odata.type": "#ManagementDomainService.Domain",
            "@odata.id": "/api/ManagementDomainService/Domains(10236)",
            "Id": 10236,
            "DeviceId": 10195,
            "PublicAddress": [
                "100.69.115.193"
            ],
            "Name": "MX-75HK1S2",
            "Description": "PowerEdge MX7000",
            "Identifier": "75HK1S2",
            "DomainTypeId": 4000,
            "DomainTypeValue": "MSM",
            "DomainRoleTypeId": 3001,
            "DomainRoleTypeValue": "MEMBER",
            "Version": "1.20.00",
            "Local": false,
            "GroupId": "28bf881c-f736-440d-b327-2fb0b2d7fd55",
            "GroupName": "test",
            "BackupLead": false,
            "Capabilities": [
                "LEADBACKUPCOMPATIBLE"
            ],
            "BackupLeadHealth": 2000
        }
    ]
}


Output — Member chassis:

{
    "@odata.context": "/api/$metadata#Collection(ManagementDomainService.Domain)",
    "@odata.count": 2,
    "value": [
        {
            "@odata.type": "#ManagementDomainService.Domain",
            "@odata.id": "/api/ManagementDomainService/Domains(10068)",
            "Id": 10068,
            "DeviceId": 10052,
            "PublicAddress": [
                "100.69.115.194"
            ],
            "Name": "MX-C4XF1S2",
            "Description": "PowerEdge MX7000",
            "Identifier": "C4XF1S2",
            "DomainTypeId": 4000,
            "DomainTypeValue": "MSM",
            "DomainRoleTypeId": 3001,
            "DomainRoleTypeValue": "MEMBER",
            "Version": "1.20.00",
            "Local": true,
            "GroupId": "28bf881c-f736-440d-b327-2fb0b2d7fd55",
            "GroupName": "test",
            "BackupLead": false,
            "Capabilities": [
                "LEADBACKUPCOMPATIBLE"
            ],
            "BackupLeadHealth": 2000
        },
        {
            "@odata.type": "#ManagementDomainService.Domain",
            "@odata.id": "/api/ManagementDomainService/Domains(10231)",
            "Id": 10231,
            "DeviceId": 0,
            "PublicAddress": [
                "100.69.115.203"
            ],
            "Name": "MX-C4WM1S2",
            "Description": "PowerEdge MX7000",
            "Identifier": "C4WM1S2",
            "DomainTypeId": 4000,
            "DomainTypeValue": "MSM",
            "DomainRoleTypeId": 3000,
            "DomainRoleTypeValue": "LEAD",
            "Version": "1.20.00",
            "Local": false,
            "GroupId": "28bf881c-f736-440d-b327-2fb0b2d7fd55",
            "GroupName": "test",
            "BackupLead": false,
            "Capabilities": [],
            "BackupLeadHealth": 2000
        }
    ]
}

Table 1. AttributesThis table lists the attributes that this method supports.
Attribute	Description
Id	Record ID.
DeviceId	Device ID.
Address	IP address.
Name	Name of the chassis.
Description	Description of the chassis.
Identifier	Service Tag of the chassis.
DomainTypeId	Information for internal programmatic use.
DomainTypeValue	Information for internal programmatic use.
DomainRoleTypeId	ID of the domain role. Possible value: 3000—LEAD 3001—MEMBER 3002—STANDALONE
DomainRoleTypeValue	Type of domain role. Possible values: LEAD MEMBER STANDALONE
Version	Version of OME–Modular.
Local	TRUE—Indicates that this domain is the local domain where the API is run. FALSE—Indicates that this domain is the remote domain where the API is run.
GroupId	Unique identifier of the group across different domains.
GroupName	Group name for the MCM domain group.
BackupLead	Indicates if the domain is a backup lead.
Capabilities	Indicates the capabilities of the domain.
LEADBACKUPCOMPATIBLE	Indicates if the domain is backup lead eligible.
BackupHealth	Indicates the health of lead data replication on the backup chassis and if the backup data is current or stale when compared to the lead data. The backup health is applicable only to backup lead domain the API, /api/ManagementDomainService/Domains. In the other domains, the backup lead is displayed as "2000" or unknown. The backup health for backup lead chassis is displayed as "2000" or unknown when the API is run on a member chassis.