Adds documentation fragment to bigip modules
This patch removes the common documentation bits and replaces them with a doc fragment that already exists in core
This commit is contained in:
parent
8e9ac4a04d
commit
5399deff0b
9 changed files with 9 additions and 274 deletions
|
@ -36,44 +36,6 @@ notes:
|
||||||
requirements:
|
requirements:
|
||||||
- bigsuds
|
- bigsuds
|
||||||
options:
|
options:
|
||||||
server:
|
|
||||||
description:
|
|
||||||
- BIG-IP host
|
|
||||||
required: true
|
|
||||||
default: null
|
|
||||||
choices: []
|
|
||||||
aliases: []
|
|
||||||
server_port:
|
|
||||||
description:
|
|
||||||
- BIG-IP server port
|
|
||||||
required: false
|
|
||||||
default: 443
|
|
||||||
version_added: "2.2"
|
|
||||||
user:
|
|
||||||
description:
|
|
||||||
- BIG-IP username
|
|
||||||
required: true
|
|
||||||
default: null
|
|
||||||
choices: []
|
|
||||||
aliases: []
|
|
||||||
password:
|
|
||||||
description:
|
|
||||||
- BIG-IP password
|
|
||||||
required: true
|
|
||||||
default: null
|
|
||||||
choices: []
|
|
||||||
aliases: []
|
|
||||||
validate_certs:
|
|
||||||
description:
|
|
||||||
- If C(no), SSL certificates will not be validated. This should only be used
|
|
||||||
on personally controlled sites. Prior to 2.0, this module would always
|
|
||||||
validate on python >= 2.7.9 and never validate on python <= 2.7.8
|
|
||||||
required: false
|
|
||||||
default: yes
|
|
||||||
choices:
|
|
||||||
- yes
|
|
||||||
- no
|
|
||||||
version_added: 2.0
|
|
||||||
session:
|
session:
|
||||||
description:
|
description:
|
||||||
- BIG-IP session support; may be useful to avoid concurrency
|
- BIG-IP session support; may be useful to avoid concurrency
|
||||||
|
@ -115,6 +77,7 @@ options:
|
||||||
default: null
|
default: null
|
||||||
choices: []
|
choices: []
|
||||||
aliases: []
|
aliases: []
|
||||||
|
extends_documentation_fragment: f5
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|
|
@ -37,23 +37,6 @@ notes:
|
||||||
requirements:
|
requirements:
|
||||||
- bigsuds
|
- bigsuds
|
||||||
options:
|
options:
|
||||||
server:
|
|
||||||
description:
|
|
||||||
- BIG-IP host
|
|
||||||
required: true
|
|
||||||
server_port:
|
|
||||||
description:
|
|
||||||
- BIG-IP server port
|
|
||||||
required: false
|
|
||||||
default: 443
|
|
||||||
user:
|
|
||||||
description:
|
|
||||||
- BIG-IP username
|
|
||||||
required: true
|
|
||||||
password:
|
|
||||||
description:
|
|
||||||
- BIG-IP password
|
|
||||||
required: true
|
|
||||||
state:
|
state:
|
||||||
description:
|
description:
|
||||||
- Virtual server state
|
- Virtual server state
|
||||||
|
@ -79,6 +62,7 @@ options:
|
||||||
- Virtual server port
|
- Virtual server port
|
||||||
required: false
|
required: false
|
||||||
default: None
|
default: None
|
||||||
|
extends_documentation_fragment: f5
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|
|
@ -37,24 +37,6 @@ notes:
|
||||||
requirements:
|
requirements:
|
||||||
- bigsuds
|
- bigsuds
|
||||||
options:
|
options:
|
||||||
server:
|
|
||||||
description:
|
|
||||||
- BIG-IP host
|
|
||||||
required: true
|
|
||||||
server_port:
|
|
||||||
description:
|
|
||||||
- BIG-IP server port
|
|
||||||
required: false
|
|
||||||
default: 443
|
|
||||||
version_added: "2.2"
|
|
||||||
user:
|
|
||||||
description:
|
|
||||||
- BIG-IP username
|
|
||||||
required: true
|
|
||||||
password:
|
|
||||||
description:
|
|
||||||
- BIG-IP password
|
|
||||||
required: true
|
|
||||||
lb_method:
|
lb_method:
|
||||||
description:
|
description:
|
||||||
- LB method of wide ip
|
- LB method of wide ip
|
||||||
|
@ -64,17 +46,11 @@ options:
|
||||||
'vs_capacity', 'least_conn', 'lowest_rtt', 'lowest_hops',
|
'vs_capacity', 'least_conn', 'lowest_rtt', 'lowest_hops',
|
||||||
'packet_rate', 'cpu', 'hit_ratio', 'qos', 'bps',
|
'packet_rate', 'cpu', 'hit_ratio', 'qos', 'bps',
|
||||||
'drop_packet', 'explicit_ip', 'connection_rate', 'vs_score']
|
'drop_packet', 'explicit_ip', 'connection_rate', 'vs_score']
|
||||||
validate_certs:
|
|
||||||
description:
|
|
||||||
- If C(no), SSL certificates will not be validated. This should only be
|
|
||||||
used on personally controlled sites using self-signed certificates.
|
|
||||||
required: false
|
|
||||||
default: true
|
|
||||||
version_added: "2.2"
|
|
||||||
wide_ip:
|
wide_ip:
|
||||||
description:
|
description:
|
||||||
- Wide IP name
|
- Wide IP name
|
||||||
required: true
|
required: true
|
||||||
|
extends_documentation_fragment: f5
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|
|
@ -38,38 +38,6 @@ notes:
|
||||||
requirements:
|
requirements:
|
||||||
- bigsuds
|
- bigsuds
|
||||||
options:
|
options:
|
||||||
server:
|
|
||||||
description:
|
|
||||||
- BIG-IP host
|
|
||||||
required: true
|
|
||||||
default: null
|
|
||||||
server_port:
|
|
||||||
description:
|
|
||||||
- BIG-IP server port
|
|
||||||
required: false
|
|
||||||
default: 443
|
|
||||||
version_added: "2.2"
|
|
||||||
user:
|
|
||||||
description:
|
|
||||||
- BIG-IP username
|
|
||||||
required: true
|
|
||||||
default: null
|
|
||||||
password:
|
|
||||||
description:
|
|
||||||
- BIG-IP password
|
|
||||||
required: true
|
|
||||||
default: null
|
|
||||||
validate_certs:
|
|
||||||
description:
|
|
||||||
- If C(no), SSL certificates will not be validated. This should only be used
|
|
||||||
on personally controlled sites. Prior to 2.0, this module would always
|
|
||||||
validate on python >= 2.7.9 and never validate on python <= 2.7.8
|
|
||||||
required: false
|
|
||||||
default: 'yes'
|
|
||||||
choices:
|
|
||||||
- yes
|
|
||||||
- no
|
|
||||||
version_added: 2.0
|
|
||||||
state:
|
state:
|
||||||
description:
|
description:
|
||||||
- Monitor state
|
- Monitor state
|
||||||
|
@ -153,6 +121,7 @@ options:
|
||||||
from the node. The default API setting is 0.
|
from the node. The default API setting is 0.
|
||||||
required: false
|
required: false
|
||||||
default: none
|
default: none
|
||||||
|
extends_documentation_fragment: f5
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|
|
@ -36,38 +36,6 @@ notes:
|
||||||
requirements:
|
requirements:
|
||||||
- bigsuds
|
- bigsuds
|
||||||
options:
|
options:
|
||||||
server:
|
|
||||||
description:
|
|
||||||
- BIG-IP host
|
|
||||||
required: true
|
|
||||||
default: null
|
|
||||||
server_port:
|
|
||||||
description:
|
|
||||||
- BIG-IP server port
|
|
||||||
required: false
|
|
||||||
default: 443
|
|
||||||
version_added: "2.2"
|
|
||||||
user:
|
|
||||||
description:
|
|
||||||
- BIG-IP username
|
|
||||||
required: true
|
|
||||||
default: null
|
|
||||||
password:
|
|
||||||
description:
|
|
||||||
- BIG-IP password
|
|
||||||
required: true
|
|
||||||
default: null
|
|
||||||
validate_certs:
|
|
||||||
description:
|
|
||||||
- If C(no), SSL certificates will not be validated. This should only be used
|
|
||||||
on personally controlled sites. Prior to 2.0, this module would always
|
|
||||||
validate on python >= 2.7.9 and never validate on python <= 2.7.8
|
|
||||||
required: false
|
|
||||||
default: 'yes'
|
|
||||||
choices:
|
|
||||||
- yes
|
|
||||||
- no
|
|
||||||
version_added: 2.0
|
|
||||||
state:
|
state:
|
||||||
description:
|
description:
|
||||||
- Monitor state
|
- Monitor state
|
||||||
|
@ -159,6 +127,7 @@ options:
|
||||||
from the node. The default API setting is 0.
|
from the node. The default API setting is 0.
|
||||||
required: false
|
required: false
|
||||||
default: none
|
default: none
|
||||||
|
extends_documentation_fragment: f5
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|
|
@ -35,42 +35,6 @@ notes:
|
||||||
requirements:
|
requirements:
|
||||||
- bigsuds
|
- bigsuds
|
||||||
options:
|
options:
|
||||||
server:
|
|
||||||
description:
|
|
||||||
- BIG-IP host
|
|
||||||
required: true
|
|
||||||
default: null
|
|
||||||
choices: []
|
|
||||||
aliases: []
|
|
||||||
server_port:
|
|
||||||
description:
|
|
||||||
- BIG-IP server port
|
|
||||||
required: false
|
|
||||||
default: 443
|
|
||||||
version_added: "2.2"
|
|
||||||
user:
|
|
||||||
description:
|
|
||||||
- BIG-IP username
|
|
||||||
required: true
|
|
||||||
default: null
|
|
||||||
choices: []
|
|
||||||
aliases: []
|
|
||||||
password:
|
|
||||||
description:
|
|
||||||
- BIG-IP password
|
|
||||||
required: true
|
|
||||||
default: null
|
|
||||||
choices: []
|
|
||||||
aliases: []
|
|
||||||
validate_certs:
|
|
||||||
description:
|
|
||||||
- If C(no), SSL certificates will not be validated. This should only be used
|
|
||||||
on personally controlled sites. Prior to 2.0, this module would always
|
|
||||||
validate on python >= 2.7.9 and never validate on python <= 2.7.8
|
|
||||||
required: false
|
|
||||||
default: 'yes'
|
|
||||||
choices: ['yes', 'no']
|
|
||||||
version_added: 2.0
|
|
||||||
state:
|
state:
|
||||||
description:
|
description:
|
||||||
- Pool member state
|
- Pool member state
|
||||||
|
@ -144,6 +108,7 @@ options:
|
||||||
required: false
|
required: false
|
||||||
default: null
|
default: null
|
||||||
choices: []
|
choices: []
|
||||||
|
extends_documentation_fragment: f5
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|
|
@ -35,44 +35,6 @@ notes:
|
||||||
requirements:
|
requirements:
|
||||||
- bigsuds
|
- bigsuds
|
||||||
options:
|
options:
|
||||||
server:
|
|
||||||
description:
|
|
||||||
- BIG-IP host
|
|
||||||
required: true
|
|
||||||
default: null
|
|
||||||
choices: []
|
|
||||||
aliases: []
|
|
||||||
server_port:
|
|
||||||
description:
|
|
||||||
- BIG-IP server port
|
|
||||||
required: false
|
|
||||||
default: 443
|
|
||||||
version_added: "2.2"
|
|
||||||
user:
|
|
||||||
description:
|
|
||||||
- BIG-IP username
|
|
||||||
required: true
|
|
||||||
default: null
|
|
||||||
choices: []
|
|
||||||
aliases: []
|
|
||||||
password:
|
|
||||||
description:
|
|
||||||
- BIG-IP password
|
|
||||||
required: true
|
|
||||||
default: null
|
|
||||||
choices: []
|
|
||||||
aliases: []
|
|
||||||
validate_certs:
|
|
||||||
description:
|
|
||||||
- If C(no), SSL certificates will not be validated. This should only be used
|
|
||||||
on personally controlled sites. Prior to 2.0, this module would always
|
|
||||||
validate on python >= 2.7.9 and never validate on python <= 2.7.8
|
|
||||||
required: false
|
|
||||||
default: 'yes'
|
|
||||||
choices:
|
|
||||||
- yes
|
|
||||||
- no
|
|
||||||
version_added: 2.0
|
|
||||||
state:
|
state:
|
||||||
description:
|
description:
|
||||||
- Pool/pool member state
|
- Pool/pool member state
|
||||||
|
@ -194,6 +156,7 @@ options:
|
||||||
default: null
|
default: null
|
||||||
choices: []
|
choices: []
|
||||||
aliases: []
|
aliases: []
|
||||||
|
extends_documentation_fragment: f5
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|
|
@ -36,35 +36,6 @@ notes:
|
||||||
requirements:
|
requirements:
|
||||||
- bigsuds
|
- bigsuds
|
||||||
options:
|
options:
|
||||||
server:
|
|
||||||
description:
|
|
||||||
- BIG-IP host
|
|
||||||
required: true
|
|
||||||
server_port:
|
|
||||||
description:
|
|
||||||
- BIG-IP server port
|
|
||||||
required: false
|
|
||||||
default: 443
|
|
||||||
version_added: "2.2"
|
|
||||||
user:
|
|
||||||
description:
|
|
||||||
- BIG-IP username
|
|
||||||
required: true
|
|
||||||
password:
|
|
||||||
description:
|
|
||||||
- BIG-IP password
|
|
||||||
required: true
|
|
||||||
validate_certs:
|
|
||||||
description:
|
|
||||||
- If C(no), SSL certificates will not be validated. This should only be used
|
|
||||||
on personally controlled sites. Prior to 2.0, this module would always
|
|
||||||
validate on python >= 2.7.9 and never validate on python <= 2.7.8
|
|
||||||
required: false
|
|
||||||
default: 'yes'
|
|
||||||
choices:
|
|
||||||
- yes
|
|
||||||
- no
|
|
||||||
version_added: 2.0
|
|
||||||
state:
|
state:
|
||||||
description:
|
description:
|
||||||
- Pool member state
|
- Pool member state
|
||||||
|
@ -145,6 +116,7 @@ options:
|
||||||
- yes
|
- yes
|
||||||
- no
|
- no
|
||||||
version_added: 2.1
|
version_added: 2.1
|
||||||
|
extends_documentation_fragment: f5
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|
|
@ -35,33 +35,6 @@ notes:
|
||||||
requirements:
|
requirements:
|
||||||
- bigsuds
|
- bigsuds
|
||||||
options:
|
options:
|
||||||
server:
|
|
||||||
description:
|
|
||||||
- BIG-IP host
|
|
||||||
required: true
|
|
||||||
server_port:
|
|
||||||
description:
|
|
||||||
- BIG-IP server port
|
|
||||||
required: false
|
|
||||||
default: 443
|
|
||||||
version_added: "2.2"
|
|
||||||
user:
|
|
||||||
description:
|
|
||||||
- BIG-IP username
|
|
||||||
required: true
|
|
||||||
password:
|
|
||||||
description:
|
|
||||||
- BIG-IP password
|
|
||||||
required: true
|
|
||||||
validate_certs:
|
|
||||||
description:
|
|
||||||
- If C(no), SSL certificates will not be validated. This should only be used
|
|
||||||
on personally controlled sites using self-signed certificates.
|
|
||||||
required: false
|
|
||||||
default: 'yes'
|
|
||||||
choices:
|
|
||||||
- yes
|
|
||||||
- no
|
|
||||||
state:
|
state:
|
||||||
description:
|
description:
|
||||||
- Virtual Server state
|
- Virtual Server state
|
||||||
|
@ -133,6 +106,7 @@ options:
|
||||||
- Virtual server description
|
- Virtual server description
|
||||||
required: false
|
required: false
|
||||||
default: None
|
default: None
|
||||||
|
extends_documentation_fragment: f5
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|
Loading…
Reference in a new issue