vmware.vmc.console.api package¶

Submodules¶

vmware.vmc.console.api.account_linking_api module¶

VMware Cloud APIs

All VMware Cloud APIs require a valid authentication token; which can be obtained by issuing a POST: ` curl -s -X POST \ -H "Content-Type: application/json" \ https://console.cloud.vmware.com/csp/gateway/am/api/auth/api-tokens/authorize?refresh_token={refresh-token} ` * This CSP API is defined at: https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST * The refresh_token used to get a valid authentication token can be obtained after successful login to following URL via a web browser: https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens. * Most VMware Cloud APIs require an org identifier. This can be obtained by issuing a GET on /vmc/api/orgs and extracting the id field # noqa: E501

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.api.account_linking_api.AccountLinkingApi(api_client=None)¶

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

orgs_org_account_link_compatible_subnets_async_get(org, linked_account_id, **kwargs)¶

Gets a customer’s compatible subnets for account linking via a task. The information is returned as a member of the task (found in task.params[‘subnet_list_result’] when you are notified it is complete), and it’s documented under ref /definitions/AwsCompatibleSubnets # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_account_link_compatible_subnets_async_get(org, linked_account_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
linked_account_id (str) – The linked connected account identifier (required)
region (str) – The region of the cloud resources to work in
sddc (str) – sddc
instance_type (str) – The server instance type to be used.
sddc_type (str) – The sddc type to be used. (1NODE, SingleAZ, MultiAZ)
num_of_hosts (int) – The number of hosts
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

Task If the method is called asynchronously, returns the request thread.

orgs_org_account_link_compatible_subnets_async_get_with_http_info(org, linked_account_id, **kwargs)¶

Gets a customer’s compatible subnets for account linking via a task. The information is returned as a member of the task (found in task.params[‘subnet_list_result’] when you are notified it is complete), and it’s documented under ref /definitions/AwsCompatibleSubnets # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_account_link_compatible_subnets_async_get_with_http_info(org, linked_account_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
linked_account_id (str) – The linked connected account identifier (required)
region (str) – The region of the cloud resources to work in
sddc (str) – sddc
instance_type (str) – The server instance type to be used.
sddc_type (str) – The sddc type to be used. (1NODE, SingleAZ, MultiAZ)
num_of_hosts (int) – The number of hosts
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(Task, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_account_link_compatible_subnets_async_post(org, aws_subnet, **kwargs)¶

Sets which subnet to use to link accounts and finishes the linking process via a task # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_account_link_compatible_subnets_async_post(org, aws_subnet, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
aws_subnet (AwsSubnet) – The subnet chosen by the customer (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

Task If the method is called asynchronously, returns the request thread.

orgs_org_account_link_compatible_subnets_async_post_with_http_info(org, aws_subnet, **kwargs)¶

Sets which subnet to use to link accounts and finishes the linking process via a task # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_account_link_compatible_subnets_async_post_with_http_info(org, aws_subnet, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
aws_subnet (AwsSubnet) – The subnet chosen by the customer (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(Task, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_account_link_compatible_subnets_get(org, linked_account_id, **kwargs)¶

Gets a customer’s compatible subnets for account linking # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_account_link_compatible_subnets_get(org, linked_account_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
linked_account_id (str) – The linked connected account identifier (required)
region (str) – The region of the cloud resources to work in
sddc (str) – sddc
force_refresh (bool) – When true, forces the mappings for datacenters to be refreshed for the connected account.
instance_type (str) – The server instance type to be used.
sddc_type (str) – The sddc type to be used. (1NODE, SingleAZ, MultiAZ)
num_of_hosts (int) – The number of hosts
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

AwsCompatibleSubnets If the method is called asynchronously, returns the request thread.

orgs_org_account_link_compatible_subnets_get_with_http_info(org, linked_account_id, **kwargs)¶

Gets a customer’s compatible subnets for account linking # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_account_link_compatible_subnets_get_with_http_info(org, linked_account_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
linked_account_id (str) – The linked connected account identifier (required)
region (str) – The region of the cloud resources to work in
sddc (str) – sddc
force_refresh (bool) – When true, forces the mappings for datacenters to be refreshed for the connected account.
instance_type (str) – The server instance type to be used.
sddc_type (str) – The sddc type to be used. (1NODE, SingleAZ, MultiAZ)
num_of_hosts (int) – The number of hosts
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(AwsCompatibleSubnets, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_account_link_compatible_subnets_post(org, **kwargs)¶

Sets which subnet to use to link accounts and finishes the linking process # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_account_link_compatible_subnets_post(org, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

AwsSubnet If the method is called asynchronously, returns the request thread.

orgs_org_account_link_compatible_subnets_post_with_http_info(org, **kwargs)¶

Sets which subnet to use to link accounts and finishes the linking process # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_account_link_compatible_subnets_post_with_http_info(org, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(AwsSubnet, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_account_link_connected_accounts_get(org, **kwargs)¶

Get a list of connected accounts # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_account_link_connected_accounts_get(org, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
provider (str) – The cloud provider of the SDDC (AWS or ZeroCloud). Default value is AWS.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

list[AwsCustomerConnectedAccount] If the method is called asynchronously, returns the request thread.

orgs_org_account_link_connected_accounts_get_with_http_info(org, **kwargs)¶

Get a list of connected accounts # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_account_link_connected_accounts_get_with_http_info(org, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
provider (str) – The cloud provider of the SDDC (AWS or ZeroCloud). Default value is AWS.
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(list[AwsCustomerConnectedAccount], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_account_link_connected_accounts_linked_account_path_id_delete(org, linked_account_path_id, **kwargs)¶

Delete a particular connected (linked) account. # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_account_link_connected_accounts_linked_account_path_id_delete(org, linked_account_path_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
linked_account_path_id (str) – The linked connected account identifier (required)
force_even_when_sddc_present (bool) – When true, forcibly removes a connected account even when SDDC’s are still linked to it.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

AwsCustomerConnectedAccount If the method is called asynchronously, returns the request thread.

orgs_org_account_link_connected_accounts_linked_account_path_id_delete_with_http_info(org, linked_account_path_id, **kwargs)¶

Delete a particular connected (linked) account. # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_account_link_connected_accounts_linked_account_path_id_delete_with_http_info(org, linked_account_path_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
linked_account_path_id (str) – The linked connected account identifier (required)
force_even_when_sddc_present (bool) – When true, forcibly removes a connected account even when SDDC’s are still linked to it.
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(AwsCustomerConnectedAccount, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_account_link_get(org, **kwargs)¶

Gets a link that can be used on a customer’s account to start the linking process. # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_account_link_get(org, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

None If the method is called asynchronously, returns the request thread.

orgs_org_account_link_get_with_http_info(org, **kwargs)¶

Gets a link that can be used on a customer’s account to start the linking process. # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_account_link_get_with_http_info(org, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

None If the method is called asynchronously, returns the request thread.

orgs_org_account_link_map_customer_zones_post(org, map_zones_request, **kwargs)¶

Creates a task to re-map customer’s datacenters across zones. # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_account_link_map_customer_zones_post(org, map_zones_request, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
map_zones_request (MapZonesRequest) – The zones request information about who to map and what to map. (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

Task If the method is called asynchronously, returns the request thread.

orgs_org_account_link_map_customer_zones_post_with_http_info(org, map_zones_request, **kwargs)¶

Creates a task to re-map customer’s datacenters across zones. # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_account_link_map_customer_zones_post_with_http_info(org, map_zones_request, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
map_zones_request (MapZonesRequest) – The zones request information about who to map and what to map. (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(Task, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_account_link_sddc_connections_get(org, **kwargs)¶

Get a list of SDDC connections currently setup for the customer’s organization. # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_account_link_sddc_connections_get(org, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
sddc (str) – sddc
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

list[AwsSddcConnection] If the method is called asynchronously, returns the request thread.

orgs_org_account_link_sddc_connections_get_with_http_info(org, **kwargs)¶

Get a list of SDDC connections currently setup for the customer’s organization. # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_account_link_sddc_connections_get_with_http_info(org, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
sddc (str) – sddc
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(list[AwsSddcConnection], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

vmware.vmc.console.api.addons_api module¶

VMware Cloud APIs

All VMware Cloud APIs require a valid authentication token; which can be obtained by issuing a POST: ` curl -s -X POST \ -H "Content-Type: application/json" \ https://console.cloud.vmware.com/csp/gateway/am/api/auth/api-tokens/authorize?refresh_token={refresh-token} ` * This CSP API is defined at: https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST * The refresh_token used to get a valid authentication token can be obtained after successful login to following URL via a web browser: https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens. * Most VMware Cloud APIs require an org identifier. This can be obtained by issuing a GET on /vmc/api/orgs and extracting the id field # noqa: E501

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.api.addons_api.AddonsApi(api_client=None)¶

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

orgs_org_sddcs_sddc_id_addons_addon_type_credentials_get(org, sddc_id, addon_type, **kwargs)¶

List all the credentials assoicated with an addon type with in a SDDC # noqa: E501

List all the credentials assoicated with an addon type with in a SDDC # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_get(org, sddc_id, addon_type, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Org id of the associated SDDC (required)
sddc_id (str) – Id of the SDDC (required)
addon_type (str) – Add on type (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

list[NewCredentials] If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_id_addons_addon_type_credentials_get_with_http_info(org, sddc_id, addon_type, **kwargs)¶

List all the credentials assoicated with an addon type with in a SDDC # noqa: E501

List all the credentials assoicated with an addon type with in a SDDC # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_get_with_http_info(org, sddc_id, addon_type, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Org id of the associated SDDC (required)
sddc_id (str) – Id of the SDDC (required)
addon_type (str) – Add on type (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(list[NewCredentials], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_get(org, sddc_id, addon_type, name, **kwargs)¶

Get credential details by name # noqa: E501

Get credential details by name # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_get(org, sddc_id, addon_type, name, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Org id of the associated SDDC (required)
sddc_id (str) – Id of the SDDC (required)
addon_type (str) – Add on type (required)
name (str) – name of the credentials (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

NewCredentials If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_get_with_http_info(org, sddc_id, addon_type, name, **kwargs)¶

Get credential details by name # noqa: E501

Get credential details by name # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_get_with_http_info(org, sddc_id, addon_type, name, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Org id of the associated SDDC (required)
sddc_id (str) – Id of the SDDC (required)
addon_type (str) – Add on type (required)
name (str) – name of the credentials (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(NewCredentials, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_put(org, sddc_id, addon_type, name, credentials, **kwargs)¶

Update credential details # noqa: E501

Update credential details # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_put(org, sddc_id, addon_type, name, credentials, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Org id of the associated SDDC (required)
sddc_id (str) – Id of the SDDC (required)
addon_type (str) – Add on type (required)
name (str) – name of the credentials (required)
credentials (UpdateCredentials) – Credentials update payload (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

NewCredentials If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_put_with_http_info(org, sddc_id, addon_type, name, credentials, **kwargs)¶

Update credential details # noqa: E501

Update credential details # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_put_with_http_info(org, sddc_id, addon_type, name, credentials, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Org id of the associated SDDC (required)
sddc_id (str) – Id of the SDDC (required)
addon_type (str) – Add on type (required)
name (str) – name of the credentials (required)
credentials (UpdateCredentials) – Credentials update payload (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(NewCredentials, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_id_addons_addon_type_credentials_post(org, sddc_id, addon_type, credentials, **kwargs)¶

Associate a new add on credentials with the SDDC such as HCX # noqa: E501

Associated a new add on credentials with the SDDC such as HCX # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_post(org, sddc_id, addon_type, credentials, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Org id of the associated SDDC (required)
sddc_id (str) – Id of the SDDC (required)
addon_type (str) – Add on type (required)
credentials (NewCredentials) – Credentials creation payload (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

NewCredentials If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_id_addons_addon_type_credentials_post_with_http_info(org, sddc_id, addon_type, credentials, **kwargs)¶

Associate a new add on credentials with the SDDC such as HCX # noqa: E501

Associated a new add on credentials with the SDDC such as HCX # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_post_with_http_info(org, sddc_id, addon_type, credentials, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Org id of the associated SDDC (required)
sddc_id (str) – Id of the SDDC (required)
addon_type (str) – Add on type (required)
credentials (NewCredentials) – Credentials creation payload (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(NewCredentials, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

vmware.vmc.console.api.clusters_api module¶

VMware Cloud APIs

All VMware Cloud APIs require a valid authentication token; which can be obtained by issuing a POST: ` curl -s -X POST \ -H "Content-Type: application/json" \ https://console.cloud.vmware.com/csp/gateway/am/api/auth/api-tokens/authorize?refresh_token={refresh-token} ` * This CSP API is defined at: https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST * The refresh_token used to get a valid authentication token can be obtained after successful login to following URL via a web browser: https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens. * Most VMware Cloud APIs require an org identifier. This can be obtained by issuing a GET on /vmc/api/orgs and extracting the id field # noqa: E501

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.api.clusters_api.ClustersApi(api_client=None)¶

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

orgs_org_sddcs_sddc_clusters_cluster_reconfigure_post(org, sddc, cluster, cluster_reconfigure_params, **kwargs)¶

Initiate a reconfiguration for the cluster. # noqa: E501

This reconfiguration will handle changing both the number of hosts and the cluster storage capacity. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_clusters_cluster_reconfigure_post(org, sddc, cluster, cluster_reconfigure_params, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
sddc (str) – Sddc identifier (required)
cluster (str) – cluster identifier (required)
cluster_reconfigure_params (ClusterReconfigureParams) – clusterReconfigureParams (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

Task If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_clusters_cluster_reconfigure_post_with_http_info(org, sddc, cluster, cluster_reconfigure_params, **kwargs)¶

Initiate a reconfiguration for the cluster. # noqa: E501

This reconfiguration will handle changing both the number of hosts and the cluster storage capacity. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_clusters_cluster_reconfigure_post_with_http_info(org, sddc, cluster, cluster_reconfigure_params, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
sddc (str) – Sddc identifier (required)
cluster (str) – cluster identifier (required)
cluster_reconfigure_params (ClusterReconfigureParams) – clusterReconfigureParams (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(Task, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

vmware.vmc.console.api.config_storage_api module¶

VMware Cloud APIs

All VMware Cloud APIs require a valid authentication token; which can be obtained by issuing a POST: ` curl -s -X POST \ -H "Content-Type: application/json" \ https://console.cloud.vmware.com/csp/gateway/am/api/auth/api-tokens/authorize?refresh_token={refresh-token} ` * This CSP API is defined at: https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST * The refresh_token used to get a valid authentication token can be obtained after successful login to following URL via a web browser: https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens. * Most VMware Cloud APIs require an org identifier. This can be obtained by issuing a GET on /vmc/api/orgs and extracting the id field # noqa: E501

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.api.config_storage_api.ConfigStorageApi(api_client=None)¶

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

orgs_org_sddcs_sddc_clusters_cluster_config_constraints_get(org, sddc, cluster, **kwargs)¶

Get storage size constraints on existing cluster. # noqa: E501

This API provides the storage choices available when reconfiguring storage in a cluster. The constraints returned will give vSAN reconfiguration biases and available vSAN capacities per reconfiguration bias. The constraints also indicate the default vSAN capacity per reconfiguration biases as well as the default reconfiguration bias. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_clusters_cluster_config_constraints_get(org, sddc, cluster, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
sddc (str) – Sddc identifier (required)
cluster (str) – cluster identifier (required)
expected_num_hosts (int) – The expected number of hosts in the cluster. If not specified, returned is based on current number of hosts in the cluster.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

VsanClusterReconfigConstraints If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_clusters_cluster_config_constraints_get_with_http_info(org, sddc, cluster, **kwargs)¶

Get storage size constraints on existing cluster. # noqa: E501

This API provides the storage choices available when reconfiguring storage in a cluster. The constraints returned will give vSAN reconfiguration biases and available vSAN capacities per reconfiguration bias. The constraints also indicate the default vSAN capacity per reconfiguration biases as well as the default reconfiguration bias. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_clusters_cluster_config_constraints_get_with_http_info(org, sddc, cluster, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
sddc (str) – Sddc identifier (required)
cluster (str) – cluster identifier (required)
expected_num_hosts (int) – The expected number of hosts in the cluster. If not specified, returned is based on current number of hosts in the cluster.
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(VsanClusterReconfigConstraints, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

vmware.vmc.console.api.credentials_api module¶

VMware Cloud APIs

All VMware Cloud APIs require a valid authentication token; which can be obtained by issuing a POST: ` curl -s -X POST \ -H "Content-Type: application/json" \ https://console.cloud.vmware.com/csp/gateway/am/api/auth/api-tokens/authorize?refresh_token={refresh-token} ` * This CSP API is defined at: https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST * The refresh_token used to get a valid authentication token can be obtained after successful login to following URL via a web browser: https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens. * Most VMware Cloud APIs require an org identifier. This can be obtained by issuing a GET on /vmc/api/orgs and extracting the id field # noqa: E501

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.api.credentials_api.CredentialsApi(api_client=None)¶

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

orgs_org_sddcs_sddc_id_addons_addon_type_credentials_get(org, sddc_id, addon_type, **kwargs)¶

List all the credentials assoicated with an addon type with in a SDDC # noqa: E501

List all the credentials assoicated with an addon type with in a SDDC # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_get(org, sddc_id, addon_type, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Org id of the associated SDDC (required)
sddc_id (str) – Id of the SDDC (required)
addon_type (str) – Add on type (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

list[NewCredentials] If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_id_addons_addon_type_credentials_get_with_http_info(org, sddc_id, addon_type, **kwargs)¶

List all the credentials assoicated with an addon type with in a SDDC # noqa: E501

List all the credentials assoicated with an addon type with in a SDDC # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_get_with_http_info(org, sddc_id, addon_type, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Org id of the associated SDDC (required)
sddc_id (str) – Id of the SDDC (required)
addon_type (str) – Add on type (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(list[NewCredentials], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_get(org, sddc_id, addon_type, name, **kwargs)¶

Get credential details by name # noqa: E501

Get credential details by name # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_get(org, sddc_id, addon_type, name, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Org id of the associated SDDC (required)
sddc_id (str) – Id of the SDDC (required)
addon_type (str) – Add on type (required)
name (str) – name of the credentials (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

NewCredentials If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_get_with_http_info(org, sddc_id, addon_type, name, **kwargs)¶

Get credential details by name # noqa: E501

Get credential details by name # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_get_with_http_info(org, sddc_id, addon_type, name, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Org id of the associated SDDC (required)
sddc_id (str) – Id of the SDDC (required)
addon_type (str) – Add on type (required)
name (str) – name of the credentials (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(NewCredentials, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_put(org, sddc_id, addon_type, name, credentials, **kwargs)¶

Update credential details # noqa: E501

Update credential details # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_put(org, sddc_id, addon_type, name, credentials, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Org id of the associated SDDC (required)
sddc_id (str) – Id of the SDDC (required)
addon_type (str) – Add on type (required)
name (str) – name of the credentials (required)
credentials (UpdateCredentials) – Credentials update payload (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

NewCredentials If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_put_with_http_info(org, sddc_id, addon_type, name, credentials, **kwargs)¶

Update credential details # noqa: E501

Update credential details # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_put_with_http_info(org, sddc_id, addon_type, name, credentials, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Org id of the associated SDDC (required)
sddc_id (str) – Id of the SDDC (required)
addon_type (str) – Add on type (required)
name (str) – name of the credentials (required)
credentials (UpdateCredentials) – Credentials update payload (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(NewCredentials, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_id_addons_addon_type_credentials_post(org, sddc_id, addon_type, credentials, **kwargs)¶

Associate a new add on credentials with the SDDC such as HCX # noqa: E501

Associated a new add on credentials with the SDDC such as HCX # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_post(org, sddc_id, addon_type, credentials, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Org id of the associated SDDC (required)
sddc_id (str) – Id of the SDDC (required)
addon_type (str) – Add on type (required)
credentials (NewCredentials) – Credentials creation payload (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

NewCredentials If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_id_addons_addon_type_credentials_post_with_http_info(org, sddc_id, addon_type, credentials, **kwargs)¶

Associate a new add on credentials with the SDDC such as HCX # noqa: E501

Associated a new add on credentials with the SDDC such as HCX # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_post_with_http_info(org, sddc_id, addon_type, credentials, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Org id of the associated SDDC (required)
sddc_id (str) – Id of the SDDC (required)
addon_type (str) – Add on type (required)
credentials (NewCredentials) – Credentials creation payload (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(NewCredentials, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

vmware.vmc.console.api.dns_api module¶

VMware Cloud APIs

All VMware Cloud APIs require a valid authentication token; which can be obtained by issuing a POST: ` curl -s -X POST \ -H "Content-Type: application/json" \ https://console.cloud.vmware.com/csp/gateway/am/api/auth/api-tokens/authorize?refresh_token={refresh-token} ` * This CSP API is defined at: https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST * The refresh_token used to get a valid authentication token can be obtained after successful login to following URL via a web browser: https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens. * Most VMware Cloud APIs require an org identifier. This can be obtained by issuing a GET on /vmc/api/orgs and extracting the id field # noqa: E501

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.api.dns_api.DnsApi(api_client=None)¶

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

orgs_org_sddcs_sddc_dns_private_put(org, sddc, **kwargs)¶

Update the DNS records of management VMs to use private IP addresses # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_dns_private_put(org, sddc, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
sddc (str) – Sddc identifier (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

Task If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_dns_private_put_with_http_info(org, sddc, **kwargs)¶

Update the DNS records of management VMs to use private IP addresses # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_dns_private_put_with_http_info(org, sddc, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
sddc (str) – Sddc identifier (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(Task, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_dns_public_put(org, sddc, **kwargs)¶

Update the DNS records of management VMs to use public IP addresses # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_dns_public_put(org, sddc, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
sddc (str) – Sddc identifier (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

Task If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_dns_public_put_with_http_info(org, sddc, **kwargs)¶

Update the DNS records of management VMs to use public IP addresses # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_dns_public_put_with_http_info(org, sddc, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
sddc (str) – Sddc identifier (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(Task, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_management_vms_management_vm_id_dns_ip_type_put(org, sddc, management_vm_id, ip_type, **kwargs)¶

Update the DNS records of management VMs to use public or private IP addresses # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_management_vms_management_vm_id_dns_ip_type_put(org, sddc, management_vm_id, ip_type, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
sddc (str) – Sddc identifier (required)
management_vm_id (str) – the management VM ID (required)
ip_type (str) – the ip type to associate with FQDN in DNS (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

Task If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_management_vms_management_vm_id_dns_ip_type_put_with_http_info(org, sddc, management_vm_id, ip_type, **kwargs)¶

Update the DNS records of management VMs to use public or private IP addresses # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_management_vms_management_vm_id_dns_ip_type_put_with_http_info(org, sddc, management_vm_id, ip_type, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
sddc (str) – Sddc identifier (required)
management_vm_id (str) – the management VM ID (required)
ip_type (str) – the ip type to associate with FQDN in DNS (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(Task, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

vmware.vmc.console.api.edges_api module¶

VMware Cloud APIs

All VMware Cloud APIs require a valid authentication token; which can be obtained by issuing a POST: ` curl -s -X POST \ -H "Content-Type: application/json" \ https://console.cloud.vmware.com/csp/gateway/am/api/auth/api-tokens/authorize?refresh_token={refresh-token} ` * This CSP API is defined at: https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST * The refresh_token used to get a valid authentication token can be obtained after successful login to following URL via a web browser: https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens. * Most VMware Cloud APIs require an org identifier. This can be obtained by issuing a GET on /vmc/api/orgs and extracting the id field # noqa: E501

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.api.edges_api.EdgesApi(api_client=None)¶

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

orgs_org_sddcs_sddc_networks40_edges_edge_id_dhcp_lease_info_get(org, sddc, edge_id, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_dhcp_lease_info_get # noqa: E501

Retrieve DHCP leaseinfo of a management or compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_dhcp_lease_info_get(org, sddc, edge_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

DhcpLeases If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_dhcp_lease_info_get_with_http_info(org, sddc, edge_id, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_dhcp_lease_info_get # noqa: E501

Retrieve DHCP leaseinfo of a management or compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_dhcp_lease_info_get_with_http_info(org, sddc, edge_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(DhcpLeases, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_dns_config_delete(org, sddc, edge_id, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_dns_config_delete # noqa: E501

Delete DNS server configuration for a management or compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_dns_config_delete(org, sddc, edge_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

None If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_dns_config_delete_with_http_info(org, sddc, edge_id, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_dns_config_delete # noqa: E501

Delete DNS server configuration for a management or compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_dns_config_delete_with_http_info(org, sddc, edge_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

None If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_dns_config_get(org, sddc, edge_id, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_dns_config_get # noqa: E501

Retrieve DNS server configuration for a management or compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_dns_config_get(org, sddc, edge_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

DnsConfig If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_dns_config_get_with_http_info(org, sddc, edge_id, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_dns_config_get # noqa: E501

Retrieve DNS server configuration for a management or compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_dns_config_get_with_http_info(org, sddc, edge_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(DnsConfig, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_dns_config_post(org, sddc, edge_id, enable, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_dns_config_post # noqa: E501

Enable or disable DNS configuration for a management or compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_dns_config_post(org, sddc, edge_id, enable, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
enable (bool) – Set to true to enable, set to false to disable. (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

None If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_dns_config_post_with_http_info(org, sddc, edge_id, enable, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_dns_config_post # noqa: E501

Enable or disable DNS configuration for a management or compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_dns_config_post_with_http_info(org, sddc, edge_id, enable, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
enable (bool) – Set to true to enable, set to false to disable. (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

None If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_dns_config_put(org, sddc, edge_id, dns_config, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_dns_config_put # noqa: E501

Configure DNS server configuration for a management or compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_dns_config_put(org, sddc, edge_id, dns_config, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
dns_config (DnsConfig) – (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

None If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_dns_config_put_with_http_info(org, sddc, edge_id, dns_config, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_dns_config_put # noqa: E501

Configure DNS server configuration for a management or compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_dns_config_put_with_http_info(org, sddc, edge_id, dns_config, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
dns_config (DnsConfig) – (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

None If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_dns_statistics_get(org, sddc, edge_id, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_dns_statistics_get # noqa: E501

Retrieve DNS server statistics for a management or compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_dns_statistics_get(org, sddc, edge_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

DnsStatusAndStats If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_dns_statistics_get_with_http_info(org, sddc, edge_id, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_dns_statistics_get # noqa: E501

Retrieve DNS server statistics for a management or compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_dns_statistics_get_with_http_info(org, sddc, edge_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(DnsStatusAndStats, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_firewall_config_delete(org, sddc, edge_id, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_firewall_config_delete # noqa: E501

Delete firewall configuration for a management or compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_firewall_config_delete(org, sddc, edge_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

None If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_firewall_config_delete_with_http_info(org, sddc, edge_id, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_firewall_config_delete # noqa: E501

Delete firewall configuration for a management or compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_firewall_config_delete_with_http_info(org, sddc, edge_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

None If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_firewall_config_get(org, sddc, edge_id, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_firewall_config_get # noqa: E501

Retrieve the firewall configuration for a management or compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_firewall_config_get(org, sddc, edge_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

FirewallConfig If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_firewall_config_get_with_http_info(org, sddc, edge_id, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_firewall_config_get # noqa: E501

Retrieve the firewall configuration for a management or compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_firewall_config_get_with_http_info(org, sddc, edge_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(FirewallConfig, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_firewall_config_put(org, sddc, edge_id, firewall_config, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_firewall_config_put # noqa: E501

Configure firewall for a management or compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_firewall_config_put(org, sddc, edge_id, firewall_config, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
firewall_config (FirewallConfig) – (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

None If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_firewall_config_put_with_http_info(org, sddc, edge_id, firewall_config, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_firewall_config_put # noqa: E501

Configure firewall for a management or compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_firewall_config_put_with_http_info(org, sddc, edge_id, firewall_config, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
firewall_config (FirewallConfig) – (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

None If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_firewall_config_rules_post(org, sddc, edge_id, firewall_rules, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_firewall_config_rules_post # noqa: E501

Append firewall rules for a management or compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_firewall_config_rules_post(org, sddc, edge_id, firewall_rules, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
firewall_rules (FirewallRules) – (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

None If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_firewall_config_rules_post_with_http_info(org, sddc, edge_id, firewall_rules, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_firewall_config_rules_post # noqa: E501

Append firewall rules for a management or compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_firewall_config_rules_post_with_http_info(org, sddc, edge_id, firewall_rules, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
firewall_rules (FirewallRules) – (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

None If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_firewall_config_rules_rule_id_delete(org, sddc, edge_id, rule_id, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_firewall_config_rules_rule_id_delete # noqa: E501

Delete a specific firewall rule for a management or compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_firewall_config_rules_rule_id_delete(org, sddc, edge_id, rule_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
rule_id (int) – Rule Identifier. (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

None If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_firewall_config_rules_rule_id_delete_with_http_info(org, sddc, edge_id, rule_id, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_firewall_config_rules_rule_id_delete # noqa: E501

Delete a specific firewall rule for a management or compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_firewall_config_rules_rule_id_delete_with_http_info(org, sddc, edge_id, rule_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
rule_id (int) – Rule Identifier. (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

None If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_firewall_config_rules_rule_id_get(org, sddc, edge_id, rule_id, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_firewall_config_rules_rule_id_get # noqa: E501

Retrieve a specific firewall rule for a management or compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_firewall_config_rules_rule_id_get(org, sddc, edge_id, rule_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
rule_id (int) – Rule Identifier. (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

Nsxfirewallrule If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_firewall_config_rules_rule_id_get_with_http_info(org, sddc, edge_id, rule_id, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_firewall_config_rules_rule_id_get # noqa: E501

Retrieve a specific firewall rule for a management or compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_firewall_config_rules_rule_id_get_with_http_info(org, sddc, edge_id, rule_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
rule_id (int) – Rule Identifier. (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(Nsxfirewallrule, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_firewall_config_rules_rule_id_put(org, sddc, edge_id, rule_id, nsxfirewallrule, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_firewall_config_rules_rule_id_put # noqa: E501

Modify the specified firewall rule for a management or compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_firewall_config_rules_rule_id_put(org, sddc, edge_id, rule_id, nsxfirewallrule, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
rule_id (int) – Rule Identifier. (required)
nsxfirewallrule (Nsxfirewallrule) – (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

None If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_firewall_config_rules_rule_id_put_with_http_info(org, sddc, edge_id, rule_id, nsxfirewallrule, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_firewall_config_rules_rule_id_put # noqa: E501

Modify the specified firewall rule for a management or compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_firewall_config_rules_rule_id_put_with_http_info(org, sddc, edge_id, rule_id, nsxfirewallrule, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
rule_id (int) – Rule Identifier. (required)
nsxfirewallrule (Nsxfirewallrule) – (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

None If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_firewall_statistics_rule_id_get(org, sddc, edge_id, rule_id, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_firewall_statistics_rule_id_get # noqa: E501

Retrieve statistics for a specific firewall rule for a management or compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_firewall_statistics_rule_id_get(org, sddc, edge_id, rule_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
rule_id (int) – Rule Identifier. (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

FirewallRuleStats If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_firewall_statistics_rule_id_get_with_http_info(org, sddc, edge_id, rule_id, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_firewall_statistics_rule_id_get # noqa: E501

Retrieve statistics for a specific firewall rule for a management or compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_firewall_statistics_rule_id_get_with_http_info(org, sddc, edge_id, rule_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
rule_id (int) – Rule Identifier. (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(FirewallRuleStats, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_ipsec_config_delete(org, sddc, edge_id, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_ipsec_config_delete # noqa: E501

Delete IPsec VPN configuration for a management or compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_ipsec_config_delete(org, sddc, edge_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

None If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_ipsec_config_delete_with_http_info(org, sddc, edge_id, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_ipsec_config_delete # noqa: E501

Delete IPsec VPN configuration for a management or compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_ipsec_config_delete_with_http_info(org, sddc, edge_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

None If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_ipsec_config_get(org, sddc, edge_id, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_ipsec_config_get # noqa: E501

Retrieve IPsec VPN configuration for a management or compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_ipsec_config_get(org, sddc, edge_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
show_sensitive_data (bool) – Set to true to show sensitive data. Default value is false.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

Ipsec If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_ipsec_config_get_with_http_info(org, sddc, edge_id, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_ipsec_config_get # noqa: E501

Retrieve IPsec VPN configuration for a management or compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_ipsec_config_get_with_http_info(org, sddc, edge_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
show_sensitive_data (bool) – Set to true to show sensitive data. Default value is false.
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(Ipsec, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_ipsec_config_put(org, sddc, edge_id, ipsec, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_ipsec_config_put # noqa: E501

Modify IPsec VPN configuration for a management or compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_ipsec_config_put(org, sddc, edge_id, ipsec, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
ipsec (Ipsec) – IPsec Configuration dto object. (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

None If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_ipsec_config_put_with_http_info(org, sddc, edge_id, ipsec, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_ipsec_config_put # noqa: E501

Modify IPsec VPN configuration for a management or compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_ipsec_config_put_with_http_info(org, sddc, edge_id, ipsec, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
ipsec (Ipsec) – IPsec Configuration dto object. (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

None If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_ipsec_statistics_get(org, sddc, edge_id, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_ipsec_statistics_get # noqa: E501

Retrieve IPsec VPN statistics for a management or compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_ipsec_statistics_get(org, sddc, edge_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

IpsecStatusAndStats If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_ipsec_statistics_get_with_http_info(org, sddc, edge_id, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_ipsec_statistics_get # noqa: E501

Retrieve IPsec VPN statistics for a management or compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_ipsec_statistics_get_with_http_info(org, sddc, edge_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(IpsecStatusAndStats, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_l2vpn_config_statistics_get(org, sddc, edge_id, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_l2vpn_config_statistics_get # noqa: E501

Retrieve L2 VPN statistics for a compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_l2vpn_config_statistics_get(org, sddc, edge_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

L2vpnStatusAndStats If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_l2vpn_config_statistics_get_with_http_info(org, sddc, edge_id, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_l2vpn_config_statistics_get # noqa: E501

Retrieve L2 VPN statistics for a compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_l2vpn_config_statistics_get_with_http_info(org, sddc, edge_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(L2vpnStatusAndStats, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_nat_config_delete(org, sddc, edge_id, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_nat_config_delete # noqa: E501

Delete all NAT configuration for the specified management or compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_nat_config_delete(org, sddc, edge_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

None If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_nat_config_delete_with_http_info(org, sddc, edge_id, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_nat_config_delete # noqa: E501

Delete all NAT configuration for the specified management or compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_nat_config_delete_with_http_info(org, sddc, edge_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

None If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_nat_config_get(org, sddc, edge_id, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_nat_config_get # noqa: E501

Retrieve NAT configuration for a management or compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_nat_config_get(org, sddc, edge_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

Nat If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_nat_config_get_with_http_info(org, sddc, edge_id, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_nat_config_get # noqa: E501

Retrieve NAT configuration for a management or compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_nat_config_get_with_http_info(org, sddc, edge_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(Nat, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_nat_config_put(org, sddc, edge_id, nat, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_nat_config_put # noqa: E501

Modify NAT configuration for a management or compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_nat_config_put(org, sddc, edge_id, nat, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
nat (Nat) – (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

None If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_nat_config_put_with_http_info(org, sddc, edge_id, nat, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_nat_config_put # noqa: E501

Modify NAT configuration for a management or compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_nat_config_put_with_http_info(org, sddc, edge_id, nat, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
nat (Nat) – (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

None If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_nat_config_rules_post(org, sddc, edge_id, nat_rules, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_nat_config_rules_post # noqa: E501

Append a NAT rule for a management or compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_nat_config_rules_post(org, sddc, edge_id, nat_rules, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
nat_rules (NatRules) – (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

None If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_nat_config_rules_post_with_http_info(org, sddc, edge_id, nat_rules, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_nat_config_rules_post # noqa: E501

Append a NAT rule for a management or compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_nat_config_rules_post_with_http_info(org, sddc, edge_id, nat_rules, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
nat_rules (NatRules) – (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

None If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_nat_config_rules_rule_id_delete(org, sddc, edge_id, rule_id, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_nat_config_rules_rule_id_delete # noqa: E501

Delete the specific NAT rule for a management or compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_nat_config_rules_rule_id_delete(org, sddc, edge_id, rule_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
rule_id (int) – Rule Identifier. (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

None If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_nat_config_rules_rule_id_delete_with_http_info(org, sddc, edge_id, rule_id, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_nat_config_rules_rule_id_delete # noqa: E501

Delete the specific NAT rule for a management or compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_nat_config_rules_rule_id_delete_with_http_info(org, sddc, edge_id, rule_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
rule_id (int) – Rule Identifier. (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

None If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_nat_config_rules_rule_id_put(org, sddc, edge_id, rule_id, nsxnatrule, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_nat_config_rules_rule_id_put # noqa: E501

Update the specific NAT rule for a management or compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_nat_config_rules_rule_id_put(org, sddc, edge_id, rule_id, nsxnatrule, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
rule_id (int) – Rule Identifier. (required)
nsxnatrule (Nsxnatrule) – (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

None If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_nat_config_rules_rule_id_put_with_http_info(org, sddc, edge_id, rule_id, nsxnatrule, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_nat_config_rules_rule_id_put # noqa: E501

Update the specific NAT rule for a management or compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_nat_config_rules_rule_id_put_with_http_info(org, sddc, edge_id, rule_id, nsxnatrule, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
rule_id (int) – Rule Identifier. (required)
nsxnatrule (Nsxnatrule) – (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

None If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_peerconfig_get(org, sddc, edge_id, objecttype, objectid, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_peerconfig_get # noqa: E501

Retrieve IPsec VPN peer configuration for a management or compute gateway (NSX Edge). The response output is free form text generated as per the template specified as request parameter input. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_peerconfig_get(org, sddc, edge_id, objecttype, objectid, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
objecttype (str) – Specify object type identifier. Valid value is ‘ipsecSiteConfig’. Required. (required)
objectid (str) – Specify object identifier, for example ‘ipsecsite-1’ for IPsec Site configuration. Required. (required)
templateid (str) – Specify template identifier and response format. Valid values are ‘text’, ‘json’ and ‘xml’. Default is ‘text’. Optional.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

dict(str, object) If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_peerconfig_get_with_http_info(org, sddc, edge_id, objecttype, objectid, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_peerconfig_get # noqa: E501

Retrieve IPsec VPN peer configuration for a management or compute gateway (NSX Edge). The response output is free form text generated as per the template specified as request parameter input. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_peerconfig_get_with_http_info(org, sddc, edge_id, objecttype, objectid, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
objecttype (str) – Specify object type identifier. Valid value is ‘ipsecSiteConfig’. Required. (required)
objectid (str) – Specify object identifier, for example ‘ipsecsite-1’ for IPsec Site configuration. Required. (required)
templateid (str) – Specify template identifier and response format. Valid values are ‘text’, ‘json’ and ‘xml’. Default is ‘text’. Optional.
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(dict(str, object), status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_statistics_dashboard_firewall_get(org, sddc, edge_id, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_statistics_dashboard_firewall_get # noqa: E501

Retrieve firewall dashboard statistics for a management or compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_statistics_dashboard_firewall_get(org, sddc, edge_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
interval (str) – 60 min by default, can be given as 1 - 60 min, oneDay, oneWeek, oneMonth, oneYear.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

DashboardStatistics If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_statistics_dashboard_firewall_get_with_http_info(org, sddc, edge_id, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_statistics_dashboard_firewall_get # noqa: E501

Retrieve firewall dashboard statistics for a management or compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_statistics_dashboard_firewall_get_with_http_info(org, sddc, edge_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
interval (str) – 60 min by default, can be given as 1 - 60 min, oneDay, oneWeek, oneMonth, oneYear.
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(DashboardStatistics, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_statistics_dashboard_interface_get(org, sddc, edge_id, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_statistics_dashboard_interface_get # noqa: E501

Retrieve interface dashboard statistics for a management or compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_statistics_dashboard_interface_get(org, sddc, edge_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
interval (str) – 60 min by default, can be given as 1 - 60 min, oneDay, oneWeek, oneMonth, oneYear.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

DashboardStatistics If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_statistics_dashboard_interface_get_with_http_info(org, sddc, edge_id, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_statistics_dashboard_interface_get # noqa: E501

Retrieve interface dashboard statistics for a management or compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_statistics_dashboard_interface_get_with_http_info(org, sddc, edge_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
interval (str) – 60 min by default, can be given as 1 - 60 min, oneDay, oneWeek, oneMonth, oneYear.
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(DashboardStatistics, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_statistics_dashboard_ipsec_get(org, sddc, edge_id, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_statistics_dashboard_ipsec_get # noqa: E501

Retrieve ipsec dashboard statistics for a management or compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_statistics_dashboard_ipsec_get(org, sddc, edge_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
interval (str) – 60 min by default, can be given as 1 - 60 min, oneDay, oneWeek, oneMonth, oneYear.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

DashboardStatistics If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_statistics_dashboard_ipsec_get_with_http_info(org, sddc, edge_id, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_statistics_dashboard_ipsec_get # noqa: E501

Retrieve ipsec dashboard statistics for a management or compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_statistics_dashboard_ipsec_get_with_http_info(org, sddc, edge_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
interval (str) – 60 min by default, can be given as 1 - 60 min, oneDay, oneWeek, oneMonth, oneYear.
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(DashboardStatistics, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_statistics_interfaces_get(org, sddc, edge_id, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_statistics_interfaces_get # noqa: E501

Retrieve interface statistics for a management or compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_statistics_interfaces_get(org, sddc, edge_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
start_time (int) – Show statistics from this start time (in milliseconds since epoch).
end_time (int) – Show statistics until this end time (in milliseconds since epoch).
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

CbmStatistics If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_statistics_interfaces_get_with_http_info(org, sddc, edge_id, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_statistics_interfaces_get # noqa: E501

Retrieve interface statistics for a management or compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_statistics_interfaces_get_with_http_info(org, sddc, edge_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
start_time (int) – Show statistics from this start time (in milliseconds since epoch).
end_time (int) – Show statistics until this end time (in milliseconds since epoch).
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(CbmStatistics, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_statistics_interfaces_internal_get(org, sddc, edge_id, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_statistics_interfaces_internal_get # noqa: E501

Retrieve internal interface statistics for a management or compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_statistics_interfaces_internal_get(org, sddc, edge_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
start_time (int) – Show statistics from this start time (in milliseconds since epoch).
end_time (int) – Show statistics until this end time (in milliseconds since epoch).
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

CbmStatistics If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_statistics_interfaces_internal_get_with_http_info(org, sddc, edge_id, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_statistics_interfaces_internal_get # noqa: E501

Retrieve internal interface statistics for a management or compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_statistics_interfaces_internal_get_with_http_info(org, sddc, edge_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
start_time (int) – Show statistics from this start time (in milliseconds since epoch).
end_time (int) – Show statistics until this end time (in milliseconds since epoch).
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(CbmStatistics, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_statistics_interfaces_uplink_get(org, sddc, edge_id, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_statistics_interfaces_uplink_get # noqa: E501

Retrieve uplink interface statistics for a management or compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_statistics_interfaces_uplink_get(org, sddc, edge_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
start_time (int) – Show statistics from this start time (in milliseconds since epoch).
end_time (int) – Show statistics until this end time (in milliseconds since epoch).
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

CbmStatistics If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_statistics_interfaces_uplink_get_with_http_info(org, sddc, edge_id, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_statistics_interfaces_uplink_get # noqa: E501

Retrieve uplink interface statistics for a management or compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_statistics_interfaces_uplink_get_with_http_info(org, sddc, edge_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
start_time (int) – Show statistics from this start time (in milliseconds since epoch).
end_time (int) – Show statistics until this end time (in milliseconds since epoch).
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(CbmStatistics, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_status_get(org, sddc, edge_id, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_status_get # noqa: E501

Retrieve the status of the specified management or compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_status_get(org, sddc, edge_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
getlatest (bool) – If true, retrieve the status live from the gateway (NSX Edge). If false, retrieve the latest available status from database.
detailed (bool) – If true, retrieve detailed status per feature. If false, retrieve aggregated summary of status per feature.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

EdgeStatus If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_status_get_with_http_info(org, sddc, edge_id, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_status_get # noqa: E501

Retrieve the status of the specified management or compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_status_get_with_http_info(org, sddc, edge_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
getlatest (bool) – If true, retrieve the status live from the gateway (NSX Edge). If false, retrieve the latest available status from database.
detailed (bool) – If true, retrieve detailed status per feature. If false, retrieve aggregated summary of status per feature.
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(EdgeStatus, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_vnics_get(org, sddc, edge_id, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_vnics_get # noqa: E501

Retrieve all interfaces for the specified management or compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_vnics_get(org, sddc, edge_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

Vnics If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_edge_id_vnics_get_with_http_info(org, sddc, edge_id, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_edge_id_vnics_get # noqa: E501

Retrieve all interfaces for the specified management or compute gateway (NSX Edge). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_edge_id_vnics_get_with_http_info(org, sddc, edge_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Edge Identifier. (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(Vnics, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_get(org, sddc, edge_type, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_get # noqa: E501

Retrieve information about all management and compute gateways and other routers (NSX Edges). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_get(org, sddc, edge_type, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_type (str) – Retrieve records matching NSX Edge type (‘gatewayServices’ or ‘distributedRouter’). Specify gatewayServices to find management and compute gateways in your SDDC. (required)
prev_edge_id (str) – Provide Edge ID as prevEdgeId to serve as reference for startIndex.
start_index (int) – Start index for the current page. Default is 0.
page_size (int) – Number of records per page. Default is 256.
sort_order_ascending (bool) – Set to true to fetch records in ascending sorted order.
sort_by (str) – Sort records using one of the column names (id, name, description, tenantId, size, enableFips).
filter (str) – Filter records matching the NSX Edge ID, name or description.
ld_rname (str) –
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

PagedEdgeList If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_edges_get_with_http_info(org, sddc, edge_type, **kwargs)¶

orgs_org_sddcs_sddc_networks40_edges_get # noqa: E501

Retrieve information about all management and compute gateways and other routers (NSX Edges). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_edges_get_with_http_info(org, sddc, edge_type, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_type (str) – Retrieve records matching NSX Edge type (‘gatewayServices’ or ‘distributedRouter’). Specify gatewayServices to find management and compute gateways in your SDDC. (required)
prev_edge_id (str) – Provide Edge ID as prevEdgeId to serve as reference for startIndex.
start_index (int) – Start index for the current page. Default is 0.
page_size (int) – Number of records per page. Default is 256.
sort_order_ascending (bool) – Set to true to fetch records in ascending sorted order.
sort_by (str) – Sort records using one of the column names (id, name, description, tenantId, size, enableFips).
filter (str) – Filter records matching the NSX Edge ID, name or description.
ld_rname (str) –
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(PagedEdgeList, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_sddc_cgws_edge_id_l2vpn_config_delete(org, sddc, edge_id, **kwargs)¶

orgs_org_sddcs_sddc_networks40_sddc_cgws_edge_id_l2vpn_config_delete # noqa: E501

Delete SDDC L2 VPN configuration. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_sddc_cgws_edge_id_l2vpn_config_delete(org, sddc, edge_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Compute Gateway Edge Identifier (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

None If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_sddc_cgws_edge_id_l2vpn_config_delete_with_http_info(org, sddc, edge_id, **kwargs)¶

orgs_org_sddcs_sddc_networks40_sddc_cgws_edge_id_l2vpn_config_delete # noqa: E501

Delete SDDC L2 VPN configuration. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_sddc_cgws_edge_id_l2vpn_config_delete_with_http_info(org, sddc, edge_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Compute Gateway Edge Identifier (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

None If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_sddc_cgws_edge_id_l2vpn_config_get(org, sddc, edge_id, **kwargs)¶

orgs_org_sddcs_sddc_networks40_sddc_cgws_edge_id_l2vpn_config_get # noqa: E501

Retrieve SDDC L2 VPN configuration. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_sddc_cgws_edge_id_l2vpn_config_get(org, sddc, edge_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Compute Gateway Edge Identifier (required)
show_sensitive_data (bool) –
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

Nsxl2vpn If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_sddc_cgws_edge_id_l2vpn_config_get_with_http_info(org, sddc, edge_id, **kwargs)¶

orgs_org_sddcs_sddc_networks40_sddc_cgws_edge_id_l2vpn_config_get # noqa: E501

Retrieve SDDC L2 VPN configuration. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_sddc_cgws_edge_id_l2vpn_config_get_with_http_info(org, sddc, edge_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Compute Gateway Edge Identifier (required)
show_sensitive_data (bool) –
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(Nsxl2vpn, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_sddc_cgws_edge_id_l2vpn_config_put(org, sddc, edge_id, nsxl2vpn, **kwargs)¶

orgs_org_sddcs_sddc_networks40_sddc_cgws_edge_id_l2vpn_config_put # noqa: E501

Modify SDDC L2 VPN configuration # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_sddc_cgws_edge_id_l2vpn_config_put(org, sddc, edge_id, nsxl2vpn, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Compute Gateway Edge Identifier (required)
nsxl2vpn (Nsxl2vpn) – (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

None If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_sddc_cgws_edge_id_l2vpn_config_put_with_http_info(org, sddc, edge_id, nsxl2vpn, **kwargs)¶

orgs_org_sddcs_sddc_networks40_sddc_cgws_edge_id_l2vpn_config_put # noqa: E501

Modify SDDC L2 VPN configuration # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_sddc_cgws_edge_id_l2vpn_config_put_with_http_info(org, sddc, edge_id, nsxl2vpn, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
edge_id (str) – Compute Gateway Edge Identifier (required)
nsxl2vpn (Nsxl2vpn) – (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

None If the method is called asynchronously, returns the request thread.

vmware.vmc.console.api.esx_api module¶

VMware Cloud APIs

All VMware Cloud APIs require a valid authentication token; which can be obtained by issuing a POST: ` curl -s -X POST \ -H "Content-Type: application/json" \ https://console.cloud.vmware.com/csp/gateway/am/api/auth/api-tokens/authorize?refresh_token={refresh-token} ` * This CSP API is defined at: https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST * The refresh_token used to get a valid authentication token can be obtained after successful login to following URL via a web browser: https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens. * Most VMware Cloud APIs require an org identifier. This can be obtained by issuing a GET on /vmc/api/orgs and extracting the id field # noqa: E501

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.api.esx_api.EsxApi(api_client=None)¶

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

orgs_org_sddcs_sddc_esxs_post(org, sddc, esx_config, **kwargs)¶

Add/Remove one or more ESX hosts in the target cloud # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_esxs_post(org, sddc, esx_config, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
sddc (str) – Sddc identifier (required)
esx_config (EsxConfig) – esxConfig (required)
action (str) – If = ‘add’, will add the esx. If = ‘remove’, will delete the esx/esxs bound to a single cluster (Cluster Id is mandatory for non cluster 1 esx remove). If = ‘force-remove’, will delete the esx even if it can lead to data loss (This is an privileged operation). If = ‘addToAll’, will add esxs to all clusters in the SDDC (This is an privileged operation). If = ‘removeFromAll’, will delete the esxs from all clusters in the SDDC (This is an privileged operation). If = ‘attach-diskgroup’, will attach the provided diskgroups to a given host (privileged). If = ‘detach-diskgroup’, will detach the diskgroups of a given host (privileged). Default behaviour is ‘add’
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

Task If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_esxs_post_with_http_info(org, sddc, esx_config, **kwargs)¶

Add/Remove one or more ESX hosts in the target cloud # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_esxs_post_with_http_info(org, sddc, esx_config, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
sddc (str) – Sddc identifier (required)
esx_config (EsxConfig) – esxConfig (required)
action (str) – If = ‘add’, will add the esx. If = ‘remove’, will delete the esx/esxs bound to a single cluster (Cluster Id is mandatory for non cluster 1 esx remove). If = ‘force-remove’, will delete the esx even if it can lead to data loss (This is an privileged operation). If = ‘addToAll’, will add esxs to all clusters in the SDDC (This is an privileged operation). If = ‘removeFromAll’, will delete the esxs from all clusters in the SDDC (This is an privileged operation). If = ‘attach-diskgroup’, will attach the provided diskgroups to a given host (privileged). If = ‘detach-diskgroup’, will detach the diskgroups of a given host (privileged). Default behaviour is ‘add’
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(Task, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

vmware.vmc.console.api.hcx_api module¶

VMware Cloud APIs

All VMware Cloud APIs require a valid authentication token; which can be obtained by issuing a POST: ` curl -s -X POST \ -H "Content-Type: application/json" \ https://console.cloud.vmware.com/csp/gateway/am/api/auth/api-tokens/authorize?refresh_token={refresh-token} ` * This CSP API is defined at: https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST * The refresh_token used to get a valid authentication token can be obtained after successful login to following URL via a web browser: https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens. * Most VMware Cloud APIs require an org identifier. This can be obtained by issuing a GET on /vmc/api/orgs and extracting the id field # noqa: E501

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.api.hcx_api.HcxApi(api_client=None)¶

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

orgs_org_sddcs_sddc_id_addons_addon_type_credentials_get(org, sddc_id, addon_type, **kwargs)¶

List all the credentials assoicated with an addon type with in a SDDC # noqa: E501

List all the credentials assoicated with an addon type with in a SDDC # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_get(org, sddc_id, addon_type, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Org id of the associated SDDC (required)
sddc_id (str) – Id of the SDDC (required)
addon_type (str) – Add on type (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

list[NewCredentials] If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_id_addons_addon_type_credentials_get_with_http_info(org, sddc_id, addon_type, **kwargs)¶

List all the credentials assoicated with an addon type with in a SDDC # noqa: E501

List all the credentials assoicated with an addon type with in a SDDC # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_get_with_http_info(org, sddc_id, addon_type, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Org id of the associated SDDC (required)
sddc_id (str) – Id of the SDDC (required)
addon_type (str) – Add on type (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(list[NewCredentials], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_get(org, sddc_id, addon_type, name, **kwargs)¶

Get credential details by name # noqa: E501

Get credential details by name # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_get(org, sddc_id, addon_type, name, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Org id of the associated SDDC (required)
sddc_id (str) – Id of the SDDC (required)
addon_type (str) – Add on type (required)
name (str) – name of the credentials (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

NewCredentials If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_get_with_http_info(org, sddc_id, addon_type, name, **kwargs)¶

Get credential details by name # noqa: E501

Get credential details by name # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_get_with_http_info(org, sddc_id, addon_type, name, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Org id of the associated SDDC (required)
sddc_id (str) – Id of the SDDC (required)
addon_type (str) – Add on type (required)
name (str) – name of the credentials (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(NewCredentials, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_put(org, sddc_id, addon_type, name, credentials, **kwargs)¶

Update credential details # noqa: E501

Update credential details # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_put(org, sddc_id, addon_type, name, credentials, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Org id of the associated SDDC (required)
sddc_id (str) – Id of the SDDC (required)
addon_type (str) – Add on type (required)
name (str) – name of the credentials (required)
credentials (UpdateCredentials) – Credentials update payload (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

NewCredentials If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_put_with_http_info(org, sddc_id, addon_type, name, credentials, **kwargs)¶

Update credential details # noqa: E501

Update credential details # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_put_with_http_info(org, sddc_id, addon_type, name, credentials, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Org id of the associated SDDC (required)
sddc_id (str) – Id of the SDDC (required)
addon_type (str) – Add on type (required)
name (str) – name of the credentials (required)
credentials (UpdateCredentials) – Credentials update payload (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(NewCredentials, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_id_addons_addon_type_credentials_post(org, sddc_id, addon_type, credentials, **kwargs)¶

Associate a new add on credentials with the SDDC such as HCX # noqa: E501

Associated a new add on credentials with the SDDC such as HCX # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_post(org, sddc_id, addon_type, credentials, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Org id of the associated SDDC (required)
sddc_id (str) – Id of the SDDC (required)
addon_type (str) – Add on type (required)
credentials (NewCredentials) – Credentials creation payload (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

NewCredentials If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_id_addons_addon_type_credentials_post_with_http_info(org, sddc_id, addon_type, credentials, **kwargs)¶

Associate a new add on credentials with the SDDC such as HCX # noqa: E501

Associated a new add on credentials with the SDDC such as HCX # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_post_with_http_info(org, sddc_id, addon_type, credentials, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Org id of the associated SDDC (required)
sddc_id (str) – Id of the SDDC (required)
addon_type (str) – Add on type (required)
credentials (NewCredentials) – Credentials creation payload (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(NewCredentials, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

vmware.vmc.console.api.locale_api module¶

VMware Cloud APIs

All VMware Cloud APIs require a valid authentication token; which can be obtained by issuing a POST: ` curl -s -X POST \ -H "Content-Type: application/json" \ https://console.cloud.vmware.com/csp/gateway/am/api/auth/api-tokens/authorize?refresh_token={refresh-token} ` * This CSP API is defined at: https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST * The refresh_token used to get a valid authentication token can be obtained after successful login to following URL via a web browser: https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens. * Most VMware Cloud APIs require an org identifier. This can be obtained by issuing a GET on /vmc/api/orgs and extracting the id field # noqa: E501

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.api.locale_api.LocaleApi(api_client=None)¶

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

locale_post(vmc_locale, **kwargs)¶

Set locale for the session # noqa: E501

Sets the locale for the session which is used for translating responses. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.locale_post(vmc_locale, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
vmc_locale (VmcLocale) – The locale to be set. (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

VmcLocale If the method is called asynchronously, returns the request thread.

locale_post_with_http_info(vmc_locale, **kwargs)¶

Set locale for the session # noqa: E501

Sets the locale for the session which is used for translating responses. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.locale_post_with_http_info(vmc_locale, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
vmc_locale (VmcLocale) – The locale to be set. (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(VmcLocale, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

vmware.vmc.console.api.msft_licensing_api module¶

VMware Cloud APIs

All VMware Cloud APIs require a valid authentication token; which can be obtained by issuing a POST: ` curl -s -X POST \ -H "Content-Type: application/json" \ https://console.cloud.vmware.com/csp/gateway/am/api/auth/api-tokens/authorize?refresh_token={refresh-token} ` * This CSP API is defined at: https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST * The refresh_token used to get a valid authentication token can be obtained after successful login to following URL via a web browser: https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens. * Most VMware Cloud APIs require an org identifier. This can be obtained by issuing a GET on /vmc/api/orgs and extracting the id field # noqa: E501

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.api.msft_licensing_api.MsftLicensingApi(api_client=None)¶

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

orgs_org_sddcs_sddc_clusters_cluster_msft_licensing_publish_post(org, sddc, cluster, config_change, **kwargs)¶

orgs_org_sddcs_sddc_clusters_cluster_msft_licensing_publish_post # noqa: E501

Sets the current Microsoft license status of the given SDDC’s cluster. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_clusters_cluster_msft_licensing_publish_post(org, sddc, cluster, config_change, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
sddc (str) – Sddc identifier (required)
cluster (str) – cluster identifier (required)
config_change (MsftLicensingConfig) – The license data to set for the clusters. (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

Task If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_clusters_cluster_msft_licensing_publish_post_with_http_info(org, sddc, cluster, config_change, **kwargs)¶

orgs_org_sddcs_sddc_clusters_cluster_msft_licensing_publish_post # noqa: E501

Sets the current Microsoft license status of the given SDDC’s cluster. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_clusters_cluster_msft_licensing_publish_post_with_http_info(org, sddc, cluster, config_change, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
sddc (str) – Sddc identifier (required)
cluster (str) – cluster identifier (required)
config_change (MsftLicensingConfig) – The license data to set for the clusters. (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(Task, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

vmware.vmc.console.api.network_api module¶

VMware Cloud APIs

All VMware Cloud APIs require a valid authentication token; which can be obtained by issuing a POST: ` curl -s -X POST \ -H "Content-Type: application/json" \ https://console.cloud.vmware.com/csp/gateway/am/api/auth/api-tokens/authorize?refresh_token={refresh-token} ` * This CSP API is defined at: https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST * The refresh_token used to get a valid authentication token can be obtained after successful login to following URL via a web browser: https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens. * Most VMware Cloud APIs require an org identifier. This can be obtained by issuing a GET on /vmc/api/orgs and extracting the id field # noqa: E501

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.api.network_api.NetworkApi(api_client=None)¶

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

orgs_org_sddcs_sddc_networking_connectivity_tests_get(org, sddc, **kwargs)¶

Retrieve metadata for connectivity tests. # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networking_connectivity_tests_get(org, sddc, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ConnectivityValidationGroups If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networking_connectivity_tests_get_with_http_info(org, sddc, **kwargs)¶

Retrieve metadata for connectivity tests. # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networking_connectivity_tests_get_with_http_info(org, sddc, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(ConnectivityValidationGroups, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networking_connectivity_tests_post(org, sddc, action, request_info, **kwargs)¶

ConnectivityValidationGroupResultWrapper will be available at task.params[‘test_result’]. # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networking_connectivity_tests_post(org, sddc, action, request_info, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
action (str) – If = ‘start’, start connectivity tests. (required)
request_info (ConnectivityValidationGroup) – request information (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

Task If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networking_connectivity_tests_post_with_http_info(org, sddc, action, request_info, **kwargs)¶

ConnectivityValidationGroupResultWrapper will be available at task.params[‘test_result’]. # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networking_connectivity_tests_post_with_http_info(org, sddc, action, request_info, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
action (str) – If = ‘start’, start connectivity tests. (required)
request_info (ConnectivityValidationGroup) – request information (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(Task, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

vmware.vmc.console.api.orgs_api module¶

VMware Cloud APIs

All VMware Cloud APIs require a valid authentication token; which can be obtained by issuing a POST: ` curl -s -X POST \ -H "Content-Type: application/json" \ https://console.cloud.vmware.com/csp/gateway/am/api/auth/api-tokens/authorize?refresh_token={refresh-token} ` * This CSP API is defined at: https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST * The refresh_token used to get a valid authentication token can be obtained after successful login to following URL via a web browser: https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens. * Most VMware Cloud APIs require an org identifier. This can be obtained by issuing a GET on /vmc/api/orgs and extracting the id field # noqa: E501

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.api.orgs_api.OrgsApi(api_client=None)¶

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

orgs_get(**kwargs)¶

Get organizations associated with calling user. # noqa: E501

Return a list of all organizations the calling user (based on credential) is authorized on. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_get(async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

list[Organization] If the method is called asynchronously, returns the request thread.

orgs_get_with_http_info(**kwargs)¶

Get organizations associated with calling user. # noqa: E501

Return a list of all organizations the calling user (based on credential) is authorized on. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(list[Organization], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_get(org, **kwargs)¶

Get details of organization # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_get(org, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

Organization If the method is called asynchronously, returns the request thread.

orgs_org_get_with_http_info(org, **kwargs)¶

Get details of organization # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_get_with_http_info(org, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(Organization, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_payment_methods_get(org, **kwargs)¶

Get payment methods of organization # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_payment_methods_get(org, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
default_flag (bool) – When true, will only return default payment methods.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

list[PaymentMethodInfo] If the method is called asynchronously, returns the request thread.

orgs_org_payment_methods_get_with_http_info(org, **kwargs)¶

Get payment methods of organization # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_payment_methods_get_with_http_info(org, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
default_flag (bool) – When true, will only return default payment methods.
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(list[PaymentMethodInfo], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_providers_get(org, **kwargs)¶

Get enabled cloud providers for an organization # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_providers_get(org, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

list[AwsCloudProvider] If the method is called asynchronously, returns the request thread.

orgs_org_providers_get_with_http_info(org, **kwargs)¶

Get enabled cloud providers for an organization # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_providers_get_with_http_info(org, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(list[AwsCloudProvider], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

vmware.vmc.console.api.publicip_api module¶

VMware Cloud APIs

All VMware Cloud APIs require a valid authentication token; which can be obtained by issuing a POST: ` curl -s -X POST \ -H "Content-Type: application/json" \ https://console.cloud.vmware.com/csp/gateway/am/api/auth/api-tokens/authorize?refresh_token={refresh-token} ` * This CSP API is defined at: https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST * The refresh_token used to get a valid authentication token can be obtained after successful login to following URL via a web browser: https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens. * Most VMware Cloud APIs require an org identifier. This can be obtained by issuing a GET on /vmc/api/orgs and extracting the id field # noqa: E501

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.api.publicip_api.PublicipApi(api_client=None)¶

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

orgs_org_sddcs_sddc_publicips_get(org, sddc, **kwargs)¶

List all public IPs for a SDDC # noqa: E501

list all public IPs for a SDDC # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_publicips_get(org, sddc, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

list[SddcPublicIp] If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_publicips_get_with_http_info(org, sddc, **kwargs)¶

List all public IPs for a SDDC # noqa: E501

list all public IPs for a SDDC # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_publicips_get_with_http_info(org, sddc, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(list[SddcPublicIp], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_publicips_id_delete(org, sddc, id, **kwargs)¶

Free one public IP for a SDDC # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_publicips_id_delete(org, sddc, id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
id (str) – ip allocation id (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

Task If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_publicips_id_delete_with_http_info(org, sddc, id, **kwargs)¶

Free one public IP for a SDDC # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_publicips_id_delete_with_http_info(org, sddc, id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
id (str) – ip allocation id (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(Task, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_publicips_id_get(org, sddc, id, **kwargs)¶

Get one public IP for a SDDC # noqa: E501

Get one public IP for a SDDC # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_publicips_id_get(org, sddc, id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
id (str) – ip allocation id (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

SddcPublicIp If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_publicips_id_get_with_http_info(org, sddc, id, **kwargs)¶

Get one public IP for a SDDC # noqa: E501

Get one public IP for a SDDC # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_publicips_id_get_with_http_info(org, sddc, id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
id (str) – ip allocation id (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(SddcPublicIp, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_publicips_id_patch(org, sddc, id, action, sddc_public_ip_object, **kwargs)¶

Attach or detach a public IP to workload VM for a SDDC # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_publicips_id_patch(org, sddc, id, action, sddc_public_ip_object, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
id (str) – ip allocation id (required)
action (str) – Type of action as ‘attach’, ‘detach’, ‘reattach’, or ‘rename’. For ‘attch’, the public IP must not be attached and ‘associated_private_ip’ in the payload needs to be set with a workload VM private IP. For ‘detach’, the public IP must be attached and ‘associated_private_ip’ in the payload should not be set with any value. For ‘reattach’, the public IP must be attached and ‘associated_private_ip’ in the payload needs to be set with a new workload VM private IP. For ‘rename’, the ‘name’ in the payload needs to have a new name string. (required)
sddc_public_ip_object (SddcPublicIp) – SddcPublicIp object to update (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

Task If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_publicips_id_patch_with_http_info(org, sddc, id, action, sddc_public_ip_object, **kwargs)¶

Attach or detach a public IP to workload VM for a SDDC # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_publicips_id_patch_with_http_info(org, sddc, id, action, sddc_public_ip_object, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
id (str) – ip allocation id (required)
action (str) – Type of action as ‘attach’, ‘detach’, ‘reattach’, or ‘rename’. For ‘attch’, the public IP must not be attached and ‘associated_private_ip’ in the payload needs to be set with a workload VM private IP. For ‘detach’, the public IP must be attached and ‘associated_private_ip’ in the payload should not be set with any value. For ‘reattach’, the public IP must be attached and ‘associated_private_ip’ in the payload needs to be set with a new workload VM private IP. For ‘rename’, the ‘name’ in the payload needs to have a new name string. (required)
sddc_public_ip_object (SddcPublicIp) – SddcPublicIp object to update (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(Task, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_publicips_post(org, sddc, spec, **kwargs)¶

Allocate public IPs for a SDDC # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_publicips_post(org, sddc, spec, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
spec (SddcAllocatePublicIpSpec) – allocation spec (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

Task If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_publicips_post_with_http_info(org, sddc, spec, **kwargs)¶

Allocate public IPs for a SDDC # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_publicips_post_with_http_info(org, sddc, spec, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
spec (SddcAllocatePublicIpSpec) – allocation spec (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(Task, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

vmware.vmc.console.api.reservations_api module¶

VMware Cloud APIs

All VMware Cloud APIs require a valid authentication token; which can be obtained by issuing a POST: ` curl -s -X POST \ -H "Content-Type: application/json" \ https://console.cloud.vmware.com/csp/gateway/am/api/auth/api-tokens/authorize?refresh_token={refresh-token} ` * This CSP API is defined at: https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST * The refresh_token used to get a valid authentication token can be obtained after successful login to following URL via a web browser: https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens. * Most VMware Cloud APIs require an org identifier. This can be obtained by issuing a GET on /vmc/api/orgs and extracting the id field # noqa: E501

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.api.reservations_api.ReservationsApi(api_client=None)¶

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

orgs_org_reservations_get(org, **kwargs)¶

Get all reservations for this org # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_reservations_get(org, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

list[MaintenanceWindowEntry] If the method is called asynchronously, returns the request thread.

orgs_org_reservations_get_with_http_info(org, **kwargs)¶

Get all reservations for this org # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_reservations_get_with_http_info(org, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(list[MaintenanceWindowEntry], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_reservations_reservation_mw_get(org, reservation, **kwargs)¶

get the maintenance window for this SDDC # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_reservations_reservation_mw_get(org, reservation, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
reservation (str) – Reservation Identifier (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

MaintenanceWindowGet If the method is called asynchronously, returns the request thread.

orgs_org_reservations_reservation_mw_get_with_http_info(org, reservation, **kwargs)¶

get the maintenance window for this SDDC # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_reservations_reservation_mw_get_with_http_info(org, reservation, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
reservation (str) – Reservation Identifier (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(MaintenanceWindowGet, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_reservations_reservation_mw_put(org, reservation, window, **kwargs)¶

update the maintenance window for this SDDC # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_reservations_reservation_mw_put(org, reservation, window, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
reservation (str) – Reservation Identifier (required)
window (MaintenanceWindow) – Maintenance Window (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

MaintenanceWindow If the method is called asynchronously, returns the request thread.

orgs_org_reservations_reservation_mw_put_with_http_info(org, reservation, window, **kwargs)¶

update the maintenance window for this SDDC # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_reservations_reservation_mw_put_with_http_info(org, reservation, window, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
reservation (str) – Reservation Identifier (required)
window (MaintenanceWindow) – Maintenance Window (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(MaintenanceWindow, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

vmware.vmc.console.api.sddc_api module¶

VMware Cloud APIs

All VMware Cloud APIs require a valid authentication token; which can be obtained by issuing a POST: ` curl -s -X POST \ -H "Content-Type: application/json" \ https://console.cloud.vmware.com/csp/gateway/am/api/auth/api-tokens/authorize?refresh_token={refresh-token} ` * This CSP API is defined at: https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST * The refresh_token used to get a valid authentication token can be obtained after successful login to following URL via a web browser: https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens. * Most VMware Cloud APIs require an org identifier. This can be obtained by issuing a GET on /vmc/api/orgs and extracting the id field # noqa: E501

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.api.sddc_api.SddcApi(api_client=None)¶

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

orgs_org_sddcs_get(org, **kwargs)¶

List all the SDDCs of an organization # noqa: E501

List all the SDDCs of an organization # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_get(org, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
include_deleted (bool) – When true, forces the result to also include deleted SDDCs.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

list[Sddc] If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_get_with_http_info(org, **kwargs)¶

List all the SDDCs of an organization # noqa: E501

List all the SDDCs of an organization # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_get_with_http_info(org, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
include_deleted (bool) – When true, forces the result to also include deleted SDDCs.
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(list[Sddc], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_post(org, sddc_config, **kwargs)¶

Provision SDDC # noqa: E501

Provision an SDDC in target cloud # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_post(org, sddc_config, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
sddc_config (AwsSddcConfig) – sddcConfig (required)
validate_only (bool) – When true, only validates the given sddc configuration without provisioning.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

Task If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_post_with_http_info(org, sddc_config, **kwargs)¶

Provision SDDC # noqa: E501

Provision an SDDC in target cloud # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_post_with_http_info(org, sddc_config, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
sddc_config (AwsSddcConfig) – sddcConfig (required)
validate_only (bool) – When true, only validates the given sddc configuration without provisioning.
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(Task, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_provision_spec_get(org, **kwargs)¶

Get sddc provision spec for an org # noqa: E501

Get sddc provision spec for an org # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_provision_spec_get(org, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ProvisionSpec If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_provision_spec_get_with_http_info(org, **kwargs)¶

Get sddc provision spec for an org # noqa: E501

Get sddc provision spec for an org # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_provision_spec_get_with_http_info(org, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(ProvisionSpec, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_clusters_cluster_delete(org, sddc, cluster, **kwargs)¶

Delete a cluster. # noqa: E501

This is a force operation which will delete the cluster even if there can be a data loss. Before calling this operation, all the VMs should be powered off. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_clusters_cluster_delete(org, sddc, cluster, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
sddc (str) – Sddc identifier (required)
cluster (str) – cluster identifier (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

Task If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_clusters_cluster_delete_with_http_info(org, sddc, cluster, **kwargs)¶

Delete a cluster. # noqa: E501

This is a force operation which will delete the cluster even if there can be a data loss. Before calling this operation, all the VMs should be powered off. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_clusters_cluster_delete_with_http_info(org, sddc, cluster, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
sddc (str) – Sddc identifier (required)
cluster (str) – cluster identifier (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(Task, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_clusters_cluster_reconfigure_post(org, sddc, cluster, cluster_reconfigure_params, **kwargs)¶

Initiate a reconfiguration for the cluster. # noqa: E501

This reconfiguration will handle changing both the number of hosts and the cluster storage capacity. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_clusters_cluster_reconfigure_post(org, sddc, cluster, cluster_reconfigure_params, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
sddc (str) – Sddc identifier (required)
cluster (str) – cluster identifier (required)
cluster_reconfigure_params (ClusterReconfigureParams) – clusterReconfigureParams (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

Task If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_clusters_cluster_reconfigure_post_with_http_info(org, sddc, cluster, cluster_reconfigure_params, **kwargs)¶

Initiate a reconfiguration for the cluster. # noqa: E501

This reconfiguration will handle changing both the number of hosts and the cluster storage capacity. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_clusters_cluster_reconfigure_post_with_http_info(org, sddc, cluster, cluster_reconfigure_params, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
sddc (str) – Sddc identifier (required)
cluster (str) – cluster identifier (required)
cluster_reconfigure_params (ClusterReconfigureParams) – clusterReconfigureParams (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(Task, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_clusters_post(org, sddc, cluster_config, **kwargs)¶

Add a cluster in the target sddc. # noqa: E501

Creates a new cluster in customers sddcs with passed clusterConfig. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_clusters_post(org, sddc, cluster_config, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
sddc (str) – Sddc identifier (required)
cluster_config (ClusterConfig) – clusterConfig (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

Task If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_clusters_post_with_http_info(org, sddc, cluster_config, **kwargs)¶

Add a cluster in the target sddc. # noqa: E501

Creates a new cluster in customers sddcs with passed clusterConfig. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_clusters_post_with_http_info(org, sddc, cluster_config, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
sddc (str) – Sddc identifier (required)
cluster_config (ClusterConfig) – clusterConfig (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(Task, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_convert_post(org, sddc, **kwargs)¶

Converts a one host SDDC to a four node DEFAULT SDDC. # noqa: E501

This API converts a one host SDDC to a four node DEFAULT SDDC. It takes care of configuring and upgrading the vCenter configurations on the SDDC for high availability and data redundancy. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_convert_post(org, sddc, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
sddc (str) – Sddc identifier (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

Task If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_convert_post_with_http_info(org, sddc, **kwargs)¶

Converts a one host SDDC to a four node DEFAULT SDDC. # noqa: E501

This API converts a one host SDDC to a four node DEFAULT SDDC. It takes care of configuring and upgrading the vCenter configurations on the SDDC for high availability and data redundancy. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_convert_post_with_http_info(org, sddc, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
sddc (str) – Sddc identifier (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(Task, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_delete(org, sddc, **kwargs)¶

Delete SDDC # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_delete(org, sddc, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
sddc (str) – Sddc identifier (required)
retain_configuration (bool) – If = ‘true’, the SDDC’s configuration is retained as a template for later use. This flag is applicable only to SDDCs in ACTIVE state.
template_name (str) – Only applicable when retainConfiguration is also set to ‘true’. When set, this value will be used as the name of the SDDC configuration template generated.
force (bool) – If = true, will delete forcefully. Beware: do not use the force flag if there is a chance an active provisioning or deleting task is running against this SDDC. This option is restricted.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

Task If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_delete_with_http_info(org, sddc, **kwargs)¶

Delete SDDC # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_delete_with_http_info(org, sddc, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
sddc (str) – Sddc identifier (required)
retain_configuration (bool) – If = ‘true’, the SDDC’s configuration is retained as a template for later use. This flag is applicable only to SDDCs in ACTIVE state.
template_name (str) – Only applicable when retainConfiguration is also set to ‘true’. When set, this value will be used as the name of the SDDC configuration template generated.
force (bool) – If = true, will delete forcefully. Beware: do not use the force flag if there is a chance an active provisioning or deleting task is running against this SDDC. This option is restricted.
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(Task, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_dns_private_put(org, sddc, **kwargs)¶

Update the DNS records of management VMs to use private IP addresses # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_dns_private_put(org, sddc, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
sddc (str) – Sddc identifier (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

Task If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_dns_private_put_with_http_info(org, sddc, **kwargs)¶

Update the DNS records of management VMs to use private IP addresses # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_dns_private_put_with_http_info(org, sddc, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
sddc (str) – Sddc identifier (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(Task, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_dns_public_put(org, sddc, **kwargs)¶

Update the DNS records of management VMs to use public IP addresses # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_dns_public_put(org, sddc, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
sddc (str) – Sddc identifier (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

Task If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_dns_public_put_with_http_info(org, sddc, **kwargs)¶

Update the DNS records of management VMs to use public IP addresses # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_dns_public_put_with_http_info(org, sddc, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
sddc (str) – Sddc identifier (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(Task, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_esxs_post(org, sddc, esx_config, **kwargs)¶

Add/Remove one or more ESX hosts in the target cloud # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_esxs_post(org, sddc, esx_config, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
sddc (str) – Sddc identifier (required)
esx_config (EsxConfig) – esxConfig (required)
action (str) – If = ‘add’, will add the esx. If = ‘remove’, will delete the esx/esxs bound to a single cluster (Cluster Id is mandatory for non cluster 1 esx remove). If = ‘force-remove’, will delete the esx even if it can lead to data loss (This is an privileged operation). If = ‘addToAll’, will add esxs to all clusters in the SDDC (This is an privileged operation). If = ‘removeFromAll’, will delete the esxs from all clusters in the SDDC (This is an privileged operation). If = ‘attach-diskgroup’, will attach the provided diskgroups to a given host (privileged). If = ‘detach-diskgroup’, will detach the diskgroups of a given host (privileged). Default behaviour is ‘add’
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

Task If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_esxs_post_with_http_info(org, sddc, esx_config, **kwargs)¶

Add/Remove one or more ESX hosts in the target cloud # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_esxs_post_with_http_info(org, sddc, esx_config, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
sddc (str) – Sddc identifier (required)
esx_config (EsxConfig) – esxConfig (required)
action (str) – If = ‘add’, will add the esx. If = ‘remove’, will delete the esx/esxs bound to a single cluster (Cluster Id is mandatory for non cluster 1 esx remove). If = ‘force-remove’, will delete the esx even if it can lead to data loss (This is an privileged operation). If = ‘addToAll’, will add esxs to all clusters in the SDDC (This is an privileged operation). If = ‘removeFromAll’, will delete the esxs from all clusters in the SDDC (This is an privileged operation). If = ‘attach-diskgroup’, will attach the provided diskgroups to a given host (privileged). If = ‘detach-diskgroup’, will detach the diskgroups of a given host (privileged). Default behaviour is ‘add’
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(Task, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_get(org, sddc, **kwargs)¶

Get SDDC # noqa: E501

Get SDDC # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_get(org, sddc, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
sddc (str) – Sddc identifier (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

Sddc If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_get_with_http_info(org, sddc, **kwargs)¶

Get SDDC # noqa: E501

Get SDDC # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_get_with_http_info(org, sddc, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
sddc (str) – Sddc identifier (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(Sddc, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_id_addons_addon_type_credentials_get(org, sddc_id, addon_type, **kwargs)¶

List all the credentials assoicated with an addon type with in a SDDC # noqa: E501

List all the credentials assoicated with an addon type with in a SDDC # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_get(org, sddc_id, addon_type, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Org id of the associated SDDC (required)
sddc_id (str) – Id of the SDDC (required)
addon_type (str) – Add on type (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

list[NewCredentials] If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_id_addons_addon_type_credentials_get_with_http_info(org, sddc_id, addon_type, **kwargs)¶

List all the credentials assoicated with an addon type with in a SDDC # noqa: E501

List all the credentials assoicated with an addon type with in a SDDC # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_get_with_http_info(org, sddc_id, addon_type, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Org id of the associated SDDC (required)
sddc_id (str) – Id of the SDDC (required)
addon_type (str) – Add on type (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(list[NewCredentials], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_get(org, sddc_id, addon_type, name, **kwargs)¶

Get credential details by name # noqa: E501

Get credential details by name # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_get(org, sddc_id, addon_type, name, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Org id of the associated SDDC (required)
sddc_id (str) – Id of the SDDC (required)
addon_type (str) – Add on type (required)
name (str) – name of the credentials (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

NewCredentials If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_get_with_http_info(org, sddc_id, addon_type, name, **kwargs)¶

Get credential details by name # noqa: E501

Get credential details by name # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_get_with_http_info(org, sddc_id, addon_type, name, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Org id of the associated SDDC (required)
sddc_id (str) – Id of the SDDC (required)
addon_type (str) – Add on type (required)
name (str) – name of the credentials (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(NewCredentials, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_put(org, sddc_id, addon_type, name, credentials, **kwargs)¶

Update credential details # noqa: E501

Update credential details # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_put(org, sddc_id, addon_type, name, credentials, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Org id of the associated SDDC (required)
sddc_id (str) – Id of the SDDC (required)
addon_type (str) – Add on type (required)
name (str) – name of the credentials (required)
credentials (UpdateCredentials) – Credentials update payload (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

NewCredentials If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_put_with_http_info(org, sddc_id, addon_type, name, credentials, **kwargs)¶

Update credential details # noqa: E501

Update credential details # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_name_put_with_http_info(org, sddc_id, addon_type, name, credentials, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Org id of the associated SDDC (required)
sddc_id (str) – Id of the SDDC (required)
addon_type (str) – Add on type (required)
name (str) – name of the credentials (required)
credentials (UpdateCredentials) – Credentials update payload (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(NewCredentials, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_id_addons_addon_type_credentials_post(org, sddc_id, addon_type, credentials, **kwargs)¶

Associate a new add on credentials with the SDDC such as HCX # noqa: E501

Associated a new add on credentials with the SDDC such as HCX # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_post(org, sddc_id, addon_type, credentials, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Org id of the associated SDDC (required)
sddc_id (str) – Id of the SDDC (required)
addon_type (str) – Add on type (required)
credentials (NewCredentials) – Credentials creation payload (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

NewCredentials If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_id_addons_addon_type_credentials_post_with_http_info(org, sddc_id, addon_type, credentials, **kwargs)¶

Associate a new add on credentials with the SDDC such as HCX # noqa: E501

Associated a new add on credentials with the SDDC such as HCX # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_id_addons_addon_type_credentials_post_with_http_info(org, sddc_id, addon_type, credentials, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Org id of the associated SDDC (required)
sddc_id (str) – Id of the SDDC (required)
addon_type (str) – Add on type (required)
credentials (NewCredentials) – Credentials creation payload (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(NewCredentials, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_management_vms_management_vm_id_dns_ip_type_put(org, sddc, management_vm_id, ip_type, **kwargs)¶

Update the DNS records of management VMs to use public or private IP addresses # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_management_vms_management_vm_id_dns_ip_type_put(org, sddc, management_vm_id, ip_type, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
sddc (str) – Sddc identifier (required)
management_vm_id (str) – the management VM ID (required)
ip_type (str) – the ip type to associate with FQDN in DNS (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

Task If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_management_vms_management_vm_id_dns_ip_type_put_with_http_info(org, sddc, management_vm_id, ip_type, **kwargs)¶

Update the DNS records of management VMs to use public or private IP addresses # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_management_vms_management_vm_id_dns_ip_type_put_with_http_info(org, sddc, management_vm_id, ip_type, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
sddc (str) – Sddc identifier (required)
management_vm_id (str) – the management VM ID (required)
ip_type (str) – the ip type to associate with FQDN in DNS (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(Task, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_patch(org, sddc, sddc_patch_request, **kwargs)¶

Patch SDDC # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_patch(org, sddc, sddc_patch_request, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
sddc (str) – Sddc identifier (required)
sddc_patch_request (SddcPatchRequest) – Patch request for the SDDC (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

Sddc If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_patch_with_http_info(org, sddc, sddc_patch_request, **kwargs)¶

Patch SDDC # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_patch_with_http_info(org, sddc, sddc_patch_request, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
sddc (str) – Sddc identifier (required)
sddc_patch_request (SddcPatchRequest) – Patch request for the SDDC (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(Sddc, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_primarycluster_get(org, sddc, **kwargs)¶

Get a primary cluster in the target sddc # noqa: E501

Retrieves the primary cluster in provided customer sddc UUID # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_primarycluster_get(org, sddc, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
sddc (str) – Sddc identifier (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

Cluster If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_primarycluster_get_with_http_info(org, sddc, **kwargs)¶

Get a primary cluster in the target sddc # noqa: E501

Retrieves the primary cluster in provided customer sddc UUID # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_primarycluster_get_with_http_info(org, sddc, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
sddc (str) – Sddc identifier (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(Cluster, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

vmware.vmc.console.api.sddc_networks_api module¶

VMware Cloud APIs

All VMware Cloud APIs require a valid authentication token; which can be obtained by issuing a POST: ` curl -s -X POST \ -H "Content-Type: application/json" \ https://console.cloud.vmware.com/csp/gateway/am/api/auth/api-tokens/authorize?refresh_token={refresh-token} ` * This CSP API is defined at: https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST * The refresh_token used to get a valid authentication token can be obtained after successful login to following URL via a web browser: https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens. * Most VMware Cloud APIs require an org identifier. This can be obtained by issuing a GET on /vmc/api/orgs and extracting the id field # noqa: E501

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.api.sddc_networks_api.SddcNetworksApi(api_client=None)¶

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

orgs_org_sddcs_sddc_networks40_sddc_networks_get(org, sddc, **kwargs)¶

orgs_org_sddcs_sddc_networks40_sddc_networks_get # noqa: E501

Retrieve all networks in an SDDC. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_sddc_networks_get(org, sddc, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
page_size (int) – Page size for pagination.
start_index (int) – Start index of page.
prev_sddc_network_id (str) – Previous logical network id.
sort_order_ascending (bool) – Sort order ascending.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

DataPageSddcNetwork If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_sddc_networks_get_with_http_info(org, sddc, **kwargs)¶

orgs_org_sddcs_sddc_networks40_sddc_networks_get # noqa: E501

Retrieve all networks in an SDDC. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_sddc_networks_get_with_http_info(org, sddc, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
page_size (int) – Page size for pagination.
start_index (int) – Start index of page.
prev_sddc_network_id (str) – Previous logical network id.
sort_order_ascending (bool) – Sort order ascending.
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(DataPageSddcNetwork, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_sddc_networks_network_id_delete(org, sddc, network_id, **kwargs)¶

orgs_org_sddcs_sddc_networks40_sddc_networks_network_id_delete # noqa: E501

Delete a network in an SDDC. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_sddc_networks_network_id_delete(org, sddc, network_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
network_id (str) – Logical Network Identifier (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

None If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_sddc_networks_network_id_delete_with_http_info(org, sddc, network_id, **kwargs)¶

orgs_org_sddcs_sddc_networks40_sddc_networks_network_id_delete # noqa: E501

Delete a network in an SDDC. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_sddc_networks_network_id_delete_with_http_info(org, sddc, network_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
network_id (str) – Logical Network Identifier (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

None If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_sddc_networks_network_id_get(org, sddc, network_id, **kwargs)¶

orgs_org_sddcs_sddc_networks40_sddc_networks_network_id_get # noqa: E501

Retrieve information about a network in an SDDC. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_sddc_networks_network_id_get(org, sddc, network_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
network_id (str) – Logical Network Identifier (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

SddcNetwork If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_sddc_networks_network_id_get_with_http_info(org, sddc, network_id, **kwargs)¶

orgs_org_sddcs_sddc_networks40_sddc_networks_network_id_get # noqa: E501

Retrieve information about a network in an SDDC. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_sddc_networks_network_id_get_with_http_info(org, sddc, network_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
network_id (str) – Logical Network Identifier (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(SddcNetwork, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_sddc_networks_network_id_put(org, sddc, network_id, sddc_network, **kwargs)¶

orgs_org_sddcs_sddc_networks40_sddc_networks_network_id_put # noqa: E501

Modify a network in an SDDC. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_sddc_networks_network_id_put(org, sddc, network_id, sddc_network, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
network_id (str) – Logical Network Identifier (required)
sddc_network (SddcNetwork) – (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

None If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_sddc_networks_network_id_put_with_http_info(org, sddc, network_id, sddc_network, **kwargs)¶

orgs_org_sddcs_sddc_networks40_sddc_networks_network_id_put # noqa: E501

Modify a network in an SDDC. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_sddc_networks_network_id_put_with_http_info(org, sddc, network_id, sddc_network, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
network_id (str) – Logical Network Identifier (required)
sddc_network (SddcNetwork) – (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

None If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_sddc_networks_post(org, sddc, sddc_network, **kwargs)¶

orgs_org_sddcs_sddc_networks40_sddc_networks_post # noqa: E501

Create a network in an SDDC. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_sddc_networks_post(org, sddc, sddc_network, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
sddc_network (SddcNetwork) – (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

None If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networks40_sddc_networks_post_with_http_info(org, sddc, sddc_network, **kwargs)¶

orgs_org_sddcs_sddc_networks40_sddc_networks_post # noqa: E501

Create a network in an SDDC. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networks40_sddc_networks_post_with_http_info(org, sddc, sddc_network, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier. (required)
sddc (str) – Sddc Identifier. (required)
sddc_network (SddcNetwork) – (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

None If the method is called asynchronously, returns the request thread.

vmware.vmc.console.api.sddc_template_api module¶

VMware Cloud APIs

All VMware Cloud APIs require a valid authentication token; which can be obtained by issuing a POST: ` curl -s -X POST \ -H "Content-Type: application/json" \ https://console.cloud.vmware.com/csp/gateway/am/api/auth/api-tokens/authorize?refresh_token={refresh-token} ` * This CSP API is defined at: https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST * The refresh_token used to get a valid authentication token can be obtained after successful login to following URL via a web browser: https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens. * Most VMware Cloud APIs require an org identifier. This can be obtained by issuing a GET on /vmc/api/orgs and extracting the id field # noqa: E501

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.api.sddc_template_api.SddcTemplateApi(api_client=None)¶

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

orgs_org_sddc_templates_get(org, **kwargs)¶

List all available SDDC configuration templates in an organization # noqa: E501

List all available SDDC configuration templates in an organization # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddc_templates_get(org, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

list[SddcTemplate] If the method is called asynchronously, returns the request thread.

orgs_org_sddc_templates_get_with_http_info(org, **kwargs)¶

List all available SDDC configuration templates in an organization # noqa: E501

List all available SDDC configuration templates in an organization # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddc_templates_get_with_http_info(org, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(list[SddcTemplate], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_sddc_templates_template_id_delete(org, template_id, **kwargs)¶

Delete SDDC template identified by given id. # noqa: E501

Delete SDDC template identified by given id. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddc_templates_template_id_delete(org, template_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
template_id (str) – SDDC Template identifier (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

Task If the method is called asynchronously, returns the request thread.

orgs_org_sddc_templates_template_id_delete_with_http_info(org, template_id, **kwargs)¶

Delete SDDC template identified by given id. # noqa: E501

Delete SDDC template identified by given id. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddc_templates_template_id_delete_with_http_info(org, template_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
template_id (str) – SDDC Template identifier (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(Task, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_sddc_templates_template_id_get(org, template_id, **kwargs)¶

Get configuration template by given template id. # noqa: E501

Get configuration template by given template id. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddc_templates_template_id_get(org, template_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
template_id (str) – SDDC Template identifier (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

SddcTemplate If the method is called asynchronously, returns the request thread.

orgs_org_sddc_templates_template_id_get_with_http_info(org, template_id, **kwargs)¶

Get configuration template by given template id. # noqa: E501

Get configuration template by given template id. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddc_templates_template_id_get_with_http_info(org, template_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
template_id (str) – SDDC Template identifier (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(SddcTemplate, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_sddc_template_get(org, sddc, **kwargs)¶

Get configuration template for an SDDC # noqa: E501

Get configuration template for an SDDC # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_sddc_template_get(org, sddc, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
sddc (str) – Sddc identifier (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

SddcTemplate If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_sddc_template_get_with_http_info(org, sddc, **kwargs)¶

Get configuration template for an SDDC # noqa: E501

Get configuration template for an SDDC # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_sddc_template_get_with_http_info(org, sddc, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
sddc (str) – Sddc identifier (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(SddcTemplate, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

vmware.vmc.console.api.storage_api module¶

VMware Cloud APIs

All VMware Cloud APIs require a valid authentication token; which can be obtained by issuing a POST: ` curl -s -X POST \ -H "Content-Type: application/json" \ https://console.cloud.vmware.com/csp/gateway/am/api/auth/api-tokens/authorize?refresh_token={refresh-token} ` * This CSP API is defined at: https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST * The refresh_token used to get a valid authentication token can be obtained after successful login to following URL via a web browser: https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens. * Most VMware Cloud APIs require an org identifier. This can be obtained by issuing a GET on /vmc/api/orgs and extracting the id field # noqa: E501

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.api.storage_api.StorageApi(api_client=None)¶

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

orgs_org_storage_cluster_constraints_get(org, provider, num_hosts, **kwargs)¶

Get constraints on cluster storage size for EBS-backed clusters. # noqa: E501

Get constraints on cluster storage size for EBS-backed clusters. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_storage_cluster_constraints_get(org, provider, num_hosts, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
provider (str) – Cloud storage provider ID (example AWS) (required)
num_hosts (int) – Number of hosts in cluster (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

VsanConfigConstraints If the method is called asynchronously, returns the request thread.

orgs_org_storage_cluster_constraints_get_with_http_info(org, provider, num_hosts, **kwargs)¶

Get constraints on cluster storage size for EBS-backed clusters. # noqa: E501

Get constraints on cluster storage size for EBS-backed clusters. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_storage_cluster_constraints_get_with_http_info(org, provider, num_hosts, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
provider (str) – Cloud storage provider ID (example AWS) (required)
num_hosts (int) – Number of hosts in cluster (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(VsanConfigConstraints, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

vmware.vmc.console.api.subscription_api module¶

VMware Cloud APIs

All VMware Cloud APIs require a valid authentication token; which can be obtained by issuing a POST: ` curl -s -X POST \ -H "Content-Type: application/json" \ https://console.cloud.vmware.com/csp/gateway/am/api/auth/api-tokens/authorize?refresh_token={refresh-token} ` * This CSP API is defined at: https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST * The refresh_token used to get a valid authentication token can be obtained after successful login to following URL via a web browser: https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens. * Most VMware Cloud APIs require an org identifier. This can be obtained by issuing a GET on /vmc/api/orgs and extracting the id field # noqa: E501

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.api.subscription_api.SubscriptionApi(api_client=None)¶

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

orgs_org_subscriptions_get(org, **kwargs)¶

Get all subscriptions # noqa: E501

Returns all subscriptions for a given org id # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_subscriptions_get(org, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
offer_type (str) – Offer Type * ON_DEMAND - on-demand subscription * TERM - term subscription * All subscriptions if not specified
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

list[SubscriptionDetails] If the method is called asynchronously, returns the request thread.

orgs_org_subscriptions_get_with_http_info(org, **kwargs)¶

Get all subscriptions # noqa: E501

Returns all subscriptions for a given org id # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_subscriptions_get_with_http_info(org, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
offer_type (str) – Offer Type * ON_DEMAND - on-demand subscription * TERM - term subscription * All subscriptions if not specified
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(list[SubscriptionDetails], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_subscriptions_offer_instances_get(org, region, product_type, **kwargs)¶

List all offers available for the specific product type in the specific region # noqa: E501

List all offers available for the specific product type in the specific region # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_subscriptions_offer_instances_get(org, region, product_type, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
region (str) – Region for the offer (required)
product_type (str) – Type of the product in offers. This has been deprecated. Please use product & type parameters (required)
product (str) – The product that you are trying to purchase, eg. host. This needs to be accompanied by the type parameter
type (str) – The type/flavor of the product you are trying it purchase,eg. an r5.metal host. This needs to be accompanied by the product parameter.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

OfferInstancesHolder If the method is called asynchronously, returns the request thread.

orgs_org_subscriptions_offer_instances_get_with_http_info(org, region, product_type, **kwargs)¶

List all offers available for the specific product type in the specific region # noqa: E501

List all offers available for the specific product type in the specific region # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_subscriptions_offer_instances_get_with_http_info(org, region, product_type, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
region (str) – Region for the offer (required)
product_type (str) – Type of the product in offers. This has been deprecated. Please use product & type parameters (required)
product (str) – The product that you are trying to purchase, eg. host. This needs to be accompanied by the type parameter
type (str) – The type/flavor of the product you are trying it purchase,eg. an r5.metal host. This needs to be accompanied by the product parameter.
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(OfferInstancesHolder, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_subscriptions_post(org, subscription_request, **kwargs)¶

Create a subscription # noqa: E501

Initiates the creation of a subscription # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_subscriptions_post(org, subscription_request, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
subscription_request (SubscriptionRequest) – subscriptionRequest (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

Task If the method is called asynchronously, returns the request thread.

orgs_org_subscriptions_post_with_http_info(org, subscription_request, **kwargs)¶

Create a subscription # noqa: E501

Initiates the creation of a subscription # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_subscriptions_post_with_http_info(org, subscription_request, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
subscription_request (SubscriptionRequest) – subscriptionRequest (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(Task, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_subscriptions_products_get(org, **kwargs)¶

List of all the products that are available for purchase. # noqa: E501

List of all the products that are available for purchase. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_subscriptions_products_get(org, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

list[SubscriptionProducts] If the method is called asynchronously, returns the request thread.

orgs_org_subscriptions_products_get_with_http_info(org, **kwargs)¶

List of all the products that are available for purchase. # noqa: E501

List of all the products that are available for purchase. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_subscriptions_products_get_with_http_info(org, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(list[SubscriptionProducts], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_subscriptions_subscription_get(org, subscription, **kwargs)¶

Get a subscription # noqa: E501

Get subscription details for a given subscription id # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_subscriptions_subscription_get(org, subscription, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
subscription (str) – SubscriptionId for an sddc. (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

SubscriptionDetails If the method is called asynchronously, returns the request thread.

orgs_org_subscriptions_subscription_get_with_http_info(org, subscription, **kwargs)¶

Get a subscription # noqa: E501

Get subscription details for a given subscription id # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_subscriptions_subscription_get_with_http_info(org, subscription, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
subscription (str) – SubscriptionId for an sddc. (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(SubscriptionDetails, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

vmware.vmc.console.api.task_api module¶

VMware Cloud APIs

All VMware Cloud APIs require a valid authentication token; which can be obtained by issuing a POST: ` curl -s -X POST \ -H "Content-Type: application/json" \ https://console.cloud.vmware.com/csp/gateway/am/api/auth/api-tokens/authorize?refresh_token={refresh-token} ` * This CSP API is defined at: https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST * The refresh_token used to get a valid authentication token can be obtained after successful login to following URL via a web browser: https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens. * Most VMware Cloud APIs require an org identifier. This can be obtained by issuing a GET on /vmc/api/orgs and extracting the id field # noqa: E501

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.api.task_api.TaskApi(api_client=None)¶

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

orgs_org_tasks_get(org, **kwargs)¶

List all tasks for organization # noqa: E501

List all tasks with optional filtering. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_tasks_get(org, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
filter (str) – Filter expression Binary Operators: ‘eq’, ‘ne’, ‘lt’, ‘gt’, ‘le’, ‘ge’, ‘mul’, ‘div’, ‘mod’, ‘sub’, ‘add’ Unary Operators: ‘not’, ‘-‘ (minus) String Operators: ‘startswith’, ‘endswith’, ‘length’, ‘contains’, ‘tolower’, ‘toupper’, Nested attributes are composed using ‘.’ Dates must be formatted as yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss[.SSS]Z Strings should enclosed in single quotes, escape single quote with two single quotes The special literal ‘created’ will be mapped to the time the resource was first created. Examples: - $filter=(updated gt 2016-08-09T13:00:00Z) and (org_id eq 278710ff4e-6b6d-4d4e-aefb-ca637f38609e) - $filter=(created eq 2016-08-09) - $filter=(created gt 2016-08-09) and (sddc.status eq ‘READY’)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

list[Task] If the method is called asynchronously, returns the request thread.

orgs_org_tasks_get_with_http_info(org, **kwargs)¶

List all tasks for organization # noqa: E501

List all tasks with optional filtering. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_tasks_get_with_http_info(org, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
filter (str) – Filter expression Binary Operators: ‘eq’, ‘ne’, ‘lt’, ‘gt’, ‘le’, ‘ge’, ‘mul’, ‘div’, ‘mod’, ‘sub’, ‘add’ Unary Operators: ‘not’, ‘-‘ (minus) String Operators: ‘startswith’, ‘endswith’, ‘length’, ‘contains’, ‘tolower’, ‘toupper’, Nested attributes are composed using ‘.’ Dates must be formatted as yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss[.SSS]Z Strings should enclosed in single quotes, escape single quote with two single quotes The special literal ‘created’ will be mapped to the time the resource was first created. Examples: - $filter=(updated gt 2016-08-09T13:00:00Z) and (org_id eq 278710ff4e-6b6d-4d4e-aefb-ca637f38609e) - $filter=(created eq 2016-08-09) - $filter=(created gt 2016-08-09) and (sddc.status eq ‘READY’)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(list[Task], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_tasks_task_get(org, task, **kwargs)¶

Get task details # noqa: E501

Retrieve details of a task. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_tasks_task_get(org, task, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
task (str) – Task identifier (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

Task If the method is called asynchronously, returns the request thread.

orgs_org_tasks_task_get_with_http_info(org, task, **kwargs)¶

Get task details # noqa: E501

Retrieve details of a task. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_tasks_task_get_with_http_info(org, task, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
task (str) – Task identifier (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(Task, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_tasks_task_post(org, task, **kwargs)¶

Modify an existing task # noqa: E501

Request that a running task be canceled. This is advisory only, some tasks may not be cancelable, and some tasks might take an arbitrary amount of time to respond to a cancelation request. The task must be monitored to determine subsequent status. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_tasks_task_post(org, task, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
task (str) – Task identifier (required)
action (str) – If = ‘cancel’, task will be canceled
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

Task If the method is called asynchronously, returns the request thread.

orgs_org_tasks_task_post_with_http_info(org, task, **kwargs)¶

Modify an existing task # noqa: E501

Request that a running task be canceled. This is advisory only, some tasks may not be cancelable, and some tasks might take an arbitrary amount of time to respond to a cancelation request. The task must be monitored to determine subsequent status. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_tasks_task_post_with_http_info(org, task, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
task (str) – Task identifier (required)
action (str) – If = ‘cancel’, task will be canceled
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(Task, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

vmware.vmc.console.api.tbrs_api module¶

VMware Cloud APIs

All VMware Cloud APIs require a valid authentication token; which can be obtained by issuing a POST: ` curl -s -X POST \ -H "Content-Type: application/json" \ https://console.cloud.vmware.com/csp/gateway/am/api/auth/api-tokens/authorize?refresh_token={refresh-token} ` * This CSP API is defined at: https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST * The refresh_token used to get a valid authentication token can be obtained after successful login to following URL via a web browser: https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens. * Most VMware Cloud APIs require an org identifier. This can be obtained by issuing a GET on /vmc/api/orgs and extracting the id field # noqa: E501

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.api.tbrs_api.TbrsApi(api_client=None)¶

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

orgs_org_tbrs_reservation_post(org, **kwargs)¶

orgs_org_tbrs_reservation_post # noqa: E501

Retreive all reservations for all SDDCs in this org # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_tbrs_reservation_post(org, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
sddc_state (SddcStateRequest) – SDDCs and/or states to query
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

dict(str, list[ReservationWindow]) If the method is called asynchronously, returns the request thread.

orgs_org_tbrs_reservation_post_with_http_info(org, **kwargs)¶

orgs_org_tbrs_reservation_post # noqa: E501

Retreive all reservations for all SDDCs in this org # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_tbrs_reservation_post_with_http_info(org, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
sddc_state (SddcStateRequest) – SDDCs and/or states to query
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(dict(str, list[ReservationWindow]), status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_tbrs_support_window_get(org, **kwargs)¶

orgs_org_tbrs_support_window_get # noqa: E501

Get all available support windows # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_tbrs_support_window_get(org, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
minimum_seats_available (int) – minimum seats available (used as a filter)
created_by (str) – user name which was used to create the support window (used as a filter)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

list[SupportWindow] If the method is called asynchronously, returns the request thread.

orgs_org_tbrs_support_window_get_with_http_info(org, **kwargs)¶

orgs_org_tbrs_support_window_get # noqa: E501

Get all available support windows # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_tbrs_support_window_get_with_http_info(org, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
minimum_seats_available (int) – minimum seats available (used as a filter)
created_by (str) – user name which was used to create the support window (used as a filter)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(list[SupportWindow], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_tbrs_support_window_id_put(org, id, sddc_id, **kwargs)¶

orgs_org_tbrs_support_window_id_put # noqa: E501

Move Sddc to new support window # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_tbrs_support_window_id_put(org, id, sddc_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
id (str) – Target Support Window ID (required)
sddc_id (SddcId) – SDDC to move (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

SupportWindowId If the method is called asynchronously, returns the request thread.

orgs_org_tbrs_support_window_id_put_with_http_info(org, id, sddc_id, **kwargs)¶

orgs_org_tbrs_support_window_id_put # noqa: E501

Move Sddc to new support window # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_tbrs_support_window_id_put_with_http_info(org, id, sddc_id, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
id (str) – Target Support Window ID (required)
sddc_id (SddcId) – SDDC to move (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(SupportWindowId, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

vmware.vmc.console.api.troubleshooting_api module¶

VMware Cloud APIs

All VMware Cloud APIs require a valid authentication token; which can be obtained by issuing a POST: ` curl -s -X POST \ -H "Content-Type: application/json" \ https://console.cloud.vmware.com/csp/gateway/am/api/auth/api-tokens/authorize?refresh_token={refresh-token} ` * This CSP API is defined at: https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST * The refresh_token used to get a valid authentication token can be obtained after successful login to following URL via a web browser: https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens. * Most VMware Cloud APIs require an org identifier. This can be obtained by issuing a GET on /vmc/api/orgs and extracting the id field # noqa: E501

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.api.troubleshooting_api.TroubleshootingApi(api_client=None)¶

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

orgs_org_sddcs_sddc_networking_connectivity_tests_get(org, sddc, **kwargs)¶

Retrieve metadata for connectivity tests. # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networking_connectivity_tests_get(org, sddc, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
sddc (str) – Sddc identifier (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ConnectivityValidationGroups If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networking_connectivity_tests_get_with_http_info(org, sddc, **kwargs)¶

Retrieve metadata for connectivity tests. # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networking_connectivity_tests_get_with_http_info(org, sddc, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
sddc (str) – Sddc identifier (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(ConnectivityValidationGroups, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networking_connectivity_tests_post(org, sddc, action, request_info, **kwargs)¶

ConnectivityValidationGroupResultWrapper will be available at task.params[‘test_result’]. # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networking_connectivity_tests_post(org, sddc, action, request_info, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
sddc (str) – Sddc identifier (required)
action (str) – If = ‘start’, start connectivity tests. (required)
request_info (ConnectivityValidationGroup) – request information (required)
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

Task If the method is called asynchronously, returns the request thread.

orgs_org_sddcs_sddc_networking_connectivity_tests_post_with_http_info(org, sddc, action, request_info, **kwargs)¶

ConnectivityValidationGroupResultWrapper will be available at task.params[‘test_result’]. # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.orgs_org_sddcs_sddc_networking_connectivity_tests_post_with_http_info(org, sddc, action, request_info, async_req=True) >>> result = thread.get()

Parameters

bool (async_req) – execute request asynchronously
org (str) – Organization identifier (required)
sddc (str) – Sddc identifier (required)
action (str) – If = ‘start’, start connectivity tests. (required)
request_info (ConnectivityValidationGroup) – request information (required)
_return_http_data_only – response data without head status code and headers
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(Task, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

vmware.vmc.console.api package¶

Submodules¶

vmware.vmc.console.api.account_linking_api module¶

vmware.vmc.console.api.addons_api module¶

vmware.vmc.console.api.clusters_api module¶

vmware.vmc.console.api.config_storage_api module¶

vmware.vmc.console.api.credentials_api module¶

vmware.vmc.console.api.dns_api module¶

vmware.vmc.console.api.edges_api module¶

vmware.vmc.console.api.esx_api module¶

vmware.vmc.console.api.hcx_api module¶

vmware.vmc.console.api.locale_api module¶

vmware.vmc.console.api.msft_licensing_api module¶

vmware.vmc.console.api.network_api module¶

vmware.vmc.console.api.orgs_api module¶

vmware.vmc.console.api.publicip_api module¶

vmware.vmc.console.api.reservations_api module¶

vmware.vmc.console.api.sddc_api module¶

vmware.vmc.console.api.sddc_networks_api module¶

vmware.vmc.console.api.sddc_template_api module¶

vmware.vmc.console.api.storage_api module¶

vmware.vmc.console.api.subscription_api module¶

vmware.vmc.console.api.task_api module¶

vmware.vmc.console.api.tbrs_api module¶

vmware.vmc.console.api.troubleshooting_api module¶

Module contents¶