com.vmware.nsx_policy.infra.tier_0s package

Submodules

com.vmware.nsx_policy.infra.tier_0s.dns_forwarder_client module

class com.vmware.nsx_policy.infra.tier_0s.dns_forwarder_client.Statistics(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

get(tier0_id, enforcement_point_path=None)

Get statistics of tier-0 DNS forwarder. - no enforcement point path specified: Statistics will be evaluated on each enforcement point. - {enforcement_point_path}: Statistics are evaluated only on the given enforcement point.

Parameters

  • tier0_id (str) – Tier-0 id (required)

  • enforcement_point_path (str or None) – String Path of the enforcement point (optional)

Return type

com.vmware.nsx_policy.model_client.AggregateDNSForwarderStatistics

Returns

com.vmware.nsx_policy.model.AggregateDNSForwarderStatistics

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

class com.vmware.nsx_policy.infra.tier_0s.dns_forwarder_client.Status(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

get(tier0_id, enforcement_point_path=None)

Get current status of tier-0 DNS forwarder. - no enforcement point path specified: Status will be evaluated on each enforcement point. - {enforcement_point_path}: Status will be evaluated only on the given enforcement point.

Parameters

  • tier0_id (str) – Tier-0 id (required)

  • enforcement_point_path (str or None) – String Path of the enforcement point (optional)

Return type

com.vmware.nsx_policy.model_client.AggregateDNSForwarderStatus

Returns

com.vmware.nsx_policy.model.AggregateDNSForwarderStatus

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

class com.vmware.nsx_policy.infra.tier_0s.dns_forwarder_client.StubFactory(stub_config)

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

Parameters

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

com.vmware.nsx_policy.infra.tier_0s.locale_services_client module

class com.vmware.nsx_policy.infra.tier_0s.locale_services_client.Bgp(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

get(tier0_id, locale_service_id)

Read BGP routing config

Parameters

  • tier0_id (str) – (required)

  • locale_service_id (str) – (required)

Return type

com.vmware.nsx_policy.model_client.BgpRoutingConfig

Returns

com.vmware.nsx_policy.model.BgpRoutingConfig

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

class com.vmware.nsx_policy.infra.tier_0s.locale_services_client.ByodServiceInstances(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

delete(tier0_id, locale_service_id, service_instance_id)

Delete BYOD policy service instance

Parameters

  • tier0_id (str) – Tier-0 id (required)

  • locale_service_id (str) – Locale service id (required)

  • service_instance_id (str) – Service instance id (required)

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

get(tier0_id, locale_service_id, service_instance_id)

Read byod service instance

Parameters

  • tier0_id (str) – Tier-0 id (required)

  • locale_service_id (str) – Locale service id (required)

  • service_instance_id (str) – Service instance id (required)

Return type

com.vmware.nsx_policy.model_client.ByodPolicyServiceInstance

Returns

com.vmware.nsx_policy.model.ByodPolicyServiceInstance

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

list(tier0_id, locale_service_id, cursor=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)

Read all BYOD service instance objects under a tier-0

Parameters

  • tier0_id (str) – Tier-0 id (required)

  • locale_service_id (str) – Locale service id (required)

  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

  • include_mark_for_delete_objects (bool or None) – Include objects that are marked for deletion in results (optional, default to false)

  • included_fields (str or None) – Comma separated list of fields that should be included in query result (optional)

  • page_size (long or None) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

  • sort_ascending (bool or None) – (optional)

  • sort_by (str or None) – Field by which records are sorted (optional)

Return type

com.vmware.nsx_policy.model_client.ByodPolicyServiceInstanceListResult

Returns

com.vmware.nsx_policy.model.ByodPolicyServiceInstanceListResult

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

patch(tier0_id, locale_service_id, service_instance_id, byod_policy_service_instance)

Create BYOD Service Instance which represent instance of service definition created on manager.

Parameters
Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

update(tier0_id, locale_service_id, service_instance_id, byod_policy_service_instance)

Create BYOD Service Instance which represent instance of service definition created on manager.

Parameters
Return type

com.vmware.nsx_policy.model_client.ByodPolicyServiceInstance

Returns

com.vmware.nsx_policy.model.ByodPolicyServiceInstance

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

class com.vmware.nsx_policy.infra.tier_0s.locale_services_client.IpsecVpnServices(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

delete(tier0_id, locale_service_id, service_id)

Delete IPSec VPN service for given locale service under Tier-0.

Parameters

  • tier0_id (str) – (required)

  • locale_service_id (str) – (required)

  • service_id (str) – (required)

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

get(tier0_id, locale_service_id, service_id)

Get IPSec VPN service for given locale service under Tier-0.

Parameters

  • tier0_id (str) – (required)

  • locale_service_id (str) – (required)

  • service_id (str) – (required)

Return type

com.vmware.nsx_policy.model_client.IPSecVpnService

Returns

com.vmware.nsx_policy.model.IPSecVpnService

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

list(tier0_id, locale_service_id, cursor=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)

Get paginated list of all IPSec VPN services for given locale service under Tier-0.

Parameters

  • tier0_id (str) – (required)

  • locale_service_id (str) – (required)

  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

  • include_mark_for_delete_objects (bool or None) – Include objects that are marked for deletion in results (optional, default to false)

  • included_fields (str or None) – Comma separated list of fields that should be included in query result (optional)

  • page_size (long or None) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

  • sort_ascending (bool or None) – (optional)

  • sort_by (str or None) – Field by which records are sorted (optional)

Return type

com.vmware.nsx_policy.model_client.IPSecVpnServiceListResult

Returns

com.vmware.nsx_policy.model.IPSecVpnServiceListResult

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

patch(tier0_id, locale_service_id, service_id, ip_sec_vpn_service)

Create or patch IPSec VPN service for given locale service under Tier-0.

Parameters
Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

update(tier0_id, locale_service_id, service_id, ip_sec_vpn_service)

Create or fully replace IPSec VPN service for given locale service under Tier-0. Revision is optional for creation and required for update.

Parameters
Return type

com.vmware.nsx_policy.model_client.IPSecVpnService

Returns

com.vmware.nsx_policy.model.IPSecVpnService

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

class com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L2vpnContext(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

get(tier0_id, locale_service_id)
Parameters

  • tier0_id (str) – (required)

  • locale_service_id (str) – (required)

Return type

com.vmware.nsx_policy.model_client.L2VpnContext

Returns

com.vmware.nsx_policy.model.L2VpnContext

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

class com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L2vpnServices(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

delete(tier0_id, locale_service_id, service_id)

Delete L2VPN service for given locale service.

Parameters

  • tier0_id (str) – (required)

  • locale_service_id (str) – (required)

  • service_id (str) – (required)

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

get(tier0_id, locale_service_id, service_id)

Get L2VPN service for given locale service.

Parameters

  • tier0_id (str) – (required)

  • locale_service_id (str) – (required)

  • service_id (str) – (required)

Return type

com.vmware.nsx_policy.model_client.L2VPNService

Returns

com.vmware.nsx_policy.model.L2VPNService

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

list(tier0_id, locale_service_id, cursor=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)

Get paginated list of all L2VPN services.

Parameters

  • tier0_id (str) – (required)

  • locale_service_id (str) – (required)

  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

  • include_mark_for_delete_objects (bool or None) – Include objects that are marked for deletion in results (optional, default to false)

  • included_fields (str or None) – Comma separated list of fields that should be included in query result (optional)

  • page_size (long or None) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

  • sort_ascending (bool or None) – (optional)

  • sort_by (str or None) – Field by which records are sorted (optional)

Return type

com.vmware.nsx_policy.model_client.L2VPNServiceListResult

Returns

com.vmware.nsx_policy.model.L2VPNServiceListResult

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

patch(tier0_id, locale_service_id, service_id, l2_vpn_service)

Create or patch L2VPN service for given locale service.

Parameters
Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

update(tier0_id, locale_service_id, service_id, l2_vpn_service)

Create or fully replace L2VPN service for given locale service. Revision is optional for creation and required for update.

Parameters
Return type

com.vmware.nsx_policy.model_client.L2VPNService

Returns

com.vmware.nsx_policy.model.L2VPNService

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

class com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L3vpnContext(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

get(tier0_id, locale_service_id)
Parameters

  • tier0_id (str) – (required)

  • locale_service_id (str) – (required)

Return type

com.vmware.nsx_policy.model_client.L3VpnContext

Returns

com.vmware.nsx_policy.model.L3VpnContext

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

class com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L3vpns(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

LIST_L3VPN_SESSION_POLICYBASEDL3VPNSESSION = 'PolicyBasedL3VpnSession'

Possible value for l3vpnSession of method L3vpns.list().

LIST_L3VPN_SESSION_ROUTEBASEDL3VPNSESSION = 'RouteBasedL3VpnSession'

Possible value for l3vpnSession of method L3vpns.list().

delete(tier0_id, locale_service_id, l3vpn_id)
Parameters

  • tier0_id (str) – (required)

  • locale_service_id (str) – (required)

  • l3vpn_id (str) – (required)

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

get(tier0_id, locale_service_id, l3vpn_id)
Parameters

  • tier0_id (str) – (required)

  • locale_service_id (str) – (required)

  • l3vpn_id (str) – (required)

Return type

com.vmware.nsx_policy.model_client.L3Vpn

Returns

com.vmware.nsx_policy.model.L3Vpn

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

list(tier0_id, locale_service_id, cursor=None, include_mark_for_delete_objects=None, included_fields=None, l3vpn_session=None, page_size=None, sort_ascending=None, sort_by=None)
Parameters

  • tier0_id (str) – (required)

  • locale_service_id (str) – (required)

  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

  • include_mark_for_delete_objects (bool or None) – Include objects that are marked for deletion in results (optional, default to false)

  • included_fields (str or None) – Comma separated list of fields that should be included in query result (optional)

  • l3vpn_session (str or None) – Resource type of L3Vpn Session (optional)

  • page_size (long or None) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

  • sort_ascending (bool or None) – (optional)

  • sort_by (str or None) – Field by which records are sorted (optional)

Return type

com.vmware.nsx_policy.model_client.L3VpnListResult

Returns

com.vmware.nsx_policy.model.L3VpnListResult

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

patch(tier0_id, locale_service_id, l3vpn_id, l3_vpn)
Parameters
Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

showsensitivedata(tier0_id, locale_service_id, l3vpn_id)
Parameters

  • tier0_id (str) – (required)

  • locale_service_id (str) – (required)

  • l3vpn_id (str) – (required)

Return type

com.vmware.nsx_policy.model_client.L3Vpn

Returns

com.vmware.nsx_policy.model.L3Vpn

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

update(tier0_id, locale_service_id, l3vpn_id, l3_vpn)
Parameters
Return type

com.vmware.nsx_policy.model_client.L3Vpn

Returns

com.vmware.nsx_policy.model.L3Vpn

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

class com.vmware.nsx_policy.infra.tier_0s.locale_services_client.ServiceInstances(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

delete(tier0_id, locale_service_id, service_instance_id)

Delete policy service instance

Parameters

  • tier0_id (str) – Tier-0 id (required)

  • locale_service_id (str) – Locale service id (required)

  • service_instance_id (str) – Service instance id (required)

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

get(tier0_id, locale_service_id, service_instance_id)

Read service instance

Parameters

  • tier0_id (str) – Tier-0 id (required)

  • locale_service_id (str) – Locale service id (required)

  • service_instance_id (str) – Service instance id (required)

Return type

com.vmware.nsx_policy.model_client.PolicyServiceInstance

Returns

com.vmware.nsx_policy.model.PolicyServiceInstance

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

list(tier0_id, locale_service_id, cursor=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)

Read all service instance objects under a tier-0

Parameters

  • tier0_id (str) – Tier-0 id (required)

  • locale_service_id (str) – Locale service id (required)

  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

  • include_mark_for_delete_objects (bool or None) – Include objects that are marked for deletion in results (optional, default to false)

  • included_fields (str or None) – Comma separated list of fields that should be included in query result (optional)

  • page_size (long or None) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

  • sort_ascending (bool or None) – (optional)

  • sort_by (str or None) – Field by which records are sorted (optional)

Return type

com.vmware.nsx_policy.model_client.PolicyServiceInstanceListResult

Returns

com.vmware.nsx_policy.model.PolicyServiceInstanceListResult

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

patch(tier0_id, locale_service_id, service_instance_id, policy_service_instance)

Create Service Instance. Please note that, only display_name, description and deployment_spec_name are allowed to be modified in an exisiting entity. If the deployment spec name is changed, it will trigger the upgrade operation for the SVMs.

Parameters
Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

reauth(tier0_id, locale_service_id, service_instance_id)
Parameters

  • tier0_id (str) – Tier-0 id (required)

  • locale_service_id (str) – Locale service id (required)

  • service_instance_id (str) – Service instance id (required)

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

update(tier0_id, locale_service_id, service_instance_id, policy_service_instance)

Create service instance. Please note that, only display_name, description and deployment_spec_name are allowed to be modified in an exisiting entity. If the deployment spec name is changed, it will trigger the upgrade operation for the SVMs.

Parameters
Return type

com.vmware.nsx_policy.model_client.PolicyServiceInstance

Returns

com.vmware.nsx_policy.model.PolicyServiceInstance

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

class com.vmware.nsx_policy.infra.tier_0s.locale_services_client.StubFactory(stub_config)

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

Parameters

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance