vpn_service_info

updated: None

vpn_service_info

Note

This plugin is part of the opentelekomcloud.cloud collection (version 0.0.1).

To install it use: ansible-galaxy collection install opentelekomcloud.cloud.

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

New in version 0.5.0: of opentelekomcloud.cloud

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 Choices/Defaults Comments
admin_state_up
boolean
    Choices:
  • no
  • yes
Specifies the administrative status.
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
string
A path to a CA Cert bundle that can be used as part of verifying SSL API requests.

aliases: cacert
client_cert
string
A path to a client certificate to use as part of the SSL transaction.

aliases: cert
client_key
string
A path to a client key to use as part of the SSL transaction.

aliases: key
cloud
raw
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
string
    Choices:
  • admin
  • internal
  • public ←
Endpoint URL type to fetch from the service catalog.

aliases: endpoint_type
project_id
string
Specifies the project ID
region_name
string
Name of the region.
router
string
Name or ID of router.
status
string
    Choices:
  • active
  • down
  • build
  • error
  • pending_create
  • pending_update
  • pending_delete
Specifies whether the VPN service is currently operational.
subnet
string
Name or ID of subnet.
timeout
integer
Default:
180
How long should ansible wait for the requested resource.
validate_certs
boolean
    Choices:
  • no ←
  • yes
Whether or not SSL API requests should be verified.
Before Ansible 2.3 this defaulted to yes.

aliases: verify
vpn_service
string
Name or ID of VPN service.
wait
boolean
    Choices:
  • no
  • yes ←
Should ansible wait until the requested resource is complete.

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 Returned Description
vpnservices
complex
On Success
Specifies the VPN service object
 
admin_state_up
boolean
success
Specifies the administrative status.

Sample:
True
 
description
string
success
Provides supplementary information about the VPN service.

Sample:
This is description
 
external_v4_ip
string
success
Specifies the IPv4 address of the VPN service external gateway.

Sample:
172.32.1.11
 
external_v6_ip
string
success
Specifies the IPv6 address of the VPN service external gateway.

Sample:
2001:db8::1
 
id
string
success
Specifies the VPN service ID.

Sample:
5c561d9d-eaea-45f6-ae3e-08d1a7080828
 
name
string
success
Specifies the VPN service name.

Sample:
test_vpn_service
 
project_id
string
success
Specifies the project ID

Sample:
10039663455a446d8ba2cbb058b0f578
 
router_id
string
success
Specifies the router ID.

Sample:
66e3b16c-8ce5-40fb-bb49-ab6d8dc3f2aa
 
status
string
success
Specifies whether the VPN service is currently operational.

Sample:
PENDING_CREATE
 
subnet_id
string
success
Specifies the subnet ID


Authors

  • Irina Pereiaslavskaia (@irina-pereiaslavskaia)

updated: None