Export:Update Export Group
Search (SHIFT+S)
API Reference
API Changes

Update Export Group

PUT /block/exports/{id}

Update an export group which includes:

  1. Add/Remove block objects (volumes, mirrors and snapshots)
  2. Add/remove clusters
  3. Add/remove hosts
  4. Add/remove initiators
Depending on the export group type (Initiator, Host or Cluster), the request is restricted to enforce the same rules as {@link #createExportGroup(ExportCreateParam)}:
  1. For initiator type groups, only initiators are accepted in the request. Further the initiators must be in the same host as the existing initiators.
  2. For host type groups, only hosts and initiators that belong to existing hosts will be accepted.
  3. For cluster type groups, only clusters, hosts and initiators will be accepted. Hosts and initiators must belong to existing clusters and hosts.
Note: The export group name, project and varray can not be modified.

idthe URN of a ViPR export group to be updated

Required Roles

  • TENANT_ADMIN

Request Payload

All parameters are required unless otherwise stated.

Field Description Type Notes
<block_export_update>
<cluster_changes>    
<add>
<cluster> URI 0-* Elements
</add>
<remove>
<cluster> URI 0-* Elements
</remove>
</cluster_changes>      
<host_changes>    
<add>
<host> URI 0-* Elements
</add>
<remove>
<host> URI 0-* Elements
</remove>
</host_changes>      
<initiator_changes>    
<add>
<initiator> URI 0-* Elements
</add>
<remove>
<initiator> URI 0-* Elements
</remove>
</initiator_changes>      
<volume_changes> Add or remove a list of volume or volume snapshots from the export
<path_parameters>    
<max_paths> Integer Valid Values:
  •  Range: 1..65535
<paths_per_initiator> Integer Valid Values:
  •  Range: 1..65535
<min_paths> Integer Valid Values:
  •  Range: 1..65535
<storage_ports>
<storage_port> URI 0-* Elements
</storage_ports>
</path_parameters>      
</block_export_update>

Response Body

The update job tracking task id

This is an asychronous operation that returns a task object. For information on working with tasks, see Asynchronous Operations.

Field Description Type Notes
<task>
<op_id> The task operation id String
<resource>    
<name> The name of the resource String
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</resource>      
<tenant>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</tenant>      
<associated_resources> A list of links for associated resources
<associated_resource>     0-* Elements
<name> The name of the resource String
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</associated_resource>      
</associated_resources>
<state> The state of the task String Valid Values:
  •  queued = task is queued
  •  pending = task is pending
  •  ready = task succeed
  •  error = task fails
<message> The task detail message String
<description> The description of the task String
<service_error>    
<code> The numerical code associated with the error encountered when processing a service request Integer
<description> The description of the error String
<details> Detailed information concerning the error String
</service_error>      
<start_time> The date and time of when the task was started DateTime
<end_time> The date and time of when the task ended DateTime
<progress> Integer
<workflow>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</workflow>      
<queuedStartTime> DateTime
<queueName> String
<name> The name assigned to this resource in ViPR. The resource name is set by a user and can be changed at any time. It is not a unique identifier. String
<id> An identifier that is generated by ViPR 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> A hyperlink to the details for this resource
<creation_time> A timestamp that shows when this resource was created in ViPR 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
</tags>
<inactive> Whether or not the resource is inactive. When a user removes a resource, the resource is put in this state before it is removed from the ViPR database. Boolean Valid Values:
  •  true
  •  false
<global> Boolean
<remote> Boolean
<vdc>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</vdc>      
<internal> Whether or not the resource is an internal resource. Boolean Valid Values:
  •  true
  •  false
</task>

JSON Example

Request
PUT: https://192.168.0.0:4443/block/exports/urn:storageos:ExportGroup:ca33f0b6-68c6-458a-8fa4-f1cb5fc231c3:.json HTTP/1.1

Content-Type: application/json
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>

{
    "cluster_changes": {},
    "host_changes": {
    		"add" :[
    			"urn:storageos:Host:adacd011-ec90-4db3-929d-550db9b78db5:vdc1"
    		]
    },
    "initiator_changes": {
    		"add":[
    			"urn:storageos:Initiator:d90880b7-b122-4cc3-ae91-56196382b497:vdc1"
    		]
    },
    "volume_changes": {
    		"add":[
    			{"id":"urn:storageos:Volume:9f67ed59-f585-4613-ad24-73c5e639ae99:vdc1"}
		],
             "remove":["urn:storageos:Volume:ea78d978-3864-4691-92fa-a3110b1a713b:vdc1"]
    }
}
Response
HTTP/1.1 200 OK
Content-Type: application/json

{
	name: "UPDATE EXPORT GROUP",
	id: "urn:storageos:Task:d58bebaf-d1e3-43d8-80f0-260f3869d2c6:vdc1",
	link: {
		rel: "self",
		href: "/vdc/tasks/urn:storageos:Task:d58bebaf-d1e3-43d8-80f0-260f3869d2c6:vdc1",
	},
	inactive: false,
	global: false,
	remote: false,
	vdc: {
		id: "urn:storageos:VirtualDataCenter:30f5bedc-048c-470c-8e7c-53118cfb82f9:vdc1",
		link: {
				rel: "self",
				href: "/vdc/urn:storageos:VirtualDataCenter:30f5bedc-048c-470c-8e7c-53118cfb82f9:vdc1"
			}
		}
	internal: false
	resource: {
		id: "urn:storageos:ExportGroup:67769dba-b1cc-4927-9b0d-0210645c2204:vdc1",
		name: "10.247.78.47",
		link: {
			rel: "self",
			href: "/block/exports/urn:storageos:ExportGroup:67769dba-b1cc-4927-9b0d-0210645c2204:vdc1"
		},
	},
	tenant: {
		id: "urn:storageos:TenantOrg:b4475e79-0424-4588-b746-0e5a49e7d531:global",
		link: {
			rel: "self",
			href: "/tenants/urn:storageos:TenantOrg:b4475e79-0424-4588-b746-0e5a49e7d531:global",
		}
	},
	state: "pending",
	description: "update export group operation",
	progress: 0,
	creation_time: 1438060151458,
	op_id: "728015ee-c4b1-446b-9f0f-a610b24d2422",
	associated_resources: [0],
	start_time: 1438060151457
}
EMC ViPR REST API
Notes: