mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
a10 - Use docs_fragments (#3281)
Remove duplicated documentation (common options defined in module_utils/a10.py). Also tidy up formatting.
This commit is contained in:
parent
0055360315
commit
9fa1afc39f
3 changed files with 13 additions and 127 deletions
|
@ -29,37 +29,22 @@ short_description: Manage A10 Networks AX/SoftAX/Thunder/vThunder devices
|
||||||
description:
|
description:
|
||||||
- Manage slb server objects on A10 Networks devices via aXAPI
|
- Manage slb server objects on A10 Networks devices via aXAPI
|
||||||
author: "Mischa Peters (@mischapeters)"
|
author: "Mischa Peters (@mischapeters)"
|
||||||
notes:
|
extends_documentation_fragment: a10
|
||||||
- Requires A10 Networks aXAPI 2.1
|
|
||||||
options:
|
options:
|
||||||
host:
|
|
||||||
description:
|
|
||||||
- hostname or ip of your A10 Networks device
|
|
||||||
required: true
|
|
||||||
username:
|
|
||||||
description:
|
|
||||||
- admin account of your A10 Networks device
|
|
||||||
required: true
|
|
||||||
aliases: ['user', 'admin']
|
|
||||||
password:
|
|
||||||
description:
|
|
||||||
- admin password of your A10 Networks device
|
|
||||||
required: true
|
|
||||||
aliases: ['pass', 'pwd']
|
|
||||||
server_name:
|
server_name:
|
||||||
description:
|
description:
|
||||||
- slb server name
|
- SLB server name.
|
||||||
required: true
|
required: true
|
||||||
aliases: ['server']
|
aliases: ['server']
|
||||||
server_ip:
|
server_ip:
|
||||||
description:
|
description:
|
||||||
- slb server IP address
|
- SLB server IP address.
|
||||||
required: false
|
required: false
|
||||||
default: null
|
default: null
|
||||||
aliases: ['ip', 'address']
|
aliases: ['ip', 'address']
|
||||||
server_status:
|
server_status:
|
||||||
description:
|
description:
|
||||||
- slb virtual server status
|
- SLB virtual server status.
|
||||||
required: false
|
required: false
|
||||||
default: enabled
|
default: enabled
|
||||||
aliases: ['status']
|
aliases: ['status']
|
||||||
|
@ -74,28 +59,10 @@ options:
|
||||||
default: null
|
default: null
|
||||||
state:
|
state:
|
||||||
description:
|
description:
|
||||||
- create, update or remove slb server
|
- Create, update or remove slb server.
|
||||||
required: false
|
required: false
|
||||||
default: present
|
default: present
|
||||||
choices: ['present', 'absent']
|
choices: ['present', 'absent']
|
||||||
write_config:
|
|
||||||
description:
|
|
||||||
- If C(yes), any changes will cause a write of the running configuration
|
|
||||||
to non-volatile memory. This will save I(all) configuration changes,
|
|
||||||
including those that may have been made manually or through other modules,
|
|
||||||
so care should be taken when specifying C(yes).
|
|
||||||
required: false
|
|
||||||
version_added: 2.2
|
|
||||||
default: "no"
|
|
||||||
choices: ["yes", "no"]
|
|
||||||
validate_certs:
|
|
||||||
description:
|
|
||||||
- If C(no), SSL certificates will not be validated. This should only be used
|
|
||||||
on personally controlled devices using self-signed certificates.
|
|
||||||
required: false
|
|
||||||
version_added: 2.2
|
|
||||||
default: 'yes'
|
|
||||||
choices: ['yes', 'no']
|
|
||||||
|
|
||||||
'''
|
'''
|
||||||
|
|
||||||
|
|
|
@ -30,47 +30,25 @@ description:
|
||||||
- Manage slb service-group objects on A10 Networks devices via aXAPI
|
- Manage slb service-group objects on A10 Networks devices via aXAPI
|
||||||
author: "Mischa Peters (@mischapeters)"
|
author: "Mischa Peters (@mischapeters)"
|
||||||
notes:
|
notes:
|
||||||
- Requires A10 Networks aXAPI 2.1
|
|
||||||
- When a server doesn't exist and is added to the service-group the server will be created
|
- When a server doesn't exist and is added to the service-group the server will be created
|
||||||
|
extends_documentation_fragment: a10
|
||||||
options:
|
options:
|
||||||
host:
|
|
||||||
description:
|
|
||||||
- hostname or ip of your A10 Networks device
|
|
||||||
required: true
|
|
||||||
default: null
|
|
||||||
aliases: []
|
|
||||||
choices: []
|
|
||||||
username:
|
|
||||||
description:
|
|
||||||
- admin account of your A10 Networks device
|
|
||||||
required: true
|
|
||||||
default: null
|
|
||||||
aliases: ['user', 'admin']
|
|
||||||
choices: []
|
|
||||||
password:
|
|
||||||
description:
|
|
||||||
- admin password of your A10 Networks device
|
|
||||||
required: true
|
|
||||||
default: null
|
|
||||||
aliases: ['pass', 'pwd']
|
|
||||||
choices: []
|
|
||||||
service_group:
|
service_group:
|
||||||
description:
|
description:
|
||||||
- slb service-group name
|
- SLB service-group name.
|
||||||
required: true
|
required: true
|
||||||
default: null
|
default: null
|
||||||
aliases: ['service', 'pool', 'group']
|
aliases: ['service', 'pool', 'group']
|
||||||
choices: []
|
|
||||||
service_group_protocol:
|
service_group_protocol:
|
||||||
description:
|
description:
|
||||||
- slb service-group protocol
|
- SLB service-group protocol.
|
||||||
required: false
|
required: false
|
||||||
default: tcp
|
default: tcp
|
||||||
aliases: ['proto', 'protocol']
|
aliases: ['proto', 'protocol']
|
||||||
choices: ['tcp', 'udp']
|
choices: ['tcp', 'udp']
|
||||||
service_group_method:
|
service_group_method:
|
||||||
description:
|
description:
|
||||||
- slb service-group loadbalancing method
|
- SLB service-group loadbalancing method.
|
||||||
required: false
|
required: false
|
||||||
default: round-robin
|
default: round-robin
|
||||||
aliases: ['method']
|
aliases: ['method']
|
||||||
|
@ -82,24 +60,6 @@ options:
|
||||||
specify the C(status:). See the examples below for details.
|
specify the C(status:). See the examples below for details.
|
||||||
required: false
|
required: false
|
||||||
default: null
|
default: null
|
||||||
aliases: []
|
|
||||||
choices: []
|
|
||||||
write_config:
|
|
||||||
description:
|
|
||||||
- If C(yes), any changes will cause a write of the running configuration
|
|
||||||
to non-volatile memory. This will save I(all) configuration changes,
|
|
||||||
including those that may have been made manually or through other modules,
|
|
||||||
so care should be taken when specifying C(yes).
|
|
||||||
required: false
|
|
||||||
default: "no"
|
|
||||||
choices: ["yes", "no"]
|
|
||||||
validate_certs:
|
|
||||||
description:
|
|
||||||
- If C(no), SSL certificates will not be validated. This should only be used
|
|
||||||
on personally controlled devices using self-signed certificates.
|
|
||||||
required: false
|
|
||||||
default: 'yes'
|
|
||||||
choices: ['yes', 'no']
|
|
||||||
|
|
||||||
'''
|
'''
|
||||||
|
|
||||||
|
|
|
@ -29,48 +29,23 @@ short_description: Manage A10 Networks devices' virtual servers
|
||||||
description:
|
description:
|
||||||
- Manage slb virtual server objects on A10 Networks devices via aXAPI
|
- Manage slb virtual server objects on A10 Networks devices via aXAPI
|
||||||
author: "Mischa Peters (@mischapeters)"
|
author: "Mischa Peters (@mischapeters)"
|
||||||
notes:
|
extends_documentation_fragment: a10
|
||||||
- Requires A10 Networks aXAPI 2.1
|
|
||||||
requirements: []
|
|
||||||
options:
|
options:
|
||||||
host:
|
|
||||||
description:
|
|
||||||
- hostname or ip of your A10 Networks device
|
|
||||||
required: true
|
|
||||||
default: null
|
|
||||||
aliases: []
|
|
||||||
choices: []
|
|
||||||
username:
|
|
||||||
description:
|
|
||||||
- admin account of your A10 Networks device
|
|
||||||
required: true
|
|
||||||
default: null
|
|
||||||
aliases: ['user', 'admin']
|
|
||||||
choices: []
|
|
||||||
password:
|
|
||||||
description:
|
|
||||||
- admin password of your A10 Networks device
|
|
||||||
required: true
|
|
||||||
default: null
|
|
||||||
aliases: ['pass', 'pwd']
|
|
||||||
choices: []
|
|
||||||
virtual_server:
|
virtual_server:
|
||||||
description:
|
description:
|
||||||
- slb virtual server name
|
- SLB virtual server name.
|
||||||
required: true
|
required: true
|
||||||
default: null
|
default: null
|
||||||
aliases: ['vip', 'virtual']
|
aliases: ['vip', 'virtual']
|
||||||
choices: []
|
|
||||||
virtual_server_ip:
|
virtual_server_ip:
|
||||||
description:
|
description:
|
||||||
- slb virtual server ip address
|
- SLB virtual server IP address.
|
||||||
required: false
|
required: false
|
||||||
default: null
|
default: null
|
||||||
aliases: ['ip', 'address']
|
aliases: ['ip', 'address']
|
||||||
choices: []
|
|
||||||
virtual_server_status:
|
virtual_server_status:
|
||||||
description:
|
description:
|
||||||
- slb virtual server status
|
- SLB virtual server status.
|
||||||
required: false
|
required: false
|
||||||
default: enable
|
default: enable
|
||||||
aliases: ['status']
|
aliases: ['status']
|
||||||
|
@ -82,22 +57,6 @@ options:
|
||||||
specify the C(service_group:) as well as the C(status:). See the examples
|
specify the C(service_group:) as well as the C(status:). See the examples
|
||||||
below for details. This parameter is required when C(state) is C(present).
|
below for details. This parameter is required when C(state) is C(present).
|
||||||
required: false
|
required: false
|
||||||
write_config:
|
|
||||||
description:
|
|
||||||
- If C(yes), any changes will cause a write of the running configuration
|
|
||||||
to non-volatile memory. This will save I(all) configuration changes,
|
|
||||||
including those that may have been made manually or through other modules,
|
|
||||||
so care should be taken when specifying C(yes).
|
|
||||||
required: false
|
|
||||||
default: "no"
|
|
||||||
choices: ["yes", "no"]
|
|
||||||
validate_certs:
|
|
||||||
description:
|
|
||||||
- If C(no), SSL certificates will not be validated. This should only be used
|
|
||||||
on personally controlled devices using self-signed certificates.
|
|
||||||
required: false
|
|
||||||
default: 'yes'
|
|
||||||
choices: ['yes', 'no']
|
|
||||||
|
|
||||||
'''
|
'''
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue