com.vmware.nsx.serviceinsertion package

Submodules

com.vmware.nsx.serviceinsertion.sections_client module

class com.vmware.nsx.serviceinsertion.sections_client.Rules(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

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

CREATEMULTIPLE_OPERATION_AFTER = 'insert_after'

Possible value for operation of method Rules.createmultiple().

CREATEMULTIPLE_OPERATION_BEFORE = 'insert_before'

Possible value for operation of method Rules.createmultiple().

CREATEMULTIPLE_OPERATION_BOTTOM = 'insert_bottom'

Possible value for operation of method Rules.createmultiple().

CREATEMULTIPLE_OPERATION_TOP = 'insert_top'

Possible value for operation of method Rules.createmultiple().

CREATE_OPERATION_AFTER = 'insert_after'

Possible value for operation of method Rules.create().

CREATE_OPERATION_BEFORE = 'insert_before'

Possible value for operation of method Rules.create().

CREATE_OPERATION_BOTTOM = 'insert_bottom'

Possible value for operation of method Rules.create().

CREATE_OPERATION_TOP = 'insert_top'

Possible value for operation of method Rules.create().

LIST_FILTER_TYPE_FILTER = 'FILTER'

Possible value for filterType of method Rules.list().

Possible value for filterType of method Rules.list().

REVISE_OPERATION_AFTER = 'insert_after'

Possible value for operation of method Rules.revise().

REVISE_OPERATION_BEFORE = 'insert_before'

Possible value for operation of method Rules.revise().

REVISE_OPERATION_BOTTOM = 'insert_bottom'

Possible value for operation of method Rules.revise().

REVISE_OPERATION_TOP = 'insert_top'

Possible value for operation of method Rules.revise().

create(section_id, service_insertion_rule, id=None, operation=None)

Adds a new serviceinsertion rule in existing serviceinsertion section.

Parameters

  • section_id (str) – (required)

  • service_insertion_rule (com.vmware.nsx.model_client.ServiceInsertionRule) – (required)

  • id (str or None) – Identifier of the anchor rule or section. This is a required field in case operation like ‘insert_before’ and ‘insert_after’. (optional)

  • operation (str or None) – Operation (optional, default to insert_top)

Return type

com.vmware.nsx.model_client.ServiceInsertionRule

Returns

com.vmware.nsx.model.ServiceInsertionRule

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

createmultiple(section_id, service_insertion_rule_list, id=None, operation=None)

Create multiple serviceinsertion rules in existing serviceinsertion section bounded by limit of 1000 serviceinsertion rules per section.

Parameters

  • section_id (str) – (required)

  • service_insertion_rule_list (com.vmware.nsx.model_client.ServiceInsertionRuleList) – (required)

  • id (str or None) – Identifier of the anchor rule or section. This is a required field in case operation like ‘insert_before’ and ‘insert_after’. (optional)

  • operation (str or None) – Operation (optional, default to insert_top)

Return type

com.vmware.nsx.model_client.ServiceInsertionRuleList

Returns

com.vmware.nsx.model.ServiceInsertionRuleList

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

delete(section_id, rule_id)

Delete existing serviceinsertion rule in a serviceinsertion section.

Parameters

  • section_id (str) – (required)

  • rule_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(section_id, rule_id)

Return existing serviceinsertion rule information in a serviceinsertion section.

Parameters

  • section_id (str) – (required)

  • rule_id (str) – (required)

Return type

com.vmware.nsx.model_client.ServiceInsertionRule

Returns

com.vmware.nsx.model.ServiceInsertionRule

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(section_id, applied_tos=None, cursor=None, destinations=None, filter_type=None, included_fields=None, page_size=None, services=None, sort_ascending=None, sort_by=None, sources=None)

Return all serviceinsertion rule(s) information for a given serviceinsertion section.

Parameters

  • section_id (str) – (required)

  • applied_tos (str or None) – AppliedTo’s referenced by this section or section’s Distributed Service Rules . (optional)

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

  • destinations (str or None) – Destinations referenced by this section’s Distributed Service Rules . (optional)

  • filter_type (str or None) – Filter type (optional, default to FILTER)

  • 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)

  • services (str or None) – NSService referenced by this section’s Distributed Service Rules . (optional)

  • sort_ascending (bool or None) – (optional)

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

  • sources (str or None) – Sources referenced by this section’s Distributed Service Rules . (optional)

Return type

com.vmware.nsx.model_client.ServiceInsertionRuleListResult

Returns

com.vmware.nsx.model.ServiceInsertionRuleListResult

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

revise(section_id, rule_id, service_insertion_rule, id=None, operation=None)

Modifies existing serviceinsertion rule along with relative position among other serviceinsertion rules inside a serviceinsertion section.

Parameters

  • section_id (str) – (required)

  • rule_id (str) – (required)

  • service_insertion_rule (com.vmware.nsx.model_client.ServiceInsertionRule) – (required)

  • id (str or None) – Identifier of the anchor rule or section. This is a required field in case operation like ‘insert_before’ and ‘insert_after’. (optional)

  • operation (str or None) – Operation (optional, default to insert_top)

Return type

com.vmware.nsx.model_client.ServiceInsertionRule

Returns

com.vmware.nsx.model.ServiceInsertionRule

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(section_id, rule_id, service_insertion_rule)

Modifies existing serviceinsertion rule in a serviceinsertion section.

Parameters
Return type

com.vmware.nsx.model_client.ServiceInsertionRule

Returns

com.vmware.nsx.model.ServiceInsertionRule

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.serviceinsertion.sections_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.serviceinsertion.service_chains_client module

class com.vmware.nsx.serviceinsertion.service_chains_client.ServicePaths(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

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

list(service_chain_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)

List all service paths for the given service chain for the given service chain id

Parameters

  • service_chain_id (str) – (required)

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

  • 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.model_client.ServicePathListResult

Returns

com.vmware.nsx.model.ServicePathListResult

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.serviceinsertion.service_chains_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.serviceinsertion.services_client module

class com.vmware.nsx.serviceinsertion.services_client.ServiceDeployments(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

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

create(service_id, service_deployment)

This will deploy a particular service on a given cluster / host. Internally multiple service instance can be created during the deployment. If there are no issues in the parameters, the call returns immediately, and the service VMs will be deployed asynchronously. To get the overall status of the deployment or to get the status of individual service vm, please use the deployment status APIs.

Parameters
Return type

com.vmware.nsx.model_client.ServiceDeployment

Returns

com.vmware.nsx.model.ServiceDeployment

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

delete(service_id, service_deployment_id, force=None)

Remove the service deployment. Will remove all the Service VMs that were created as part of this deployment. User can send optional force delete option which will force remove the deployment, but should be used only when the regular delete is not working. Regular delete will ensure proper cleanup of Service VMs and related objects. Directly calling this API without trying regular undeploy will result in unexpected results, and orphan objects.

Parameters

  • service_id (str) – (required)

  • service_deployment_id (str) – (required)

  • force (bool or None) – Force delete the resource even if it is being used somewhere (optional, default to false)

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(service_id, service_deployment_id)

Returns detail of service deployment.

Parameters

  • service_id (str) – (required)

  • service_deployment_id (str) – (required)

Return type

com.vmware.nsx.model_client.ServiceDeployment

Returns

com.vmware.nsx.model.ServiceDeployment

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(service_id)

Returns the list of deployments for the given service

Parameters

service_id (str) – (required)

Return type

com.vmware.nsx.model_client.ServiceDeploymentListResult

Returns

com.vmware.nsx.model.ServiceDeploymentListResult

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(service_id, service_deployment_id, service_deployment)

Modifies an existing Service Deployment. This will not update the already deployed service instances, deployed via this deployment.

Parameters
Return type

com.vmware.nsx.model_client.ServiceDeployment

Returns

com.vmware.nsx.model.ServiceDeployment

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

upgrade(service_id, service_deployment_id)

Upgrade API is currently disabled. Please refer to vendor documentation on how to upgrade individual appliances. Upgrade all VMs part of this service deployment using newer version of OVF. New OVF version isn’t expected in this call because it is published by the partner by updating the service definition. This API simply upgrades to the latest version published by the partner.

Parameters

  • service_id (str) – (required)

  • service_deployment_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

class com.vmware.nsx.serviceinsertion.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.

create(service_id, base_service_instance)

Adds a new Service-Instance under the specified Service.

Parameters
Return type

vmware.vapi.struct.VapiStruct

Returns

com.vmware.nsx.model.BaseServiceInstance The return value will contain all the attributes defined in com.vmware.nsx.model_client.BaseServiceInstance.

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

delete(service_id, service_instance_id)

Delete existing Service-Instance for a given Service-Insertion Service.

Parameters

  • service_id (str) – (required)

  • service_instance_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(service_id, service_instance_id)

Returns Service-Instance information for a given Service-Insertion Service.

Parameters

  • service_id (str) – (required)

  • service_instance_id (str) – (required)

Return type

vmware.vapi.struct.VapiStruct

Returns

com.vmware.nsx.model.BaseServiceInstance The return value will contain all the attributes defined in com.vmware.nsx.model_client.BaseServiceInstance.

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(service_id)

Returns all Service-Instance(s) for a given Service-Insertion Service.

Parameters

service_id (str) – (required)

Return type

com.vmware.nsx.model_client.ServiceInstanceListResult

Returns

com.vmware.nsx.model.ServiceInstanceListResult

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(service_id, service_instance_id, base_service_instance)

Modifies an existing Service-Instance for a given Service-Insertion Service.

Parameters

  • service_id (str) – (required)

  • service_instance_id (str) – (required)

  • base_service_instance (vmware.vapi.struct.VapiStruct) – (required) The parameter must contain all the attributes defined in com.vmware.nsx.model_client.BaseServiceInstance.

Return type

vmware.vapi.struct.VapiStruct

Returns

com.vmware.nsx.model.BaseServiceInstance The return value will contain all the attributes defined in com.vmware.nsx.model_client.BaseServiceInstance.

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.serviceinsertion.services_client.ServiceProfiles(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

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

create(service_id, base_service_profile)

Adds a new service profile.

Parameters
Return type

vmware.vapi.struct.VapiStruct

Returns

com.vmware.nsx.model.BaseServiceProfile The return value will contain all the attributes defined in com.vmware.nsx.model_client.BaseServiceProfile.

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

delete(service_id, service_profile_id)

Delete service profile for a given service.

Parameters

  • service_id (str) – (required)

  • service_profile_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(service_id, service_profile_id)

Returns detailed service profile information for a given Service.

Parameters

  • service_id (str) – (required)

  • service_profile_id (str) – (required)

Return type

vmware.vapi.struct.VapiStruct

Returns

com.vmware.nsx.model.BaseServiceProfile The return value will contain all the attributes defined in com.vmware.nsx.model_client.BaseServiceProfile.

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(service_id)

List all service profiles of a service.

Parameters

service_id (str) – (required)

Return type

com.vmware.nsx.model_client.SIServiceProfileListResult

Returns

com.vmware.nsx.model.SIServiceProfileListResult

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.serviceinsertion.services_client.SolutionConfigs(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

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

create(service_id, solution_config)

Adds a solution config. Solution Config are service level objects, required for configuring the NXGI partner Service after deployment.

Parameters
Return type

com.vmware.nsx.model_client.SolutionConfig

Returns

com.vmware.nsx.model.SolutionConfig

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

delete(service_id, solution_config_id)

Deletes solution config information for a given service.

Parameters

  • service_id (str) – (required)

  • solution_config_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(service_id, solution_config_id)

Returns Solution Config information for a given solution config id.

Parameters

  • service_id (str) – (required)

  • solution_config_id (str) – (required)

Return type

com.vmware.nsx.model_client.SolutionConfig

Returns

com.vmware.nsx.model.SolutionConfig

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(service_id)

Returns Solution Config information for a given service.

Parameters

service_id (str) – (required)

Return type

com.vmware.nsx.model_client.SolutionConfigListResult

Returns

com.vmware.nsx.model.SolutionConfigListResult

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(service_id, solution_config_id, solution_config)

Updates a solution config. Solution Config are service level objects, required for configuring the NXGI partner Service after deployment.

Parameters
Return type

com.vmware.nsx.model_client.SolutionConfig

Returns

com.vmware.nsx.model.SolutionConfig

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.serviceinsertion.services_client.StubFactory(stub_config)

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

Parameters

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

class com.vmware.nsx.serviceinsertion.services_client.VendorTemplates(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

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

create(service_id, vendor_template)

Adds a new vendor template. Vendor templates are service level objects, registered to be used in Service Profiles.

Parameters
Return type

com.vmware.nsx.model_client.VendorTemplate

Returns

com.vmware.nsx.model.VendorTemplate

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

delete(service_id, vendor_template_id)

Delete vendor template information for a given service. Please make sure to delete all the Service Profile(s), which refer to this vendor tempalte before deleting the template itself.

Parameters

  • service_id (str) – (required)

  • vendor_template_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(service_id, vendor_template_id)

Returns detailed vendor template information for a given service.

Parameters

  • service_id (str) – (required)

  • vendor_template_id (str) – (required)

Return type

com.vmware.nsx.model_client.VendorTemplate

Returns

com.vmware.nsx.model.VendorTemplate

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(service_id, vendor_template_name=None)

List all vendor templates of a service.

Parameters

  • service_id (str) – (required)

  • vendor_template_name (str or None) – Name of vendor template (optional)

Return type

com.vmware.nsx.model_client.VendorTemplateListResult

Returns

com.vmware.nsx.model.VendorTemplateListResult

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