### Navigation

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

# networking Package

## `networking` Package

## `dns_client` Module

class `com.vmware.appliance.networking.dns_client.``Domains`(config)

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

  `Domains` class provides methods DNS search domains.

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

  `add`(domain)

    Add domain to DNS search domains.

    Parameters: | domain (`str`) – Domain to add.
    Raise : | `com.vmware.vapi.std.errors_client.Error` Generic error

  `list`()

    Get list of DNS search domains.

    Return type: | `list` of `str`
    Returns: | List of domains.
    Raise : | `com.vmware.vapi.std.errors_client.Error` Generic error

  `set`(domains)

    Set DNS search domains.

    Parameters: | domains (`list` of `str`) – List of domains.
    Raise : | `com.vmware.vapi.std.errors_client.Error` Generic error

class `com.vmware.appliance.networking.dns_client.``Hostname`(config)

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

  `Hostname` class provides methods Performs operations on Fully Qualified Doman Name.

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

  class `Message`(message=None, result=None)

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

    `Hostname.Message` class Test result and message

    Tip

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

    Parameters: | message (`str`) – message result (`Hostname.MessageStatus`) – result of the test

  class `Hostname.``MessageStatus`(string)

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

    `Hostname.MessageStatus` class Individual test result

    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 `MessageStatus` instance.

    `failure` = MessageStatus(string=u'failure')

      message indicates the test failed.

    `success` = MessageStatus(string=u'success')

      message indicates that the test was successful.

  class `Hostname.``TestStatus`(string)

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

    `Hostname.TestStatus` class Health indicator

    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 `TestStatus` instance.

    `green` = TestStatus(string=u'green')

      All tests were successful for given data

    `orange` = TestStatus(string=u'orange')

      In case data has more than one test, this indicates not all tests were successful

    `red` = TestStatus(string=u'red')

      All tests failed for given data

  class `Hostname.``TestStatusInfo`(status=None, messages=None)

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

    `Hostname.TestStatusInfo` class Overall test result

    Tip

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

    Parameters: | status (`Hostname.TestStatus`) – Overall status of tests run. messages (`list` of `Hostname.Message`) – messages

  `Hostname.``get`()

    Get the Fully Qualified Doman Name.

    Return type: | `str`
    Returns: | FQDN.
    Raise : | `com.vmware.vapi.std.errors_client.Error` Generic error

  `Hostname.``set`(name)

    Set the Fully Qualified Domain Name.

    Parameters: | name (`str`) – FQDN.
    Raise : | `com.vmware.vapi.std.errors_client.Error` Generic error

  `Hostname.``test`(name)

    Test the Fully Qualified Domain Name.

    Parameters: | name (`str`) – FQDN.
    Return type: | `Hostname.TestStatusInfo`
    Returns: | FQDN status
    Raise : | `com.vmware.vapi.std.errors_client.Error` Generic error

class `com.vmware.appliance.networking.dns_client.``Servers`(config)

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

  `Servers` class provides methods DNS server configuration.

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

  class `DNSServerConfig`(mode=None, servers=None)

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

    `Servers.DNSServerConfig` class This structure represents the configuration state used to determine DNS servers.

    Tip

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

    Parameters: | mode (`Servers.DNSServerMode`) – Define how to determine the DNS servers. Leave the servers argument empty if the mode argument is “DHCP”. Set the servers argument to a comma-separated list of DNS servers if the mode argument is “static”. The DNS server are assigned from the specified list. servers (`list` of `str`) – List of the currently used DNS servers.

  class `Servers.``DNSServerMode`(string)

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

    `Servers.DNSServerMode` class Describes DNS Server source (DHCP,static)

    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 `DNSServerMode` instance.

    `dhcp` = DNSServerMode(string=u'dhcp')

      DNS address is automatically assigned by a DHCP server.

    `is_static` = DNSServerMode(string=u'is_static')

      DNS address is static.

  class `Servers.``Message`(message=None, result=None)

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

    `Servers.Message` class Test result and message

    Tip

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

    Parameters: | message (`str`) – message result (`Servers.MessageStatus`) – result of the test

  class `Servers.``MessageStatus`(string)

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

    `Servers.MessageStatus` class Individual test result

    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 `MessageStatus` instance.

    `failure` = MessageStatus(string=u'failure')

      message indicates the test failed.

    `success` = MessageStatus(string=u'success')

      message indicates that the test was successful.

  class `Servers.``TestStatus`(string)

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

    `Servers.TestStatus` class Health indicator

    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 `TestStatus` instance.

    `green` = TestStatus(string=u'green')

      All tests were successful for given data

    `orange` = TestStatus(string=u'orange')

      In case data has more than one test, this indicates not all tests were successful

    `red` = TestStatus(string=u'red')

      All tests failed for given data

  class `Servers.``TestStatusInfo`(status=None, messages=None)

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

    `Servers.TestStatusInfo` class Overall test result

    Tip

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

    Parameters: | status (`Servers.TestStatus`) – Overall status of tests run. messages (`list` of `Servers.Message`) – messages

  `Servers.``add`(server)

    Add a DNS server. This method fails if mode argument is “dhcp”

    Parameters: | server (`str`) – DNS server.
    Raise : | `com.vmware.vapi.std.errors_client.Error` Generic error

  `Servers.``get`()

    Get DNS server configuration.

    Return type: | `Servers.DNSServerConfig`
    Returns: | DNS server configuration.
    Raise : | `com.vmware.vapi.std.errors_client.Error` Generic error

  `Servers.``set`(config)

    Set the DNS server configuration. If you set the mode argument to “DHCP”, a DHCP refresh is forced.

    Parameters: | config (`Servers.DNSServerConfig`) – DNS server configuration.
    Raise : | `com.vmware.vapi.std.errors_client.Error` Generic error

  `Servers.``test`(servers)

    Test if dns servers are reachable.

    Parameters: | servers (`list` of `str`) – DNS servers.
    Return type: | `Servers.TestStatusInfo`
    Returns: | DNS reacable status
    Raise : | `com.vmware.vapi.std.errors_client.Error` Generic error

### Navigation

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