opentelekomcloud / opentelekomcloud.cloud / 0.6.0 / module / vpn_service_info Query VPN services. | "added in version" 0.5.0 of opentelekomcloud.cloud" Authors: Irina Pereiaslavskaia (@irina-pereiaslavskaia)opentelekomcloud.cloud.vpn_service_info (0.6.0) — module
Install with ansible-galaxy collection install opentelekomcloud.cloud:==0.6.0
collections: - name: opentelekomcloud.cloud version: 0.6.0
This module is used to query VPN services.
# 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
auth: description: - Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default I(password) plugin, this would contain I(auth_url), I(username), I(password), I(project_name) and any information about domains (for example, I(os_user_domain_name) or I(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. type: dict wait: default: true description: - Should ansible wait until the requested resource is complete. type: bool cloud: description: - Named cloud or cloud config to operate against. If I(cloud) is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for I(auth) and I(auth_type). This parameter is not needed if I(auth) is provided or if OpenStack OS_* environment variables are present. If I(cloud) is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. type: raw router: description: Name or ID of router. type: str status: choices: - active - down - build - error - pending_create - pending_update - pending_delete description: Specifies whether the VPN service is currently operational. type: str subnet: description: Name or ID of subnet. type: str ca_cert: aliases: - cacert description: - A path to a CA Cert bundle that can be used as part of verifying SSL API requests. type: str timeout: default: 180 description: - How long should ansible wait for the requested resource. type: int auth_type: description: - 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 I(auth) parameter should be updated accordingly. type: str interface: aliases: - endpoint_type choices: - admin - internal - public default: public description: - Endpoint URL type to fetch from the service catalog. type: str client_key: aliases: - key description: - A path to a client key to use as part of the SSL transaction. type: str project_id: description: Specifies the project ID type: str api_timeout: description: - 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. type: int client_cert: aliases: - cert description: - A path to a client certificate to use as part of the SSL transaction. type: str description: description: Provides supplementary information about the VPN service. type: str region_name: description: - Name of the region. type: str vpn_service: description: Name or ID of VPN service. type: str admin_state_up: description: Specifies the administrative status. type: bool external_v4_ip: description: Specifies the IPv4 address of the VPN service external gateway. type: str external_v6_ip: description: Specifies the IPv6 address of the VPN service external gateway. type: str validate_certs: aliases: - verify default: false description: - Whether or not SSL API requests should be verified. - Before Ansible 2.3 this defaulted to C(yes). type: bool
vpnservices: contains: admin_state_up: description: Specifies the administrative status. sample: true type: bool description: description: Provides supplementary information about the VPN service. sample: This is description type: str external_v4_ip: description: - Specifies the IPv4 address of the VPN service external gateway. sample: 172.32.1.11 type: str external_v6_ip: description: - Specifies the IPv6 address of the VPN service external gateway. sample: 2001:db8::1 type: str id: description: Specifies the VPN service ID. sample: 5c561d9d-eaea-45f6-ae3e-08d1a7080828 type: str name: description: Specifies the VPN service name. sample: test_vpn_service type: str project_id: description: Specifies the project ID sample: 10039663455a446d8ba2cbb058b0f578 type: str router_id: description: Specifies the router ID. sample: 66e3b16c-8ce5-40fb-bb49-ab6d8dc3f2aa type: str status: description: - Specifies whether the VPN service is currently operational. sample: PENDING_CREATE type: str subnet_id: description: Specifies the subnet ID type: str description: Specifies the VPN service object returned: On Success type: complex