fusion.PlacementGroupsApi

All URIs are relative to https://api.pure1.purestorage.com/fusion/api/1.2

Method	HTTP request	Description
create_placement_group	POST /tenants/{tenant_name}/tenant-spaces/{tenant_space_name}/placement-groups	Creates a Placement Group.
delete_placement_group	DELETE /tenants/{tenant_name}/tenant-spaces/{tenant_space_name}/placement-groups/{placement_group_name}	Deletes a specific Placement Group.
get_placement_group	GET /tenants/{tenant_name}/tenant-spaces/{tenant_space_name}/placement-groups/{placement_group_name}	Gets a specific Placement Group.
get_placement_group_by_id	GET /resources/placement-groups/{placement_group_id}	Gets a specific Placement Group.
get_placement_group_sessions	GET /tenants/{tenant_name}/tenant-spaces/{tenant_space_name}/placement-groups/{placement_group_name}/sessions	Gets iSCSI sessions data of a specific Placement Group.
get_placement_groups_performance	GET /tenants/{tenant_name}/tenant-spaces/{tenant_space_name}/placement-groups/{placement_group_name}/performance	Get performance metrics of a specific Placement Group
get_placement_groups_space	GET /tenants/{tenant_name}/tenant-spaces/{tenant_space_name}/placement-groups/{placement_group_name}/space	Get space metrics of a specific Placement Group
list_placement_groups	GET /tenants/{tenant_name}/tenant-spaces/{tenant_space_name}/placement-groups	Gets a list of all Placement Groups.
query_placement_groups	GET /resources/placement-groups	Returns a list of Placement Groups from query
update_placement_group	PATCH /tenants/{tenant_name}/tenant-spaces/{tenant_space_name}/placement-groups/{placement_group_name}	Updates a specific Placement Group.

create_placement_group

Operation create_placement_group(body, tenant_name, tenant_space_name, x_request_id=x_request_id, authorization=authorization, x_correlation_id=x_correlation_id)

Creates a Placement Group.

Example

from __future__ import print_function
import time
import fusion
from fusion.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = fusion.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = fusion.PlacementGroupsApi(fusion.ApiClient(configuration))
body = fusion.PlacementGroupPost() # PlacementGroupPost | 
tenant_name = 'tenant_name_example' # str | The Tenant name
tenant_space_name = 'tenant_space_name_example' # str | The Tenant Space name
x_request_id = 'x_request_id_example' # str | The Request ID supplied with the request, used to perform operations idempotently. (optional)
authorization = 'authorization_example' # str | Access token (in JWT format) required to use any API endpoint. (optional)
x_correlation_id = 'x_correlation_id_example' # str | The Correlation ID provided will be added to log messages and can be used for support. The same Correlation ID may be used for separate requests, to track a higher level workflow. (optional)

try:
    # Creates a Placement Group.
    api_response = api_instance.create_placement_group(body, tenant_name, tenant_space_name, x_request_id=x_request_id, authorization=authorization, x_correlation_id=x_correlation_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PlacementGroupsApi->create_placement_group: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	PlacementGroupPost
tenant_name	str	The Tenant name
tenant_space_name	str	The Tenant Space name
x_request_id	str	The Request ID supplied with the request, used to perform operations idempotently.	[optional]
authorization	str	Access token (in JWT format) required to use any API endpoint.	[optional]
x_correlation_id	str	The Correlation ID provided will be added to log messages and can be used for support. The same Correlation ID may be used for separate requests, to track a higher level workflow.	[optional]

Return type

Operation

Authorization

accessToken, oauth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_placement_group

Operation delete_placement_group(tenant_name, tenant_space_name, placement_group_name, x_request_id=x_request_id, authorization=authorization, x_correlation_id=x_correlation_id)

Deletes a specific Placement Group.

Example

from __future__ import print_function
import time
import fusion
from fusion.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = fusion.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = fusion.PlacementGroupsApi(fusion.ApiClient(configuration))
tenant_name = 'tenant_name_example' # str | The Tenant name
tenant_space_name = 'tenant_space_name_example' # str | The Tenant Space name
placement_group_name = 'placement_group_name_example' # str | The Placement Group name
x_request_id = 'x_request_id_example' # str | The Request ID supplied with the request, used to perform operations idempotently. (optional)
authorization = 'authorization_example' # str | Access token (in JWT format) required to use any API endpoint. (optional)
x_correlation_id = 'x_correlation_id_example' # str | The Correlation ID provided will be added to log messages and can be used for support. The same Correlation ID may be used for separate requests, to track a higher level workflow. (optional)

try:
    # Deletes a specific Placement Group.
    api_response = api_instance.delete_placement_group(tenant_name, tenant_space_name, placement_group_name, x_request_id=x_request_id, authorization=authorization, x_correlation_id=x_correlation_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PlacementGroupsApi->delete_placement_group: %s\n" % e)

Parameters

Name	Type	Description	Notes
tenant_name	str	The Tenant name
tenant_space_name	str	The Tenant Space name
placement_group_name	str	The Placement Group name
x_request_id	str	The Request ID supplied with the request, used to perform operations idempotently.	[optional]
authorization	str	Access token (in JWT format) required to use any API endpoint.	[optional]
x_correlation_id	str	The Correlation ID provided will be added to log messages and can be used for support. The same Correlation ID may be used for separate requests, to track a higher level workflow.	[optional]

Return type

Operation

Authorization

accessToken, oauth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_placement_group

PlacementGroup get_placement_group(tenant_name, tenant_space_name, placement_group_name, x_request_id=x_request_id, authorization=authorization, x_correlation_id=x_correlation_id)

Gets a specific Placement Group.

Example

from __future__ import print_function
import time
import fusion
from fusion.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = fusion.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = fusion.PlacementGroupsApi(fusion.ApiClient(configuration))
tenant_name = 'tenant_name_example' # str | The Tenant name
tenant_space_name = 'tenant_space_name_example' # str | The Tenant Space name
placement_group_name = 'placement_group_name_example' # str | The Placement Group name
x_request_id = 'x_request_id_example' # str | The Request ID supplied with the request, used to perform operations idempotently. (optional)
authorization = 'authorization_example' # str | Access token (in JWT format) required to use any API endpoint. (optional)
x_correlation_id = 'x_correlation_id_example' # str | The Correlation ID provided will be added to log messages and can be used for support. The same Correlation ID may be used for separate requests, to track a higher level workflow. (optional)

try:
    # Gets a specific Placement Group.
    api_response = api_instance.get_placement_group(tenant_name, tenant_space_name, placement_group_name, x_request_id=x_request_id, authorization=authorization, x_correlation_id=x_correlation_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PlacementGroupsApi->get_placement_group: %s\n" % e)

Parameters

Name	Type	Description	Notes
tenant_name	str	The Tenant name
tenant_space_name	str	The Tenant Space name
placement_group_name	str	The Placement Group name
x_request_id	str	The Request ID supplied with the request, used to perform operations idempotently.	[optional]
authorization	str	Access token (in JWT format) required to use any API endpoint.	[optional]
x_correlation_id	str	The Correlation ID provided will be added to log messages and can be used for support. The same Correlation ID may be used for separate requests, to track a higher level workflow.	[optional]

Return type

PlacementGroup

Authorization

accessToken, oauth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_placement_group_by_id

PlacementGroup get_placement_group_by_id(placement_group_id, x_request_id=x_request_id, authorization=authorization, x_correlation_id=x_correlation_id)

Gets a specific Placement Group.

Example

from __future__ import print_function
import time
import fusion
from fusion.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = fusion.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = fusion.PlacementGroupsApi(fusion.ApiClient(configuration))
placement_group_id = 'placement_group_id_example' # str | The Placement Group ID
x_request_id = 'x_request_id_example' # str | The Request ID supplied with the request, used to perform operations idempotently. (optional)
authorization = 'authorization_example' # str | Access token (in JWT format) required to use any API endpoint. (optional)
x_correlation_id = 'x_correlation_id_example' # str | The Correlation ID provided will be added to log messages and can be used for support. The same Correlation ID may be used for separate requests, to track a higher level workflow. (optional)

try:
    # Gets a specific Placement Group.
    api_response = api_instance.get_placement_group_by_id(placement_group_id, x_request_id=x_request_id, authorization=authorization, x_correlation_id=x_correlation_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PlacementGroupsApi->get_placement_group_by_id: %s\n" % e)

Parameters

Name	Type	Description	Notes
placement_group_id	str	The Placement Group ID
x_request_id	str	The Request ID supplied with the request, used to perform operations idempotently.	[optional]
authorization	str	Access token (in JWT format) required to use any API endpoint.	[optional]
x_correlation_id	str	The Correlation ID provided will be added to log messages and can be used for support. The same Correlation ID may be used for separate requests, to track a higher level workflow.	[optional]

Return type

PlacementGroup

Authorization

accessToken, oauth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_placement_group_sessions

SessionList get_placement_group_sessions(tenant_name, tenant_space_name, placement_group_name, x_request_id=x_request_id, authorization=authorization, x_correlation_id=x_correlation_id)

Gets iSCSI sessions data of a specific Placement Group.

Example

from __future__ import print_function
import time
import fusion
from fusion.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = fusion.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = fusion.PlacementGroupsApi(fusion.ApiClient(configuration))
tenant_name = 'tenant_name_example' # str | The Tenant name
tenant_space_name = 'tenant_space_name_example' # str | The Tenant Space name
placement_group_name = 'placement_group_name_example' # str | The Placement Group name
x_request_id = 'x_request_id_example' # str | The Request ID supplied with the request, used to perform operations idempotently. (optional)
authorization = 'authorization_example' # str | Access token (in JWT format) required to use any API endpoint. (optional)
x_correlation_id = 'x_correlation_id_example' # str | The Correlation ID provided will be added to log messages and can be used for support. The same Correlation ID may be used for separate requests, to track a higher level workflow. (optional)

try:
    # Gets iSCSI sessions data of a specific Placement Group.
    api_response = api_instance.get_placement_group_sessions(tenant_name, tenant_space_name, placement_group_name, x_request_id=x_request_id, authorization=authorization, x_correlation_id=x_correlation_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PlacementGroupsApi->get_placement_group_sessions: %s\n" % e)

Parameters

Name	Type	Description	Notes
tenant_name	str	The Tenant name
tenant_space_name	str	The Tenant Space name
placement_group_name	str	The Placement Group name
x_request_id	str	The Request ID supplied with the request, used to perform operations idempotently.	[optional]
authorization	str	Access token (in JWT format) required to use any API endpoint.	[optional]
x_correlation_id	str	The Correlation ID provided will be added to log messages and can be used for support. The same Correlation ID may be used for separate requests, to track a higher level workflow.	[optional]

Return type

SessionList

Authorization

accessToken, oauth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_placement_groups_performance

Performance get_placement_groups_performance(tenant_name, tenant_space_name, placement_group_name, x_request_id=x_request_id, authorization=authorization, x_correlation_id=x_correlation_id)

Get performance metrics of a specific Placement Group

Example

from __future__ import print_function
import time
import fusion
from fusion.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = fusion.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = fusion.PlacementGroupsApi(fusion.ApiClient(configuration))
tenant_name = 'tenant_name_example' # str | The Tenant name
tenant_space_name = 'tenant_space_name_example' # str | The Tenant Space name
placement_group_name = 'placement_group_name_example' # str | The Placement Group name
x_request_id = 'x_request_id_example' # str | The Request ID supplied with the request, used to perform operations idempotently. (optional)
authorization = 'authorization_example' # str | Access token (in JWT format) required to use any API endpoint. (optional)
x_correlation_id = 'x_correlation_id_example' # str | The Correlation ID provided will be added to log messages and can be used for support. The same Correlation ID may be used for separate requests, to track a higher level workflow. (optional)

try:
    # Get performance metrics of a specific Placement Group
    api_response = api_instance.get_placement_groups_performance(tenant_name, tenant_space_name, placement_group_name, x_request_id=x_request_id, authorization=authorization, x_correlation_id=x_correlation_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PlacementGroupsApi->get_placement_groups_performance: %s\n" % e)

Parameters

Name	Type	Description	Notes
tenant_name	str	The Tenant name
tenant_space_name	str	The Tenant Space name
placement_group_name	str	The Placement Group name
x_request_id	str	The Request ID supplied with the request, used to perform operations idempotently.	[optional]
authorization	str	Access token (in JWT format) required to use any API endpoint.	[optional]
x_correlation_id	str	The Correlation ID provided will be added to log messages and can be used for support. The same Correlation ID may be used for separate requests, to track a higher level workflow.	[optional]

Return type

Performance

Authorization

accessToken, oauth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_placement_groups_space

Space get_placement_groups_space(tenant_name, tenant_space_name, placement_group_name, x_request_id=x_request_id, authorization=authorization, x_correlation_id=x_correlation_id)

Get space metrics of a specific Placement Group

Example

from __future__ import print_function
import time
import fusion
from fusion.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = fusion.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = fusion.PlacementGroupsApi(fusion.ApiClient(configuration))
tenant_name = 'tenant_name_example' # str | The Tenant name
tenant_space_name = 'tenant_space_name_example' # str | The Tenant Space name
placement_group_name = 'placement_group_name_example' # str | The Placement Group name
x_request_id = 'x_request_id_example' # str | The Request ID supplied with the request, used to perform operations idempotently. (optional)
authorization = 'authorization_example' # str | Access token (in JWT format) required to use any API endpoint. (optional)
x_correlation_id = 'x_correlation_id_example' # str | The Correlation ID provided will be added to log messages and can be used for support. The same Correlation ID may be used for separate requests, to track a higher level workflow. (optional)

try:
    # Get space metrics of a specific Placement Group
    api_response = api_instance.get_placement_groups_space(tenant_name, tenant_space_name, placement_group_name, x_request_id=x_request_id, authorization=authorization, x_correlation_id=x_correlation_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PlacementGroupsApi->get_placement_groups_space: %s\n" % e)

Parameters

Name	Type	Description	Notes
tenant_name	str	The Tenant name
tenant_space_name	str	The Tenant Space name
placement_group_name	str	The Placement Group name
x_request_id	str	The Request ID supplied with the request, used to perform operations idempotently.	[optional]
authorization	str	Access token (in JWT format) required to use any API endpoint.	[optional]
x_correlation_id	str	The Correlation ID provided will be added to log messages and can be used for support. The same Correlation ID may be used for separate requests, to track a higher level workflow.	[optional]

Return type

Space

Authorization

accessToken, oauth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_placement_groups

PlacementGroupList list_placement_groups(tenant_name, tenant_space_name, x_request_id=x_request_id, authorization=authorization, x_correlation_id=x_correlation_id, filter=filter, sort=sort, limit=limit, offset=offset, id=id, name=name, display_name=display_name, array_id=array_id, iqn=iqn, storage_service_id=storage_service_id, availability_zone_id=availability_zone_id, placement_engine=placement_engine)

Gets a list of all Placement Groups.

Example

from __future__ import print_function
import time
import fusion
from fusion.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = fusion.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = fusion.PlacementGroupsApi(fusion.ApiClient(configuration))
tenant_name = 'tenant_name_example' # str | The Tenant name
tenant_space_name = 'tenant_space_name_example' # str | The Tenant Space name
x_request_id = 'x_request_id_example' # str | The Request ID supplied with the request, used to perform operations idempotently. (optional)
authorization = 'authorization_example' # str | Access token (in JWT format) required to use any API endpoint. (optional)
x_correlation_id = 'x_correlation_id_example' # str | The Correlation ID provided will be added to log messages and can be used for support. The same Correlation ID may be used for separate requests, to track a higher level workflow. (optional)
filter = 'filter_example' # str | filter should use expression language for filtering (optional)
sort = 'sort_example' # str | Returns the response items in the order specified. Set sort to the field(s) in the response by which to sort. Sorting can be performed on any of the fields in the response, and the items can be sorted in ascending or descending order by these fields. By default, the response items are sorted in ascending order. To sort in descending order, append the minus sign (-) to the field. A single request can be sorted on multiple fields. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple fields, list the fields as comma-separated values. (E.g. \"sort=size-,name\") (optional)
limit = 56 # int |  (optional)
offset = 56 # int |  (optional)
id = 'id_example' # str |  (optional)
name = 'name_example' # str |  (optional)
display_name = 'display_name_example' # str |  (optional)
array_id = 'array_id_example' # str |  (optional)
iqn = 'iqn_example' # str |  (optional)
storage_service_id = 'storage_service_id_example' # str |  (optional)
availability_zone_id = 'availability_zone_id_example' # str |  (optional)
placement_engine = 'placement_engine_example' # str |  (optional)

try:
    # Gets a list of all Placement Groups.
    api_response = api_instance.list_placement_groups(tenant_name, tenant_space_name, x_request_id=x_request_id, authorization=authorization, x_correlation_id=x_correlation_id, filter=filter, sort=sort, limit=limit, offset=offset, id=id, name=name, display_name=display_name, array_id=array_id, iqn=iqn, storage_service_id=storage_service_id, availability_zone_id=availability_zone_id, placement_engine=placement_engine)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PlacementGroupsApi->list_placement_groups: %s\n" % e)

Parameters

Name	Type	Description	Notes
tenant_name	str	The Tenant name
tenant_space_name	str	The Tenant Space name
x_request_id	str	The Request ID supplied with the request, used to perform operations idempotently.	[optional]
authorization	str	Access token (in JWT format) required to use any API endpoint.	[optional]
x_correlation_id	str	The Correlation ID provided will be added to log messages and can be used for support. The same Correlation ID may be used for separate requests, to track a higher level workflow.	[optional]
filter	str	filter should use expression language for filtering	[optional]
sort	str	Returns the response items in the order specified. Set sort to the field(s) in the response by which to sort. Sorting can be performed on any of the fields in the response, and the items can be sorted in ascending or descending order by these fields. By default, the response items are sorted in ascending order. To sort in descending order, append the minus sign (-) to the field. A single request can be sorted on multiple fields. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple fields, list the fields as comma-separated values. (E.g. "sort=size-,name")	[optional]
limit	int		[optional]
offset	int		[optional]
id	str		[optional]
name	str		[optional]
display_name	str		[optional]
array_id	str		[optional]
iqn	str		[optional]
storage_service_id	str		[optional]
availability_zone_id	str		[optional]
placement_engine	str		[optional]

Return type

PlacementGroupList

Authorization

accessToken, oauth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

query_placement_groups

PlacementGroupList query_placement_groups(x_request_id=x_request_id, authorization=authorization, x_correlation_id=x_correlation_id, filter=filter, sort=sort, limit=limit, offset=offset, id=id, name=name, display_name=display_name, tenant_space_id=tenant_space_id, tenant_id=tenant_id, array_id=array_id, iqn=iqn, storage_service_id=storage_service_id, availability_zone_id=availability_zone_id, placement_engine=placement_engine, region_name=region_name, availability_zone_name=availability_zone_name, array_name=array_name)

Returns a list of Placement Groups from query

Example

from __future__ import print_function
import time
import fusion
from fusion.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = fusion.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = fusion.PlacementGroupsApi(fusion.ApiClient(configuration))
x_request_id = 'x_request_id_example' # str | The Request ID supplied with the request, used to perform operations idempotently. (optional)
authorization = 'authorization_example' # str | Access token (in JWT format) required to use any API endpoint. (optional)
x_correlation_id = 'x_correlation_id_example' # str | The Correlation ID provided will be added to log messages and can be used for support. The same Correlation ID may be used for separate requests, to track a higher level workflow. (optional)
filter = 'filter_example' # str | filter should use expression language for filtering (optional)
sort = 'sort_example' # str | Returns the response items in the order specified. Set sort to the field(s) in the response by which to sort. Sorting can be performed on any of the fields in the response, and the items can be sorted in ascending or descending order by these fields. By default, the response items are sorted in ascending order. To sort in descending order, append the minus sign (-) to the field. A single request can be sorted on multiple fields. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple fields, list the fields as comma-separated values. (E.g. \"sort=size-,name\") (optional)
limit = 56 # int |  (optional)
offset = 56 # int |  (optional)
id = 'id_example' # str |  (optional)
name = 'name_example' # str |  (optional)
display_name = 'display_name_example' # str |  (optional)
tenant_space_id = 'tenant_space_id_example' # str |  (optional)
tenant_id = 'tenant_id_example' # str |  (optional)
array_id = 'array_id_example' # str |  (optional)
iqn = 'iqn_example' # str |  (optional)
storage_service_id = 'storage_service_id_example' # str |  (optional)
availability_zone_id = 'availability_zone_id_example' # str |  (optional)
placement_engine = 'placement_engine_example' # str |  (optional)
region_name = 'region_name_example' # str | Region that array belongs to. (optional)
availability_zone_name = 'availability_zone_name_example' # str | Availability zone that array belongs to. (optional)
array_name = 'array_name_example' # str | Return placement-groups across all tenant spaces that are located on the array. (region_name and availability_zone_name required) (optional)

try:
    # Returns a list of Placement Groups from query
    api_response = api_instance.query_placement_groups(x_request_id=x_request_id, authorization=authorization, x_correlation_id=x_correlation_id, filter=filter, sort=sort, limit=limit, offset=offset, id=id, name=name, display_name=display_name, tenant_space_id=tenant_space_id, tenant_id=tenant_id, array_id=array_id, iqn=iqn, storage_service_id=storage_service_id, availability_zone_id=availability_zone_id, placement_engine=placement_engine, region_name=region_name, availability_zone_name=availability_zone_name, array_name=array_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PlacementGroupsApi->query_placement_groups: %s\n" % e)

Parameters

Name	Type	Description	Notes
x_request_id	str	The Request ID supplied with the request, used to perform operations idempotently.	[optional]
authorization	str	Access token (in JWT format) required to use any API endpoint.	[optional]
x_correlation_id	str	The Correlation ID provided will be added to log messages and can be used for support. The same Correlation ID may be used for separate requests, to track a higher level workflow.	[optional]
filter	str	filter should use expression language for filtering	[optional]
sort	str	Returns the response items in the order specified. Set sort to the field(s) in the response by which to sort. Sorting can be performed on any of the fields in the response, and the items can be sorted in ascending or descending order by these fields. By default, the response items are sorted in ascending order. To sort in descending order, append the minus sign (-) to the field. A single request can be sorted on multiple fields. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple fields, list the fields as comma-separated values. (E.g. "sort=size-,name")	[optional]
limit	int		[optional]
offset	int		[optional]
id	str		[optional]
name	str		[optional]
display_name	str		[optional]
tenant_space_id	str		[optional]
tenant_id	str		[optional]
array_id	str		[optional]
iqn	str		[optional]
storage_service_id	str		[optional]
availability_zone_id	str		[optional]
placement_engine	str		[optional]
region_name	str	Region that array belongs to.	[optional]
availability_zone_name	str	Availability zone that array belongs to.	[optional]
array_name	str	Return placement-groups across all tenant spaces that are located on the array. (region_name and availability_zone_name required)	[optional]

Return type

PlacementGroupList

Authorization

accessToken, oauth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_placement_group

Operation update_placement_group(body, tenant_name, tenant_space_name, placement_group_name, x_request_id=x_request_id, authorization=authorization, x_correlation_id=x_correlation_id)

Updates a specific Placement Group.

Example

from __future__ import print_function
import time
import fusion
from fusion.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = fusion.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = fusion.PlacementGroupsApi(fusion.ApiClient(configuration))
body = fusion.PlacementGroupPatch() # PlacementGroupPatch | 
tenant_name = 'tenant_name_example' # str | The Tenant name
tenant_space_name = 'tenant_space_name_example' # str | The Tenant Space name
placement_group_name = 'placement_group_name_example' # str | The Placement Group name
x_request_id = 'x_request_id_example' # str | The Request ID supplied with the request, used to perform operations idempotently. (optional)
authorization = 'authorization_example' # str | Access token (in JWT format) required to use any API endpoint. (optional)
x_correlation_id = 'x_correlation_id_example' # str | The Correlation ID provided will be added to log messages and can be used for support. The same Correlation ID may be used for separate requests, to track a higher level workflow. (optional)

try:
    # Updates a specific Placement Group.
    api_response = api_instance.update_placement_group(body, tenant_name, tenant_space_name, placement_group_name, x_request_id=x_request_id, authorization=authorization, x_correlation_id=x_correlation_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PlacementGroupsApi->update_placement_group: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	PlacementGroupPatch
tenant_name	str	The Tenant name
tenant_space_name	str	The Tenant Space name
placement_group_name	str	The Placement Group name
x_request_id	str	The Request ID supplied with the request, used to perform operations idempotently.	[optional]
authorization	str	Access token (in JWT format) required to use any API endpoint.	[optional]
x_correlation_id	str	The Correlation ID provided will be added to log messages and can be used for support. The same Correlation ID may be used for separate requests, to track a higher level workflow.	[optional]

Return type

Operation

Authorization

accessToken, oauth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

PlacementGroupsApi.md

Latest commit

History

PlacementGroupsApi.md

File metadata and controls

fusion.PlacementGroupsApi

create_placement_group

Example

Parameters

Return type

Authorization

HTTP request headers

delete_placement_group

Example

Parameters

Return type

Authorization

HTTP request headers

get_placement_group

Example

Parameters

Return type

Authorization

HTTP request headers

get_placement_group_by_id

Example

Parameters

Return type

Authorization

HTTP request headers

get_placement_group_sessions

Example

Parameters

Return type

Authorization

HTTP request headers

get_placement_groups_performance

Example

Parameters

Return type

Authorization

HTTP request headers

get_placement_groups_space

Example

Parameters

Return type

Authorization

HTTP request headers

list_placement_groups

Example

Parameters

Return type

Authorization

HTTP request headers

query_placement_groups

Example

Parameters

Return type

Authorization

HTTP request headers

update_placement_group

Example

Parameters

Return type

Authorization

HTTP request headers