com.vmware package

Subpackages

• com.vmware.nsx_policy package
  • Subpackages
    • com.vmware.nsx_policy.aaa package
      • Submodules
      • com.vmware.nsx_policy.aaa.vidm_client module
    • com.vmware.nsx_policy.cluster package
      • Submodules
      • com.vmware.nsx_policy.cluster.backups_client module
      • com.vmware.nsx_policy.cluster.restore_client module
    • com.vmware.nsx_policy.infra package
      • Subpackages
        • com.vmware.nsx_policy.infra.domains package
          • Subpackages
            • com.vmware.nsx_policy.infra.domains.gateway_policies package
              • Submodules
              • com.vmware.nsx_policy.infra.domains.gateway_policies.rules_client module
            • com.vmware.nsx_policy.infra.domains.groups package
              • Submodules
              • com.vmware.nsx_policy.infra.domains.groups.members_client module
              • com.vmware.nsx_policy.infra.domains.groups.statistics_client module
            • com.vmware.nsx_policy.infra.domains.security_policies package
              • Submodules
              • com.vmware.nsx_policy.infra.domains.security_policies.rules_client module
          • Submodules
          • com.vmware.nsx_policy.infra.domains.communication_maps_client module
          • com.vmware.nsx_policy.infra.domains.endpoint_policies_client module
          • com.vmware.nsx_policy.infra.domains.forwarding_policies_client module
          • com.vmware.nsx_policy.infra.domains.gateway_policies_client module
          • com.vmware.nsx_policy.infra.domains.groups_client module
          • com.vmware.nsx_policy.infra.domains.redirection_policies_client module
          • com.vmware.nsx_policy.infra.domains.security_policies_client module
        • com.vmware.nsx_policy.infra.lb_services package
          • Submodules
          • com.vmware.nsx_policy.infra.lb_services.lb_pools_client module
          • com.vmware.nsx_policy.infra.lb_services.lb_virtual_servers_client module
        • com.vmware.nsx_policy.infra.realized_state package
          • Subpackages
            • com.vmware.nsx_policy.infra.realized_state.enforcement_points package
              • Submodules
              • com.vmware.nsx_policy.infra.realized_state.enforcement_points.firewalls_client module
              • com.vmware.nsx_policy.infra.realized_state.enforcement_points.groups_client module
              • com.vmware.nsx_policy.infra.realized_state.enforcement_points.ip_sets_client module
              • com.vmware.nsx_policy.infra.realized_state.enforcement_points.mac_sets_client module
              • com.vmware.nsx_policy.infra.realized_state.enforcement_points.services_client module
              • com.vmware.nsx_policy.infra.realized_state.enforcement_points.virtual_machines_client module
          • Submodules
          • com.vmware.nsx_policy.infra.realized_state.enforcement_points_client module
        • com.vmware.nsx_policy.infra.segments package
          • Submodules
          • com.vmware.nsx_policy.infra.segments.ports_client module
        • com.vmware.nsx_policy.infra.service_references package
          • Submodules
          • com.vmware.nsx_policy.infra.service_references.service_profiles_client module
        • com.vmware.nsx_policy.infra.settings package
          • Subpackages
            • com.vmware.nsx_policy.infra.settings.firewall package
              • Submodules
              • com.vmware.nsx_policy.infra.settings.firewall.idfw_client module
              • com.vmware.nsx_policy.infra.settings.firewall.security_client module
          • Submodules
          • com.vmware.nsx_policy.infra.settings.firewall_client module
        • com.vmware.nsx_policy.infra.sites package
          • Subpackages
            • com.vmware.nsx_policy.infra.sites.enforcement_points package
              • Submodules
              • com.vmware.nsx_policy.infra.sites.enforcement_points.edge_clusters_client module
          • Submodules
          • com.vmware.nsx_policy.infra.sites.enforcement_points_client module
        • com.vmware.nsx_policy.infra.tier_0s package
          • Subpackages
            • com.vmware.nsx_policy.infra.tier_0s.groups package
              • Submodules
              • com.vmware.nsx_policy.infra.tier_0s.groups.members_client module
            • com.vmware.nsx_policy.infra.tier_0s.locale_services package
              • Subpackages
                • com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp package
                  • Submodules
                  • com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp.neighbors_client module
                • com.vmware.nsx_policy.infra.tier_0s.locale_services.ipsec_vpn_services package
                  • Submodules
                  • com.vmware.nsx_policy.infra.tier_0s.locale_services.ipsec_vpn_services.sessions_client module
                • com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context package
                  • Submodules
                  • com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context.l2vpns_client module
                • com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_services package
                  • Submodules
                  • com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_services.sessions_client module
              • Submodules
              • com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp_client module
              • com.vmware.nsx_policy.infra.tier_0s.locale_services.byod_service_instances_client module
              • com.vmware.nsx_policy.infra.tier_0s.locale_services.endpoints_client module
              • com.vmware.nsx_policy.infra.tier_0s.locale_services.interfaces_client module
              • com.vmware.nsx_policy.infra.tier_0s.locale_services.ipsec_vpn_services_client module
              • com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context_client module
              • com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_services_client module
              • com.vmware.nsx_policy.infra.tier_0s.locale_services.l3vpns_client module
              • com.vmware.nsx_policy.infra.tier_0s.locale_services.service_instances_client module
            • com.vmware.nsx_policy.infra.tier_0s.nat package
              • Submodules
              • com.vmware.nsx_policy.infra.tier_0s.nat.nat_rules_client module
          • Submodules
          • com.vmware.nsx_policy.infra.tier_0s.dns_forwarder_client module
          • com.vmware.nsx_policy.infra.tier_0s.locale_services_client module
          • com.vmware.nsx_policy.infra.tier_0s.nat_client module
        • com.vmware.nsx_policy.infra.tier_1s package
          • Subpackages
            • com.vmware.nsx_policy.infra.tier_1s.locale_services package
              • Subpackages
                • com.vmware.nsx_policy.infra.tier_1s.locale_services.ipsec_vpn_services package
                  • Submodules
                  • com.vmware.nsx_policy.infra.tier_1s.locale_services.ipsec_vpn_services.sessions_client module
              • Submodules
              • com.vmware.nsx_policy.infra.tier_1s.locale_services.interfaces_client module
              • com.vmware.nsx_policy.infra.tier_1s.locale_services.ipsec_vpn_services_client module
              • com.vmware.nsx_policy.infra.tier_1s.locale_services.service_instances_client module
            • com.vmware.nsx_policy.infra.tier_1s.nat package
              • Submodules
              • com.vmware.nsx_policy.infra.tier_1s.nat.nat_rules_client module
            • com.vmware.nsx_policy.infra.tier_1s.segments package
              • Submodules
              • com.vmware.nsx_policy.infra.tier_1s.segments.ports_client module
          • Submodules
          • com.vmware.nsx_policy.infra.tier_1s.dns_forwarder_client module
          • com.vmware.nsx_policy.infra.tier_1s.locale_services_client module
          • com.vmware.nsx_policy.infra.tier_1s.nat_client module
          • com.vmware.nsx_policy.infra.tier_1s.segments_client module
      • Submodules
      • com.vmware.nsx_policy.infra.context_profiles_client module
      • com.vmware.nsx_policy.infra.deployment_zones_client module
      • com.vmware.nsx_policy.infra.domains_client module
      • com.vmware.nsx_policy.infra.drafts_client module
      • com.vmware.nsx_policy.infra.flood_protection_profiles_client module
      • com.vmware.nsx_policy.infra.ip_pools_client module
      • com.vmware.nsx_policy.infra.lb_services_client module
      • com.vmware.nsx_policy.infra.realized_state_client module
      • com.vmware.nsx_policy.infra.segments_client module
      • com.vmware.nsx_policy.infra.service_references_client module
      • com.vmware.nsx_policy.infra.services_client module
      • com.vmware.nsx_policy.infra.session_timer_profiles_client module
      • com.vmware.nsx_policy.infra.sites_client module
      • com.vmware.nsx_policy.infra.tier_0s_client module
      • com.vmware.nsx_policy.infra.tier_1s_client module
  • Submodules
  • com.vmware.nsx_policy.aaa_client module
  • com.vmware.nsx_policy.cluster_client module
  • com.vmware.nsx_policy.compliance_client module
  • com.vmware.nsx_policy.configs_client module
  • com.vmware.nsx_policy.enforcement_points_client module
  • com.vmware.nsx_policy.eula_client module
  • com.vmware.nsx_policy.fine_tuning_client module
  • com.vmware.nsx_policy.infra_client module
  • com.vmware.nsx_policy.model_client module
  • com.vmware.nsx_policy.tasks_client module
  • com.vmware.nsx_policy.ui_views_client module
  • com.vmware.nsx_policy.upgrade_client module

Submodules

com.vmware.nsx_policy_client module

class com.vmware.nsx_policy_client.Batch(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

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

create(batch_request, atomic=None)

Enables you to make multiple API requests using a single request. The batch API takes in an array of logical HTTP requests represented as JSON arrays. Each request has a method (GET, PUT, POST, or DELETE), a relative_url (the portion of the URL after https://<nsx-mgr>/api/), optional headers array (corresponding to HTTP headers) and an optional body (for POST and PUT requests). The batch API returns an array of logical HTTP responses represented as JSON arrays. Each response has a status code, an optional headers array and an optional body (which is a JSON-encoded string).

Parameters

• batch_request (com.vmware.nsx_policy.model_client.BatchRequest) – (required)

• atomic (bool or None) – transactional atomicity for the batch of requests embedded in the batch list (optional, default to false)

Return type

com.vmware.nsx_policy.model_client.BatchResponse

Returns

com.vmware.nsx_policy.model.BatchResponse

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_client.Cluster(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

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

backuptoremote()

Request one-time backup. The backup will be uploaded using the same server configuration as for automatic backup.

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

summarizeinventorytoremote()

Request one-time inventory summary. The backup will be uploaded using the same server configuration as for an automatic backup.

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_client.ErrorResolver(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

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

get(error_id)

Returns some metadata about the given error_id. This includes information of whether there is a resolver present for the given error_id and its associated user input data

Parameters

error_id (str) – (required)

Return type

com.vmware.nsx_policy.model_client.ErrorResolverInfo

Returns

com.vmware.nsx_policy.model.ErrorResolverInfo

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

Returns a list of metadata for all the error resolvers registered.

Return type

com.vmware.nsx_policy.model_client.ErrorResolverInfoList

Returns

com.vmware.nsx_policy.model.ErrorResolverInfoList

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

resolveerror(error_resolver_metadata_list)

Invokes the corresponding error resolver for the given error(s) present in the payload

Parameters

error_resolver_metadata_list (com.vmware.nsx_policy.model_client.ErrorResolverMetadataList) – (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_policy_client.Infra(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

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

get(filter=None)

Read infra. Returns only the infra related properties. Inner object are not populated.

Parameters

filter (str or None) – Filter string as java regex (optional)

Return type

com.vmware.nsx_policy.model_client.Infra

Returns

com.vmware.nsx_policy.model.Infra

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(infra, enforce_revision_check=None)

Patch API at infra level can be used in two flavours 1. Like a regular API to update Infra object 2. Hierarchical API: To create/update/delete entire or part of intent hierarchy Hierarchical API: Provides users a way to create entire or part of intent in single API invocation. Input is expressed in a tree format. Each node in tree can have multiple children of different types. System will resolve the dependecies of nodes within the intent tree and will create the model. Children for any node can be specified using ChildResourceReference or ChildPolicyConfigResource. If a resource is specified using ChildResourceReference then it will not be updated only its children will be updated. If Object is specified using ChildPolicyConfigResource, object along with its children will be updated. Hierarchical API can also be used to delete any sub-branch of entire tree.

Parameters

• infra (com.vmware.nsx_policy.model_client.Infra) – (required)

• enforce_revision_check (bool or None) – Force revision check (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

update(infra)

Update the infra including all the nested entities

Parameters

infra (com.vmware.nsx_policy.model_client.Infra) – (required)

Return type

com.vmware.nsx_policy.model_client.Infra

Returns

com.vmware.nsx_policy.model.Infra

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_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_policy_client.Tasks(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

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

get(task_id)

Get information about the specified task

Parameters

task_id (str) – ID of task to read (required)

Return type

com.vmware.nsx_policy.model_client.TaskProperties

Returns

com.vmware.nsx_policy.model.TaskProperties

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(cursor=None, included_fields=None, page_size=None, request_uri=None, sort_ascending=None, sort_by=None, status=None, user=None)

Get information about all tasks

Parameters

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

• request_uri (str or None) – Request URI(s) to include in query result (optional)

• sort_ascending (bool or None) – (optional)

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

• status (str or None) – Status(es) to include in query result (optional)

• user (str or None) – Names of users to include in query result (optional)

Return type

com.vmware.nsx_policy.model_client.TaskListResult

Returns

com.vmware.nsx_policy.model.TaskListResult

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_client.UiViews(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

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

create(view)

Creates a new View.

Parameters

view (com.vmware.nsx_policy.model_client.View) – (required)

Return type

com.vmware.nsx_policy.model_client.View

Returns

com.vmware.nsx_policy.model.View

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

Delete View

Parameters

view_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(tag=None, view_ids=None, widget_id=None)

If no query params are specified then all the views entitled for the user are returned. The views to which a user is entitled to include the views created by the user and the shared views.

Parameters

• tag (str or None) – The tag for which associated views to be queried. (optional)

• view_ids (str or None) – Ids of the Views (optional)

• widget_id (str or None) – Id of widget configuration (optional)

Return type

com.vmware.nsx_policy.model_client.ViewList

Returns

com.vmware.nsx_policy.model.ViewList

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_0(view_id)

Returns Information about a specific View.

Parameters

view_id (str) – (required)

Return type

com.vmware.nsx_policy.model_client.View

Returns

com.vmware.nsx_policy.model.View

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(view_id, view)

Update View

Parameters

• view_id (str) – (required)

• view (com.vmware.nsx_policy.model_client.View) – (required)

Return type

com.vmware.nsx_policy.model_client.View

Returns

com.vmware.nsx_policy.model.View

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

com.vmware.nsx_policy_client_for_vmc module