OpenManage Enterprise Version 3.2 and OpenManage Enterprise - Modular Edition Version 1.00.10 RESTful API Guide

PDF

PUT method for ManagementDomainService

This method creates a new 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

Example for creating a group
Input:
{
  "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
    }
  ]
}

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

Example for editing a group
Input:
{
		"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
    }
  ]
}

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

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 standalone chassis are automatically approved. Manual: Join requests from a standalone chassis are queued on the lead for administrator's approval. 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.