{ "opencollection": "1.0.0", "info": { "name": "FlashArray REST Active Directory Vchost Connections API", "version": "2.52" }, "items": [ { "info": { "name": "Vchost Connections", "type": "folder" }, "items": [ { "info": { "name": "Pure Storage List the Vchost-connections Between Protocol Endpoint and Vchost.", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/vchost-connections", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "all_vchosts", "value": "", "type": "query", "description": "If set to `true`, the storage container represented by the protocol endpoint\nis accessible to all vchosts.\nUsers should not specify `vchost_ids` or `vchost_names` in the request.\nIf set to `false`, the storage container represented by the protocol endpoint\nis only accessible to the vchosts that have explicit vchost-connections with\nthe protocol endpoint. Users need to specify `vchost_ids` or `vchost_names` in the request.\n" }, { "name": "continuation_token", "value": "", "type": "query", "description": "A token used to retrieve the next page of data\nwith some consistency guaranteed.\nThe token is a Base64 encoded value.\nSet `continuation_token` to the system-generated token taken from the `x-next-token`\nheader field of the response.\nA query has reached its last page when the response does not include a token.\nPagination requires the `limit` and `continuation_token`\nquery parameters.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Narrows down the results to only the response objects\nthat satisfy the filter criteria.\n" }, { "name": "limit", "value": "10", "type": "query", "description": "Limits the size of the response to the specified number of objects on each page.\nTo return the total number of resources, set `limit=0`.\nThe total number of resources is returned as a `total_item_count` value.\nIf the page size requested is larger than the system maximum limit,\nthe server returns the maximum limit, disregarding the requested page size.\n" }, { "name": "offset", "value": "10", "type": "query", "description": "The starting position based on the results of the query\nin relation to the full set of response objects returned.\n" }, { "name": "protocol_endpoint_ids", "value": "", "type": "query", "description": "A comma-separated list of protocol endpoint IDs.\nPerforms the operation on the protocol endpoints specified.\nFor example, `peid01,peid02`.\nCannot be used in conjunction with `protocol_endpoint_names`.\nIf the list contains more than one value,\nthen `vchost_ids` or `vchost_names` must have exactly one value.\n" }, { "name": "protocol_endpoint_names", "value": "", "type": "query", "description": "A comma-separated list of protocol endpoint names.\nPerforms the operation on the protocol endpoints specified.\nFor example, `pe01,pe02`.\nCannot be used in conjunction with `protocol_endpoint_ids`.\nIf the list contains more than one value,\nthen `vchost_ids` or `vchost_names` must have exactly one value.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sorts the response objects by the specified fields. Sorting can be applied to any field name\n in the response, in ascending order by default, or in descending order by prefixing the\n field name with a minus sign (-). Multiple fields can be specified as a comma-separated\n list (e.g., sort volumes by size descending, then by name ascending). If sort is provided,\n the response will not include a continuation_token.\n" }, { "name": "total_item_count", "value": "", "type": "query", "description": "If set to `true`, the `total_item_count` matching the\nspecified query parameters is calculated and returned in\nthe response. If set to `false`, the `total_item_count`\nis `null` in the response. This may speed up queries\nwhere the `total_item_count` is large. If not specified,\ndefaults to `false`.\n" }, { "name": "vchost_ids", "value": "", "type": "query", "description": "A comma-separated list of vchost IDs.\nPerforms the operation on the vchosts specified.\nFor example, `vchostid01,vchostid02`.\nCannot be used in conjunction with `vchost_names`.\nIf the list contains more than one value,\nthen `protocol_endpoint_ids` or `protocol_endpoint_names` must have exactly one value.\n" }, { "name": "vchost_names", "value": "", "type": "query", "description": "A comma-separated list of vchost names.\nPerforms the operation on the vchosts specified.\nFor example, `vchost01,vchost02`.\nCannot be used in conjunction with `vchost_ids`.\nIf the list contains more than one value,\nthen `protocol_endpoint_ids` or `protocol_endpoint_names` must have exactly one value.\n" } ] }, "docs": "Displays a list of vchost-connections between the protocol endpoint and vchost.\n\n" }, { "info": { "name": "Pure Storage Create a Vchost-connection Between Protocol Endpoint and Vchost.", "type": "http" }, "http": { "method": "POST", "url": "/api/2.52/vchost-connections", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "all_vchosts", "value": "", "type": "query", "description": "If set to `true`, the storage container represented by the protocol endpoint\nis accessible to all vchosts.\nUsers should not specify `vchost_ids` or `vchost_names` in the request.\nIf set to `false`, the storage container represented by the protocol endpoint\nis only accessible to the vchosts that have explicit vchost-connections with\nthe protocol endpoint. Users need to specify `vchost_ids` or `vchost_names` in the request.\n" }, { "name": "allow_stretched_multi_vchost", "value": "", "type": "query", "description": "If set to `true`, users are allowed to create a new\nvchost-connection to a stretched container that already has\na vchost-connection. In principle, a stretched container can\nonly have one vchost-connection at a time.\n" }, { "name": "protocol_endpoint_ids", "value": "", "type": "query", "description": "A comma-separated list of protocol endpoint IDs.\nPerforms the operation on the protocol endpoints specified.\nFor example, `peid01,peid02`.\nCannot be used in conjunction with `protocol_endpoint_names`.\nIf the list contains more than one value,\nthen `vchost_ids` or `vchost_names` must have exactly one value.\n" }, { "name": "protocol_endpoint_names", "value": "", "type": "query", "description": "A comma-separated list of protocol endpoint names.\nPerforms the operation on the protocol endpoints specified.\nFor example, `pe01,pe02`.\nCannot be used in conjunction with `protocol_endpoint_ids`.\nIf the list contains more than one value,\nthen `vchost_ids` or `vchost_names` must have exactly one value.\n" }, { "name": "vchost_ids", "value": "", "type": "query", "description": "A comma-separated list of vchost IDs.\nPerforms the operation on the vchosts specified.\nFor example, `vchostid01,vchostid02`.\nCannot be used in conjunction with `vchost_names`.\nIf the list contains more than one value,\nthen `protocol_endpoint_ids` or `protocol_endpoint_names` must have exactly one value.\n" }, { "name": "vchost_names", "value": "", "type": "query", "description": "A comma-separated list of vchost names.\nPerforms the operation on the vchosts specified.\nFor example, `vchost01,vchost02`.\nCannot be used in conjunction with `vchost_ids`.\nIf the list contains more than one value,\nthen `protocol_endpoint_ids` or `protocol_endpoint_names` must have exactly one value.\n" } ] }, "docs": "Creates a vchost-connection between protocol endpoint and vchost.\nEach vchost is associated with a vCenter. Each protocol endpoint\nis associated with a storage container. A vchost-connection makes\nthe storage container accessible to the vCenter when the vCenter\nattempts to mount the container. One of `protocol_endpoint_names`\nor `protocol_endpoint_ids` query parameters and one of `vchost_names`\nor `vchost_ids` query parameters are required. But if `all_vchosts` is\nset to `true`, `vchost_names` a" }, { "info": { "name": "Pure Storage Delete the Vchost-connection Between a Protocol Endpoint and its Vchost", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.52/vchost-connections", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "all_vchosts", "value": "", "type": "query", "description": "If set to `true`, the storage container represented by the protocol endpoint\nis accessible to all vchosts.\nUsers should not specify `vchost_ids` or `vchost_names` in the request.\nIf set to `false`, the storage container represented by the protocol endpoint\nis only accessible to the vchosts that have explicit vchost-connections with\nthe protocol endpoint. Users need to specify `vchost_ids` or `vchost_names` in the request.\n" }, { "name": "protocol_endpoint_ids", "value": "", "type": "query", "description": "A comma-separated list of protocol endpoint IDs.\nPerforms the operation on the protocol endpoints specified.\nFor example, `peid01,peid02`.\nCannot be used in conjunction with `protocol_endpoint_names`.\nIf the list contains more than one value,\nthen `vchost_ids` or `vchost_names` must have exactly one value.\n" }, { "name": "protocol_endpoint_names", "value": "", "type": "query", "description": "A comma-separated list of protocol endpoint names.\nPerforms the operation on the protocol endpoints specified.\nFor example, `pe01,pe02`.\nCannot be used in conjunction with `protocol_endpoint_ids`.\nIf the list contains more than one value,\nthen `vchost_ids` or `vchost_names` must have exactly one value.\n" }, { "name": "vchost_ids", "value": "", "type": "query", "description": "A comma-separated list of vchost IDs.\nPerforms the operation on the vchosts specified.\nFor example, `vchostid01,vchostid02`.\nCannot be used in conjunction with `vchost_names`.\nIf the list contains more than one value,\nthen `protocol_endpoint_ids` or `protocol_endpoint_names` must have exactly one value.\n" }, { "name": "vchost_names", "value": "", "type": "query", "description": "A comma-separated list of vchost names.\nPerforms the operation on the vchosts specified.\nFor example, `vchost01,vchost02`.\nCannot be used in conjunction with `vchost_ids`.\nIf the list contains more than one value,\nthen `protocol_endpoint_ids` or `protocol_endpoint_names` must have exactly one value.\n" } ] }, "docs": "Deletes the vchost-connection between a protocol endpoint and its vchost.\nThe storage container represented by the protocol endpoint will no longer\nbe visible to the vCenter represented by the vchost.\nOne of the `protocol_endpoint_names` or `protocol_endpoint_ids` query parameters,\nand one of the `vchost_names` or `vchost_ids` query parameters are required.\nBut if `all_vchosts` is set to `true`, `vchost_names` and `vchost_ids`\nshould not be specified.\n\n" } ] } ], "bundled": true }