saltext.vmware.modules.vmc_direct_connect#

Salt execution module for VMC Direct Connect Provides methods to Display Direct Connect Information of an SDDC.

saltext.vmware.modules.vmc_direct_connect.get_accounts(hostname, refresh_key, authorization_host, org_id, sddc_id, verify_ssl=True, cert=None)[source]#

Retrieves Direct Connect Account information for given SDDC

CLI Example:

salt vm_minion vmc_direct_connect.get_accounts hostname=nsxt-manager.local ...

hostname: The host name of NSX-T manager
refresh_key: API Token of the user which is used to get the Access Token required for VMC operations
authorization_host: Hostname of the VMC cloud console
org_id: The Id of organization to which the SDDC belongs to
sddc_id: The Id of SDDC for which the Direct Connect Account information should be retrieved
verify_ssl: (Optional) Option to enable/disable SSL verification. Enabled by default. If set to False, the certificate validation is skipped.
cert: (Optional) Path to the SSL client certificate file to connect to VMC Cloud Console. The certificate can be retrieved from browser.

saltext.vmware.modules.vmc_direct_connect.get_associated_groups(hostname, refresh_key, authorization_host, org_id, sddc_id, verify_ssl=True, cert=None)[source]#

Retrieves Direct Connect Associated Groups information for given SDDC

CLI Example:

salt vm_minion vmc_direct_connect.get_associated_groups hostname=nsxt-manager.local ...

hostname: The host name of NSX-T manager
refresh_key: API Token of the user which is used to get the Access Token required for VMC operations
authorization_host: Hostname of the VMC cloud console
org_id: The Id of organization to which the SDDC belongs to
sddc_id: The Id of SDDC for which the Direct Connect Associated Groups information should be retrieved
verify_ssl: (Optional) Option to enable/disable SSL verification. Enabled by default. If set to False, the certificate validation is skipped.
cert: (Optional) Path to the SSL client certificate file to connect to VMC Cloud Console. The certificate can be retrieved from browser.

saltext.vmware.modules.vmc_direct_connect.get_bgp_info(hostname, refresh_key, authorization_host, org_id, sddc_id, verify_ssl=True, cert=None)[source]#

Retrieves Direct Connect BGP related information for given SDDC, including current Autonomous System Number of the VGW attached to the VPC

CLI Example:

salt vm_minion vmc_direct_connect.get_bgp_info hostname=nsxt-manager.local ...

hostname: The host name of NSX-T manager
refresh_key: API Token of the user which is used to get the Access Token required for VMC operations
authorization_host: Hostname of the VMC cloud console
org_id: The Id of organization to which the SDDC belongs to
sddc_id: The Id of SDDC for which the Direct Connect BGP related information should be retrieved
verify_ssl: (Optional) Option to enable/disable SSL verification. Enabled by default. If set to False, the certificate validation is skipped.
cert: (Optional) Path to the SSL client certificate file to connect to VMC Cloud Console. The certificate can be retrieved from browser.

saltext.vmware.modules.vmc_direct_connect.get_bgp_status(hostname, refresh_key, authorization_host, org_id, sddc_id, verify_ssl=True, cert=None)[source]#

Retrieves Direct Connect BGP status information for given SDDC

CLI Example:

salt vm_minion vmc_direct_connect.get_bgp_status hostname=nsxt-manager.local ...

hostname: The host name of NSX-T manager
refresh_key: API Token of the user which is used to get the Access Token required for VMC operations
authorization_host: Hostname of the VMC cloud console
org_id: The Id of organization to which the SDDC belongs to
sddc_id: The Id of SDDC for which the Direct Connect BGP status information should be retrieved
verify_ssl: (Optional) Option to enable/disable SSL verification. Enabled by default. If set to False, the certificate validation is skipped.
cert: (Optional) Path to the SSL client certificate file to connect to VMC Cloud Console. The certificate can be retrieved from browser.

saltext.vmware.modules.vmc_direct_connect.get_advertised_routes(hostname, refresh_key, authorization_host, org_id, sddc_id, verify_ssl=True, cert=None)[source]#

Retrieves BGP routes that are advertised by Direct Connect from VMC provider to on-premise datacenter.

CLI Example:

salt vm_minion vmc_direct_connect.get_advertised_routes hostname=nsxt-manager.local ...

hostname: The host name of NSX-T manager
refresh_key: API Token of the user which is used to get the Access Token required for VMC operations
authorization_host: Hostname of the VMC cloud console
org_id: The Id of organization to which the SDDC belongs to
sddc_id: The Id of SDDC for which the BGP routes that are advertised by Direct Connect should be retrieved
verify_ssl: (Optional) Option to enable/disable SSL verification. Enabled by default. If set to False, the certificate validation is skipped.
cert: (Optional) Path to the SSL client certificate file to connect to VMC Cloud Console. The certificate can be retrieved from browser.

saltext.vmware.modules.vmc_direct_connect.get_learned_routes(hostname, refresh_key, authorization_host, org_id, sddc_id, verify_ssl=True, cert=None)[source]#

Retrieve BGP routes that are learned by Direct Connect from on-premise datacenter.

CLI Example:

salt vm_minion vmc_direct_connect.get_learned_routes hostname=nsxt-manager.local ...

hostname: The host name of NSX-T manager
refresh_key: API Token of the user which is used to get the Access Token required for VMC operations
authorization_host: Hostname of the VMC cloud console
org_id: The Id of organization to which the SDDC belongs to
sddc_id: The Id of SDDC for which the BGP routes that are learned by Direct Connect should be retrieved
verify_ssl: (Optional) Option to enable/disable SSL verification. Enabled by default. If set to False, the certificate validation is skipped.
cert: (Optional) Path to the SSL client certificate file to connect to VMC Cloud Console. The certificate can be retrieved from browser.

saltext.vmware.modules.vmc_direct_connect.get_vifs(hostname, refresh_key, authorization_host, org_id, sddc_id, verify_ssl=True, cert=None)[source]#

Retrieves Direct Connect VIFs (Virtual Interface) available in the given SDDC. The response includes all non-connected VIFs (with states “available”, “down”, “pending” and “confirming”) and connected VIFs that are available to the given SDDC.

CLI Example:

salt vm_minion vmc_direct_connect.get_vifs hostname=nsxt-manager.local ...

hostname: The host name of NSX-T manager
refresh_key: API Token of the user which is used to get the Access Token required for VMC operations
authorization_host: Hostname of the VMC cloud console
org_id: The Id of organization to which the SDDC belongs to
sddc_id: The Id of SDDC for which the Direct Connect VIFs should be retrieved
verify_ssl: (Optional) Option to enable/disable SSL verification. Enabled by default. If set to False, the certificate validation is skipped.
cert: (Optional) Path to the SSL client certificate file to connect to VMC Cloud Console. The certificate can be retrieved from browser.