OpenManage Enterprise Version 3.3.1 and OpenManage Enterprise - Modular Edition Version 1.10.00 RESTful API Guide

PDF

PUT method for ManagementDomainService

This method creates a Multi-Chassis Management (MCM) domain or updates an existing domain.

Description

Creates or updates an MCM domain.

Privilege

APPLIANCE_SETUP

HTTP response codes

200

Example request body

Request for creating a group


{
  "GroupName": "Example-Group",
  "GroupDescription": "Example-Group",
  "JoinApproval": "Automatic",
  "ConfigReplication":
  [
    {
      "ConfigType": "Power",
      "Enabled": false
    },
    {
      "ConfigType": "UserAuthentication",
      "Enabled": true
    },
    {
      "ConfigType": "AlertDestinations",
      "Enabled": false
    },
    {
      "ConfigType": "TimeSettings",
      "Enabled": false
    },
    {
      "ConfigType": "ProxySettings",
      "Enabled": false
    },
    {
      "ConfigType": "SecuritySettings",
      "Enabled": false
    },
    {
      "ConfigType": "NetworkServices",
      "Enabled": false
    },
    {
      "ConfigType": "LocalAccessConfiguration",
      "Enabled": false
    }
  ],"VirtualIPConfiguration": {
			"IPv4": {
						"StaticIPv4Address":"10.35.155.155",
						"SubnetMask":"255.255.255.32",
						"Gateway":"10.35.2.1"
			}
		}
}

Example response body

Request for creating a group

{
  "JobId": 36183,
  "Status": "Success"
}

Example request body

Request for editing a group

{
		"GroupId": "91e0b654-9de4-4a62-b5b1-c0da11d81b70",  --Mandatory
  "DeviceGroupId": 31436, --Optional
  "GroupName": "Example-Group", -Mandatory
  "GroupDescription": "Example-Group",  Optional
  "JoinApproval": "Automatic",  -Mandatory
  "ConfigReplication":
  [
    {
      "ConfigType": "Power",
      "Enabled": false
    },
    {
      "ConfigType": "UserAuthentication",
      "Enabled": true
    },
    {
      "ConfigType": "AlertDestinations",
      "Enabled": false
    },
    {
      "ConfigType": "TimeSettings",
      "Enabled": false
    },
    {
      "ConfigType": "ProxySettings",
      "Enabled": false
    },
    {
      "ConfigType": "SecuritySettings",
      "Enabled": false
    },
    {
      "ConfigType": "NetworkServices",
      "Enabled": false
    },
    {
      "ConfigType": "LocalAccessConfiguration",
      "Enabled": false
    }
  ]
}

Example response body

Request for editing a group

{
  "JobId": 36181,
  "Status": "SUCCESS"
}

Example request body

Request for configuring static IPv4 on the lead chassis

{
        "GroupName": "256",
        "GroupDescription": "",
        "JoinApproval": "Manual",
        "ConfigReplication": [
            {
                "ConfigType": "UserAuthentication",
                "Enabled": false
            },
            {
                "ConfigType": "NetworkServices",
                "Enabled": false
            },
            {
                "ConfigType": "AlertDestinations",
                "Enabled": false
            },
            {
                "ConfigType": "LocalAccessConfiguration",
                "Enabled": false
            },
            {
                "ConfigType": "Power",
                "Enabled": false
            },
            {
                "ConfigType": "ProxySettings",
                "Enabled": false
            },
            {
                "ConfigType": "TimeSettings",
                "Enabled": false
            },
            {
                "ConfigType": "SecuritySettings",
                "Enabled": false
            }
        ],
        "VirtualIPConfiguration": {
			"IPv4": {
						"StaticIPv4Address":"10.35.155.155",
						"SubnetMask":"255.255.255.32",
						"Gateway":"10.35.2.1"
			}
		}
}

Example response body

Request for configuring static IPv4 on the lead chassis

{
		"GroupId": "4964",
		"Status": "Success"
}

NOTE: You can use the API, /api/JobService/Jobs(JobId) for polling the job status.

Table 1. AttributesThis table lists the attributes that this method supports.
Attribute	Description
GroupId	Unique group ID across different domains.
GroupName	Name of the group.
GroupDescription	Description of the group.
JoinApproval	Join approval Automatic: Join requests from a stand-alone chassis are automatically approved. Manual: Join requests from a stand-alone chassis are queued on the lead for approval of the administrator. Onboarding of the remote chassis does not get initiated until approved.
ConfigReplication	Configuration that is replicated when a new domain joins this group.
ConfigType	Configuration type.
Enabled	Indicates if the configuration type is propagated to the member domain.
DeviceGroupId	The ID of the device group associated with the management domain.
VirtualIPConfiguration	The virtual IP that must be configured on the lead chassis.
IPv4	Details of the virtual IPv4 address.
StaticIPv4Address	Static IPv4 that must be configured for the lead chassis.
SubnetMask	Subnet mask that must be configured for the lead chassis.
Gateway	Gateway that must be configured for the lead chassis.