mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-05-08 06:12:51 +00:00
cloudstack: streamline modules doc (part 6) (#54641)
* Parameter types added * Copyright format fixes * Doc style fixes * Examples format fixes * validate-module errors fixes
This commit is contained in:
committed by
René Moser
parent
6a27e308dd
commit
eff1f8851c
@@ -18,43 +18,51 @@ module: cs_vpn_customer_gateway
|
||||
short_description: Manages site-to-site VPN customer gateway configurations on Apache CloudStack based clouds.
|
||||
description:
|
||||
- Create, update and remove VPN customer gateways.
|
||||
version_added: "2.5"
|
||||
author: "René Moser (@resmo)"
|
||||
version_added: '2.5'
|
||||
author: René Moser (@resmo)
|
||||
options:
|
||||
name:
|
||||
description:
|
||||
- Name of the gateway.
|
||||
type: str
|
||||
required: true
|
||||
cidrs:
|
||||
description:
|
||||
- List of guest CIDRs behind the gateway.
|
||||
- Required if C(state=present).
|
||||
- Required if I(state=present).
|
||||
type: list
|
||||
aliases: [ cidr ]
|
||||
gateway:
|
||||
description:
|
||||
- Public IP address of the gateway.
|
||||
- Required if C(state=present).
|
||||
- Required if I(state=present).
|
||||
type: str
|
||||
esp_policy:
|
||||
description:
|
||||
- ESP policy in the format e.g. C(aes256-sha1;modp1536).
|
||||
- Required if C(state=present).
|
||||
- Required if I(state=present).
|
||||
type: str
|
||||
ike_policy:
|
||||
description:
|
||||
- IKE policy in the format e.g. C(aes256-sha1;modp1536).
|
||||
- Required if C(state=present).
|
||||
- Required if I(state=present).
|
||||
type: str
|
||||
ipsec_psk:
|
||||
description:
|
||||
- IPsec Preshared-Key.
|
||||
- Cannot contain newline or double quotes.
|
||||
- Required if C(state=present).
|
||||
- Required if I(state=present).
|
||||
type: str
|
||||
ike_lifetime:
|
||||
description:
|
||||
- Lifetime in seconds of phase 1 VPN connection.
|
||||
- Defaulted to 86400 by the API on creation if not set.
|
||||
type: int
|
||||
esp_lifetime:
|
||||
description:
|
||||
- Lifetime in seconds of phase 2 VPN connection.
|
||||
- Defaulted to 3600 by the API on creation if not set.
|
||||
type: int
|
||||
dpd:
|
||||
description:
|
||||
- Enable Dead Peer Detection.
|
||||
@@ -68,29 +76,32 @@ options:
|
||||
state:
|
||||
description:
|
||||
- State of the VPN customer gateway.
|
||||
type: str
|
||||
default: present
|
||||
choices: [ present, absent ]
|
||||
domain:
|
||||
description:
|
||||
- Domain the VPN customer gateway is related to.
|
||||
type: str
|
||||
account:
|
||||
description:
|
||||
- Account the VPN customer gateway is related to.
|
||||
type: str
|
||||
project:
|
||||
description:
|
||||
- Name of the project the VPN gateway is related to.
|
||||
type: str
|
||||
poll_async:
|
||||
description:
|
||||
- Poll async jobs until job has finished.
|
||||
default: true
|
||||
default: yes
|
||||
type: bool
|
||||
extends_documentation_fragment: cloudstack
|
||||
'''
|
||||
|
||||
EXAMPLES = r'''
|
||||
- name: Create a vpn customer gateway
|
||||
local_action:
|
||||
module: cs_vpn_customer_gateway
|
||||
cs_vpn_customer_gateway:
|
||||
name: my vpn customer gateway
|
||||
cidrs:
|
||||
- 192.168.123.0/24
|
||||
@@ -99,12 +110,13 @@ EXAMPLES = r'''
|
||||
gateway: 10.10.1.1
|
||||
ike_policy: aes256-sha1;modp1536
|
||||
ipsec_psk: "S3cr3Tk3Y"
|
||||
delegate_to: localhost
|
||||
|
||||
- name: Remove a vpn customer gateway
|
||||
local_action:
|
||||
module: cs_vpn_customer_gateway
|
||||
cs_vpn_customer_gateway:
|
||||
name: my vpn customer gateway
|
||||
state: absent
|
||||
delegate_to: localhost
|
||||
'''
|
||||
|
||||
RETURN = r'''
|
||||
|
||||
Reference in New Issue
Block a user