EKM Cluster:Update Cluster

Search (SHIFT+S)

Update Cluster

PUT /ekm/cluster/{id}

id

Required Roles

Requires one of the following roles:

SYSTEM_ADMIN
SYSTEM_MONITOR

Request Payload

<ekmcluster_update>
   <name></name>
   <ekm_mapping_set>
      <ekm_mapping>
         <vdc_id></vdc_id>
         <ekm_servers_list>
            <ekm_server></ekm_server>
         </ekm_servers_list>
      </ekm_mapping>
   </ekm_mapping_set>
</ekmcluster_update>

{
  "name": "",
  "ekm_mapping_set": [
    {
      "vdc_id": "",
      "ekm_servers_list": [
        ""
      ]
    }
  ]
}

All parameters are required unless otherwise stated.

Field	Description	Type	Notes
ekmcluster_update
name		String
ekm_mapping_set
ekm_mapping			0-* Elements
vdc_id		String
ekm_servers_list
ekm_server		String	0-* Elements

Response Body

Field	Description	Type	Notes
ekmcluster
cluster_type		String
last_modified		Long
status		String
ekm_mapping_set
ekm_mapping			0-* Elements
vdc_id		String
ekm_servers_list
ekm_server		String	0-* Elements
activation_initiated_on_vdc		String
activation_message		String
name	Name assigned to this resource in ECS. The resource name is set by a user and can be changed at any time. It is not a unique identifier.	String
id	Identifier that is generated by ECS when the resource is created. The resource Id is guaranteed to be unique and immutable across all virtual data centers for all time.	URI	Valid Values: urn:storageos:resource-type:UUID:
link	Hyperlink to the details for this resource
creation_time	Timestamp that shows when this resource was created in ECS	DateTime	Valid Values: YYYY-MM-DDTHH:mm:ssZ
tags	Keywords and labels that can be added by a user to a resource to make it easy to find when doing a search.
tag		String	0-* Elements
inactive	Indicates whether the resource is inactive. When a user removes a resource, the resource is put in this state before it is removed from the ECS database.	Boolean	Valid Values: true false
global	Indicates whether the resource is global.	Boolean	Valid Values: true false
remote	Indicates whether the resource is remote.	Boolean	Valid Values: true false
vdc
id	Id of the related object	URI
link	Hyperlink to the related object
internal	Indicates whether the resource is an internal resource.	Boolean	Valid Values: true false

Examples

Request

PUT https://localhost:4443/ekm/cluster/urn:EKMCluster:77a5b6f9-2828-48d6-91a5-738204fbb207

Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8" ?>
<ekmcluster_update>
      <name>testcluster</name>
      <vdc_id>vdcId</vdc_id>
      <ekm_mapping_set>
           <ekm_mapping>
              <vdc_id>urn:storageos:VirtualDataCenterData:e02b05ef-5ec3-4b06-ad55-a2a9a52e5f01</vdc_id>
              <ekm_servers_list>
                   <ekm_server>urn:storageos:EKMServer:ad164ea1-f7be-3476-9e69-a93e0bec8683</ekm_server>
              </ekm_servers_list>
           </ekm_mapping>
      </ekm_mapping_set>
</ekmcluster_update>

Response

HTTP/1.1 200 OK
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ekmcluster>
     <id>77a5b6f9-2828-48d6-91a5-738204fbb207</id>
     <name>testcluster</name>
     <tags/>
     <cluster_type>GEMALTO</cluster_type>
     <last_modified>1539623094248</last_modified>
     <ekm_mapping_set>
         <ekm_mapping>
            <ekm_servers_list>
              <ekm_server>urn:storageos:EKMServer:ad164ea1-f7be-3476-9e69-a93e0bec8683</ekm_server>
            </ekm_servers_list>
            <vdc_id>urn:storageos:VirtualDataCenterData:e02b05ef-5ec3-4b06-ad55-a2a9a52e5f01</vdc_id>
         </ekm_mapping>
     </ekm_mapping_set>
     <status>UNACTIVATED</status>
</ekmcluster>

Request

PUT https://localhost:4443/ekm/cluster/urn:EKMCluster:77a5b6f9-2828-48d6-91a5-738204fbb207
Content-Type: application/json
{
      "name": "testcluster",
      "ekm_mapping_set":[
           "ekm_mapping":{
              "vdc_id": "urn:storageos:VirtualDataCenterData:e02b05ef-5ec3-4b06-ad55-a2a9a52e5f01",
              "ekm_servers_list":[
                 "ekm_server": "testserver022",
               ],
           }
      ]
}

Response

HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": "urn:EKMCluster:77a5b6f9-2828-48d6-91a5-738204fbb207",
    "name": "testcluster",
    "cluster_type": "GEMALTO",
    "ekm_mapping_set":[
           "ekm_mapping":{
              "vdc_id": "urn:storageos:VirtualDataCenterData:e02b05ef-5ec3-4b06-ad55-a2a9a52e5f01",
              "ekm_servers_list":[
                 "ekm_server": "urn:storageos:EKMServer:ad164ea1-f7be-3476-9e69-a93e0bec8683",
               ],
           }
      ],
    "status": "UNACTIVATED"
}