opentelekomcloud.cloud.vpn_service_info module -- Query VPN services.

Note

This module is part of the opentelekomcloud.cloud collection (version 0.14.6).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install opentelekomcloud.cloud. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: opentelekomcloud.cloud.vpn_service_info.

New in opentelekomcloud.cloud 0.5.0

Synopsis

• This module is used to query VPN services.

Requirements

The below requirements are needed on the host that executes this module.

• python >= 3.6

• openstacksdk >= 0.36.0

Parameters

Parameter	Comments
admin_state_up boolean	Specifies the administrative status. Choices: false true
api_timeout integer	How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library.
auth dictionary	Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth_url, username, password, project_name and any information about domains (for example, os_user_domain_name or os_project_domain_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS_* environment variables are present.
auth_type string	Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly.
ca_cert aliases: cacert string	A path to a CA Cert bundle that can be used as part of verifying SSL API requests.
client_cert aliases: cert string	A path to a client certificate to use as part of the SSL transaction.
client_key aliases: key string	A path to a client key to use as part of the SSL transaction.
cloud any	Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth_type. This parameter is not needed if auth is provided or if OpenStack OS_* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml.
description string	Provides supplementary information about the VPN service.
external_v4_ip string	Specifies the IPv4 address of the VPN service external gateway.
external_v6_ip string	Specifies the IPv6 address of the VPN service external gateway.
interface aliases: endpoint_type string	Endpoint URL type to fetch from the service catalog. Choices: "admin" "internal" "public" ← (default)
project_id string	Specifies the project ID
region_name string	Name of the region.
router string	Name or ID of router.
sdk_log_level string	Log level of the OpenStackSDK Choices: "ERROR" "WARN" ← (default) "INFO" "DEBUG"
sdk_log_path string	Path to the logfile of the OpenStackSDK. If empty no log is written
status string	Specifies whether the VPN service is currently operational. Choices: "active" "down" "build" "error" "pending_create" "pending_update" "pending_delete"
subnet string	Name or ID of subnet.
timeout integer	How long should ansible wait for the requested resource. Default: 180
validate_certs aliases: verify boolean	Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to yes. Choices: false true
vpn_service string	Name or ID of VPN service.
wait boolean	Should ansible wait until the requested resource is complete. Choices: false true ← (default)

Notes

Note

• The standard OpenStack environment variables, such as OS_USERNAME may be used instead of providing explicit values.

• Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at https://docs.openstack.org/openstacksdk/

Examples

# Get VPN Services (all parameters are specified)
- opentelekomcloud.cloud.vpn_service_info:
    admin_state_up: true
    description: "This is description"
    external_v4_ip: "172.32.1.11"
    external_v6_ip: "2001:db8::1"
    router: "66e3b16c-8ce5-40fb-bb49-ab6d8dc3f2aa"
    status: "PENDING_CREATE"
    subnet: "14067794-975d-461e-b502-dd40c0383d26"
    project_id: "959db9b6000d4a1fa1c6fd17b6820f00"
    vpn_service: "test_vpn"
  register: vpn_services

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
vpnservices complex	Specifies the VPN service object Returned: On Success
admin_state_up boolean	Specifies the administrative status. Returned: success Sample: true
description string	Provides supplementary information about the VPN service. Returned: success Sample: "This is description"
external_v4_ip string	Specifies the IPv4 address of the VPN service external gateway. Returned: success Sample: "172.32.1.11"
external_v6_ip string	Specifies the IPv6 address of the VPN service external gateway. Returned: success Sample: "2001:db8::1"
id string	Specifies the VPN service ID. Returned: success Sample: "5c561d9d-eaea-45f6-ae3e-08d1a7080828"
name string	Specifies the VPN service name. Returned: success Sample: "test_vpn_service"
project_id string	Specifies the project ID Returned: success Sample: "10039663455a446d8ba2cbb058b0f578"
router_id string	Specifies the router ID. Returned: success Sample: "66e3b16c-8ce5-40fb-bb49-ab6d8dc3f2aa"
status string	Specifies whether the VPN service is currently operational. Returned: success Sample: "PENDING_CREATE"
subnet_id string	Specifies the subnet ID Returned: success

Authors

• Irina Pereiaslavskaia (@irina-pereiaslavskaia)

Collection links

• Issue Tracker
• Homepage
• Repository (Sources)

last updated: 2024-11-15 11:10 UTC - commit: 50bda984453bb05944b37f6d85b6380fcf26d10b