saltext.vmware.modules.vmc_vpn_statistics#
Salt execution module for VPN statistics Provides methods to Display VPN Statistics and Sessions.
- saltext.vmware.modules.vmc_vpn_statistics.get_ipsec_statistics(hostname, refresh_key, authorization_host, org_id, sddc_id, locale_service_id, service_id, session_id, tier0_id=None, tier1_id=None, verify_ssl=True, cert=None, enforcement_point_path=None)[source]#
Retrieves VPN IPSec Statistics from Given SDDC
CLI Example:
salt vm_minion vmc_vpn_statistics.get_ipsec_statistics hostname=nsxt-manager.local ...
- hostname
The host name of NSX-T manager
- refresh_key
refresh_key to get access token
- authorization_host
hostname to get access token
- org_id
org_id of the SDDC
- sddc_id
sddc_id from which ipsec statistics should be retrieved
- locale_service_id
id of locale service for example default
- service_id
id of service for example default
- session_id
id of session
Enter one of the tier0 or tier1 id
- tier0_id
id of tier0 for example vmc
- tier1_id is currently not supported
id of tier1
- 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.
- enforcement_point_path
(Optional) String Path of the enforcement point
- saltext.vmware.modules.vmc_vpn_statistics.get_ipsec_sessions(hostname, refresh_key, authorization_host, org_id, sddc_id, locale_service_id, service_id, tier0_id=None, tier1_id=None, verify_ssl=True, cert=None, cursor=None, page_size=None, sort_by=None, sort_ascending=None)[source]#
- Retrieves ipsec session from Given SDDC
this also include l2vpn sessions
CLI Example:
salt vm_minion vmc_vpn_statistics.get_ipsec_sessions hostname=nsxt-manager.local ...
- hostname
The host name of NSX-T manager
- refresh_key
refresh_key to get access token
- authorization_host
hostname to get access token
- org_id
org_id of the SDDC
- sddc_id
sddc_id from which public ips should be retrieved
- locale_service_id
id of locale service for example default
- service_id
id of service for example default
Enter one of the tier0 or tier1 id
- tier0_id
id of tier0 for example vmc
- tier1_id is currently not supported
id of tier1
- 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.
- cursor
(Optional) Opaque cursor to be used for getting next page of records (supplied by current result page)
- page_size
(Optional) Maximum number of results to return in this page. Default page size is 1000.
- sort_by
(Optional) Field by which records are sorted
- sort_ascending
(Optional) Boolean value to sort result in ascending order. Enabled by default.
- saltext.vmware.modules.vmc_vpn_statistics.get_l2vpn_statistics(hostname, refresh_key, authorization_host, org_id, sddc_id, locale_service_id, service_id, session_id, tier0_id=None, tier1_id=None, verify_ssl=True, cert=None, enforcement_point_path=None, source=None)[source]#
Retrieves L2VPN Statistics from Given SDDC
CLI Example:
salt vm_minion vmc_vpn_statistics.get_l2vpn_statistics hostname=nsxt-manager.local ...
- hostname
The host name of NSX-T manager
- refresh_key
refresh_key to get access token
- authorization_host
hostname to get access token
- org_id
org_id of the SDDC
- sddc_id
sddc_id from which ipsec statistics should be retrieved
- locale_service_id
id of locale service for example default
- service_id
id of service for example default
- session_id
id of session
Enter one of the tier0 or tier1 id
- tier0_id
id of tier0 for example vmc
- tier1_id is currently not supported
id of tier1
- 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.
- enforcement_point_path
(Optional) String Path of the enforcement point
- source
(Optional) valid options are realtime, cached
- saltext.vmware.modules.vmc_vpn_statistics.get_l2vpn_sessions(hostname, refresh_key, authorization_host, org_id, sddc_id, locale_service_id, service_id, tier0_id=None, tier1_id=None, verify_ssl=True, cert=None, cursor=None, page_size=None, sort_by=None, sort_ascending=None)[source]#
Retrieves l2vpn session from Given SDDC
CLI Example:
salt vm_minion vmc_vpn_statistics.get_l2vpn_sessions hostname=nsxt-manager.local ...
- hostname
The host name of NSX-T manager
- refresh_key
refresh_key to get access token
- authorization_host
hostname to get access token
- org_id
org_id of the SDDC
- sddc_id
sddc_id from which public ips should be retrieved
- locale_service_id
id of locale service for example default
- service_id
id of service for example default
Enter one of the tier0 or tier1 id
- tier0_id
id of tier0 for example vmc
- tier1_id is currently not supported
id of tier1
- 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.
- cursor
(Optional) Opaque cursor to be used for getting next page of records (supplied by current result page)
- page_size
(Optional) Maximum number of results to return in this page. Default page size is 1000.
- sort_by
(Optional) Field by which records are sorted
- sort_ascending
(Optional) Boolean value to sort result in ascending order. Enabled by default.