Cns Volume Manager Cns Configure Volume AC Ls

Cns Volume Manager Cns Configure Volume AC Ls

Modify the ACL configurations for existing volumes.

Multiple requests configuring the same volume at the same time will be serialized in CNS.

Note that this API is currently supported for file volumes only.

Following privileges will be required on file volumes, to perform this operation:

  • Host.Config.Storage on vSAN file service enabled vSAN cluster, required for file volume only

Faults that can be set in individual result entry, corresponding to each CnsVolumeACLConfigureSpec instance in input:

  • vmodl.fault.InvalidArgument Set if the input spec has invlid field.
  • vim.fault.NotFound Set in case of the volume can not be found.
  • vim.fault.CnsFault Set in case of any other failure scenarios.
Request
URI
POST
https://{api_host}/sdk/vim25/{release}/vsan/CnsVolumeManager/{moId}/CnsConfigureVolumeACLs
COPY
Path Parameters
string
moId
Required

The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case CnsVolumeManager/{moId}.

string
release
Required

The vSphere release schema. The current specification covers vSphere 9.0.0.0 APIs.

Request Body
CnsConfigureVolumeACLsRequestType of type(s) application/json
Required 
"CnsConfigureVolumeACLsRequestType Object"
array of object
ACLConfigSpecs
Required

Specifications for volumes ACL configuration.

Authentication
This operation uses the following authentication methods.
Responses
200

Task to track the progress and overall state of this operation.

Returns MoRefTask of type(s) application/json 
"MoRefTask Object"

500

InvalidArgument: Thrown if: 1) two or more ACLConfigSpec instances are passed; 2) the volume ID is empty; 3) file service reports the invalid inputs.

NotFound: Thrown if the volume or cluster can not be found by CNS.

CnsFault: Thrown for any other authorization failure scenrios.

Returns MethodFault of type(s) application/json
This response body class contains all of the following: InlineMethodFault0 
"MethodFault Object"
faultCause
Optional

Fault which is the cause of this fault.

array of object
faultMessage
Optional

Message which has details about the error Message can also contain a key to message catalog which can be used to generate better localized messages.


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/vsan/CnsVolumeManager/{moId}/CnsConfigureVolumeACLs
On This Page
V San Service Api Operations
POST
Cns Volume Manager Cns Attach Volume
POST
Cns Volume Manager Cns Configure Volume AC Ls
POST
Cns Volume Manager Cns Create Volume
POST
Cns Volume Manager Cns Create Snapshots
POST
Cns Volume Manager Cns Delete Volume
POST
Cns Volume Manager Cns Delete Snapshots
POST
Cns Volume Manager Cns Detach Volume
POST
Cns Volume Manager Cns Extend Volume
POST
Cns Volume Manager Cns Query Volume
POST
Cns Volume Manager Cns Query Async
POST
Cns Volume Manager Cns Reconfig Volume Policy
POST
Cns Volume Manager Cns Relocate Volume
POST
Cns Volume Manager Cns Update Volume Metadata