### Navigation

- index
- modules |
- next |
- previous |
- vSphere Automation SDK for Python 6.5.0 documentation »
- com Package »
- vmware Package »

# vapi Package

## `vapi` Package

## `metadata_client` Module

The `com.vmware.vapi.metadata_client` module provides metadata classes. These are classes that provide different facets of API information. Clients can use these classes to:

- Discover APIs available in the infrastructure.
- Fetch metadata that can be used to build presentation layers like CLI, REST, etc.
- Fetch authentication and authorization metadata.

class `com.vmware.vapi.metadata_client.``SourceCreateSpec`(description=None, type=None, filepath=None, address=None)

  Bases: `vmware.vapi.bindings.struct.VapiStruct`

  The `SourceCreateSpec` class contains the registration information for a metadata source.

  Tip

  The arguments are used to initialize data attributes with the same names.

  Parameters: | description (`str`) – English language human readable description of the source. type (`SourceType`) – Type of the metadata source. filepath (`str`) – Absolute file path of the metamodel metadata file that has the metamodel information about one component element. This attribute is optional and it is only relevant when the value of `type` is `SourceType.FILE`. address (`str`) – Connection information of the remote server. This should be of the format http(s)://IP:port/namespace. The remote server should contain the classes in `com.vmware.vapi.metadata.metamodel_client` module. It could expose metamodel information of one or more components. This attribute is optional and it is only relevant when the value of `type` is `SourceType.REMOTE`.

class `com.vmware.vapi.metadata_client.``SourceInfo`(type=None, file_name=None, remote_addr=None, msg_protocol=None)

  Bases: `vmware.vapi.bindings.struct.VapiStruct`

  Metadata source info

  Tip

  The arguments are used to initialize data attributes with the same names.

  Parameters: | type (`SourceType`) – Type of the metadata source file_name (`str`) – Name of the metadata source file This attribute is optional and it is only relevant when the value of `type` is `SourceType.FILE`. remote_addr (`str`) – Address of the remote metadata source This attribute is optional and it is only relevant when the value of `type` is `SourceType.REMOTE`. msg_protocol (`str`) – Message protocol to be used This attribute is optional and it is only relevant when the value of `type` is `SourceType.REMOTE`.

class `com.vmware.vapi.metadata_client.``SourceType`(string)

  Bases: `vmware.vapi.bindings.enum.Enum`

  The `SourceType` class defines the types of sources for API metadata. You specify the type of source when adding a metadata source to a metadata service.

  Note

  This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

  Parameters: | string (`str`) – String value for the `SourceType` instance.

  `FILE` = SourceType(string=u'FILE')

    Indicates the metadata source is a JSON file.

  `REMOTE` = SourceType(string=u'REMOTE')

    Indicates the metadata source is a remote server.

## `std_client` Module

The `com.vmware.vapi.std_client` module provides standard types that can be used in the interface specification of any class.

class `com.vmware.vapi.std_client.``AuthenticationScheme`

  Bases: `vmware.vapi.bindings.struct.VapiStruct`

  The `AuthenticationScheme` class defines constants for authentication scheme identifiers for authentication mechanisms present in the vAPI infrastructure shipped by VMware.

  A third party extension can define and implements it’s own authentication mechanism and define a constant in a different IDL file.

  Tip

  The arguments are used to initialize data attributes with the same names.

  `NO_AUTHENTICATION` = 'com.vmware.vapi.std.security.no_authentication'

    Indicates that the request doesn’t need any authentication.

  `OAUTH_ACCESS_TOKEN` = 'com.vmware.vapi.std.security.oauth'

    Indicates that the security context in a request is using OAuth2 based authentication scheme.

    In this scheme, the following pieces of information has to be passed in the SecurityContext structure in the execution context of the request:

    - The scheme identifier - com.vmware.vapi.std.security.oauth
    - Valid OAuth2 access token - This is usually acquired by OAuth2 Authorization Server after successful authentication of the end user.

    > Sample security context in JSON format that matches the specification: ``{

    ‘schemeId’: ‘com.vmware.vapi.std.security.oauth’, ‘accesstoken’: .... }`` vAPI runtime provides convenient factory methods that takes OAuth2 access token as input parameter and creates a security context that conforms to the above format.

  `SAML_BEARER_TOKEN` = 'com.vmware.vapi.std.security.saml_bearer_token'

    Indicates that the security context in a request is using a SAML bearer token based authentication scheme.

    In this scheme, the following pieces of information has to be passed in the SecurityContext structure in the execution context of the request:

    - The scheme identifier: com.vmware.vapi.std.security.saml_bearer_token
    - The token itself

    > Sample security context in JSON format that matches the specification: ``{

    ‘schemeId’: ‘com.vmware.vapi.std.security.saml_bearer_token’, ‘token’: ‘the token itself’ }`` vAPI runtime provide convenient factory methods that take SAML bearer token and to create the security context that conforms to the above mentioned format.

  `SAML_HOK_TOKEN` = 'com.vmware.vapi.std.security.saml_hok_token'

    Indicates that the security context in a request is using a SAML holder-of-key token based authentication scheme.

    In this scheme, the following pieces of information has to be passed in the SecurityContext structure in the execution context of the request:

    - The scheme identifier: com.vmware.vapi.std.security.saml_hok_token
    - Signature of the request: This includes - algorithm used for signing the request, SAML holder of key token and signature digest
    - Request timestamp: This includes the `created` and `expires` timestamp of the request. The timestamp should match the following format - YYYY-MM-DDThh:mm:ss.sssZ (e.g. 1878-03-03T19:20:30.451Z).

    > Sample security context in JSON format that matches the specification: ``{

    ‘schemeId’: ‘com.vmware.vapi.std.security.saml_hok_token’, ‘signature’: { ‘alg’: ‘RS256’, ‘samlToken’: ..., ‘value’: ...,``, ‘timestamp’: { ‘created’: ‘2012-10-26T12:24:18.941Z’, ‘expires’: ‘2012-10-26T12:44:18.941Z’, } } } vAPI runtime provide convenient factory methods that take SAML holder of key token and private key to create the security context that conforms to the above mentioned format.

  `SESSION_ID` = 'com.vmware.vapi.std.security.session_id'

    Indicates that the security context in a request is using a session identifier based authentication scheme.

    In this scheme, the following pieces of information has to be passed in the SecurityContext structure in the execution context of the request:

    - The scheme identifier - com.vmware.vapi.std.security.session_id
    - Valid session identifier - This is usually returned by a login method of a session manager interface for a particular vAPI service of this authentication scheme

    > Sample security context in JSON format that matches the specification: ``{

    ‘schemeId’: ‘com.vmware.vapi.std.security.session_id’, ‘sessionId’: ...., }`` vAPI runtime provides convenient factory methods that take session identifier as input parameter and create a security context that conforms to the above format.

  `USER_PASSWORD` = 'com.vmware.vapi.std.security.user_pass'

    Indicates that the security context in a request is using username/password based authentication scheme.

    In this scheme, the following pieces of information has to be passed in the SecurityContext structure in the execution context of the request:

    - The scheme identifier - com.vmware.vapi.std.security.user_pass
    - Username
    - Password

    > Sample security context in JSON format that matches the specification: ``{

    ‘schemeId’: ‘com.vmware.vapi.std.security.user_pass’, ‘userName’: ...., ‘password’: ... }`` vAPI runtime provides convenient factory methods that take username and password as input parameters and create a security context that conforms to the above format.

class `com.vmware.vapi.std_client.``DynamicID`(type=None, id=None)

  Bases: `vmware.vapi.bindings.struct.VapiStruct`

  The `DynamicID` class represents an identifier for a resource of an arbitrary type.

  Tip

  The arguments are used to initialize data attributes with the same names.

  Parameters: | type (`str`) – The type of resource being identified (for example `com.acme.Person`). Classes that contain methods for creating and deleting resources typically contain a class attribute specifying the resource type for the resources being created and deleted. The API metamodel metadata classes include a class that allows retrieving all the known resource types. id (`str`) – The identifier for a resource whose type is specified by `DynamicID.type`. When clients pass a value of this class as a parameter, the attribute `type` must contain the actual resource type. When methods return a value of this class as a return value, the attribute `type` will contain the actual resource type.

class `com.vmware.vapi.std_client.``LocalizableMessage`(id=None, default_message=None, args=None)

  Bases: `vmware.vapi.bindings.struct.VapiStruct`

  The `LocalizableMessage` class represents a localizable string or message template. Classes include one or more localizable message templates in the exceptions they report so that clients can display diagnostic messages in the native language of the user. Classes can include localizable strings in the data returned from methods to allow clients to display localized status information in the native language of the user.

  Tip

  The arguments are used to initialize data attributes with the same names.

  Parameters: | id (`str`) – Unique identifier of the localizable string or message template. This identifier is typically used to retrieve a locale-specific string or message template from a message catalog. default_message (`str`) – The value of this localizable string or message template in the `en_US` (English) locale. If `LocalizableMessage.id` refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog. args (`list` of `str`) – Arguments to be substituted into a message template.

## `vcenter_client` Module

class `com.vmware.vapi.vcenter_client.``Activation`(config)

  Bases: `vmware.vapi.bindings.stub.VapiInterface`

  The `Activation` class provides methods for tasks cancelation.

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

  `cancel`(activation_id)

    Sends a request to cancel the task associated with the provided `activation_id`.

    Parameters: | activation_id (`str`) – the `activation_id` associated with a vCenter Server task to be canceled. The parameter must be an identifier for the resource type: `com.vmware.Activation`.
    Raise : | `com.vmware.vapi.std.errors_client.NotFound` if a vCenter Server task with the given `activation_id` was not found.
    Raise : | `com.vmware.vapi.std.errors_client.NotAllowedInCurrentState` if the vCenter Server task associated with the given `activation_id` is not cancelable.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthorized` if the user is not authorized to cancel the task.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthenticated` if the user is not authenticated.
    Raise : | `com.vmware.vapi.std.errors_client.ServiceUnavailable` if the task cancelation cannot be performed due to vCenter server is unreachable or it is not properly configured.

## Subpackages

- metadata Package
  - `metadata` Package
  - `authentication_client` Module
  - `cli_client` Module
  - `metamodel_client` Module
  - `privilege_client` Module
  - `routing_client` Module
  - Subpackages
    - authentication Package
      - `authentication` Package
      - `service_client` Module
    - metamodel Package
      - `metamodel` Package
      - `resource_client` Module
      - `service_client` Module
    - privilege Package
      - `privilege` Package
      - `service_client` Module
    - routing Package
      - `routing` Package
      - `service_client` Module
- std Package
  - `std` Package
  - `activation_client` Module
  - `errors_client` Module
  - `interposition_client` Module
  - `introspection_client` Module

### Navigation

- index
- modules |
- next |
- previous |
- vSphere Automation SDK for Python 6.5.0 documentation »
- com Package »
- vmware Package »