Created
July 18, 2018 13:25
-
-
Save versionsix/31ea2d7c89c5a946edf3f99f561e0b03 to your computer and use it in GitHub Desktop.
atom ansible snippets
This file has been truncated, but you can view the full file.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
'.source.ansible': | |
'a10_server': | |
'prefix': "a10_server_snippet" | |
'description': "Manage A10 Networks AX/SoftAX/Thunder/vThunder devices' server object." | |
'body': """ | |
a10_server: | |
username: ${1:null} # required. An account with administrator privileges. | |
host: ${2:null} # required. Hostname or IP of the A10 Networks device. | |
password: ${3:null} # required. Password for the C(username) account. | |
server_name: ${4:undefined} # required. The SLB (Server Load Balancer) server name. | |
force: ${5:false} # not required. If C(yes) do not get a cached copy. | |
write_config: ${6|yes,no|} # not required. choices: yes;no. 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). | |
server_ports: ${7:null} # not required. A list of ports to create for the server. Each list item should be a dictionary which specifies the C(port:) and C(protocol:), but can also optionally specify the C(status:). See the examples below for details. This parameter is required when C(state) is C(present). | |
force_basic_auth: ${8:false} # not required. Credentials specified with I(url_username) and I(url_password) should be passed in HTTP Header. | |
http_agent: ${9:ansible-httpget} # not required. Header to identify as, generally appears in web server logs. | |
url_username: ${10:undefined} # not required. The username for use in HTTP basic authentication.,This parameter can be used without I(url_password) for sites that allow empty passwords | |
client_key: ${11:undefined} # not required. PEM formatted file that contains your private key to be used for SSL client authentication. If C(client_cert) contains both the certificate and key, this option is not required. | |
url_password: ${12:undefined} # not required. The password for use in HTTP basic authentication.,If the I(url_username) parameter is not specified, the I(url_password) parameter will not be used. | |
use_proxy: ${13:true} # not required. If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. | |
url: ${14:undefined} # not required. HTTP, HTTPS, or FTP URL in the form (http|https|ftp)://[user[:pass]]@host.domain[:port]/path | |
partition: ${15:null} # not required. set active-partition | |
server_status: ${16|enabled,disabled|} # not required. choices: enabled;disabled. The SLB virtual server status. | |
state: ${17|present,absent|} # not required. choices: present;absent. This is to specify the operation to create, update or remove SLB server. | |
server_ip: ${18:null} # not required. The SLB server IPv4 address. | |
validate_certs: ${19|yes,no|} # not required. choices: yes;no. If C(no), SSL certificates will not be validated. This should only be used on personally controlled devices using self-signed certificates. | |
client_cert: ${20:undefined} # not required. PEM formatted certificate chain file to be used for SSL client authentication. This file can also include the key as well, and if the key is included, C(client_key) is not required. | |
""" | |
'a10_server_axapi3': | |
'prefix': "a10_server_axapi3_snippet" | |
'description': "Manage A10 Networks AX/SoftAX/Thunder/vThunder devices" | |
'body': """ | |
a10_server_axapi3: | |
username: ${1:null} # required. An account with administrator privileges. | |
host: ${2:null} # required. Hostname or IP of the A10 Networks device. | |
password: ${3:null} # required. Password for the C(username) account. | |
server_name: ${4:undefined} # required. The SLB (Server Load Balancer) server name. | |
server_ip: ${5:undefined} # required. The SLB (Server Load Balancer) server IPv4 address. | |
force: ${6:false} # not required. If C(yes) do not get a cached copy. | |
write_config: ${7|yes,no|} # not required. choices: yes;no. 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). | |
server_ports: ${8:null} # not required. A list of ports to create for the server. Each list item should be a dictionary which specifies the C(port:) and C(protocol:). | |
force_basic_auth: ${9:false} # not required. Credentials specified with I(url_username) and I(url_password) should be passed in HTTP Header. | |
http_agent: ${10:ansible-httpget} # not required. Header to identify as, generally appears in web server logs. | |
url_username: ${11:undefined} # not required. The username for use in HTTP basic authentication.,This parameter can be used without I(url_password) for sites that allow empty passwords | |
operation: ${12|create,update,remove|} # not required. choices: create;update;remove. Create, Update or Remove SLB server. For create and update operation, we use the IP address and server name specified in the POST message. For delete operation, we use the server name in the request URI. | |
client_key: ${13:undefined} # not required. PEM formatted file that contains your private key to be used for SSL client authentication. If C(client_cert) contains both the certificate and key, this option is not required. | |
url_password: ${14:undefined} # not required. The password for use in HTTP basic authentication.,If the I(url_username) parameter is not specified, the I(url_password) parameter will not be used. | |
use_proxy: ${15:true} # not required. If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. | |
url: ${16:undefined} # not required. HTTP, HTTPS, or FTP URL in the form (http|https|ftp)://[user[:pass]]@host.domain[:port]/path | |
server_status: ${17|enable,disable|} # not required. choices: enable;disable. The SLB (Server Load Balancer) virtual server status. | |
validate_certs: ${18|yes,no|} # not required. choices: yes;no. If C(no), SSL certificates will not be validated. This should only be used on personally controlled devices using self-signed certificates. | |
client_cert: ${19:undefined} # not required. PEM formatted certificate chain file to be used for SSL client authentication. This file can also include the key as well, and if the key is included, C(client_key) is not required. | |
""" | |
'a10_service_group': | |
'prefix': "a10_service_group_snippet" | |
'description': "Manage A10 Networks AX/SoftAX/Thunder/vThunder devices' service groups." | |
'body': """ | |
a10_service_group: | |
username: ${1:null} # required. An account with administrator privileges. | |
password: ${2:null} # required. Password for the C(username) account. | |
service_group: ${3:null} # required. The SLB (Server Load Balancing) service-group name | |
host: ${4:null} # required. Hostname or IP of the A10 Networks device. | |
force: ${5:false} # not required. If C(yes) do not get a cached copy. | |
url_username: ${6:undefined} # not required. The username for use in HTTP basic authentication.,This parameter can be used without I(url_password) for sites that allow empty passwords | |
force_basic_auth: ${7:false} # not required. Credentials specified with I(url_username) and I(url_password) should be passed in HTTP Header. | |
servers: ${8:null} # not required. A list of servers to add to the service group. Each list item should be a dictionary which specifies the C(server:) and C(port:), but can also optionally specify the C(status:). See the examples below for details. | |
http_agent: ${9:ansible-httpget} # not required. Header to identify as, generally appears in web server logs. | |
service_group_protocol: ${10|tcp,udp|} # not required. choices: tcp;udp. The SLB service-group protocol of TCP or UDP. | |
client_key: ${11:undefined} # not required. PEM formatted file that contains your private key to be used for SSL client authentication. If C(client_cert) contains both the certificate and key, this option is not required. | |
url_password: ${12:undefined} # not required. The password for use in HTTP basic authentication.,If the I(url_username) parameter is not specified, the I(url_password) parameter will not be used. | |
use_proxy: ${13:true} # not required. If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. | |
url: ${14:undefined} # not required. HTTP, HTTPS, or FTP URL in the form (http|https|ftp)://[user[:pass]]@host.domain[:port]/path | |
partition: ${15:null} # not required. set active-partition | |
state: ${16|present,absent|} # not required. choices: present;absent. If the specified service group should exists. | |
write_config: ${17|yes,no|} # not required. choices: yes;no. 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). | |
service_group_method: ${18|round-robin,weighted-rr,least-connection,weighted-least-connection,service-least-connection,service-weighted-least-connection,fastest-response,least-request,round-robin-strict,src-ip-only-hash,src-ip-hash|} # not required. choices: round-robin;weighted-rr;least-connection;weighted-least-connection;service-least-connection;service-weighted-least-connection;fastest-response;least-request;round-robin-strict;src-ip-only-hash;src-ip-hash. The SLB service-group load balancing method, such as round-robin or weighted-rr. | |
validate_certs: ${19|yes,no|} # not required. choices: yes;no. If C(no), SSL certificates will not be validated. This should only be used on personally controlled devices using self-signed certificates. | |
client_cert: ${20:undefined} # not required. PEM formatted certificate chain file to be used for SSL client authentication. This file can also include the key as well, and if the key is included, C(client_key) is not required. | |
""" | |
'a10_virtual_server': | |
'prefix': "a10_virtual_server_snippet" | |
'description': "Manage A10 Networks AX/SoftAX/Thunder/vThunder devices' virtual servers." | |
'body': """ | |
a10_virtual_server: | |
username: ${1:null} # required. An account with administrator privileges. | |
host: ${2:null} # required. Hostname or IP of the A10 Networks device. | |
virtual_server: ${3:null} # required. The SLB (Server Load Balancing) virtual server name. | |
password: ${4:null} # required. Password for the C(username) account. | |
force: ${5:false} # not required. If C(yes) do not get a cached copy. | |
url_username: ${6:undefined} # not required. The username for use in HTTP basic authentication.,This parameter can be used without I(url_password) for sites that allow empty passwords | |
force_basic_auth: ${7:false} # not required. Credentials specified with I(url_username) and I(url_password) should be passed in HTTP Header. | |
virtual_server_ports: ${8:undefined} # not required. A list of ports to create for the virtual server. Each list item should be a dictionary which specifies the C(port:) and C(type:), but can also optionally 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). | |
http_agent: ${9:ansible-httpget} # not required. Header to identify as, generally appears in web server logs. | |
client_key: ${10:undefined} # not required. PEM formatted file that contains your private key to be used for SSL client authentication. If C(client_cert) contains both the certificate and key, this option is not required. | |
url_password: ${11:undefined} # not required. The password for use in HTTP basic authentication.,If the I(url_username) parameter is not specified, the I(url_password) parameter will not be used. | |
use_proxy: ${12:true} # not required. If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. | |
url: ${13:undefined} # not required. HTTP, HTTPS, or FTP URL in the form (http|https|ftp)://[user[:pass]]@host.domain[:port]/path | |
partition: ${14:null} # not required. set active-partition | |
state: ${15|present,absent|} # not required. choices: present;absent. If the specified virtual server should exist. | |
virtual_server_status: ${16|enabled,disabled|} # not required. choices: enabled;disabled. The SLB virtual server status, such as enabled or disabled. | |
write_config: ${17|yes,no|} # not required. choices: yes;no. 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). | |
virtual_server_ip: ${18:null} # not required. The SLB virtual server IPv4 address. | |
validate_certs: ${19|yes,no|} # not required. choices: yes;no. If C(no), SSL certificates will not be validated. This should only be used on personally controlled devices using self-signed certificates. | |
client_cert: ${20:undefined} # not required. PEM formatted certificate chain file to be used for SSL client authentication. This file can also include the key as well, and if the key is included, C(client_key) is not required. | |
""" | |
'accelerate': | |
'prefix': "accelerate_snippet" | |
'description': "Enable accelerated mode on remote node" | |
'body': """ | |
accelerate: | |
timeout: ${1:300} # not required. The number of seconds the socket will wait for data. If none is received when the timeout value is reached, the connection will be closed. | |
minutes: ${2:30} # not required. The I(accelerate) listener daemon is started on nodes and will stay around for this number of minutes before turning itself off. | |
port: ${3:5099} # not required. TCP port for the socket connection | |
multi_key: ${4:false} # not required. When enabled, the daemon will open a local socket file which can be used by future daemon executions to upload a new key to the already running daemon, so that multiple users can connect using different keys. This access still requires an ssh connection as the uid for which the daemon is currently running. | |
ipv6: ${5:false} # not required. The listener daemon on the remote host will bind to the ipv6 localhost socket if this parameter is set to true. | |
""" | |
'aci_aaa_user': | |
'prefix': "aci_aaa_user_snippet" | |
'description': "Manage AAA users (aaa:User)" | |
'body': """ | |
aci_aaa_user: | |
username: ${1:admin} # required. The username to use for authentication. | |
host: ${2:undefined} # required. IP Address or hostname of APIC resolvable by Ansible control host. | |
password: ${3:undefined} # required. The password to use for authentication. | |
last_name: ${4:undefined} # not required. The last name of the locally-authenticated user. | |
use_ssl: ${5:yes} # not required. If C(no), an HTTP connection will be used instead of the default HTTPS connection. | |
aaa_password: ${6:undefined} # not required. The password of the locally-authenticated user. | |
first_name: ${7:undefined} # not required. The first name of the locally-authenticated user. | |
use_proxy: ${8:yes} # not required. If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. | |
port: ${9:443 (for https) and 80 (for http)} # not required. Port number to be used for REST connection. | |
state: ${10|absent,present,query|} # not required. choices: absent;present;query. Use C(present) or C(absent) for adding or removing.,Use C(query) for listing an object or multiple objects. | |
email: ${11:undefined} # not required. The email address of the locally-authenticated user. | |
private_key: ${12:undefined} # not required. PEM formatted file that contains your private key to be used for signature-based authentication.,The name of the key (without extension) is used as the certificate name in ACI, unless C(certificate_name) is specified. | |
aaa_user: ${13:undefined} # not required. The name of the locally-authenticated user user to add. | |
description: ${14:undefined} # not required. Description for the AAA user. | |
certificate_name: ${15:C(private_key) basename} # not required. The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.,It defaults to the C(private_key) basename, without extension. | |
expires: ${16:undefined} # not required. Whether to enable an expiration date for the locally-authenticated user account. | |
phone: ${17:undefined} # not required. The phone number of the locally-authenticated user. | |
aaa_password_lifetime: ${18:undefined} # not required. The lifetime of the locally-authenticated user password. | |
enabled: ${19:undefined} # not required. The status of the locally-authenticated user account. | |
output_level: ${20|debug,info,normal|} # not required. choices: debug;info;normal. Influence the output of this ACI module.,C(normal) means the standard output, incl. C(current) dict,C(info) means informational output, incl. C(previous), C(proposed) and C(sent) dicts,C(debug) means debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information | |
aaa_password_update_required: ${21:undefined} # not required. Whether this account needs password update. | |
clear_password_history: ${22:undefined} # not required. Whether to clear the password history of a locally-authenticated user. | |
expiration: ${23:undefined} # not required. The expiration date of the locally-authenticated user account. | |
timeout: ${24:30} # not required. The socket level timeout in seconds. | |
validate_certs: ${25:yes} # not required. If C(no), SSL certificates will not be validated.,This should only set to C(no) used on personally controlled sites using self-signed certificates. | |
""" | |
'aci_aaa_user_certificate': | |
'prefix': "aci_aaa_user_certificate_snippet" | |
'description': "Manage AAA user certificates (aaa:UserCert)" | |
'body': """ | |
aci_aaa_user_certificate: | |
username: ${1:admin} # required. The username to use for authentication. | |
host: ${2:undefined} # required. IP Address or hostname of APIC resolvable by Ansible control host. | |
password: ${3:undefined} # required. The password to use for authentication. | |
private_key: ${4:undefined} # not required. PEM formatted file that contains your private key to be used for signature-based authentication.,The name of the key (without extension) is used as the certificate name in ACI, unless C(certificate_name) is specified. | |
aaa_user: ${5:undefined} # not required. The name of the user to add a certificate to. | |
use_proxy: ${6:yes} # not required. If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. | |
certificate: ${7:undefined} # not required. The PEM format public key extracted from the X.509 certificate. | |
certificate_name: ${8:C(private_key) basename} # not required. The name of the user certificate entry in ACI. | |
output_level: ${9|debug,info,normal|} # not required. choices: debug;info;normal. Influence the output of this ACI module.,C(normal) means the standard output, incl. C(current) dict,C(info) means informational output, incl. C(previous), C(proposed) and C(sent) dicts,C(debug) means debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information | |
state: ${10|absent,present,query|} # not required. choices: absent;present;query. Use C(present) or C(absent) for adding or removing.,Use C(query) for listing an object or multiple objects. | |
aaa_user_type: ${11|user,appuser|} # not required. choices: user;appuser. Whether this is a normal user or an appuser. | |
timeout: ${12:30} # not required. The socket level timeout in seconds. | |
use_ssl: ${13:yes} # not required. If C(no), an HTTP connection will be used instead of the default HTTPS connection. | |
validate_certs: ${14:yes} # not required. If C(no), SSL certificates will not be validated.,This should only set to C(no) used on personally controlled sites using self-signed certificates. | |
port: ${15:443 (for https) and 80 (for http)} # not required. Port number to be used for REST connection. | |
""" | |
'aci_access_port_to_interface_policy_leaf_profile': | |
'prefix': "aci_access_port_to_interface_policy_leaf_profile_snippet" | |
'description': "Manage Fabric interface policy leaf profile interface selectors (infra:HPortS, infra:RsAccBaseGrp, infra:PortBlk)" | |
'body': """ | |
aci_access_port_to_interface_policy_leaf_profile: | |
username: ${1:admin} # required. The username to use for authentication. | |
from: ${2:undefined} # required. The beggining (from range) of the port range block for the leaf access port block. | |
access_port_selector: ${3:undefined} # required. The name of the Fabric access policy leaf interface profile access port selector. | |
leaf_port_blk: ${4:undefined} # required. The name of the Fabric access policy leaf interface profile access port block. | |
host: ${5:undefined} # required. IP Address or hostname of APIC resolvable by Ansible control host. | |
to: ${6:undefined} # required. The end (to range) of the port range block for the leaf access port block. | |
password: ${7:undefined} # required. The password to use for authentication. | |
leaf_interface_profile: ${8:undefined} # required. The name of the Fabric access policy leaf interface profile. | |
output_level: ${9|debug,info,normal|} # not required. choices: debug;info;normal. Influence the output of this ACI module.,C(normal) means the standard output, incl. C(current) dict,C(info) means informational output, incl. C(previous), C(proposed) and C(sent) dicts,C(debug) means debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information | |
private_key: ${10:undefined} # not required. PEM formatted file that contains your private key to be used for signature-based authentication.,The name of the key (without extension) is used as the certificate name in ACI, unless C(certificate_name) is specified. | |
description: ${11:undefined} # not required. The description to assign to the C(access_port_selector) | |
validate_certs: ${12:yes} # not required. If C(no), SSL certificates will not be validated.,This should only set to C(no) used on personally controlled sites using self-signed certificates. | |
certificate_name: ${13:C(private_key) basename} # not required. The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.,It defaults to the C(private_key) basename, without extension. | |
policy_group: ${14:undefined} # not required. The name of the fabric access policy group to be associated with the leaf interface profile interface selector. | |
leaf_port_blk_description: ${15:undefined} # not required. The description to assign to the C(leaf_port_blk) | |
state: ${16|absent,present,query|} # not required. choices: absent;present;query. Use C(present) or C(absent) for adding or removing.,Use C(query) for listing an object or multiple objects. | |
timeout: ${17:30} # not required. The socket level timeout in seconds. | |
use_ssl: ${18:yes} # not required. If C(no), an HTTP connection will be used instead of the default HTTPS connection. | |
port: ${19:443 (for https) and 80 (for http)} # not required. Port number to be used for REST connection. | |
use_proxy: ${20:yes} # not required. If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. | |
""" | |
'aci_aep': | |
'prefix': "aci_aep_snippet" | |
'description': "Manage attachable Access Entity Profile (AEP) objects (infra:AttEntityP, infra:ProvAcc)" | |
'body': """ | |
aci_aep: | |
username: ${1:admin} # required. The username to use for authentication. | |
aep: ${2:undefined} # required. The name of the Attachable Access Entity Profile. | |
host: ${3:undefined} # required. IP Address or hostname of APIC resolvable by Ansible control host. | |
password: ${4:undefined} # required. The password to use for authentication. | |
private_key: ${5:undefined} # not required. PEM formatted file that contains your private key to be used for signature-based authentication.,The name of the key (without extension) is used as the certificate name in ACI, unless C(certificate_name) is specified. | |
description: ${6:undefined} # not required. Description for the AEP. | |
certificate_name: ${7:C(private_key) basename} # not required. The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.,It defaults to the C(private_key) basename, without extension. | |
infra_vlan: ${8:no} # not required. Enable infrastructure VLAN.,The hypervisor functions of the AEP.,C(no) will disable the infrastructure vlan if it is enabled. | |
output_level: ${9|debug,info,normal|} # not required. choices: debug;info;normal. Influence the output of this ACI module.,C(normal) means the standard output, incl. C(current) dict,C(info) means informational output, incl. C(previous), C(proposed) and C(sent) dicts,C(debug) means debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information | |
state: ${10|absent,present,query|} # not required. choices: absent;present;query. Use C(present) or C(absent) for adding or removing.,Use C(query) for listing an object or multiple objects. | |
timeout: ${11:30} # not required. The socket level timeout in seconds. | |
use_ssl: ${12:yes} # not required. If C(no), an HTTP connection will be used instead of the default HTTPS connection. | |
validate_certs: ${13:yes} # not required. If C(no), SSL certificates will not be validated.,This should only set to C(no) used on personally controlled sites using self-signed certificates. | |
port: ${14:443 (for https) and 80 (for http)} # not required. Port number to be used for REST connection. | |
use_proxy: ${15:yes} # not required. If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. | |
""" | |
'aci_aep_to_domain': | |
'prefix': "aci_aep_to_domain_snippet" | |
'description': "Bind AEPs to Physical or Virtual Domains (infra:RsDomP)" | |
'body': """ | |
aci_aep_to_domain: | |
username: ${1:admin} # required. The username to use for authentication. | |
host: ${2:undefined} # required. IP Address or hostname of APIC resolvable by Ansible control host. | |
password: ${3:undefined} # required. The password to use for authentication. | |
aep: ${4:undefined} # not required. The name of the Attachable Access Entity Profile. | |
domain: ${5:undefined} # not required. Name of the physical or virtual domain being associated with the AEP. | |
use_proxy: ${6:yes} # not required. If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. | |
certificate_name: ${7:C(private_key) basename} # not required. The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.,It defaults to the C(private_key) basename, without extension. | |
private_key: ${8:undefined} # not required. PEM formatted file that contains your private key to be used for signature-based authentication.,The name of the key (without extension) is used as the certificate name in ACI, unless C(certificate_name) is specified. | |
domain_type: ${9|fc,l2dom,l3dom,phys,vmm|} # not required. choices: fc;l2dom;l3dom;phys;vmm. Determines if the Domain is physical (phys) or virtual (vmm). | |
state: ${10|absent,present,query|} # not required. choices: absent;present;query. Use C(present) or C(absent) for adding or removing.,Use C(query) for listing an object or multiple objects. | |
output_level: ${11|debug,info,normal|} # not required. choices: debug;info;normal. Influence the output of this ACI module.,C(normal) means the standard output, incl. C(current) dict,C(info) means informational output, incl. C(previous), C(proposed) and C(sent) dicts,C(debug) means debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information | |
timeout: ${12:30} # not required. The socket level timeout in seconds. | |
use_ssl: ${13:yes} # not required. If C(no), an HTTP connection will be used instead of the default HTTPS connection. | |
vm_provider: ${14|cloudfoundry,kubernetes,microsoft,openshift,openstack,redhat,vmware|} # not required. choices: cloudfoundry;kubernetes;microsoft;openshift;openstack;redhat;vmware. The VM platform for VMM Domains.,Support for Kubernetes was added in ACI v3.0.,Support for CloudFoundry, OpenShift and Red Hat was added in ACI v3.1. | |
validate_certs: ${15:yes} # not required. If C(no), SSL certificates will not be validated.,This should only set to C(no) used on personally controlled sites using self-signed certificates. | |
port: ${16:443 (for https) and 80 (for http)} # not required. Port number to be used for REST connection. | |
""" | |
'aci_ap': | |
'prefix': "aci_ap_snippet" | |
'description': "Manage top level Application Profile (AP) objects (fv:Ap)" | |
'body': """ | |
aci_ap: | |
username: ${1:admin} # required. The username to use for authentication. | |
host: ${2:undefined} # required. IP Address or hostname of APIC resolvable by Ansible control host. | |
ap: ${3:undefined} # required. The name of the application network profile. | |
password: ${4:undefined} # required. The password to use for authentication. | |
tenant: ${5:undefined} # required. The name of an existing tenant. | |
private_key: ${6:undefined} # not required. PEM formatted file that contains your private key to be used for signature-based authentication.,The name of the key (without extension) is used as the certificate name in ACI, unless C(certificate_name) is specified. | |
description: ${7:undefined} # not required. Description for the AP. | |
certificate_name: ${8:C(private_key) basename} # not required. The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.,It defaults to the C(private_key) basename, without extension. | |
output_level: ${9|debug,info,normal|} # not required. choices: debug;info;normal. Influence the output of this ACI module.,C(normal) means the standard output, incl. C(current) dict,C(info) means informational output, incl. C(previous), C(proposed) and C(sent) dicts,C(debug) means debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information | |
state: ${10|absent,present,query|} # not required. choices: absent;present;query. Use C(present) or C(absent) for adding or removing.,Use C(query) for listing an object or multiple objects. | |
timeout: ${11:30} # not required. The socket level timeout in seconds. | |
use_ssl: ${12:yes} # not required. If C(no), an HTTP connection will be used instead of the default HTTPS connection. | |
validate_certs: ${13:yes} # not required. If C(no), SSL certificates will not be validated.,This should only set to C(no) used on personally controlled sites using self-signed certificates. | |
port: ${14:443 (for https) and 80 (for http)} # not required. Port number to be used for REST connection. | |
use_proxy: ${15:yes} # not required. If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. | |
""" | |
'aci_bd': | |
'prefix': "aci_bd_snippet" | |
'description': "Manage Bridge Domains (BD) objects (fv:BD)" | |
'body': """ | |
aci_bd: | |
username: ${1:admin} # required. The username to use for authentication. | |
host: ${2:undefined} # required. IP Address or hostname of APIC resolvable by Ansible control host. | |
password: ${3:undefined} # required. The password to use for authentication. | |
bd: ${4:undefined} # not required. The name of the Bridge Domain. | |
arp_flooding: ${5:no} # not required. Determines if the Bridge Domain should flood ARP traffic.,The APIC defaults new Bridge Domains to C(no). | |
igmp_snoop_policy: ${6:undefined} # not required. The name of the IGMP Snooping Policy the Bridge Domain should use when overriding the default IGMP Snooping Policy. | |
endpoint_retention_action: ${7|inherit,resolve|} # not required. choices: inherit;resolve. Determines if the Bridge Domain should inherit or resolve the End Point Retention Policy.,The APIC defaults new Bridge Domain to End Point Retention Policies to C(resolve). | |
description: ${8:undefined} # not required. Description for the Bridge Domain. | |
certificate_name: ${9:C(private_key) basename} # not required. The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.,It defaults to the C(private_key) basename, without extension. | |
l3_unknown_multicast: ${10|flood,opt-flood|} # not required. choices: flood;opt-flood. Determines the forwarding method to use for unknown multicast destinations.,The APCI defaults new Bridge Domains to C(flood). | |
enable_routing: ${11:yes} # not required. Determines if IP forwarding should be allowed.,The APIC defaults new Bridge Domains to C(yes). | |
private_key: ${12:undefined} # not required. PEM formatted file that contains your private key to be used for signature-based authentication.,The name of the key (without extension) is used as the certificate name in ACI, unless C(certificate_name) is specified. | |
vrf: ${13:undefined} # not required. The name of the VRF. | |
bd_type: ${14|ethernet,fc|} # not required. choices: ethernet;fc. The type of traffic on the Bridge Domain.,The APIC defaults new Bridge Domains to C(ethernet). | |
use_ssl: ${15:yes} # not required. If C(no), an HTTP connection will be used instead of the default HTTPS connection. | |
ip_learning: ${16:undefined} # not required. Determines if the Bridge Domain should learn End Point IPs.,The APIC defaults new Bridge Domains to C(yes). | |
port: ${17:443 (for https) and 80 (for http)} # not required. Port number to be used for REST connection. | |
tenant: ${18:undefined} # not required. The name of the Tenant. | |
l2_unknown_unicast: ${19|proxy,flood|} # not required. choices: proxy;flood. Determines what forwarding method to use for unknown l2 destinations.,The APIC defaults new Bridge domains to C(proxy). | |
endpoint_retention_policy: ${20:undefined} # not required. The name of the End Point Retention Policy the Bridge Domain should use when overriding the default End Point Retention Policy. | |
use_proxy: ${21:yes} # not required. If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. | |
multi_dest: ${22|bd-flood,drop,encap-flood|} # not required. choices: bd-flood;drop;encap-flood. Determines the forwarding method for L2 multicast, broadcast, and link layer traffic.,The APIC defaults new Bridge Domains to C(bd-flood). | |
endpoint_clear: ${23:no} # not required. Clears all End Points in all Leaves when C(yes).,The APIC defaults new Bridge Domains to C(no).,The value is not reset to disabled once End Points have been cleared; that requires a second task. | |
output_level: ${24|debug,info,normal|} # not required. choices: debug;info;normal. Influence the output of this ACI module.,C(normal) means the standard output, incl. C(current) dict,C(info) means informational output, incl. C(previous), C(proposed) and C(sent) dicts,C(debug) means debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information | |
state: ${25|absent,present,query|} # not required. choices: absent;present;query. Use C(present) or C(absent) for adding or removing.,Use C(query) for listing an object or multiple objects. | |
ipv6_nd_policy: ${26:undefined} # not required. The name of the IPv6 Neighbor Discovery Policy the Bridge Domain should use when overridding the default IPV6 ND Policy. | |
timeout: ${27:30} # not required. The socket level timeout in seconds. | |
mac_address: ${28:00:22:BD:F8:19:FF} # not required. The MAC Address to assign to the C(bd) instead of using the default. | |
endpoint_move_detect: ${29|default,garp|} # not required. choices: default;garp. Determines if GARP should be enabled to detect when End Points move.,The APIC defaults new Bridge Domains to C(garp). | |
enable_multicast: ${30:no} # not required. Determines if PIM is enabled,The APIC defaults new Bridge Domains to C(no). | |
validate_certs: ${31:yes} # not required. If C(no), SSL certificates will not be validated.,This should only set to C(no) used on personally controlled sites using self-signed certificates. | |
limit_ip_learn: ${32:yes} # not required. Determines if the BD should limit IP learning to only subnets owned by the Bridge Domain.,The APIC defaults new Bridge Domains to C(yes). | |
""" | |
'aci_bd_subnet': | |
'prefix': "aci_bd_subnet_snippet" | |
'description': "Manage Subnets (fv:Subnet)" | |
'body': """ | |
aci_bd_subnet: | |
username: ${1:admin} # required. The username to use for authentication. | |
host: ${2:undefined} # required. IP Address or hostname of APIC resolvable by Ansible control host. | |
password: ${3:undefined} # required. The password to use for authentication. | |
use_ssl: ${4:yes} # not required. If C(no), an HTTP connection will be used instead of the default HTTPS connection. | |
gateway: ${5:undefined} # not required. The IPv4 or IPv6 gateway address for the Subnet. | |
use_proxy: ${6:yes} # not required. If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. | |
port: ${7:443 (for https) and 80 (for http)} # not required. Port number to be used for REST connection. | |
state: ${8|absent,present,query|} # not required. choices: absent;present;query. Use C(present) or C(absent) for adding or removing.,Use C(query) for listing an object or multiple objects. | |
subnet_name: ${9:undefined} # not required. The name of the Subnet. | |
scope: ${10|private,public,shared,private,shared,public,shared|} # not required. choices: private;public;shared;private,shared;public,shared. Determines the scope of the Subnet.,The C(private) option only allows communication with hosts in the same VRF.,The C(public) option allows the Subnet to be advertised outside of the ACI Fabric, and allows communication with hosts in other VRFs.,The shared option limits communication to hosts in either the same VRF or the shared VRF.,The value is a list of options, C(private) and C(public) are mutually exclusive, but both can be used with C(shared).,The APIC defaults new Subnets to C(private). | |
bd: ${11:undefined} # not required. The name of the Bridge Domain. | |
private_key: ${12:undefined} # not required. PEM formatted file that contains your private key to be used for signature-based authentication.,The name of the key (without extension) is used as the certificate name in ACI, unless C(certificate_name) is specified. | |
description: ${13:undefined} # not required. The description for the Subnet. | |
certificate_name: ${14:C(private_key) basename} # not required. The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.,It defaults to the C(private_key) basename, without extension. | |
nd_prefix_policy: ${15:undefined} # not required. The IPv6 Neighbor Discovery Prefix Policy to associate with the Subnet. | |
enable_vip: ${16:no} # not required. Determines if the Subnet should be treated as a VIP; used when the BD is extended to multiple sites.,The APIC defaults new Subnets to C(no). | |
preferred: ${17:no} # not required. Determines if the Subnet is preferred over all available Subnets. Only one Subnet per Address Family (IPv4/IPv6). can be preferred in the Bridge Domain.,The APIC defaults new Subnets to C(no). | |
route_profile_l3_out: ${18:undefined} # not required. The L3 Out that contains the assocated Route Profile. | |
tenant: ${19:undefined} # not required. The name of the Tenant. | |
mask: ${20|Any 0 to 32 for IPv4 Addresses,0-128 for IPv6 Addresses|} # not required. choices: Any 0 to 32 for IPv4 Addresses;0-128 for IPv6 Addresses. The subnet mask for the Subnet.,This is the number assocated with CIDR notation. | |
subnet_control: ${21|nd_ra,no_gw,querier_ip,unspecified|} # not required. choices: nd_ra;no_gw;querier_ip;unspecified. Determines the Subnet's Control State.,The C(querier_ip) option is used to treat the gateway_ip as an IGMP querier source IP.,The C(nd_ra) option is used to treate the gateway_ip address as a Neighbor Discovery Router Advertisement Prefix.,The C(no_gw) option is used to remove default gateway functionality from the gateway address.,The APIC defaults new Subnets to C(nd_ra). | |
output_level: ${22|debug,info,normal|} # not required. choices: debug;info;normal. Influence the output of this ACI module.,C(normal) means the standard output, incl. C(current) dict,C(info) means informational output, incl. C(previous), C(proposed) and C(sent) dicts,C(debug) means debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information | |
route_profile: ${23:undefined} # not required. The Route Profile to the associate with the Subnet. | |
timeout: ${24:30} # not required. The socket level timeout in seconds. | |
validate_certs: ${25:yes} # not required. If C(no), SSL certificates will not be validated.,This should only set to C(no) used on personally controlled sites using self-signed certificates. | |
""" | |
'aci_bd_to_l3out': | |
'prefix': "aci_bd_to_l3out_snippet" | |
'description': "Bind Bridge Domain to L3 Out (fv:RsBDToOut)" | |
'body': """ | |
aci_bd_to_l3out: | |
username: ${1:admin} # required. The username to use for authentication. | |
host: ${2:undefined} # required. IP Address or hostname of APIC resolvable by Ansible control host. | |
password: ${3:undefined} # required. The password to use for authentication. | |
bd: ${4:undefined} # not required. The name of the Bridge Domain. | |
private_key: ${5:undefined} # not required. PEM formatted file that contains your private key to be used for signature-based authentication.,The name of the key (without extension) is used as the certificate name in ACI, unless C(certificate_name) is specified. | |
use_proxy: ${6:yes} # not required. If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. | |
certificate_name: ${7:C(private_key) basename} # not required. The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.,It defaults to the C(private_key) basename, without extension. | |
l3out: ${8:undefined} # not required. The name of the l3out to associate with th Bridge Domain. | |
state: ${9|absent,present,query|} # not required. choices: absent;present;query. Use C(present) or C(absent) for adding or removing.,Use C(query) for listing an object or multiple objects. | |
output_level: ${10|debug,info,normal|} # not required. choices: debug;info;normal. Influence the output of this ACI module.,C(normal) means the standard output, incl. C(current) dict,C(info) means informational output, incl. C(previous), C(proposed) and C(sent) dicts,C(debug) means debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information | |
timeout: ${11:30} # not required. The socket level timeout in seconds. | |
use_ssl: ${12:yes} # not required. If C(no), an HTTP connection will be used instead of the default HTTPS connection. | |
validate_certs: ${13:yes} # not required. If C(no), SSL certificates will not be validated.,This should only set to C(no) used on personally controlled sites using self-signed certificates. | |
port: ${14:443 (for https) and 80 (for http)} # not required. Port number to be used for REST connection. | |
tenant: ${15:undefined} # not required. The name of the Tenant. | |
""" | |
'aci_config_rollback': | |
'prefix': "aci_config_rollback_snippet" | |
'description': "Provides rollback and rollback preview functionality (config:ImportP)" | |
'body': """ | |
aci_config_rollback: | |
username: ${1:admin} # required. The username to use for authentication. | |
export_policy: ${2:undefined} # required. The export policy that the C(snapshot) is associated to. | |
password: ${3:undefined} # required. The password to use for authentication. | |
snapshot: ${4:undefined} # required. The name of the snapshot to rollback to, or the base snapshot to use for comparison.,The C(aci_snapshot) module can be used to query the list of available snapshots. | |
host: ${5:undefined} # required. IP Address or hostname of APIC resolvable by Ansible control host. | |
use_proxy: ${6:yes} # not required. If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. | |
import_mode: ${7|atomic,best-effort|} # not required. choices: atomic;best-effort. Determines how the import should be handled by the APIC.,The APIC defaults new Import Policies to C(atomic). | |
description: ${8:undefined} # not required. The description for the Import Policy. | |
fail_on_decrypt: ${9:yes} # not required. Determines if the APIC should fail the rollback if unable to decrypt secured data.,The APIC defaults new Import Policies to C(yes). | |
compare_export_policy: ${10:undefined} # not required. The export policy that the C(compare_snapshot) is associated to. | |
private_key: ${11:undefined} # not required. PEM formatted file that contains your private key to be used for signature-based authentication.,The name of the key (without extension) is used as the certificate name in ACI, unless C(certificate_name) is specified. | |
output_level: ${12|debug,info,normal|} # not required. choices: debug;info;normal. Influence the output of this ACI module.,C(normal) means the standard output, incl. C(current) dict,C(info) means informational output, incl. C(previous), C(proposed) and C(sent) dicts,C(debug) means debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information | |
validate_certs: ${13:yes} # not required. If C(no), SSL certificates will not be validated.,This should only set to C(no) used on personally controlled sites using self-signed certificates. | |
state: ${14|preview,rollback|} # not required. choices: preview;rollback. Use C(preview) for previewing the diff between two snapshots.,Use C(rollback) for reverting the configuration to a previous snapshot. | |
timeout: ${15:30} # not required. The socket level timeout in seconds. | |
certificate_name: ${16:C(private_key) basename} # not required. The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.,It defaults to the C(private_key) basename, without extension. | |
import_type: ${17|merge,replace|} # not required. choices: merge;replace. Determines how the current and snapshot configuration should be compared for replacement.,The APIC defaults new Import Policies to C(replace). | |
use_ssl: ${18:yes} # not required. If C(no), an HTTP connection will be used instead of the default HTTPS connection. | |
compare_snapshot: ${19:undefined} # not required. The name of the snapshot to compare with C(snapshot). | |
port: ${20:443 (for https) and 80 (for http)} # not required. Port number to be used for REST connection. | |
import_policy: ${21:undefined} # not required. The name of the Import Policy to use for config rollback. | |
""" | |
'aci_config_snapshot': | |
'prefix': "aci_config_snapshot_snippet" | |
'description': "Manage Config Snapshots (config:Snapshot, config:ExportP)" | |
'body': """ | |
aci_config_snapshot: | |
username: ${1:admin} # required. The username to use for authentication. | |
host: ${2:undefined} # required. IP Address or hostname of APIC resolvable by Ansible control host. | |
password: ${3:undefined} # required. The password to use for authentication. | |
include_secure: ${4:yes} # not required. Determines if secure information should be included in the backup.,The APIC defaults new Export Policies to C(yes). | |
description: ${5:undefined} # not required. The description for the Config Export Policy. | |
format: ${6|json,xml|} # not required. choices: json;xml. Sets the config backup to be formatted in JSON or XML.,The APIC defaults new Export Policies to C(json) | |
certificate_name: ${7:C(private_key) basename} # not required. The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.,It defaults to the C(private_key) basename, without extension. | |
private_key: ${8:undefined} # not required. PEM formatted file that contains your private key to be used for signature-based authentication.,The name of the key (without extension) is used as the certificate name in ACI, unless C(certificate_name) is specified. | |
max_count: ${9|range between 1 and 10|} # not required. choices: range between 1 and 10. Determines how many snapshots can exist for the Export Policy before the APIC starts to rollover.,The APIC defaults new Export Policies to C(3). | |
use_ssl: ${10:yes} # not required. If C(no), an HTTP connection will be used instead of the default HTTPS connection. | |
port: ${11:443 (for https) and 80 (for http)} # not required. Port number to be used for REST connection. | |
export_policy: ${12:undefined} # not required. The name of the Export Policy to use for Config Snapshots. | |
use_proxy: ${13:yes} # not required. If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. | |
output_level: ${14|debug,info,normal|} # not required. choices: debug;info;normal. Influence the output of this ACI module.,C(normal) means the standard output, incl. C(current) dict,C(info) means informational output, incl. C(previous), C(proposed) and C(sent) dicts,C(debug) means debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information | |
state: ${15|absent,present,query|} # not required. choices: absent;present;query. Use C(present) or C(absent) for adding or removing.,Use C(query) for listing an object or multiple objects. | |
snapshot: ${16:undefined} # not required. The name of the snapshot to delete. | |
timeout: ${17:30} # not required. The socket level timeout in seconds. | |
validate_certs: ${18:yes} # not required. If C(no), SSL certificates will not be validated.,This should only set to C(no) used on personally controlled sites using self-signed certificates. | |
""" | |
'aci_contract': | |
'prefix': "aci_contract_snippet" | |
'description': "Manage contract resources (vz:BrCP)" | |
'body': """ | |
aci_contract: | |
username: ${1:admin} # required. The username to use for authentication. | |
host: ${2:undefined} # required. IP Address or hostname of APIC resolvable by Ansible control host. | |
password: ${3:undefined} # required. The password to use for authentication. | |
tenant: ${4:undefined} # required. The name of the tenant. | |
contract: ${5:undefined} # required. The name of the contract. | |
private_key: ${6:undefined} # not required. PEM formatted file that contains your private key to be used for signature-based authentication.,The name of the key (without extension) is used as the certificate name in ACI, unless C(certificate_name) is specified. | |
description: ${7:undefined} # not required. Description for the contract. | |
certificate_name: ${8:C(private_key) basename} # not required. The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.,It defaults to the C(private_key) basename, without extension. | |
dscp: ${9|AF11,AF12,AF13,AF21,AF22,AF23,AF31,AF32,AF33,AF41,AF42,AF43,CS0,CS1,CS2,CS3,CS4,CS5,CS6,CS7,EF,VA,unspecified|} # not required. choices: AF11;AF12;AF13;AF21;AF22;AF23;AF31;AF32;AF33;AF41;AF42;AF43;CS0;CS1;CS2;CS3;CS4;CS5;CS6;CS7;EF;VA;unspecified. The target Differentiated Service (DSCP) value. | |
use_ssl: ${10:yes} # not required. If C(no), an HTTP connection will be used instead of the default HTTPS connection. | |
port: ${11:443 (for https) and 80 (for http)} # not required. Port number to be used for REST connection. | |
output_level: ${12|debug,info,normal|} # not required. choices: debug;info;normal. Influence the output of this ACI module.,C(normal) means the standard output, incl. C(current) dict,C(info) means informational output, incl. C(previous), C(proposed) and C(sent) dicts,C(debug) means debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information | |
use_proxy: ${13:yes} # not required. If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. | |
priority: ${14|level1,level2,level3,unspecified|} # not required. choices: level1;level2;level3;unspecified. The desired QoS class to be used. | |
state: ${15|absent,present,query|} # not required. choices: absent;present;query. Use C(present) or C(absent) for adding or removing.,Use C(query) for listing an object or multiple objects. | |
timeout: ${16:30} # not required. The socket level timeout in seconds. | |
scope: ${17|application-profile,context,global,tenant|} # not required. choices: application-profile;context;global;tenant. The scope of a service contract. | |
validate_certs: ${18:yes} # not required. If C(no), SSL certificates will not be validated.,This should only set to C(no) used on personally controlled sites using self-signed certificates. | |
""" | |
'aci_contract_subject': | |
'prefix': "aci_contract_subject_snippet" | |
'description': "Manage initial Contract Subjects (vz:Subj)" | |
'body': """ | |
aci_contract_subject: | |
username: ${1:admin} # required. The username to use for authentication. | |
password: ${2:undefined} # required. The password to use for authentication. | |
host: ${3:undefined} # required. IP Address or hostname of APIC resolvable by Ansible control host. | |
use_proxy: ${4:yes} # not required. If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. | |
private_key: ${5:undefined} # not required. PEM formatted file that contains your private key to be used for signature-based authentication.,The name of the key (without extension) is used as the certificate name in ACI, unless C(certificate_name) is specified. | |
description: ${6:undefined} # not required. Description for the contract subject. | |
consumer_match: ${7|all,at_least_one,at_most_one,none|} # not required. choices: all;at_least_one;at_most_one;none. The match criteria across consumers.,The APIC defaults new Contract Subjects to C(at_least_one). | |
certificate_name: ${8:C(private_key) basename} # not required. The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.,It defaults to the C(private_key) basename, without extension. | |
output_level: ${9|debug,info,normal|} # not required. choices: debug;info;normal. Influence the output of this ACI module.,C(normal) means the standard output, incl. C(current) dict,C(info) means informational output, incl. C(previous), C(proposed) and C(sent) dicts,C(debug) means debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information | |
dscp: ${10|AF11,AF12,AF13,AF21,AF22,AF23,AF31,AF32,AF33,AF41,AF42,AF43,CS0,CS1,CS2,CS3,CS4,CS5,CS6,CS7,EF,VA,unspecified|} # not required. choices: AF11;AF12;AF13;AF21;AF22;AF23;AF31;AF32;AF33;AF41;AF42;AF43;CS0;CS1;CS2;CS3;CS4;CS5;CS6;CS7;EF;VA;unspecified. The target DSCP.,The APIC defaults new Contract Subjects to C(unspecified). | |
priority: ${11|level1,level2,level3,unspecified|} # not required. choices: level1;level2;level3;unspecified. The QoS class.,The APIC defaults new Contract Subjects to C(unspecified). | |
state: ${12|absent,present,query|} # not required. choices: absent;present;query. Use C(present) or C(absent) for adding or removing.,Use C(query) for listing an object or multiple objects. | |
contract: ${13:undefined} # not required. The name of the Contract. | |
timeout: ${14:30} # not required. The socket level timeout in seconds. | |
use_ssl: ${15:yes} # not required. If C(no), an HTTP connection will be used instead of the default HTTPS connection. | |
reverse_filter: ${16:yes} # not required. Determines if the APIC should reverse the src and dst ports to allow the return traffic back, since ACI is stateless filter.,The APIC defaults new Contract Subjects to C(yes). | |
provider_match: ${17|all,at_least_one,at_most_one,none|} # not required. choices: all;at_least_one;at_most_one;none. The match criteria across providers.,The APIC defaults new Contract Subjects to C(at_least_one). | |
validate_certs: ${18:yes} # not required. If C(no), SSL certificates will not be validated.,This should only set to C(no) used on personally controlled sites using self-signed certificates. | |
port: ${19:443 (for https) and 80 (for http)} # not required. Port number to be used for REST connection. | |
tenant: ${20:undefined} # not required. The name of the tenant. | |
subject: ${21:undefined} # not required. The contract subject name. | |
""" | |
'aci_contract_subject_to_filter': | |
'prefix': "aci_contract_subject_to_filter_snippet" | |
'description': "Bind Contract Subjects to Filters (vz:RsSubjFiltAtt)" | |
'body': """ | |
aci_contract_subject_to_filter: | |
username: ${1:admin} # required. The username to use for authentication. | |
host: ${2:undefined} # required. IP Address or hostname of APIC resolvable by Ansible control host. | |
password: ${3:undefined} # required. The password to use for authentication. | |
tenant: ${4:undefined} # required. The name of the tenant. | |
private_key: ${5:undefined} # not required. PEM formatted file that contains your private key to be used for signature-based authentication.,The name of the key (without extension) is used as the certificate name in ACI, unless C(certificate_name) is specified. | |
certificate_name: ${6:C(private_key) basename} # not required. The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.,It defaults to the C(private_key) basename, without extension. | |
use_ssl: ${7:yes} # not required. If C(no), an HTTP connection will be used instead of the default HTTPS connection. | |
port: ${8:443 (for https) and 80 (for http)} # not required. Port number to be used for REST connection. | |
use_proxy: ${9:yes} # not required. If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. | |
output_level: ${10|debug,info,normal|} # not required. choices: debug;info;normal. Influence the output of this ACI module.,C(normal) means the standard output, incl. C(current) dict,C(info) means informational output, incl. C(previous), C(proposed) and C(sent) dicts,C(debug) means debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information | |
log: ${11|log,none|} # not required. choices: log;none. Determines if the binding should be set to log.,The APIC defaults new Subject to Filter bindings to C(none). | |
contract: ${12:undefined} # not required. The name of the contract. | |
filter: ${13:undefined} # not required. The name of the Filter to bind to the Subject. | |
state: ${14|absent,present,query|} # not required. choices: absent;present;query. Use C(present) or C(absent) for adding or removing.,Use C(query) for listing an object or multiple objects. | |
timeout: ${15:30} # not required. The socket level timeout in seconds. | |
subject: ${16:undefined} # not required. The name of the Contract Subject. | |
validate_certs: ${17:yes} # not required. If C(no), SSL certificates will not be validated.,This should only set to C(no) used on personally controlled sites using self-signed certificates. | |
""" | |
'aci_domain': | |
'prefix': "aci_domain_snippet" | |
'description': "Manage physical, virtual, bridged, routed or FC domain profiles (phys:DomP, vmm:DomP, l2ext:DomP, l3ext:DomP, fc:DomP)" | |
'body': """ | |
aci_domain: | |
username: ${1:admin} # required. The username to use for authentication. | |
password: ${2:undefined} # required. The password to use for authentication. | |
host: ${3:undefined} # required. IP Address or hostname of APIC resolvable by Ansible control host. | |
output_level: ${4|debug,info,normal|} # not required. choices: debug;info;normal. Influence the output of this ACI module.,C(normal) means the standard output, incl. C(current) dict,C(info) means informational output, incl. C(previous), C(proposed) and C(sent) dicts,C(debug) means debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information | |
domain: ${5:undefined} # not required. Name of the physical, virtual, bridged routed or FC domain profile. | |
use_proxy: ${6:yes} # not required. If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. | |
certificate_name: ${7:C(private_key) basename} # not required. The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.,It defaults to the C(private_key) basename, without extension. | |
private_key: ${8:undefined} # not required. PEM formatted file that contains your private key to be used for signature-based authentication.,The name of the key (without extension) is used as the certificate name in ACI, unless C(certificate_name) is specified. | |
dscp: ${9|AF11,AF12,AF13,AF21,AF22,AF23,AF31,AF32,AF33,AF41,AF42,AF43,CS0,CS1,CS2,CS3,CS4,CS5,CS6,CS7,EF,VA,unspecified|} # not required. choices: AF11;AF12;AF13;AF21;AF22;AF23;AF31;AF32;AF33;AF41;AF42;AF43;CS0;CS1;CS2;CS3;CS4;CS5;CS6;CS7;EF;VA;unspecified. The target Differentiated Service (DSCP) value. | |
port: ${10:443 (for https) and 80 (for http)} # not required. Port number to be used for REST connection. | |
domain_type: ${11|fc,l2dom,l3dom,phys,vmm|} # not required. choices: fc;l2dom;l3dom;phys;vmm. The type of domain profile.,C(fc): The FC domain profile is a policy pertaining to single FC Management domain,C(l2dom): The external bridged domain profile is a policy for managing L2 bridged infrastructure bridged outside the fabric.,C(l3dom): The external routed domain profile is a policy for managing L3 routed infrastructure outside the fabric.,C(phys): The physical domain profile stores the physical resources and encap resources that should be used for EPGs associated with this domain.,C(vmm): The VMM domain profile is a policy for grouping VM controllers with similar networking policy requirements. | |
state: ${12|absent,present,query|} # not required. choices: absent;present;query. Use C(present) or C(absent) for adding or removing.,Use C(query) for listing an object or multiple objects. | |
timeout: ${13:30} # not required. The socket level timeout in seconds. | |
encap_mode: ${14|unknown,vlan,vxlan|} # not required. choices: unknown;vlan;vxlan. The layer 2 encapsulation protocol to use with the virtual switch. | |
vswitch: ${15|avs,default,dvs,unknown|} # not required. choices: avs;default;dvs;unknown. The virtual switch to use for vmm domains. | |
multicast_address: ${16:undefined} # not required. The muticast IP address to use for the virtual switch. | |
use_ssl: ${17:yes} # not required. If C(no), an HTTP connection will be used instead of the default HTTPS connection. | |
validate_certs: ${18:yes} # not required. If C(no), SSL certificates will not be validated.,This should only set to C(no) used on personally controlled sites using self-signed certificates. | |
vm_provider: ${19|cloudfoundry,kubernetes,microsoft,openshift,openstack,redhat,vmware|} # not required. choices: cloudfoundry;kubernetes;microsoft;openshift;openstack;redhat;vmware. The VM platform for VMM Domains.,Support for Kubernetes was added in ACI v3.0.,Support for CloudFoundry, OpenShift and Red Hat was added in ACI v3.1. | |
""" | |
'aci_domain_to_vlan_pool': | |
'prefix': "aci_domain_to_vlan_pool_snippet" | |
'description': "Bind Domain to VLAN Pools (infra:RsVlanNs)" | |
'body': """ | |
aci_domain_to_vlan_pool: | |
username: ${1:admin} # required. The username to use for authentication. | |
pool_allocation_mode: ${2|dynamic,static|} # required. choices: dynamic;static. The method used for allocating VLANs to resources. | |
host: ${3:undefined} # required. IP Address or hostname of APIC resolvable by Ansible control host. | |
password: ${4:undefined} # required. The password to use for authentication. | |
domain: ${5:undefined} # not required. Name of the domain being associated with the VLAN Pool. | |
certificate_name: ${6:C(private_key) basename} # not required. The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.,It defaults to the C(private_key) basename, without extension. | |
private_key: ${7:undefined} # not required. PEM formatted file that contains your private key to be used for signature-based authentication.,The name of the key (without extension) is used as the certificate name in ACI, unless C(certificate_name) is specified. | |
domain_type: ${8|fc,l2dom,l3dom,phys,vmm|} # not required. choices: fc;l2dom;l3dom;phys;vmm. Determines if the Domain is physical (phys) or virtual (vmm). | |
use_ssl: ${9:yes} # not required. If C(no), an HTTP connection will be used instead of the default HTTPS connection. | |
vm_provider: ${10|cloudfoundry,kubernetes,microsoft,openshift,openstack,redhat,vmware|} # not required. choices: cloudfoundry;kubernetes;microsoft;openshift;openstack;redhat;vmware. The VM platform for VMM Domains.,Support for Kubernetes was added in ACI v3.0.,Support for CloudFoundry, OpenShift and Red Hat was added in ACI v3.1. | |
port: ${11:443 (for https) and 80 (for http)} # not required. Port number to be used for REST connection. | |
pool: ${12:undefined} # not required. The name of the pool. | |
use_proxy: ${13:yes} # not required. If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. | |
output_level: ${14|debug,info,normal|} # not required. choices: debug;info;normal. Influence the output of this ACI module.,C(normal) means the standard output, incl. C(current) dict,C(info) means informational output, incl. C(previous), C(proposed) and C(sent) dicts,C(debug) means debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information | |
state: ${15|absent,present,query|} # not required. choices: absent;present;query. Use C(present) or C(absent) for adding or removing.,Use C(query) for listing an object or multiple objects. | |
timeout: ${16:30} # not required. The socket level timeout in seconds. | |
validate_certs: ${17:yes} # not required. If C(no), SSL certificates will not be validated.,This should only set to C(no) used on personally controlled sites using self-signed certificates. | |
""" | |
'aci_encap_pool': | |
'prefix': "aci_encap_pool_snippet" | |
'description': "Manage encap pools (fvns:VlanInstP, fvns:VxlanInstP, fvns:VsanInstP)" | |
'body': """ | |
aci_encap_pool: | |
username: ${1:admin} # required. The username to use for authentication. | |
host: ${2:undefined} # required. IP Address or hostname of APIC resolvable by Ansible control host. | |
pool_type: ${3|vlan,vxlan,vsan|} # required. choices: vlan;vxlan;vsan. The encap type of C(pool). | |
password: ${4:undefined} # required. The password to use for authentication. | |
output_level: ${5|debug,info,normal|} # not required. choices: debug;info;normal. Influence the output of this ACI module.,C(normal) means the standard output, incl. C(current) dict,C(info) means informational output, incl. C(previous), C(proposed) and C(sent) dicts,C(debug) means debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information | |
private_key: ${6:undefined} # not required. PEM formatted file that contains your private key to be used for signature-based authentication.,The name of the key (without extension) is used as the certificate name in ACI, unless C(certificate_name) is specified. | |
pool_allocation_mode: ${7|dynamic,static|} # not required. choices: dynamic;static. The method used for allocating encaps to resources.,Only vlan and vsan support allocation modes. | |
description: ${8:undefined} # not required. Description for the C(pool). | |
certificate_name: ${9:C(private_key) basename} # not required. The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.,It defaults to the C(private_key) basename, without extension. | |
state: ${10|absent,present,query|} # not required. choices: absent;present;query. Use C(present) or C(absent) for adding or removing.,Use C(query) for listing an object or multiple objects. | |
timeout: ${11:30} # not required. The socket level timeout in seconds. | |
use_ssl: ${12:yes} # not required. If C(no), an HTTP connection will be used instead of the default HTTPS connection. | |
validate_certs: ${13:yes} # not required. If C(no), SSL certificates will not be validated.,This should only set to C(no) used on personally controlled sites using self-signed certificates. | |
port: ${14:443 (for https) and 80 (for http)} # not required. Port number to be used for REST connection. | |
pool: ${15:undefined} # not required. The name of the pool. | |
use_proxy: ${16:yes} # not required. If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. | |
""" | |
'aci_encap_pool_range': | |
'prefix': "aci_encap_pool_range_snippet" | |
'description': "Manage encap ranges assigned to pools (fvns:EncapBlk, fvns:VsanEncapBlk)" | |
'body': """ | |
aci_encap_pool_range: | |
username: ${1:admin} # required. The username to use for authentication. | |
host: ${2:undefined} # required. IP Address or hostname of APIC resolvable by Ansible control host. | |
pool_type: ${3|vlan,vxlan,vsan|} # required. choices: vlan;vxlan;vsan. The encap type of C(pool). | |
password: ${4:undefined} # required. The password to use for authentication. | |
range_end: ${5:undefined} # not required. The end of encap range. | |
range_start: ${6:undefined} # not required. The start of the encap range. | |
private_key: ${7:undefined} # not required. PEM formatted file that contains your private key to be used for signature-based authentication.,The name of the key (without extension) is used as the certificate name in ACI, unless C(certificate_name) is specified. | |
pool_allocation_mode: ${8|dynamic,static|} # not required. choices: dynamic;static. The method used for allocating encaps to resources.,Only vlan and vsan support allocation modes. | |
description: ${9:undefined} # not required. Description for the pool range. | |
certificate_name: ${10:C(private_key) basename} # not required. The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.,It defaults to the C(private_key) basename, without extension. | |
validate_certs: ${11:yes} # not required. If C(no), SSL certificates will not be validated.,This should only set to C(no) used on personally controlled sites using self-signed certificates. | |
state: ${12|absent,present,query|} # not required. choices: absent;present;query. Use C(present) or C(absent) for adding or removing.,Use C(query) for listing an object or multiple objects. | |
output_level: ${13|debug,info,normal|} # not required. choices: debug;info;normal. Influence the output of this ACI module.,C(normal) means the standard output, incl. C(current) dict,C(info) means informational output, incl. C(previous), C(proposed) and C(sent) dicts,C(debug) means debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information | |
timeout: ${14:30} # not required. The socket level timeout in seconds. | |
use_ssl: ${15:yes} # not required. If C(no), an HTTP connection will be used instead of the default HTTPS connection. | |
allocation_mode: ${16|dynamic,inherit,static|} # not required. choices: dynamic;inherit;static. The method used for allocating encaps to resources.,Only vlan and vsan support allocation modes. | |
use_proxy: ${17:yes} # not required. If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. | |
port: ${18:443 (for https) and 80 (for http)} # not required. Port number to be used for REST connection. | |
pool: ${19:undefined} # not required. The name of the pool that the range should be assigned to. | |
range_name: ${20:undefined} # not required. The name to give to the encap range. | |
""" | |
'aci_epg': | |
'prefix': "aci_epg_snippet" | |
'description': "Manage End Point Groups (EPG) objects (fv:AEPg)" | |
'body': """ | |
aci_epg: | |
bd: ${1:undefined} # required. Name of the bridge domain being associated with the EPG. | |
username: ${2:admin} # required. The username to use for authentication. | |
host: ${3:undefined} # required. IP Address or hostname of APIC resolvable by Ansible control host. | |
ap: ${4:undefined} # required. Name of an existing application network profile, that will contain the EPGs. | |
epg: ${5:undefined} # required. Name of the end point group. | |
password: ${6:undefined} # required. The password to use for authentication. | |
private_key: ${7:undefined} # not required. PEM formatted file that contains your private key to be used for signature-based authentication.,The name of the key (without extension) is used as the certificate name in ACI, unless C(certificate_name) is specified. | |
description: ${8:undefined} # not required. Description for the EPG. | |
certificate_name: ${9:C(private_key) basename} # not required. The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.,It defaults to the C(private_key) basename, without extension. | |
fwd_control: ${10|none,proxy-arp|} # not required. choices: none;proxy-arp. The forwarding control used by the EPG.,The APIC defaults new EPGs to C(none). | |
port: ${11:443 (for https) and 80 (for http)} # not required. Port number to be used for REST connection. | |
priority: ${12|level1,level2,level3,unspecified|} # not required. choices: level1;level2;level3;unspecified. QoS class. | |
state: ${13|absent,present,query|} # not required. choices: absent;present;query. Use C(present) or C(absent) for adding or removing.,Use C(query) for listing an object or multiple objects. | |
preferred_group: ${14:no} # not required. Whether ot not the EPG is part of the Preferred Group and can communicate without contracts.,This is very convenient for migration scenarios, or when ACI is used for network automation but not for policy. | |
output_level: ${15|debug,info,normal|} # not required. choices: debug;info;normal. Influence the output of this ACI module.,C(normal) means the standard output, incl. C(current) dict,C(info) means informational output, incl. C(previous), C(proposed) and C(sent) dicts,C(debug) means debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information | |
timeout: ${16:30} # not required. The socket level timeout in seconds. | |
use_ssl: ${17:yes} # not required. If C(no), an HTTP connection will be used instead of the default HTTPS connection. | |
validate_certs: ${18:yes} # not required. If C(no), SSL certificates will not be validated.,This should only set to C(no) used on personally controlled sites using self-signed certificates. | |
intra_epg_isolation: ${19|enforced,unenforced|} # not required. choices: enforced;unenforced. Intra EPG Isolation. | |
tenant: ${20:undefined} # not required. Name of an existing tenant. | |
use_proxy: ${21:yes} # not required. If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. | |
""" | |
'aci_epg_monitoring_policy': | |
'prefix': "aci_epg_monitoring_policy_snippet" | |
'description': "Manage monitoring policies (mon:EPGPol)" | |
'body': """ | |
aci_epg_monitoring_policy: | |
username: ${1:admin} # required. The username to use for authentication. | |
host: ${2:undefined} # required. IP Address or hostname of APIC resolvable by Ansible control host. | |
monitoring_policy: ${3:undefined} # required. The name of the monitoring policy. | |
password: ${4:undefined} # required. The password to use for authentication. | |
tenant: ${5:undefined} # required. The name of the tenant. | |
private_key: ${6:undefined} # not required. PEM formatted file that contains your private key to be used for signature-based authentication.,The name of the key (without extension) is used as the certificate name in ACI, unless C(certificate_name) is specified. | |
description: ${7:undefined} # not required. Description for the monitoring policy. | |
certificate_name: ${8:C(private_key) basename} # not required. The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.,It defaults to the C(private_key) basename, without extension. | |
output_level: ${9|debug,info,normal|} # not required. choices: debug;info;normal. Influence the output of this ACI module.,C(normal) means the standard output, incl. C(current) dict,C(info) means informational output, incl. C(previous), C(proposed) and C(sent) dicts,C(debug) means debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information | |
state: ${10|absent,present,query|} # not required. choices: absent;present;query. Use C(present) or C(absent) for adding or removing.,Use C(query) for listing an object or multiple objects. | |
timeout: ${11:30} # not required. The socket level timeout in seconds. | |
use_ssl: ${12:yes} # not required. If C(no), an HTTP connection will be used instead of the default HTTPS connection. | |
validate_certs: ${13:yes} # not required. If C(no), SSL certificates will not be validated.,This should only set to C(no) used on personally controlled sites using self-signed certificates. | |
port: ${14:443 (for https) and 80 (for http)} # not required. Port number to be used for REST connection. | |
use_proxy: ${15:yes} # not required. If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. | |
""" | |
'aci_epg_to_contract': | |
'prefix': "aci_epg_to_contract_snippet" | |
'description': "Bind EPGs to Contracts (fv:RsCons, fv:RsProv)" | |
'body': """ | |
aci_epg_to_contract: | |
username: ${1:admin} # required. The username to use for authentication. | |
password: ${2:undefined} # required. The password to use for authentication. | |
host: ${3:undefined} # required. IP Address or hostname of APIC resolvable by Ansible control host. | |
contract_type: ${4|consumer,proivder|} # required. choices: consumer;proivder. Determines if the EPG should Provide or Consume the Contract. | |
output_level: ${5|debug,info,normal|} # not required. choices: debug;info;normal. Influence the output of this ACI module.,C(normal) means the standard output, incl. C(current) dict,C(info) means informational output, incl. C(previous), C(proposed) and C(sent) dicts,C(debug) means debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information | |
private_key: ${6:undefined} # not required. PEM formatted file that contains your private key to be used for signature-based authentication.,The name of the key (without extension) is used as the certificate name in ACI, unless C(certificate_name) is specified. | |
use_proxy: ${7:yes} # not required. If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. | |
certificate_name: ${8:C(private_key) basename} # not required. The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.,It defaults to the C(private_key) basename, without extension. | |
contract: ${9:undefined} # not required. The name of the contract. | |
priority: ${10|level1,level2,level3,unspecified|} # not required. choices: level1;level2;level3;unspecified. QoS class.,The APIC defaults new EPG to Contract bindings to C(unspecified). | |
ap: ${11:undefined} # not required. Name of an existing application network profile, that will contain the EPGs. | |
state: ${12|absent,present,query|} # not required. choices: absent;present;query. Use C(present) or C(absent) for adding or removing.,Use C(query) for listing an object or multiple objects. | |
timeout: ${13:30} # not required. The socket level timeout in seconds. | |
use_ssl: ${14:yes} # not required. If C(no), an HTTP connection will be used instead of the default HTTPS connection. | |
epg: ${15:undefined} # not required. The name of the end point group. | |
provider_match: ${16|all,at_least_one,at_most_one,none|} # not required. choices: all;at_least_one;at_most_one;none. The matching algorithm for Provided Contracts.,The APIC defaults new EPG to Provided Contracts to C(at_least_one). | |
validate_certs: ${17:yes} # not required. If C(no), SSL certificates will not be validated.,This should only set to C(no) used on personally controlled sites using self-signed certificates. | |
port: ${18:443 (for https) and 80 (for http)} # not required. Port number to be used for REST connection. | |
tenant: ${19:undefined} # not required. Name of an existing tenant. | |
""" | |
'aci_epg_to_domain': | |
'prefix': "aci_epg_to_domain_snippet" | |
'description': "Bind EPGs to Domains (fv:RsDomAtt)" | |
'body': """ | |
aci_epg_to_domain: | |
username: ${1:admin} # required. The username to use for authentication. | |
host: ${2:undefined} # required. IP Address or hostname of APIC resolvable by Ansible control host. | |
password: ${3:undefined} # required. The password to use for authentication. | |
domain: ${4:undefined} # not required. Name of the physical or virtual domain being associated with the EPG. | |
allow_useg: ${5|encap,useg|} # not required. choices: encap;useg. Allows micro-segmentation.,The APIC defaults new EPG to Domain bindings to use C(encap). | |
ap: ${6:undefined} # not required. Name of an existing application network profile, that will contain the EPGs. | |
use_ssl: ${7:yes} # not required. If C(no), an HTTP connection will be used instead of the default HTTPS connection. | |
vm_provider: ${8|cloudfoundry,kubernetes,microsoft,openshift,openstack,redhat,vmware|} # not required. choices: cloudfoundry;kubernetes;microsoft;openshift;openstack;redhat;vmware. The VM platform for VMM Domains.,Support for Kubernetes was added in ACI v3.0.,Support for CloudFoundry, OpenShift and Red Hat was added in ACI v3.1. | |
port: ${9:443 (for https) and 80 (for http)} # not required. Port number to be used for REST connection. | |
use_proxy: ${10:yes} # not required. If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. | |
primary_encap: ${11|range from 1 to 4096|} # not required. choices: range from 1 to 4096. Determines the primary VLAN ID when using useg. | |
state: ${12|absent,present,query|} # not required. choices: absent;present;query. Use C(present) or C(absent) for adding or removing.,Use C(query) for listing an object or multiple objects. | |
encap: ${13|range from 1 to 4096|} # not required. choices: range from 1 to 4096. The VLAN encapsulation for the EPG when binding a VMM Domain with static encap_mode.,This acts as the secondary encap when using useg. | |
private_key: ${14:undefined} # not required. PEM formatted file that contains your private key to be used for signature-based authentication.,The name of the key (without extension) is used as the certificate name in ACI, unless C(certificate_name) is specified. | |
certificate_name: ${15:C(private_key) basename} # not required. The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.,It defaults to the C(private_key) basename, without extension. | |
domain_type: ${16|phys,vmm|} # not required. choices: phys;vmm. Determines if the Domain is physical (phys) or virtual (vmm). | |
encap_mode: ${17|auto,vlan,vxlan|} # not required. choices: auto;vlan;vxlan. The ecapsulataion method to be used.,The APIC defaults new EPG to Domain bindings to C(auto). | |
netflow: ${18:no} # not required. Determines if netflow should be enabled.,The APIC defaults new EPG to Domain binings to C(no). | |
resolution_immediacy: ${19|immediate,lazy,pre-provision|} # not required. choices: immediate;lazy;pre-provision. Determines when the policies should be resolved and available.,The APIC defaults new EPG to Domain bindings to C(lazy). | |
tenant: ${20:undefined} # not required. Name of an existing tenant. | |
deploy_immediacy: ${21|immediate,lazy|} # not required. choices: immediate;lazy. Determines when the policy is pushed to hardware Policy CAM.,The APIC defaults new EPG to Domain bindings to C(lazy). | |
output_level: ${22|debug,info,normal|} # not required. choices: debug;info;normal. Influence the output of this ACI module.,C(normal) means the standard output, incl. C(current) dict,C(info) means informational output, incl. C(previous), C(proposed) and C(sent) dicts,C(debug) means debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information | |
timeout: ${23:30} # not required. The socket level timeout in seconds. | |
epg: ${24:undefined} # not required. Name of the end point group. | |
validate_certs: ${25:yes} # not required. If C(no), SSL certificates will not be validated.,This should only set to C(no) used on personally controlled sites using self-signed certificates. | |
""" | |
'aci_fabric_node': | |
'prefix': "aci_fabric_node_snippet" | |
'description': "Manage Fabric Node Members (fabric:NodeIdentP)" | |
'body': """ | |
aci_fabric_node: | |
username: ${1:admin} # required. The username to use for authentication. | |
host: ${2:undefined} # required. IP Address or hostname of APIC resolvable by Ansible control host. | |
password: ${3:undefined} # required. The password to use for authentication. | |
private_key: ${4:undefined} # not required. PEM formatted file that contains your private key to be used for signature-based authentication.,The name of the key (without extension) is used as the certificate name in ACI, unless C(certificate_name) is specified. | |
description: ${5:undefined} # not required. Description for the new Fabric Node Member. | |
certificate_name: ${6:C(private_key) basename} # not required. The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.,It defaults to the C(private_key) basename, without extension. | |
node_id: ${7:undefined} # not required. Node ID Number for the new Fabric Node Member. | |
use_ssl: ${8:yes} # not required. If C(no), an HTTP connection will be used instead of the default HTTPS connection. | |
serial: ${9:undefined} # not required. Serial Number for the new Fabric Node Member. | |
pod_id: ${10:undefined} # not required. The pod id of the new Fabric Node Member. | |
use_proxy: ${11:yes} # not required. If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. | |
switch: ${12:undefined} # not required. Switch Name for the new Fabric Node Member. | |
port: ${13:443 (for https) and 80 (for http)} # not required. Port number to be used for REST connection. | |
output_level: ${14|debug,info,normal|} # not required. choices: debug;info;normal. Influence the output of this ACI module.,C(normal) means the standard output, incl. C(current) dict,C(info) means informational output, incl. C(previous), C(proposed) and C(sent) dicts,C(debug) means debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information | |
state: ${15|absent,present,query|} # not required. choices: absent;present;query. Use C(present) or C(absent) for adding or removing.,Use C(query) for listing an object or multiple objects. | |
role: ${16|leaf,spine,unspecified|} # not required. choices: leaf;spine;unspecified. Role for the new Fabric Node Member. | |
timeout: ${17:30} # not required. The socket level timeout in seconds. | |
validate_certs: ${18:yes} # not required. If C(no), SSL certificates will not be validated.,This should only set to C(no) used on personally controlled sites using self-signed certificates. | |
""" | |
'aci_filter': | |
'prefix': "aci_filter_snippet" | |
'description': "Manages top level filter objects (vz:Filter)" | |
'body': """ | |
aci_filter: | |
username: ${1:admin} # required. The username to use for authentication. | |
host: ${2:undefined} # required. IP Address or hostname of APIC resolvable by Ansible control host. | |
filter: ${3:undefined} # required. The name of the filter. | |
password: ${4:undefined} # required. The password to use for authentication. | |
tenant: ${5:undefined} # required. The name of the tenant. | |
output_level: ${6|debug,info,normal|} # not required. choices: debug;info;normal. Influence the output of this ACI module.,C(normal) means the standard output, incl. C(current) dict,C(info) means informational output, incl. C(previous), C(proposed) and C(sent) dicts,C(debug) means debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information | |
private_key: ${7:undefined} # not required. PEM formatted file that contains your private key to be used for signature-based authentication.,The name of the key (without extension) is used as the certificate name in ACI, unless C(certificate_name) is specified. | |
description: ${8:undefined} # not required. Description for the filter. | |
certificate_name: ${9:C(private_key) basename} # not required. The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.,It defaults to the C(private_key) basename, without extension. | |
state: ${10|absent,present,query|} # not required. choices: absent;present;query. Use C(present) or C(absent) for adding or removing.,Use C(query) for listing an object or multiple objects. | |
timeout: ${11:30} # not required. The socket level timeout in seconds. | |
use_ssl: ${12:yes} # not required. If C(no), an HTTP connection will be used instead of the default HTTPS connection. | |
validate_certs: ${13:yes} # not required. If C(no), SSL certificates will not be validated.,This should only set to C(no) used on personally controlled sites using self-signed certificates. | |
port: ${14:443 (for https) and 80 (for http)} # not required. Port number to be used for REST connection. | |
use_proxy: ${15:yes} # not required. If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. | |
""" | |
'aci_filter_entry': | |
'prefix': "aci_filter_entry_snippet" | |
'description': "Manage filter entries (vz:Entry)" | |
'body': """ | |
aci_filter_entry: | |
username: ${1:admin} # required. The username to use for authentication. | |
host: ${2:undefined} # required. IP Address or hostname of APIC resolvable by Ansible control host. | |
password: ${3:undefined} # required. The password to use for authentication. | |
dst_port_end: ${4|Valid TCP/UDP Port Ranges|} # not required. choices: Valid TCP/UDP Port Ranges. Used to set the destination end port when ip_protocol is tcp or udp.,The APIC defaults new Filter Entries to C(unspecified). | |
ether_type: ${5|arp,fcoe,ip,mac_security,mpls_ucast,trill,unspecified|} # not required. choices: arp;fcoe;ip;mac_security;mpls_ucast;trill;unspecified. The Ethernet type.,The APIC defaults new Filter Entries to C(unspecified). | |
arp_flag: ${6|arp_reply,arp_request,unspecified|} # not required. choices: arp_reply;arp_request;unspecified. The arp flag to use when the ether_type is arp.,The APIC defaults new Filter Entries to C(unspecified). | |
private_key: ${7:undefined} # not required. PEM formatted file that contains your private key to be used for signature-based authentication.,The name of the key (without extension) is used as the certificate name in ACI, unless C(certificate_name) is specified. | |
use_ssl: ${8:yes} # not required. If C(no), an HTTP connection will be used instead of the default HTTPS connection. | |
port: ${9:443 (for https) and 80 (for http)} # not required. Port number to be used for REST connection. | |
ip_protocol: ${10|eigrp,egp,icmp,icmpv6,igmp,igp,l2tp,ospfigp,pim,tcp,udp,unspecified|} # not required. choices: eigrp;egp;icmp;icmpv6;igmp;igp;l2tp;ospfigp;pim;tcp;udp;unspecified. The IP Protocol type when ether_type is ip.,The APIC defaults new Filter Entries to C(unspecified). | |
output_level: ${11|debug,info,normal|} # not required. choices: debug;info;normal. Influence the output of this ACI module.,C(normal) means the standard output, incl. C(current) dict,C(info) means informational output, incl. C(previous), C(proposed) and C(sent) dicts,C(debug) means debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information | |
use_proxy: ${12:yes} # not required. If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. | |
icmp_msg_type: ${13|dst_unreachable,echo,echo_reply,src_quench,time_exceeded,unspecified|} # not required. choices: dst_unreachable;echo;echo_reply;src_quench;time_exceeded;unspecified. ICMPv4 message type; used when ip_protocol is icmp.,The APIC defaults new Filter Entries to C(unspecified). | |
state: ${14|absent,present,query|} # not required. choices: absent;present;query. present, absent, query | |
dst_port_start: ${15|Valid TCP/UDP Port Ranges|} # not required. choices: Valid TCP/UDP Port Ranges. Used to set the destination start port when ip_protocol is tcp or udp.,The APIC defaults new Filter Entries to C(unspecified). | |
description: ${16:undefined} # not required. Description for the Filter Entry. | |
icmp6_msg_type: ${17|dst_unreachable,echo_request,echo_reply,neighbor_advertisement,neighbor_solicitation,redirect,time_exceeded,unspecified|} # not required. choices: dst_unreachable;echo_request;echo_reply;neighbor_advertisement;neighbor_solicitation;redirect;time_exceeded;unspecified. ICMPv6 message type; used when ip_protocol is icmpv6.,The APIC defaults new Filter Entries to C(unspecified). | |
certificate_name: ${18:C(private_key) basename} # not required. The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.,It defaults to the C(private_key) basename, without extension. | |
stateful: ${19:undefined} # not required. Determines the statefulness of the filter entry. | |
tenant: ${20:undefined} # not required. The name of the tenant. | |
filter: ${21:undefined} # not required. The name of Filter that the entry should belong to. | |
dst_port: ${22|Valid TCP/UDP Port Ranges|} # not required. choices: Valid TCP/UDP Port Ranges. Used to set both destination start and end ports to the same value when ip_protocol is tcp or udp.,The APIC defaults new Filter Entries to C(unspecified). | |
timeout: ${23:30} # not required. The socket level timeout in seconds. | |
entry: ${24:undefined} # not required. Then name of the Filter Entry. | |
validate_certs: ${25:yes} # not required. If C(no), SSL certificates will not be validated.,This should only set to C(no) used on personally controlled sites using self-signed certificates. | |
""" | |
'aci_firmware_source': | |
'prefix': "aci_firmware_source_snippet" | |
'description': "Manage firmware image sources (firmware:OSource)" | |
'body': """ | |
aci_firmware_source: | |
username: ${1:admin} # required. The username to use for authentication. | |
host: ${2:undefined} # required. IP Address or hostname of APIC resolvable by Ansible control host. | |
password: ${3:undefined} # required. The password to use for authentication. | |
source: ${4:undefined} # required. The identifying name for the outside source of images, such as an HTTP or SCP server. | |
private_key: ${5:undefined} # not required. PEM formatted file that contains your private key to be used for signature-based authentication.,The name of the key (without extension) is used as the certificate name in ACI, unless C(certificate_name) is specified. | |
timeout: ${6:30} # not required. The socket level timeout in seconds. | |
certificate_name: ${7:C(private_key) basename} # not required. The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.,It defaults to the C(private_key) basename, without extension. | |
use_ssl: ${8:yes} # not required. If C(no), an HTTP connection will be used instead of the default HTTPS connection. | |
port: ${9:443 (for https) and 80 (for http)} # not required. Port number to be used for REST connection. | |
url_password: ${10:undefined} # not required. The Firmware password or key string. | |
url_protocol: ${11|http,local,scp,usbkey|} # not required. choices: http;local;scp;usbkey. The Firmware download protocol. | |
use_proxy: ${12:yes} # not required. If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. | |
url: ${13:undefined} # not required. The firmware URL for the image(s) on the source. | |
output_level: ${14|debug,info,normal|} # not required. choices: debug;info;normal. Influence the output of this ACI module.,C(normal) means the standard output, incl. C(current) dict,C(info) means informational output, incl. C(previous), C(proposed) and C(sent) dicts,C(debug) means debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information | |
state: ${15|absent,present,query|} # not required. choices: absent;present;query. Use C(present) or C(absent) for adding or removing.,Use C(query) for listing an object or multiple objects. | |
url_username: ${16:undefined} # not required. The username for the source. | |
polling_interval: ${17:undefined} # not required. Polling interval in minutes. | |
validate_certs: ${18:yes} # not required. If C(no), SSL certificates will not be validated.,This should only set to C(no) used on personally controlled sites using self-signed certificates. | |
""" | |
'aci_interface_policy_fc': | |
'prefix': "aci_interface_policy_fc_snippet" | |
'description': "Manage Fibre Channel interface policies (fc:IfPol)" | |
'body': """ | |
aci_interface_policy_fc: | |
username: ${1:admin} # required. The username to use for authentication. | |
host: ${2:undefined} # required. IP Address or hostname of APIC resolvable by Ansible control host. | |
fc_policy: ${3:undefined} # required. The name of the Fiber Channel interface policy. | |
password: ${4:undefined} # required. The password to use for authentication. | |
private_key: ${5:undefined} # not required. PEM formatted file that contains your private key to be used for signature-based authentication.,The name of the key (without extension) is used as the certificate name in ACI, unless C(certificate_name) is specified. | |
description: ${6:undefined} # not required. The description of the Fiber Channel interface policy. | |
certificate_name: ${7:C(private_key) basename} # not required. The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.,It defaults to the C(private_key) basename, without extension. | |
output_level: ${8|debug,info,normal|} # not required. choices: debug;info;normal. Influence the output of this ACI module.,C(normal) means the standard output, incl. C(current) dict,C(info) means informational output, incl. C(previous), C(proposed) and C(sent) dicts,C(debug) means debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information | |
validate_certs: ${9:yes} # not required. If C(no), SSL certificates will not be validated.,This should only set to C(no) used on personally controlled sites using self-signed certificates. | |
state: ${10|absent,present,query|} # not required. choices: absent;present;query. Use C(present) or C(absent) for adding or removing.,Use C(query) for listing an object or multiple objects. | |
timeout: ${11:30} # not required. The socket level timeout in seconds. | |
use_ssl: ${12:yes} # not required. If C(no), an HTTP connection will be used instead of the default HTTPS connection. | |
port_mode: ${13|f,np|} # not required. choices: f;np. Port Mode | |
port: ${14:443 (for https) and 80 (for http)} # not required. Port number to be used for REST connection. | |
use_proxy: ${15:yes} # not required. If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. | |
""" | |
'aci_interface_policy_l2': | |
'prefix': "aci_interface_policy_l2_snippet" | |
'description': "Manage Layer 2 interface policies (l2:IfPol)" | |
'body': """ | |
aci_interface_policy_l2: | |
username: ${1:admin} # required. The username to use for authentication. | |
host: ${2:undefined} # required. IP Address or hostname of APIC resolvable by Ansible control host. | |
password: ${3:undefined} # required. The password to use for authentication. | |
l2_policy: ${4:undefined} # required. The name of the Layer 2 interface policy. | |
private_key: ${5:undefined} # not required. PEM formatted file that contains your private key to be used for signature-based authentication.,The name of the key (without extension) is used as the certificate name in ACI, unless C(certificate_name) is specified. | |
description: ${6:undefined} # not required. The description of the Layer 2 interface policy. | |
certificate_name: ${7:C(private_key) basename} # not required. The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.,It defaults to the C(private_key) basename, without extension. | |
vepa: ${8|disabled,enabled|} # not required. choices: disabled;enabled. Determines if Virtual Ethernet Port Aggregator is disabled or enabled. | |
use_ssl: ${9:yes} # not required. If C(no), an HTTP connection will be used instead of the default HTTPS connection. | |
vlan_scope: ${10|global,portlocal|} # not required. choices: global;portlocal. The scope of the VLAN. | |
port: ${11:443 (for https) and 80 (for http)} # not required. Port number to be used for REST connection. | |
use_proxy: ${12:yes} # not required. If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. | |
output_level: ${13|debug,info,normal|} # not required. choices: debug;info;normal. Influence the output of this ACI module.,C(normal) means the standard output, incl. C(current) dict,C(info) means informational output, incl. C(previous), C(proposed) and C(sent) dicts,C(debug) means debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information | |
state: ${14|absent,present,query|} # not required. choices: absent;present;query. Use C(present) or C(absent) for adding or removing.,Use C(query) for listing an object or multiple objects. | |
qinq: ${15|core,disabled,edge|} # not required. choices: core;disabled;edge. Determines if QinQ is disabled or if the port should be considered a core or edge port. | |
timeout: ${16:30} # not required. The socket level timeout in seconds. | |
validate_certs: ${17:yes} # not required. If C(no), SSL certificates will not be validated.,This should only set to C(no) used on personally controlled sites using self-signed certificates. | |
""" | |
'aci_interface_policy_leaf_policy_group': | |
'prefix': "aci_interface_policy_leaf_policy_group_snippet" | |
'description': "Manage fabric interface policy leaf policy groups (infra:AccBndlGrp, infra:AccPortGrp)" | |
'body': """ | |
aci_interface_policy_leaf_policy_group: | |
username: ${1:admin} # required. The username to use for authentication. | |
host: ${2:undefined} # required. IP Address or hostname of APIC resolvable by Ansible control host. | |
password: ${3:undefined} # required. The password to use for authentication. | |
private_key: ${4:undefined} # not required. PEM formatted file that contains your private key to be used for signature-based authentication.,The name of the key (without extension) is used as the certificate name in ACI, unless C(certificate_name) is specified. | |
stp_interface_policy: ${5:undefined} # not required. Choice of stp_interface_policy to be used as part of the leaf policy group to be created. | |
description: ${6:undefined} # not required. Description for the leaf policy group to be created. | |
egress_data_plane_policing_policy: ${7:undefined} # not required. Choice of egress_data_plane_policing_policy to be used as part of the leaf policy group to be created. | |
certificate_name: ${8:C(private_key) basename} # not required. The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.,It defaults to the C(private_key) basename, without extension. | |
cdp_policy: ${9:undefined} # not required. Choice of cdp_policy to be used as part of the leaf policy group to be created. | |
storm_control_interface_policy: ${10:undefined} # not required. Choice of storm_control_interface_policy to be used as part of the leaf policy group to be created. | |
port_channel_policy: ${11:undefined} # not required. Choice of port_channel_policy to be used as part of the leaf policy group to be created. | |
mcp_policy: ${12:undefined} # not required. Choice of mcp_policy to be used as part of the leaf policy group to be created. | |
lag_type: ${13|leaf,link,node|} # not required. choices: leaf;link;node. Selector for the type of leaf policy group we want to create.,C(leaf) for Leaf Access Port Policy Group,C(link) for Port Channel (PC),C(node) for Virtual Port Channel (VPC) | |
use_ssl: ${14:yes} # not required. If C(no), an HTTP connection will be used instead of the default HTTPS connection. | |
monitoring_policy: ${15:undefined} # not required. Choice of monitoring_policy to be used as part of the leaf policy group to be created. | |
port: ${16:443 (for https) and 80 (for http)} # not required. Port number to be used for REST connection. | |
aep: ${17:undefined} # not required. Choice of attached_entity_profile (AEP) to be used as part of the leaf policy group to be created. | |
use_proxy: ${18:yes} # not required. If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. | |
priority_flow_control_policy: ${19:undefined} # not required. Choice of priority_flow_control_policy to be used as part of the leaf policy group to be created. | |
fibre_channel_interface_policy: ${20:undefined} # not required. Choice of fibre_channel_interface_policy to be used as part of the leaf policy group to be created. | |
l2_interface_policy: ${21:undefined} # not required. Choice of l2_interface_policy to be used as part of the leaf policy group to be created. | |
policy_group: ${22:undefined} # not required. Name of the leaf policy group to be added/deleted. | |
port_security_policy: ${23:undefined} # not required. Choice of port_security_policy to be used as part of the leaf policy group to be created. | |
output_level: ${24|debug,info,normal|} # not required. choices: debug;info;normal. Influence the output of this ACI module.,C(normal) means the standard output, incl. C(current) dict,C(info) means informational output, incl. C(previous), C(proposed) and C(sent) dicts,C(debug) means debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information | |
link_level_policy: ${25:undefined} # not required. Choice of link_level_policy to be used as part of the leaf policy group to be created. | |
state: ${26|absent,present,query|} # not required. choices: absent;present;query. Use C(present) or C(absent) for adding or removing.,Use C(query) for listing an object or multiple objects. | |
ingress_data_plane_policing_policy: ${27:undefined} # not required. Choice of ingress_data_plane_policing_policy to be used as part of the leaf policy group to be created. | |
timeout: ${28:30} # not required. The socket level timeout in seconds. | |
slow_drain_policy: ${29:undefined} # not required. Choice of slow_drain_policy to be used as part of the leaf policy group to be created. | |
validate_certs: ${30:yes} # not required. If C(no), SSL certificates will not be validated.,This should only set to C(no) used on personally controlled sites using self-signed certificates. | |
lldp_policy: ${31:undefined} # not required. Choice of lldp_policy to be used as part of the leaf policy group to be created. | |
""" | |
'aci_interface_policy_leaf_profile': | |
'prefix': "aci_interface_policy_leaf_profile_snippet" | |
'description': "Manage fabric interface policy leaf profiles (infra:AccPortP)" | |
'body': """ | |
aci_interface_policy_leaf_profile: | |
username: ${1:admin} # required. The username to use for authentication. | |
host: ${2:undefined} # required. IP Address or hostname of APIC resolvable by Ansible control host. | |
password: ${3:undefined} # required. The password to use for authentication. | |
leaf_interface_profile: ${4:undefined} # required. The name of the Fabric access policy leaf interface profile. | |
private_key: ${5:undefined} # not required. PEM formatted file that contains your private key to be used for signature-based authentication.,The name of the key (without extension) is used as the certificate name in ACI, unless C(certificate_name) is specified. | |
use_proxy: ${6:yes} # not required. If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. | |
certificate_name: ${7:C(private_key) basename} # not required. The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.,It defaults to the C(private_key) basename, without extension. | |
output_level: ${8|debug,info,normal|} # not required. choices: debug;info;normal. Influence the output of this ACI module.,C(normal) means the standard output, incl. C(current) dict,C(info) means informational output, incl. C(previous), C(proposed) and C(sent) dicts,C(debug) means debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information | |
validate_certs: ${9:yes} # not required. If C(no), SSL certificates will not be validated.,This should only set to C(no) used on personally controlled sites using self-signed certificates. | |
state: ${10|absent,present,query|} # not required. choices: absent;present;query. Use C(present) or C(absent) for adding or removing.,Use C(query) for listing an object or multiple objects. | |
timeout: ${11:30} # not required. The socket level timeout in seconds. | |
use_ssl: ${12:yes} # not required. If C(no), an HTTP connection will be used instead of the default HTTPS connection. | |
port: ${13:443 (for https) and 80 (for http)} # not required. Port number to be used for REST connection. | |
description: ${14:undefined} # not required. Description for the Fabric access policy leaf interface profile. | |
""" | |
'aci_interface_policy_lldp': | |
'prefix': "aci_interface_policy_lldp_snippet" | |
'description': "Manage LLDP interface policies (lldp:IfPol)" | |
'body': """ | |
aci_interface_policy_lldp: | |
username: ${1:admin} # required. The username to use for authentication. | |
receive_state: ${2|disabled,enabled|} # required. choices: disabled;enabled. Enable or disable Receive state. | |
lldp_policy: ${3:undefined} # required. The LLDP interface policy name. | |
host: ${4:undefined} # required. IP Address or hostname of APIC resolvable by Ansible control host. | |
password: ${5:undefined} # required. The password to use for authentication. | |
private_key: ${6:undefined} # not required. PEM formatted file that contains your private key to be used for signature-based authentication.,The name of the key (without extension) is used as the certificate name in ACI, unless C(certificate_name) is specified. | |
description: ${7:undefined} # not required. The description for the LLDP interface policy name. | |
certificate_name: ${8:C(private_key) basename} # not required. The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.,It defaults to the C(private_key) basename, without extension. | |
output_level: ${9|debug,info,normal|} # not required. choices: debug;info;normal. Influence the output of this ACI module.,C(normal) means the standard output, incl. C(current) dict,C(info) means informational output, incl. C(previous), C(proposed) and C(sent) dicts,C(debug) means debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information | |
state: ${10|absent,present,query|} # not required. choices: absent;present;query. Use C(present) or C(absent) for adding or removing.,Use C(query) for listing an object or multiple objects. | |
transmit_state: ${11|disabled,enabled|} # not required. choices: disabled;enabled. Enable or Disable Transmit state. | |
timeout: ${12:30} # not required. The socket level timeout in seconds. | |
use_ssl: ${13:yes} # not required. If C(no), an HTTP connection will be used instead of the default HTTPS connection. | |
validate_certs: ${14:yes} # not required. If C(no), SSL certificates will not be validated.,This should only set to C(no) used on personally controlled sites using self-signed certificates. | |
port: ${15:443 (for https) and 80 (for http)} # not required. Port number to be used for REST connection. | |
use_proxy: ${16:yes} # not required. If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. | |
""" | |
'aci_interface_policy_mcp': | |
'prefix': "aci_interface_policy_mcp_snippet" | |
'description': "Manage MCP interface policies (mcp:IfPol)" | |
'body': """ | |
aci_interface_policy_mcp: | |
username: ${1:admin} # required. The username to use for authentication. | |
host: ${2:undefined} # required. IP Address or hostname of APIC resolvable by Ansible control host. | |
password: ${3:undefined} # required. The password to use for authentication. | |
mcp: ${4:undefined} # required. The name of the MCP interface. | |
use_proxy: ${5:yes} # not required. If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. | |
private_key: ${6:undefined} # not required. PEM formatted file that contains your private key to be used for signature-based authentication.,The name of the key (without extension) is used as the certificate name in ACI, unless C(certificate_name) is specified. | |
description: ${7:undefined} # not required. The description for the MCP interface. | |
certificate_name: ${8:C(private_key) basename} # not required. The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.,It defaults to the C(private_key) basename, without extension. | |
output_level: ${9|debug,info,normal|} # not required. choices: debug;info;normal. Influence the output of this ACI module.,C(normal) means the standard output, incl. C(current) dict,C(info) means informational output, incl. C(previous), C(proposed) and C(sent) dicts,C(debug) means debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information | |
state: ${10|absent,present,query|} # not required. choices: absent;present;query. Use C(present) or C(absent) for adding or removing.,Use C(query) for listing an object or multiple objects. | |
admin_state: ${11|disable,enable|} # not required. choices: disable;enable. Enable or disable admin state. | |
timeout: ${12:30} # not required. The socket level timeout in seconds. | |
use_ssl: ${13:yes} # not required. If C(no), an HTTP connection will be used instead of the default HTTPS connection. | |
validate_certs: ${14:yes} # not required. If C(no), SSL certificates will not be validated.,This should only set to C(no) used on personally controlled sites using self-signed certificates. | |
port: ${15:443 (for https) and 80 (for http)} # not required. Port number to be used for REST connection. | |
""" | |
'aci_interface_policy_port_channel': | |
'prefix': "aci_interface_policy_port_channel_snippet" | |
'description': "Manage port channel interface policies (lacp:LagPol)" | |
'body': """ | |
aci_interface_policy_port_channel: | |
port_channel: ${1:undefined} # required. Name of the port channel. | |
username: ${2:admin} # required. The username to use for authentication. | |
host: ${3:undefined} # required. IP Address or hostname of APIC resolvable by Ansible control host. | |
password: ${4:undefined} # required. The password to use for authentication. | |
min_links: ${5|Ranges from 1 to 16|} # not required. choices: Ranges from 1 to 16. Minimum links (range 1-16).,The APIC defaults new Port Channel Policies to C(1). | |
use_ssl: ${6:yes} # not required. If C(no), an HTTP connection will be used instead of the default HTTPS connection. | |
fast_select: ${7:yes} # not required. Determines if Fast Select is enabled for Hot Standby Ports.,This makes up the LACP Policy Control Policy; if one setting is defined, then all other Control Properties left undefined or set to false will not exist after the task is ran.,The APIC defaults new LACP Policies to C(yes). | |
port: ${8:443 (for https) and 80 (for http)} # not required. Port number to be used for REST connection. | |
use_proxy: ${9:yes} # not required. If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. | |
load_defer: ${10:no} # not required. Determines if Load Defer is enabled.,This makes up the LACP Policy Control Policy; if one setting is defined, then all other Control Properties left undefined or set to false will not exist after the task is ran.,The APIC defaults new LACP Policies to C(no). | |
state: ${11|absent,present,query|} # not required. choices: absent;present;query. Use C(present) or C(absent) for adding or removing.,Use C(query) for listing an object or multiple objects. | |
private_key: ${12:undefined} # not required. PEM formatted file that contains your private key to be used for signature-based authentication.,The name of the key (without extension) is used as the certificate name in ACI, unless C(certificate_name) is specified. | |
description: ${13:undefined} # not required. The description for the port channel. | |
certificate_name: ${14:C(private_key) basename} # not required. The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.,It defaults to the C(private_key) basename, without extension. | |
graceful_convergence: ${15:yes} # not required. Determines if Graceful Convergence is enabled.,This makes up the LACP Policy Control Policy; if one setting is defined, then all other Control Properties left undefined or set to false will not exist after the task is ran.,The APIC defaults new LACP Policies to C(yes). | |
symmetric_hash: ${16:no} # not required. Determines if Symmetric Hashing is enabled.,This makes up the LACP Policy Control Policy; if one setting is defined, then all other Control Properties left undefined or set to false will not exist after the task is ran.,The APIC defaults new LACP Policies to C(no). | |
suspend_individual: ${17:yes} # not required. Determines if Suspend Individual is enabled.,This makes up the LACP Policy Control Policy; if one setting is defined, then all other Control Properties left undefined or set to false will not exist after the task is ran.,The APIC defaults new LACP Policies to C(yes). | |
output_level: ${18|debug,info,normal|} # not required. choices: debug;info;normal. Influence the output of this ACI module.,C(normal) means the standard output, incl. C(current) dict,C(info) means informational output, incl. C(previous), C(proposed) and C(sent) dicts,C(debug) means debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information | |
mode: ${19|active,mac-pin,mac-pin-nicload,off,passive|} # not required. choices: active;mac-pin;mac-pin-nicload;off;passive. Port channel interface policy mode.,Determines the LACP method to use for forming port-channels.,The APIC defaults new Port Channel Polices to C(off). | |
timeout: ${20:30} # not required. The socket level timeout in seconds. | |
validate_certs: ${21:yes} # not required. If C(no), SSL certificates will not be validated.,This should only set to C(no) used on personally controlled sites using self-signed certificates. | |
max_links: ${22|Ranges from 1 to 16|} # not required. choices: Ranges from 1 to 16. Maximum links (range 1-16).,The APIC defaults new Port Channel Policies to C(16). | |
""" | |
'aci_interface_policy_port_security': | |
'prefix': "aci_interface_policy_port_security_snippet" | |
'description': "Manage port security (l2:PortSecurityPol)" | |
'body': """ | |
aci_interface_policy_port_security: | |
username: ${1:admin} # required. The username to use for authentication. | |
host: ${2:undefined} # required. IP Address or hostname of APIC resolvable by Ansible control host. | |
port_security: ${3:undefined} # required. The name of the port security. | |
password: ${4:undefined} # required. The password to use for authentication. | |
private_key: ${5:undefined} # not required. PEM formatted file that contains your private key to be used for signature-based authentication.,The name of the key (without extension) is used as the certificate name in ACI, unless C(certificate_name) is specified. | |
max_end_points: ${6:undefined} # not required. Maximum number of end points (range 0-12000).,The APIC defaults new port-security policies to C(0). | |
description: ${7:undefined} # not required. The description for the contract. | |
certificate_name: ${8:C(private_key) basename} # not required. The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.,It defaults to the C(private_key) basename, without extension. | |
output_level: ${9|debug,info,normal|} # not required. choices: debug;info;normal. Influence the output of this ACI module.,C(normal) means the standard output, incl. C(current) dict,C(info) means informational output, incl. C(previous), C(proposed) and C(sent) dicts,C(debug) means debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information | |
state: ${10|absent,present,query|} # not required. choices: absent;present;query. Use C(present) or C(absent) for adding or removing.,Use C(query) for listing an object or multiple objects. | |
timeout: ${11:30} # not required. The socket level timeout in seconds. | |
use_ssl: ${12:yes} # not required. If C(no), an HTTP connection will be used instead of the default HTTPS connection. | |
validate_certs: ${13:yes} # not required. If C(no), SSL certificates will not be validated.,This should only set to C(no) used on personally controlled sites using self-signed certificates. | |
port: ${14:443 (for https) and 80 (for http)} # not required. Port number to be used for REST connection. | |
use_proxy: ${15:yes} # not required. If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. | |
""" | |
'aci_interface_selector_to_switch_policy_leaf_profile': | |
'prefix': "aci_interface_selector_to_switch_policy_leaf_profile_snippet" | |
'description': "Bind interface selector profiles to switch policy leaf profiles (infra:RsAccPortP)" | |
'body': """ | |
aci_interface_selector_to_switch_policy_leaf_profile: | |
username: ${1:admin} # required. The username to use for authentication. | |
host: ${2:undefined} # required. IP Address or hostname of APIC resolvable by Ansible control host. | |
password: ${3:undefined} # required. The password to use for authentication. | |
private_key: ${4:undefined} # not required. PEM formatted file that contains your private key to be used for signature-based authentication.,The name of the key (without extension) is used as the certificate name in ACI, unless C(certificate_name) is specified. | |
use_proxy: ${5:yes} # not required. If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. | |
certificate_name: ${6:C(private_key) basename} # not required. The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.,It defaults to the C(private_key) basename, without extension. | |
leaf_profile: ${7:undefined} # not required. Name of the Leaf Profile to which we add a Selector. | |
output_level: ${8|debug,info,normal|} # not required. choices: debug;info;normal. Influence the output of this ACI module.,C(normal) means the standard output, incl. C(current) dict,C(info) means informational output, incl. C(previous), C(proposed) and C(sent) dicts,C(debug) means debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information | |
state: ${9|absent,present,query|} # not required. choices: absent;present;query. Use C(present) or C(absent) for adding or removing.,Use C(query) for listing an object or multiple objects. | |
timeout: ${10:30} # not required. The socket level timeout in seconds. | |
use_ssl: ${11:yes} # not required. If C(no), an HTTP connection will be used instead of the default HTTPS connection. | |
interface_selector: ${12:undefined} # not required. Name of Interface Profile Selector to be added and associated with the Leaf Profile. | |
validate_certs: ${13:yes} # not required. If C(no), SSL certificates will not be validated.,This should only set to C(no) used on personally controlled sites using self-signed certificates. | |
port: ${14:443 (for https) and 80 (for http)} # not required. Port number to be used for REST connection. | |
""" | |
'aci_l3out_route_tag_policy': | |
'prefix': "aci_l3out_route_tag_policy_snippet" | |
'description': "Manage route tag policies (l3ext:RouteTagPol)" | |
'body': """ | |
aci_l3out_route_tag_policy: | |
username: ${1:admin} # required. The username to use for authentication. | |
host: ${2:undefined} # required. IP Address or hostname of APIC resolvable by Ansible control host. | |
rtp: ${3:undefined} # required. The name of the route tag policy. | |
password: ${4:undefined} # required. The password to use for authentication. | |
tenant: ${5:undefined} # required. The name of the tenant. | |
private_key: ${6:undefined} # not required. PEM formatted file that contains your private key to be used for signature-based authentication.,The name of the key (without extension) is used as the certificate name in ACI, unless C(certificate_name) is specified. | |
description: ${7:undefined} # not required. The description for the route tag policy. | |
certificate_name: ${8:C(private_key) basename} # not required. The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.,It defaults to the C(private_key) basename, without extension. | |
output_level: ${9|debug,info,normal|} # not required. choices: debug;info;normal. Influence the output of this ACI module.,C(normal) means the standard output, incl. C(current) dict,C(info) means informational output, incl. C(previous), C(proposed) and C(sent) dicts,C(debug) means debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information | |
state: ${10|absent,present,query|} # not required. choices: absent;present;query. Use C(present) or C(absent) for adding or removing.,Use C(query) for listing an object or multiple objects. | |
tag: ${11:4294967295} # not required. The value of the route tag (range 0-4294967295). | |
timeout: ${12:30} # not required. The socket level timeout in seconds. | |
use_ssl: ${13:yes} # not required. If C(no), an HTTP connection will be used instead of the default HTTPS connection. | |
validate_certs: ${14:yes} # not required. If C(no), SSL certificates will not be validated.,This should only set to C(no) used on personally controlled sites using self-signed certificates. | |
port: ${15:443 (for https) and 80 (for http)} # not required. Port number to be used for REST connection. | |
use_proxy: ${16:yes} # not required. If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. | |
""" | |
'aci_rest': | |
'prefix': "aci_rest_snippet" | |
'description': "Direct access to the Cisco APIC REST API" | |
'body': """ | |
aci_rest: | |
username: ${1:admin} # required. The username to use for authentication. | |
host: ${2:undefined} # required. IP Address or hostname of APIC resolvable by Ansible control host. | |
path: ${3:undefined} # required. URI being used to execute API calls.,Must end in C(.xml) or C(.json). | |
password: ${4:undefined} # required. The password to use for authentication. | |
src: ${5:undefined} # not required. Name of the absolute path of the filname that includes the body of the http request being sent to the ACI fabric. | |
private_key: ${6:undefined} # not required. PEM formatted file that contains your private key to be used for signature-based authentication.,The name of the key (without extension) is used as the certificate name in ACI, unless C(certificate_name) is specified. | |
use_proxy: ${7:yes} # not required. If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. | |
certificate_name: ${8:C(private_key) basename} # not required. The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.,It defaults to the C(private_key) basename, without extension. | |
port: ${9:443 (for https) and 80 (for http)} # not required. Port number to be used for REST connection. | |
content: ${10:undefined} # not required. When used instead of C(src), sets the payload of the API request directly.,This may be convenient to template simple requests, for anything complex use the M(template) module. | |
output_level: ${11|debug,info,normal|} # not required. choices: debug;info;normal. Influence the output of this ACI module.,C(normal) means the standard output, incl. C(current) dict,C(info) means informational output, incl. C(previous), C(proposed) and C(sent) dicts,C(debug) means debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information | |
timeout: ${12:30} # not required. The socket level timeout in seconds. | |
use_ssl: ${13:yes} # not required. If C(no), an HTTP connection will be used instead of the default HTTPS connection. | |
validate_certs: ${14:yes} # not required. If C(no), SSL certificates will not be validated.,This should only set to C(no) used on personally controlled sites using self-signed certificates. | |
method: ${15|delete,get,post|} # not required. choices: delete;get;post. The HTTP method of the request.,Using C(delete) is typically used for deleting objects.,Using C(get) is typically used for querying objects.,Using C(post) is typically used for modifying objects. | |
""" | |
'aci_static_binding_to_epg': | |
'prefix': "aci_static_binding_to_epg_snippet" | |
'description': "Bind static paths to EPGs (fv:RsPathAtt)" | |
'body': """ | |
aci_static_binding_to_epg: | |
username: ${1:admin} # required. The username to use for authentication. | |
host: ${2:undefined} # required. IP Address or hostname of APIC resolvable by Ansible control host. | |
password: ${3:undefined} # required. The password to use for authentication. | |
interface_type: ${4|fex,port_channel,switch_port,vpc|} # not required. choices: fex;port_channel;switch_port;vpc. The type of interface for the static EPG deployement.,The APIC defaults the C(interface_type) to C(switch_port). | |
ap: ${5:undefined} # not required. Name of an existing application network profile, that will contain the EPGs. | |
leafs: ${6:undefined} # not required. The switch ID(s) that the C(interface) belongs to.,When C(interface_type) is C(switch_port), C(port_channel), or C(fex), then C(leafs) is a string of the leaf ID.,When C(interface_type) is C(vpc), then C(leafs) is a list with both leaf IDs.,The C(leafs) value is usually something like '101' or '101-102' depending on C(connection_type). | |
use_ssl: ${7:yes} # not required. If C(no), an HTTP connection will be used instead of the default HTTPS connection. | |
pod_id: ${8:undefined} # not required. The pod number part of the tDn.,C(pod_id) is usually an integer below 10. | |
interface_mode: ${9|802.1p,access,native,regular,tagged,trunk,untagged|} # not required. choices: 802.1p;access;native;regular;tagged;trunk;untagged. Determines how layer 2 tags will be read from and added to frames.,Values C(802.1p) and C(native) are identical.,Values C(access) and C(untagged) are identical.,Values C(regular), C(tagged) and C(trunk) are identical.,The APIC defaults the mode to C(trunk). | |
use_proxy: ${10:yes} # not required. If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. | |
port: ${11:443 (for https) and 80 (for http)} # not required. Port number to be used for REST connection. | |
state: ${12|absent,present,query|} # not required. choices: absent;present;query. Use C(present) or C(absent) for adding or removing.,Use C(query) for listing an object or multiple objects. | |
private_key: ${13:undefined} # not required. PEM formatted file that contains your private key to be used for signature-based authentication.,The name of the key (without extension) is used as the certificate name in ACI, unless C(certificate_name) is specified. | |
certificate_name: ${14:C(private_key) basename} # not required. The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.,It defaults to the C(private_key) basename, without extension. | |
primary_encap_id: ${15|Valid encap IDs for specified encap,currently 1 to 4096|} # not required. choices: Valid encap IDs for specified encap;currently 1 to 4096. Determines the primary encapsulation ID associating the C(epg) with the interface path when using micro-segmentation. | |
interface: ${16:undefined} # not required. The C(interface) string value part of the tDn.,Usually a policy group like \"test-IntPolGrp\" or an interface of the following format \"1/7\" depending on C(interface_type). | |
encap_id: ${17|Valid encap IDs for specified encap,currently 1 to 4096|} # not required. choices: Valid encap IDs for specified encap;currently 1 to 4096. The encapsulation ID associating the C(epg) with the interface path.,This acts as the secondary C(encap_id) when using micro-segmentation. | |
tenant: ${18:undefined} # not required. Name of an existing tenant. | |
deploy_immediacy: ${19|immediate,lazy|} # not required. choices: immediate;lazy. The Deployement Immediacy of Static EPG on PC, VPC or Interface.,The APIC defaults the Deployement Immediacy to C(lazy). | |
output_level: ${20|debug,info,normal|} # not required. choices: debug;info;normal. Influence the output of this ACI module.,C(normal) means the standard output, incl. C(current) dict,C(info) means informational output, incl. C(previous), C(proposed) and C(sent) dicts,C(debug) means debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information | |
timeout: ${21:30} # not required. The socket level timeout in seconds. | |
epg: ${22:undefined} # not required. The name of the end point group. | |
validate_certs: ${23:yes} # not required. If C(no), SSL certificates will not be validated.,This should only set to C(no) used on personally controlled sites using self-signed certificates. | |
extpaths: ${24:undefined} # not required. The C(extpaths) integer value part of the tDn.,C(extpaths) is only used if C(interface_type) is C(fex).,Usually something like '1011'. | |
""" | |
'aci_switch_leaf_selector': | |
'prefix': "aci_switch_leaf_selector_snippet" | |
'description': "Bind leaf selectors to switch policy leaf profiles (infra:LeafS, infra:NodeBlk, infra:RsAccNodePGrep)" | |
'body': """ | |
aci_switch_leaf_selector: | |
username: ${1:admin} # required. The username to use for authentication. | |
host: ${2:undefined} # required. IP Address or hostname of APIC resolvable by Ansible control host. | |
password: ${3:undefined} # required. The password to use for authentication. | |
use_proxy: ${4:yes} # not required. If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. | |
private_key: ${5:undefined} # not required. PEM formatted file that contains your private key to be used for signature-based authentication.,The name of the key (without extension) is used as the certificate name in ACI, unless C(certificate_name) is specified. | |
from: ${6:undefined} # not required. Start of Node Block Range | |
description: ${7:undefined} # not required. The description to assign to the C(leaf) | |
certificate_name: ${8:C(private_key) basename} # not required. The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.,It defaults to the C(private_key) basename, without extension. | |
leaf_profile: ${9:undefined} # not required. Name of the Leaf Profile to which we add a Selector. | |
output_level: ${10|debug,info,normal|} # not required. choices: debug;info;normal. Influence the output of this ACI module.,C(normal) means the standard output, incl. C(current) dict,C(info) means informational output, incl. C(previous), C(proposed) and C(sent) dicts,C(debug) means debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information | |
to: ${11:undefined} # not required. Start of Node Block Range | |
state: ${12|absent,present,query|} # not required. choices: absent;present;query. Use C(present) or C(absent) for adding or removing.,Use C(query) for listing an object or multiple objects. | |
leaf_node_blk_description: ${13:undefined} # not required. The description to assign to the C(leaf_node_blk) | |
timeout: ${14:30} # not required. The socket level timeout in seconds. | |
use_ssl: ${15:yes} # not required. If C(no), an HTTP connection will be used instead of the default HTTPS connection. | |
leaf: ${16:undefined} # not required. Name of Leaf Selector. | |
validate_certs: ${17:yes} # not required. If C(no), SSL certificates will not be validated.,This should only set to C(no) used on personally controlled sites using self-signed certificates. | |
port: ${18:443 (for https) and 80 (for http)} # not required. Port number to be used for REST connection. | |
leaf_node_blk: ${19:undefined} # not required. Name of Node Block range to be added to Leaf Selector of given Leaf Profile | |
policy_group: ${20:undefined} # not required. Name of the Policy Group to be added to Leaf Selector of given Leaf Profile | |
""" | |
'aci_switch_policy_leaf_profile': | |
'prefix': "aci_switch_policy_leaf_profile_snippet" | |
'description': "Manage switch policy leaf profiles (infra:NodeP)" | |
'body': """ | |
aci_switch_policy_leaf_profile: | |
username: ${1:admin} # required. The username to use for authentication. | |
host: ${2:undefined} # required. IP Address or hostname of APIC resolvable by Ansible control host. | |
password: ${3:undefined} # required. The password to use for authentication. | |
private_key: ${4:undefined} # not required. PEM formatted file that contains your private key to be used for signature-based authentication.,The name of the key (without extension) is used as the certificate name in ACI, unless C(certificate_name) is specified. | |
use_proxy: ${5:yes} # not required. If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. | |
certificate_name: ${6:C(private_key) basename} # not required. The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.,It defaults to the C(private_key) basename, without extension. | |
leaf_profile: ${7:undefined} # not required. The name of the Leaf Profile. | |
output_level: ${8|debug,info,normal|} # not required. choices: debug;info;normal. Influence the output of this ACI module.,C(normal) means the standard output, incl. C(current) dict,C(info) means informational output, incl. C(previous), C(proposed) and C(sent) dicts,C(debug) means debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information | |
state: ${9|absent,present,query|} # not required. choices: absent;present;query. Use C(present) or C(absent) for adding or removing.,Use C(query) for listing an object or multiple objects. | |
timeout: ${10:30} # not required. The socket level timeout in seconds. | |
use_ssl: ${11:yes} # not required. If C(no), an HTTP connection will be used instead of the default HTTPS connection. | |
validate_certs: ${12:yes} # not required. If C(no), SSL certificates will not be validated.,This should only set to C(no) used on personally controlled sites using self-signed certificates. | |
port: ${13:443 (for https) and 80 (for http)} # not required. Port number to be used for REST connection. | |
description: ${14:undefined} # not required. Description for the Leaf Profile. | |
""" | |
'aci_switch_policy_vpc_protection_group': | |
'prefix': "aci_switch_policy_vpc_protection_group_snippet" | |
'description': "Manage switch policy explicit vPC protection groups (fabric:ExplicitGEp, fabric:NodePEp)." | |
'body': """ | |
aci_switch_policy_vpc_protection_group: | |
username: ${1:admin} # required. The username to use for authentication. | |
switch_2_id: ${2:undefined} # required. The ID of the Second Leaf Switch for the Explicit vPC Protection Group. | |
switch_1_id: ${3:undefined} # required. The ID of the first Leaf Switch for the Explicit vPC Protection Group. | |
host: ${4:undefined} # required. IP Address or hostname of APIC resolvable by Ansible control host. | |
protection_group: ${5:undefined} # required. The name of the Explicit vPC Protection Group. | |
password: ${6:undefined} # required. The password to use for authentication. | |
protection_group_id: ${7:undefined} # required. The Explicit vPC Protection Group ID. | |
private_key: ${8:undefined} # not required. PEM formatted file that contains your private key to be used for signature-based authentication.,The name of the key (without extension) is used as the certificate name in ACI, unless C(certificate_name) is specified. | |
certificate_name: ${9:C(private_key) basename} # not required. The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.,It defaults to the C(private_key) basename, without extension. | |
vpc_domain_policy: ${10:undefined} # not required. The vPC domain policy to be associated with the Explicit vPC Protection Group. | |
use_ssl: ${11:yes} # not required. If C(no), an HTTP connection will be used instead of the default HTTPS connection. | |
port: ${12:443 (for https) and 80 (for http)} # not required. Port number to be used for REST connection. | |
use_proxy: ${13:yes} # not required. If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. | |
validate_certs: ${14:yes} # not required. If C(no), SSL certificates will not be validated.,This should only set to C(no) used on personally controlled sites using self-signed certificates. | |
output_level: ${15|debug,info,normal|} # not required. choices: debug;info;normal. Influence the output of this ACI module.,C(normal) means the standard output, incl. C(current) dict,C(info) means informational output, incl. C(previous), C(proposed) and C(sent) dicts,C(debug) means debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information | |
state: ${16|absent,present,query|} # not required. choices: absent;present;query. Use C(present) or C(absent) for adding or removing.,Use C(query) for listing an object or multiple objects. | |
timeout: ${17:30} # not required. The socket level timeout in seconds. | |
""" | |
'aci_taboo_contract': | |
'prefix': "aci_taboo_contract_snippet" | |
'description': "Manage taboo contracts (vz:BrCP)" | |
'body': """ | |
aci_taboo_contract: | |
username: ${1:admin} # required. The username to use for authentication. | |
taboo_contract: ${2:undefined} # required. The name of the Taboo Contract. | |
host: ${3:undefined} # required. IP Address or hostname of APIC resolvable by Ansible control host. | |
password: ${4:undefined} # required. The password to use for authentication. | |
tenant: ${5:undefined} # required. The name of the tenant. | |
description: ${6:undefined} # not required. The description for the Taboo Contract. | |
certificate_name: ${7:C(private_key) basename} # not required. The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.,It defaults to the C(private_key) basename, without extension. | |
private_key: ${8:undefined} # not required. PEM formatted file that contains your private key to be used for signature-based authentication.,The name of the key (without extension) is used as the certificate name in ACI, unless C(certificate_name) is specified. | |
output_level: ${9|debug,info,normal|} # not required. choices: debug;info;normal. Influence the output of this ACI module.,C(normal) means the standard output, incl. C(current) dict,C(info) means informational output, incl. C(previous), C(proposed) and C(sent) dicts,C(debug) means debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information | |
state: ${10|absent,present,query|} # not required. choices: absent;present;query. Use C(present) or C(absent) for adding or removing.,Use C(query) for listing an object or multiple objects. | |
timeout: ${11:30} # not required. The socket level timeout in seconds. | |
use_ssl: ${12:yes} # not required. If C(no), an HTTP connection will be used instead of the default HTTPS connection. | |
scope: ${13|application-profile,context,global,tenant|} # not required. choices: application-profile;context;global;tenant. The scope of a service contract.,The APIC defaults new Taboo Contracts to C(context). | |
validate_certs: ${14:yes} # not required. If C(no), SSL certificates will not be validated.,This should only set to C(no) used on personally controlled sites using self-signed certificates. | |
port: ${15:443 (for https) and 80 (for http)} # not required. Port number to be used for REST connection. | |
use_proxy: ${16:yes} # not required. If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. | |
""" | |
'aci_tenant': | |
'prefix': "aci_tenant_snippet" | |
'description': "Manage tenants (fv:Tenant)" | |
'body': """ | |
aci_tenant: | |
username: ${1:admin} # required. The username to use for authentication. | |
host: ${2:undefined} # required. IP Address or hostname of APIC resolvable by Ansible control host. | |
password: ${3:undefined} # required. The password to use for authentication. | |
tenant: ${4:undefined} # required. The name of the tenant. | |
private_key: ${5:undefined} # not required. PEM formatted file that contains your private key to be used for signature-based authentication.,The name of the key (without extension) is used as the certificate name in ACI, unless C(certificate_name) is specified. | |
use_proxy: ${6:yes} # not required. If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. | |
certificate_name: ${7:C(private_key) basename} # not required. The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.,It defaults to the C(private_key) basename, without extension. | |
output_level: ${8|debug,info,normal|} # not required. choices: debug;info;normal. Influence the output of this ACI module.,C(normal) means the standard output, incl. C(current) dict,C(info) means informational output, incl. C(previous), C(proposed) and C(sent) dicts,C(debug) means debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information | |
state: ${9|absent,present,query|} # not required. choices: absent;present;query. Use C(present) or C(absent) for adding or removing.,Use C(query) for listing an object or multiple objects. | |
timeout: ${10:30} # not required. The socket level timeout in seconds. | |
use_ssl: ${11:yes} # not required. If C(no), an HTTP connection will be used instead of the default HTTPS connection. | |
validate_certs: ${12:yes} # not required. If C(no), SSL certificates will not be validated.,This should only set to C(no) used on personally controlled sites using self-signed certificates. | |
port: ${13:443 (for https) and 80 (for http)} # not required. Port number to be used for REST connection. | |
description: ${14:undefined} # not required. Description for the tenant. | |
""" | |
'aci_tenant_action_rule_profile': | |
'prefix': "aci_tenant_action_rule_profile_snippet" | |
'description': "Manage action rule profiles (rtctrl:AttrP)" | |
'body': """ | |
aci_tenant_action_rule_profile: | |
username: ${1:admin} # required. The username to use for authentication. | |
host: ${2:undefined} # required. IP Address or hostname of APIC resolvable by Ansible control host. | |
password: ${3:undefined} # required. The password to use for authentication. | |
output_level: ${4|debug,info,normal|} # not required. choices: debug;info;normal. Influence the output of this ACI module.,C(normal) means the standard output, incl. C(current) dict,C(info) means informational output, incl. C(previous), C(proposed) and C(sent) dicts,C(debug) means debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information | |
private_key: ${5:undefined} # not required. PEM formatted file that contains your private key to be used for signature-based authentication.,The name of the key (without extension) is used as the certificate name in ACI, unless C(certificate_name) is specified. | |
description: ${6:undefined} # not required. The description for the action rule profile. | |
certificate_name: ${7:C(private_key) basename} # not required. The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.,It defaults to the C(private_key) basename, without extension. | |
action_rule: ${8:undefined} # not required. The name of the action rule profile. | |
state: ${9|absent,present,query|} # not required. choices: absent;present;query. Use C(present) or C(absent) for adding or removing.,Use C(query) for listing an object or multiple objects. | |
timeout: ${10:30} # not required. The socket level timeout in seconds. | |
use_ssl: ${11:yes} # not required. If C(no), an HTTP connection will be used instead of the default HTTPS connection. | |
validate_certs: ${12:yes} # not required. If C(no), SSL certificates will not be validated.,This should only set to C(no) used on personally controlled sites using self-signed certificates. | |
port: ${13:443 (for https) and 80 (for http)} # not required. Port number to be used for REST connection. | |
tenant: ${14:undefined} # not required. The name of the tenant. | |
use_proxy: ${15:yes} # not required. If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. | |
""" | |
'aci_tenant_ep_retention_policy': | |
'prefix': "aci_tenant_ep_retention_policy_snippet" | |
'description': "Manage End Point (EP) retention protocol policies (fv:EpRetPol)" | |
'body': """ | |
aci_tenant_ep_retention_policy: | |
username: ${1:admin} # required. The username to use for authentication. | |
host: ${2:undefined} # required. IP Address or hostname of APIC resolvable by Ansible control host. | |
password: ${3:undefined} # required. The password to use for authentication. | |
private_key: ${4:undefined} # not required. PEM formatted file that contains your private key to be used for signature-based authentication.,The name of the key (without extension) is used as the certificate name in ACI, unless C(certificate_name) is specified. | |
description: ${5:undefined} # not required. Description for the End point rentention policy. | |
certificate_name: ${6:C(private_key) basename} # not required. The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.,It defaults to the C(private_key) basename, without extension. | |
hold_interval: ${7:300} # not required. Hold Interval (range 5secs - 65535secs). | |
epr_policy: ${8:undefined} # not required. The name of the end point retention policy. | |
bounce_trigger: ${9:coop} # not required. Determines if the bounce entries are installed by RARP Flood or COOP Protocol.,The APIC defaults new End Point Retention Policies to C(coop). | |
output_level: ${10|debug,info,normal|} # not required. choices: debug;info;normal. Influence the output of this ACI module.,C(normal) means the standard output, incl. C(current) dict,C(info) means informational output, incl. C(previous), C(proposed) and C(sent) dicts,C(debug) means debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information | |
validate_certs: ${11:yes} # not required. If C(no), SSL certificates will not be validated.,This should only set to C(no) used on personally controlled sites using self-signed certificates. | |
state: ${12|absent,present,query|} # not required. choices: absent;present;query. Use C(present) or C(absent) for adding or removing.,Use C(query) for listing an object or multiple objects. | |
timeout: ${13:30} # not required. The socket level timeout in seconds. | |
local_ep_interval: ${14:900} # not required. Local end point Aging Interval (range 120secs - 65535secs).,0 is used for infinite. | |
bounce_age: ${15:630} # not required. Bounce Entry Aging Interval (range 150secs - 65535secs),0 is used for infinite. | |
move_frequency: ${16:256} # not required. Move frequency per second (range 0secs - 65535secs).,0 is used for none. | |
use_ssl: ${17:yes} # not required. If C(no), an HTTP connection will be used instead of the default HTTPS connection. | |
remote_ep_interval: ${18:300} # not required. Remote end point Aging Interval (range 120secs - 65535secs).,O is used for infinite. | |
port: ${19:443 (for https) and 80 (for http)} # not required. Port number to be used for REST connection. | |
tenant: ${20:undefined} # not required. The name of an existing tenant. | |
use_proxy: ${21:yes} # not required. If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. | |
""" | |
'aci_tenant_span_dst_group': | |
'prefix': "aci_tenant_span_dst_group_snippet" | |
'description': "Manage SPAN destination groups (span:DestGrp)" | |
'body': """ | |
aci_tenant_span_dst_group: | |
username: ${1:admin} # required. The username to use for authentication. | |
host: ${2:undefined} # required. IP Address or hostname of APIC resolvable by Ansible control host. | |
password: ${3:undefined} # required. The password to use for authentication. | |
dst_group: ${4:undefined} # required. The name of the SPAN destination group. | |
tenant: ${5:undefined} # required. The name of the tenant. | |
private_key: ${6:undefined} # not required. PEM formatted file that contains your private key to be used for signature-based authentication.,The name of the key (without extension) is used as the certificate name in ACI, unless C(certificate_name) is specified. | |
description: ${7:undefined} # not required. The description of the SPAN destination group. | |
certificate_name: ${8:C(private_key) basename} # not required. The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.,It defaults to the C(private_key) basename, without extension. | |
output_level: ${9|debug,info,normal|} # not required. choices: debug;info;normal. Influence the output of this ACI module.,C(normal) means the standard output, incl. C(current) dict,C(info) means informational output, incl. C(previous), C(proposed) and C(sent) dicts,C(debug) means debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information | |
validate_certs: ${10:yes} # not required. If C(no), SSL certificates will not be validated.,This should only set to C(no) used on personally controlled sites using self-signed certificates. | |
state: ${11|absent,present,query|} # not required. choices: absent;present;query. Use C(present) or C(absent) for adding or removing.,Use C(query) for listing an object or multiple objects. | |
timeout: ${12:30} # not required. The socket level timeout in seconds. | |
use_ssl: ${13:yes} # not required. If C(no), an HTTP connection will be used instead of the default HTTPS connection. | |
port: ${14:443 (for https) and 80 (for http)} # not required. Port number to be used for REST connection. | |
use_proxy: ${15:yes} # not required. If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. | |
""" | |
'aci_tenant_span_src_group': | |
'prefix': "aci_tenant_span_src_group_snippet" | |
'description': "Manage SPAN source groups (span:SrcGrp)" | |
'body': """ | |
aci_tenant_span_src_group: | |
username: ${1:admin} # required. The username to use for authentication. | |
host: ${2:undefined} # required. IP Address or hostname of APIC resolvable by Ansible control host. | |
password: ${3:undefined} # required. The password to use for authentication. | |
private_key: ${4:undefined} # not required. PEM formatted file that contains your private key to be used for signature-based authentication.,The name of the key (without extension) is used as the certificate name in ACI, unless C(certificate_name) is specified. | |
description: ${5:undefined} # not required. The description for Span source group. | |
certificate_name: ${6:C(private_key) basename} # not required. The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.,It defaults to the C(private_key) basename, without extension. | |
admin_state: ${7|enabled,disabled|} # not required. choices: enabled;disabled. Enable or disable the span sources. | |
use_ssl: ${8:yes} # not required. If C(no), an HTTP connection will be used instead of the default HTTPS connection. | |
dst_group: ${9:undefined} # not required. The Span destination group to associate with the source group. | |
port: ${10:443 (for https) and 80 (for http)} # not required. Port number to be used for REST connection. | |
tenant: ${11:undefined} # not required. The name of the Tenant. | |
use_proxy: ${12:yes} # not required. If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. | |
src_group: ${13:undefined} # not required. The name of the Span source group. | |
output_level: ${14|debug,info,normal|} # not required. choices: debug;info;normal. Influence the output of this ACI module.,C(normal) means the standard output, incl. C(current) dict,C(info) means informational output, incl. C(previous), C(proposed) and C(sent) dicts,C(debug) means debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information | |
state: ${15|absent,present,query|} # not required. choices: absent;present;query. Use C(present) or C(absent) for adding or removing.,Use C(query) for listing an object or multiple objects. | |
timeout: ${16:30} # not required. The socket level timeout in seconds. | |
validate_certs: ${17:yes} # not required. If C(no), SSL certificates will not be validated.,This should only set to C(no) used on personally controlled sites using self-signed certificates. | |
""" | |
'aci_tenant_span_src_group_to_dst_group': | |
'prefix': "aci_tenant_span_src_group_to_dst_group_snippet" | |
'description': "Bind SPAN source groups to destination groups (span:SpanLbl)" | |
'body': """ | |
aci_tenant_span_src_group_to_dst_group: | |
username: ${1:admin} # required. The username to use for authentication. | |
host: ${2:undefined} # required. IP Address or hostname of APIC resolvable by Ansible control host. | |
password: ${3:undefined} # required. The password to use for authentication. | |
private_key: ${4:undefined} # not required. PEM formatted file that contains your private key to be used for signature-based authentication.,The name of the key (without extension) is used as the certificate name in ACI, unless C(certificate_name) is specified. | |
description: ${5:undefined} # not required. The description for Span source group to destination group binding. | |
certificate_name: ${6:C(private_key) basename} # not required. The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.,It defaults to the C(private_key) basename, without extension. | |
src_group: ${7:undefined} # not required. The name of the Span source group. | |
output_level: ${8|debug,info,normal|} # not required. choices: debug;info;normal. Influence the output of this ACI module.,C(normal) means the standard output, incl. C(current) dict,C(info) means informational output, incl. C(previous), C(proposed) and C(sent) dicts,C(debug) means debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information | |
validate_certs: ${9:yes} # not required. If C(no), SSL certificates will not be validated.,This should only set to C(no) used on personally controlled sites using self-signed certificates. | |
state: ${10|absent,present,query|} # not required. choices: absent;present;query. Use C(present) or C(absent) for adding or removing.,Use C(query) for listing an object or multiple objects. | |
timeout: ${11:30} # not required. The socket level timeout in seconds. | |
use_ssl: ${12:yes} # not required. If C(no), an HTTP connection will be used instead of the default HTTPS connection. | |
dst_group: ${13:undefined} # not required. The Span destination group to associate with the source group. | |
port: ${14:443 (for https) and 80 (for http)} # not required. Port number to be used for REST connection. | |
tenant: ${15:undefined} # not required. The name of the Tenant. | |
use_proxy: ${16:yes} # not required. If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. | |
""" | |
'aci_vlan_pool': | |
'prefix': "aci_vlan_pool_snippet" | |
'description': "Manage VLAN pools (fvns:VlanInstP)" | |
'body': """ | |
aci_vlan_pool: | |
username: ${1:admin} # required. The username to use for authentication. | |
host: ${2:undefined} # required. IP Address or hostname of APIC resolvable by Ansible control host. | |
password: ${3:undefined} # required. The password to use for authentication. | |
private_key: ${4:undefined} # not required. PEM formatted file that contains your private key to be used for signature-based authentication.,The name of the key (without extension) is used as the certificate name in ACI, unless C(certificate_name) is specified. | |
pool_allocation_mode: ${5|dynamic,static|} # not required. choices: dynamic;static. The method used for allocating VLANs to resources. | |
description: ${6:undefined} # not required. Description for the C(pool). | |
certificate_name: ${7:C(private_key) basename} # not required. The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.,It defaults to the C(private_key) basename, without extension. | |
output_level: ${8|debug,info,normal|} # not required. choices: debug;info;normal. Influence the output of this ACI module.,C(normal) means the standard output, incl. C(current) dict,C(info) means informational output, incl. C(previous), C(proposed) and C(sent) dicts,C(debug) means debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information | |
state: ${9|absent,present,query|} # not required. choices: absent;present;query. Use C(present) or C(absent) for adding or removing.,Use C(query) for listing an object or multiple objects. | |
timeout: ${10:30} # not required. The socket level timeout in seconds. | |
use_ssl: ${11:yes} # not required. If C(no), an HTTP connection will be used instead of the default HTTPS connection. | |
validate_certs: ${12:yes} # not required. If C(no), SSL certificates will not be validated.,This should only set to C(no) used on personally controlled sites using self-signed certificates. | |
port: ${13:443 (for https) and 80 (for http)} # not required. Port number to be used for REST connection. | |
pool: ${14:undefined} # not required. The name of the pool. | |
use_proxy: ${15:yes} # not required. If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. | |
""" | |
'aci_vlan_pool_encap_block': | |
'prefix': "aci_vlan_pool_encap_block_snippet" | |
'description': "Manage encap blocks assigned to VLAN pools (fvns:EncapBlk)" | |
'body': """ | |
aci_vlan_pool_encap_block: | |
username: ${1:admin} # required. The username to use for authentication. | |
password: ${2:undefined} # required. The password to use for authentication. | |
host: ${3:undefined} # required. IP Address or hostname of APIC resolvable by Ansible control host. | |
private_key: ${4:undefined} # not required. PEM formatted file that contains your private key to be used for signature-based authentication.,The name of the key (without extension) is used as the certificate name in ACI, unless C(certificate_name) is specified. | |
pool_allocation_mode: ${5|dynamic,static|} # not required. choices: dynamic;static. The method used for allocating encaps to resources. | |
block_end: ${6:undefined} # not required. The end of encap block. | |
description: ${7:undefined} # not required. Description for the pool encap block. | |
certificate_name: ${8:C(private_key) basename} # not required. The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.,It defaults to the C(private_key) basename, without extension. | |
block_start: ${9:undefined} # not required. The start of the encap block. | |
output_level: ${10|debug,info,normal|} # not required. choices: debug;info;normal. Influence the output of this ACI module.,C(normal) means the standard output, incl. C(current) dict,C(info) means informational output, incl. C(previous), C(proposed) and C(sent) dicts,C(debug) means debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information | |
block_name: ${11:undefined} # not required. The name to give to the encap block. | |
state: ${12|absent,present,query|} # not required. choices: absent;present;query. Use C(present) or C(absent) for adding or removing.,Use C(query) for listing an object or multiple objects. | |
timeout: ${13:30} # not required. The socket level timeout in seconds. | |
use_ssl: ${14:yes} # not required. If C(no), an HTTP connection will be used instead of the default HTTPS connection. | |
allocation_mode: ${15|dynamic,inherit,static|} # not required. choices: dynamic;inherit;static. The method used for allocating encaps to resources. | |
validate_certs: ${16:yes} # not required. If C(no), SSL certificates will not be validated.,This should only set to C(no) used on personally controlled sites using self-signed certificates. | |
port: ${17:443 (for https) and 80 (for http)} # not required. Port number to be used for REST connection. | |
pool: ${18:undefined} # not required. The name of the pool that the encap block should be assigned to. | |
use_proxy: ${19:yes} # not required. If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. | |
""" | |
'aci_vrf': | |
'prefix': "aci_vrf_snippet" | |
'description': "Manage contexts or VRFs (fv:Ctx)" | |
'body': """ | |
aci_vrf: | |
username: ${1:admin} # required. The username to use for authentication. | |
host: ${2:undefined} # required. IP Address or hostname of APIC resolvable by Ansible control host. | |
password: ${3:undefined} # required. The password to use for authentication. | |
private_key: ${4:undefined} # not required. PEM formatted file that contains your private key to be used for signature-based authentication.,The name of the key (without extension) is used as the certificate name in ACI, unless C(certificate_name) is specified. | |
description: ${5:undefined} # not required. The description for the VRF. | |
certificate_name: ${6:C(private_key) basename} # not required. The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.,It defaults to the C(private_key) basename, without extension. | |
vrf: ${7:undefined} # not required. The name of the VRF. | |
use_ssl: ${8:yes} # not required. If C(no), an HTTP connection will be used instead of the default HTTPS connection. | |
port: ${9:443 (for https) and 80 (for http)} # not required. Port number to be used for REST connection. | |
tenant: ${10:undefined} # not required. The name of the Tenant the VRF should belong to. | |
use_proxy: ${11:yes} # not required. If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. | |
policy_control_preference: ${12|enforced,unenforced|} # not required. choices: enforced;unenforced. Determines if the Fabric should enforce Contrac Policies. | |
policy_control_direction: ${13|egress,ingress|} # not required. choices: egress;ingress. Determines if the policy should be enforced by the fabric on ingress or egress. | |
output_level: ${14|debug,info,normal|} # not required. choices: debug;info;normal. Influence the output of this ACI module.,C(normal) means the standard output, incl. C(current) dict,C(info) means informational output, incl. C(previous), C(proposed) and C(sent) dicts,C(debug) means debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information | |
state: ${15|absent,present,query|} # not required. choices: absent;present;query. Use C(present) or C(absent) for adding or removing.,Use C(query) for listing an object or multiple objects. | |
timeout: ${16:30} # not required. The socket level timeout in seconds. | |
validate_certs: ${17:yes} # not required. If C(no), SSL certificates will not be validated.,This should only set to C(no) used on personally controlled sites using self-signed certificates. | |
""" | |
'acl': | |
'prefix': "acl_snippet" | |
'description': "Sets and retrieves file ACL information." | |
'body': """ | |
acl: | |
path: ${1:undefined} # required. The full path of the file or object. | |
recursive: ${2:no} # not required. Recursively sets the specified ACL (added in Ansible 2.0). Incompatible with C(state=query). | |
default: ${3:no} # not required. if the target is a directory, setting this to yes will make it the default acl for entities created inside the directory. It causes an error if path is a file. | |
entity: ${4:undefined} # not required. actual user or group that the ACL applies to when matching entity types user or group are selected. | |
state: ${5|absent,present,query|} # not required. choices: absent;present;query. defines whether the ACL should be present or not. The C(query) state gets the current acl without changing it, for use in 'register' operations. | |
follow: ${6:yes} # not required. whether to follow symlinks on the path if a symlink is encountered. | |
etype: ${7|group,mask,other,user|} # not required. choices: group;mask;other;user. the entity type of the ACL to apply, see setfacl documentation for more info. | |
entry: ${8:undefined} # not required. DEPRECATED. The acl to set or remove. This must always be quoted in the form of '<etype>:<qualifier>:<perms>'. The qualifier may be empty for some types, but the type and perms are always required. '-' can be used as placeholder when you do not care about permissions. This is now superseded by entity, type and permissions fields. | |
permissions: ${9:undefined} # not required. Permissions to apply/remove can be any combination of r, w and x (read, write and execute respectively) | |
""" | |
'add_host': | |
'prefix': "add_host_snippet" | |
'description': "add a host (and alternatively a group) to the ansible-playbook in-memory inventory" | |
'body': """ | |
add_host: | |
name: ${1:undefined} # required. The hostname/ip of the host to add to the inventory, can include a colon and a port number. | |
groups: ${2:undefined} # not required. The groups to add the hostname to, comma separated. | |
""" | |
'airbrake_deployment': | |
'prefix': "airbrake_deployment_snippet" | |
'description': "Notify airbrake about app deployments" | |
'body': """ | |
airbrake_deployment: | |
environment: ${1:undefined} # required. The airbrake environment name, typically 'production', 'staging', etc. | |
token: ${2:undefined} # required. API token. | |
repo: ${3:undefined} # not required. URL of the project repository | |
user: ${4:undefined} # not required. The username of the person doing the deployment | |
url: ${5:https://airbrake.io/deploys.txt} # not required. Optional URL to submit the notification to. Use to send notifications to Airbrake-compliant tools like Errbit. | |
validate_certs: ${6|yes,no|} # not required. choices: yes;no. If C(no), SSL certificates for the target url will not be validated. This should only be used on personally controlled sites using self-signed certificates. | |
revision: ${7:undefined} # not required. A hash, number, tag, or other identifier showing what revision was deployed | |
""" | |
'aireos_command': | |
'prefix': "aireos_command_snippet" | |
'description': "Run commands on remote devices running Cisco WLC" | |
'body': """ | |
aireos_command: | |
commands: ${1:undefined} # required. List of commands to send to the remote aireos device over the configured provider. The resulting output from the command is returned. If the I(wait_for) argument is provided, the module is not returned until the condition is satisfied or the number of retries has expired. | |
retries: ${2:10} # not required. Specifies the number of retries a command should by tried before it is considered failed. The command is run on the target device every retry and evaluated against the I(wait_for) conditions. | |
interval: ${3:1} # not required. Configures the interval in seconds to wait between retries of the command. If the command does not pass the specified conditions, the interval indicates how long to wait before trying the command again. | |
provider: ${4:null} # not required. A dict object containing connection details. | |
wait_for: ${5:null} # not required. List of conditions to evaluate against the output of the command. The task will wait for each condition to be true before moving forward. If the conditional is not true within the configured number of retries, the task fails. See examples. | |
match: ${6|any,all|} # not required. choices: any;all. The I(match) argument is used in conjunction with the I(wait_for) argument to specify the match policy. Valid values are C(all) or C(any). If the value is set to C(all) then all conditionals in the wait_for must be satisfied. If the value is set to C(any) then only one of the values must be satisfied. | |
""" | |
'aireos_config': | |
'prefix': "aireos_config_snippet" | |
'description': "Manage Cisco WLC configurations" | |
'body': """ | |
aireos_config: | |
src: ${1:null} # not required. Specifies the source path to the file that contains the configuration or configuration template to load. The path to the source file can either be the full path on the Ansible control host or a relative path from the playbook or role root directory. This argument is mutually exclusive with I(lines). | |
after: ${2:null} # not required. The ordered set of commands to append to the end of the command stack if a change needs to be made. Just like with I(before) this allows the playbook designer to append a set of commands to be executed after the command set. | |
lines: ${3:null} # not required. The ordered set of commands that should be configured. The commands must be the exact same commands as found in the device run-config. Be sure to note the configuration command syntax as some commands are automatically modified by the device config parser. | |
diff_against: ${4|intended,running|} # not required. choices: intended;running. When using the C(ansible-playbook --diff) command line argument the module can generate diffs against different sources.,When this option is configured as I(intended), the module will return the diff of the running-config against the configuration provided in the C(intended_config) argument.,When this option is configured as I(running), the module will return the before and after diff of the running-config with respect to any changes made to the device configuration. | |
intended_config: ${5:undefined} # not required. The C(intended_config) provides the master configuration that the node should conform to and is used to check the final running-config against. This argument will not modify any settings on the remote device and is strictly used to check the compliance of the current device's configuration against. When specifying this argument, the task should also modify the C(diff_against) value and set it to I(intended). | |
running_config: ${6:null} # not required. The module, by default, will connect to the remote device and retrieve the current running-config to use as a base for comparing against the contents of source. There are times when it is not desirable to have the task get the current running-config for every task in a playbook. The I(running_config) argument allows the implementer to pass in the configuration to use as the base config for comparison. | |
provider: ${7:null} # not required. A dict object containing connection details. | |
before: ${8:null} # not required. The ordered set of commands to push on to the command stack if a change needs to be made. This allows the playbook designer the opportunity to perform configuration commands prior to pushing any changes without affecting how the set of commands are matched against the system. | |
save: ${9:false} # not required. The C(save) argument instructs the module to save the running- config to the startup-config at the conclusion of the module running. If check mode is specified, this argument is ignored. | |
backup: ${10:false} # not required. This argument will cause the module to create a full backup of the current C(running-config) from the remote device before any changes are made. The backup file is written to the C(backup) folder in the playbook root directory. If the directory does not exist, it is created. | |
match: ${11|line,none|} # not required. choices: line;none. Instructs the module on the way to perform the matching of the set of commands against the current device config. If match is set to I(line), commands are matched line by line. If match is set to I(none), the module will not attempt to compare the source configuration with the running configuration on the remote device. | |
diff_ignore_lines: ${12:undefined} # not required. Use this argument to specify one or more lines that should be ignored during the diff. This is used for lines in the configuration that are automatically updated by the system. This argument takes a list of regular expressions or exact line matches. | |
""" | |
'aix_inittab': | |
'prefix': "aix_inittab_snippet" | |
'description': "Manages the inittab on AIX" | |
'body': """ | |
aix_inittab: | |
action: ${1|boot,bootwait,hold,initdefault,false,once,ondemand,powerfail,powerwait,respawn,sysinit,wait|} # required. choices: boot;bootwait;hold;initdefault;false;once;ondemand;powerfail;powerwait;respawn;sysinit;wait. Action what the init has to do with this entry. | |
command: ${2:undefined} # required. What command has to run. | |
name: ${3:undefined} # required. Name of the inittab entry. | |
runlevel: ${4:undefined} # required. Runlevel of the entry. | |
state: ${5|absent,present|} # not required. choices: absent;present. Whether the entry should be present or absent in the inittab file. | |
insertafter: ${6:undefined} # not required. After which inittabline should the new entry inserted. | |
""" | |
'aix_lvol': | |
'prefix': "aix_lvol_snippet" | |
'description': "Configure AIX LVM logical volumes" | |
'body': """ | |
aix_lvol: | |
vg: ${1:undefined} # required. The volume group this logical volume is part of. | |
lv: ${2:undefined} # required. The name of the logical volume. | |
pvs: ${3:undefined} # not required. Comma separated list of physical volumes e.g. C(hdisk1,hdisk2). | |
lv_type: ${4:jfs2} # not required. The type of the logical volume. | |
copies: ${5:1} # not required. The number of copies of the logical volume. Maximum copies are 3. | |
state: ${6|absent,present|} # not required. choices: absent;present. Control if the logical volume exists. If C(present) and the volume does not already exist then the C(size) option is required. | |
policy: ${7|maximum,minimum|} # not required. choices: maximum;minimum. Sets the interphysical volume allocation policy. C(maximum) allocates logical partitions across the maximum number of physical volumes. C(minimum) allocates logical partitions across the minimum number of physical volumes. | |
opts: ${8:undefined} # not required. Free-form options to be passed to the mklv command. | |
size: ${9:undefined} # not required. The size of the logical volume with one of the [MGT] units. | |
""" | |
'alternatives': | |
'prefix': "alternatives_snippet" | |
'description': "Manages alternative programs for common commands" | |
'body': """ | |
alternatives: | |
path: ${1:undefined} # required. The path to the real executable that the link should point to. | |
name: ${2:undefined} # required. The generic name of the link. | |
priority: ${3:50} # not required. The priority of the alternative | |
link: ${4:undefined} # not required. The path to the symbolic link that should point to the real executable.,This option is always required on RHEL-based distributions. On Debian-based distributions this option is required when the alternative I(name) is unknown to the system. | |
""" | |
'aos_asn_pool': | |
'prefix': "aos_asn_pool_snippet" | |
'description': "Manage AOS ASN Pool" | |
'body': """ | |
aos_asn_pool: | |
session: ${1:undefined} # required. An existing AOS session as obtained by M(aos_login) module. | |
ranges: ${2:undefined} # not required. List of ASNs ranges to add to the ASN Pool. Each range must have 2 values. | |
content: ${3:undefined} # not required. Datastructure of the ASN Pool to manage. The data can be in YAML / JSON or directly a variable. It's the same datastructure that is returned on success in I(value). | |
state: ${4|present,absent|} # not required. choices: present;absent. Indicate what is the expected state of the ASN Pool (present or not). | |
name: ${5:undefined} # not required. Name of the ASN Pool to manage. Only one of I(name), I(id) or I(content) can be set. | |
id: ${6:undefined} # not required. AOS Id of the ASN Pool to manage. Only one of I(name), I(id) or I(content) can be set. | |
""" | |
'aos_blueprint': | |
'prefix': "aos_blueprint_snippet" | |
'description': "Manage AOS blueprint instance" | |
'body': """ | |
aos_blueprint: | |
session: ${1:undefined} # required. An existing AOS session as obtained by M(aos_login) module. | |
state: ${2|present,absent,build-ready|} # not required. choices: present;absent;build-ready. Indicate what is the expected state of the Blueprint. | |
reference_arch: ${3:undefined} # not required. When creating a blueprint, this value identifies a known AOS reference architecture value. I(Refer to AOS-server documentation for available values). | |
name: ${4:undefined} # not required. Name of the Blueprint to manage. Only one of I(name) or I(id) can be set. | |
timeout: ${5:5} # not required. When I(state=build-ready), this timeout identifies timeout in seconds to wait before declaring a failure. | |
id: ${6:undefined} # not required. AOS Id of the IP Pool to manage (can't be used to create a new IP Pool). Only one of I(name) or I(id) can be set. | |
template: ${7:undefined} # not required. When creating a blueprint, this value identifies, by name, an existing engineering design template within the AOS-server. | |
""" | |
'aos_blueprint_param': | |
'prefix': "aos_blueprint_param_snippet" | |
'description': "Manage AOS blueprint parameter values" | |
'body': """ | |
aos_blueprint_param: | |
blueprint: ${1:undefined} # required. Blueprint Name or Id as defined in AOS. | |
session: ${2:undefined} # required. An existing AOS session as obtained by M(aos_login) module. | |
state: ${3|present,absent|} # not required. choices: present;absent. Indicate what is the expected state of the Blueprint Parameter (present or not). | |
name: ${4:undefined} # not required. Name of blueprint parameter, as defined by AOS design template. You can use the option I(get_param_list) to get the complete list of supported parameters for your blueprint. | |
get_param_list: ${5:undefined} # not required. Get the complete list of supported parameters for this blueprint and the description of those parameters. | |
value: ${6:undefined} # not required. Blueprint parameter value. This value may be transformed by using the I(param_map) field; used when the blueprint parameter requires an AOS unique ID value. | |
param_map: ${7:undefined} # not required. Defines the aos-pyez collection that will is used to map the user-defined item name into the AOS unique ID value. For example, if the caller provides an IP address pool I(param_value) called \"Server-IpAddrs\", then the aos-pyez collection is 'IpPools'. Some I(param_map) are already defined by default like I(logical_device_maps). | |
""" | |
'aos_blueprint_virtnet': | |
'prefix': "aos_blueprint_virtnet_snippet" | |
'description': "Manage AOS blueprint parameter values" | |
'body': """ | |
aos_blueprint_virtnet: | |
blueprint: ${1:undefined} # required. Blueprint Name or Id as defined in AOS. | |
session: ${2:undefined} # required. An existing AOS session as obtained by M(aos_login) module. | |
content: ${3:undefined} # not required. Datastructure of the Virtual Network to manage. The data can be in YAML / JSON or directly a variable. It's the same datastructure that is returned on success in I(value). | |
state: ${4|present,absent|} # not required. choices: present;absent. Indicate what is the expected state of the Virtual Network (present or not). | |
name: ${5:undefined} # not required. Name of Virtual Network as part of the Blueprint. | |
""" | |
'aos_device': | |
'prefix': "aos_device_snippet" | |
'description': "Manage Devices on AOS Server" | |
'body': """ | |
aos_device: | |
session: ${1:undefined} # required. An existing AOS session as obtained by M(aos_login) module. | |
state: ${2|normal|} # not required. choices: normal. Define in which state the device should be. Currently only I(normal) is supported but the goal is to add I(maint) and I(decomm). | |
name: ${3:undefined} # not required. The device serial-number; i.e. uniquely identifies the device in the AOS system. Only one of I(name) or I(id) can be set. | |
approve: ${4|yes,no|} # not required. choices: yes;no. The approve argument instruct the module to convert a device in quarantine mode into approved mode. | |
id: ${5:undefined} # not required. The AOS internal id for a device; i.e. uniquely identifies the device in the AOS system. Only one of I(name) or I(id) can be set. | |
location: ${6:undefined} # not required. When approving a device using the I(approve) argument, it's possible define the location of the device. | |
""" | |
'aos_external_router': | |
'prefix': "aos_external_router_snippet" | |
'description': "Manage AOS External Router" | |
'body': """ | |
aos_external_router: | |
session: ${1:undefined} # required. An existing AOS session as obtained by M(aos_login) module. | |
content: ${2:undefined} # not required. Datastructure of the External Router to create. The format is defined by the I(content_format) parameter. It's the same datastructure that is returned on success in I(value). | |
state: ${3|present,absent|} # not required. choices: present;absent. Indicate what is the expected state of the External Router (present or not). | |
name: ${4:undefined} # not required. Name of the External Router to manage. Only one of I(name), I(id) or I(content) can be set. | |
loopback: ${5:undefined} # not required. IP address of the Loopback interface of the external_router. | |
asn: ${6:undefined} # not required. ASN id of the external_router. | |
id: ${7:undefined} # not required. AOS Id of the External Router to manage (can't be used to create a new External Router), Only one of I(name), I(id) or I(content) can be set. | |
""" | |
'aos_ip_pool': | |
'prefix': "aos_ip_pool_snippet" | |
'description': "Manage AOS IP Pool" | |
'body': """ | |
aos_ip_pool: | |
session: ${1:undefined} # required. An existing AOS session as obtained by M(aos_login) module. | |
content: ${2:undefined} # not required. Datastructure of the IP Pool to manage. The data can be in YAML / JSON or directly a variable. It's the same datastructure that is returned on success in I(value). | |
subnets: ${3:undefined} # not required. List of subnet that needs to be part of the IP Pool. | |
state: ${4|present,absent|} # not required. choices: present;absent. Indicate what is the expected state of the IP Pool (present or not). | |
name: ${5:undefined} # not required. Name of the IP Pool to manage. Only one of I(name), I(id) or I(content) can be set. | |
id: ${6:undefined} # not required. AOS Id of the IP Pool to manage (can't be used to create a new IP Pool), Only one of I(name), I(id) or I(content) can be set. | |
""" | |
'aos_logical_device': | |
'prefix': "aos_logical_device_snippet" | |
'description': "Manage AOS Logical Device" | |
'body': """ | |
aos_logical_device: | |
session: ${1:undefined} # required. An existing AOS session as obtained by M(aos_login) module. | |
content: ${2:undefined} # not required. Datastructure of the Logical Device to create. The data can be in YAML / JSON or directly a variable. It's the same datastructure that is returned on success in I(value). | |
state: ${3|present,absent|} # not required. choices: present;absent. Indicate what is the expected state of the Logical Device (present or not). | |
name: ${4:undefined} # not required. Name of the Logical Device to manage. Only one of I(name), I(id) or I(content) can be set. | |
id: ${5:undefined} # not required. AOS Id of the Logical Device to manage (can't be used to create a new Logical Device), Only one of I(name), I(id) or I(content) can be set. | |
""" | |
'aos_logical_device_map': | |
'prefix': "aos_logical_device_map_snippet" | |
'description': "Manage AOS Logical Device Map" | |
'body': """ | |
aos_logical_device_map: | |
session: ${1:undefined} # required. An existing AOS session as obtained by M(aos_login) module. | |
content: ${2:undefined} # not required. Datastructure of the Logical Device Map to manage. The data can be in YAML / JSON or directly a variable. It's the same datastructure that is returned on success in I(value). Only one of I(name), I(id) or I(content) can be set. | |
state: ${3|present,absent|} # not required. choices: present;absent. Indicate what is the expected state of the Logical Device Map (present or not). | |
name: ${4:undefined} # not required. Name of the Logical Device Map to manage. Only one of I(name), I(id) or I(content) can be set. | |
id: ${5:undefined} # not required. AOS Id of the Logical Device Map to manage (can't be used to create a new Logical Device Map), Only one of I(name), I(id) or I(content) can be set. | |
""" | |
'aos_login': | |
'prefix': "aos_login_snippet" | |
'description': "Login to AOS server for session token" | |
'body': """ | |
aos_login: | |
server: ${1:undefined} # required. Address of the AOS Server on which you want to open a connection. | |
passwd: ${2:admin} # not required. Password to use when connecting to the AOS server. | |
user: ${3:admin} # not required. Login username to use when connecting to the AOS server. | |
port: ${4:443} # not required. Port number to use when connecting to the AOS server. | |
""" | |
'aos_rack_type': | |
'prefix': "aos_rack_type_snippet" | |
'description': "Manage AOS Rack Type" | |
'body': """ | |
aos_rack_type: | |
session: ${1:undefined} # required. An existing AOS session as obtained by M(aos_login) module. | |
content: ${2:undefined} # not required. Datastructure of the Rack Type to create. The data can be in YAML / JSON or directly a variable. It's the same datastructure that is returned on success in I(value). | |
state: ${3|present,absent|} # not required. choices: present;absent. Indicate what is the expected state of the Rack Type (present or not). | |
name: ${4:undefined} # not required. Name of the Rack Type to manage. Only one of I(name), I(id) or I(content) can be set. | |
id: ${5:undefined} # not required. AOS Id of the Rack Type to manage (can't be used to create a new Rack Type), Only one of I(name), I(id) or I(content) can be set. | |
""" | |
'aos_template': | |
'prefix': "aos_template_snippet" | |
'description': "Manage AOS Template" | |
'body': """ | |
aos_template: | |
session: ${1:undefined} # required. An existing AOS session as obtained by M(aos_login) module. | |
content: ${2:undefined} # not required. Datastructure of the Template to create. The data can be in YAML / JSON or directly a variable. It's the same datastructure that is returned on success in I(value). | |
state: ${3|present,absent|} # not required. choices: present;absent. Indicate what is the expected state of the Template (present or not). | |
name: ${4:undefined} # not required. Name of the Template to manage. Only one of I(name), I(id) or I(src) can be set. | |
id: ${5:undefined} # not required. AOS Id of the Template to manage (can't be used to create a new Template), Only one of I(name), I(id) or I(src) can be set. | |
""" | |
'apache2_mod_proxy': | |
'prefix': "apache2_mod_proxy_snippet" | |
'description': "Set and/or get members' attributes of an Apache httpd 2.4 mod_proxy balancer pool" | |
'body': """ | |
apache2_mod_proxy: | |
balancer_vhost: ${1:None} # required. (ipv4|ipv6|fqdn):port of the Apache httpd 2.4 mod_proxy balancer pool. | |
tls: ${2|true,false|} # not required. choices: true;false. Use https to access balancer management page. | |
member_host: ${3:None} # not required. (ipv4|ipv6|fqdn) of the balancer member to get or to set attributes to. Port number is autodetected and should not be specified here. If undefined, apache2_mod_proxy module will return a members list of dictionaries of all the current balancer pool members' attributes. | |
validate_certs: ${4|true,false|} # not required. choices: true;false. Validate ssl/tls certificates. | |
state: ${5|present,absent,enabled,disabled,drained,hot_standby,ignore_errors|} # not required. choices: present;absent;enabled;disabled;drained;hot_standby;ignore_errors. Desired state of the member host. (absent|disabled),drained,hot_standby,ignore_errors can be simultaneously invoked by separating them with a comma (e.g. state=drained,ignore_errors). | |
balancer_url_suffix: ${6:/balancer-manager/} # not required. Suffix of the balancer pool url required to access the balancer pool status page (e.g. balancer_vhost[:port]/balancer_url_suffix). | |
""" | |
'apache2_module': | |
'prefix': "apache2_module_snippet" | |
'description': "Enables/disables a module of the Apache2 webserver." | |
'body': """ | |
apache2_module: | |
name: ${1:undefined} # required. Name of the module to enable/disable as given to C(a2enmod/a2dismod). | |
state: ${2|present,absent|} # not required. choices: present;absent. Desired state of the module. | |
identifier: ${3:undefined} # not required. Identifier of the module as listed by C(apache2ctl -M). This is optional and usually determined automatically by the common convention of appending C(_module) to I(name) as well as custom exception for popular modules. | |
force: ${4|True,False|} # not required. choices: True;False. Force disabling of default modules and override Debian warnings. | |
ignore_configcheck: ${5|True,False|} # not required. choices: True;False. Ignore configuration checks about inconsistent module configuration. Especially for mpm_* modules. | |
""" | |
'apk': | |
'prefix': "apk_snippet" | |
'description': "Manages apk packages" | |
'body': """ | |
apk: | |
available: ${1|yes,no|} # not required. choices: yes;no. During upgrade, reset versioned world dependencies and change logic to prefer replacing or downgrading packages (instead of holding them) if the currently installed package is no longer available from any repository. | |
state: ${2|present,absent,latest|} # not required. choices: present;absent;latest. Indicates the desired package(s) state.,C(present) ensures the package(s) is/are present.,C(absent) ensures the package(s) is/are absent.,C(latest) ensures the package(s) is/are present and the latest version(s). | |
upgrade: ${3|yes,no|} # not required. choices: yes;no. Upgrade all installed packages to their latest version. | |
update_cache: ${4|yes,no|} # not required. choices: yes;no. Update repository indexes. Can be run with other steps or on it's own. | |
name: ${5:null} # not required. A package name, like C(foo), or multiple packages, like C(foo, bar). | |
repository: ${6:null} # not required. A package repository or multiple repositories. Unlike with the underlying apk command, this list will override the system repositories rather than supplement them. | |
""" | |
'apt': | |
'prefix': "apt_snippet" | |
'description': "Manages apt-packages" | |
'body': """ | |
apt: | |
autoremove: ${1:no} # not required. If C(yes), remove unused dependency packages for all module states except I(build-dep). It can also be used as the only option.,Previous to version 2.4, autoclean was also an alias for autoremove, now it is its own separate command. See documentation for further information. | |
force: ${2:no} # not required. Corresponds to the C(--force-yes) to I(apt-get) and implies C(allow_unauthenticated: yes),This option will disable checking both the packages' signatures and the certificates of the web servers they are downloaded from.,This option *is not* the equivalent of passing the C(-f) flag to I(apt-get) on the command line,**This is a destructive operation with the potential to destroy your system, and it should almost never be used.** Please also see C(man apt-get) for more information. | |
force_apt_get: ${3:no} # not required. Force usage of apt-get instead of aptitude | |
update_cache: ${4:no} # not required. Run the equivalent of C(apt-get update) before the operation. Can be run as part of the package installation or as a separate step. | |
only_upgrade: ${5:no} # not required. Only upgrade a package if it is already installed. | |
deb: ${6:undefined} # not required. Path to a .deb package on the remote machine.,If :// in the path, ansible will attempt to download deb before installing. (Version added 2.1) | |
cache_valid_time: ${7:0} # not required. Update the apt cache if its older than the I(cache_valid_time). This option is set in seconds. As of Ansible 2.4, this implicitly sets I(update_cache) if set. | |
dpkg_options: ${8:force-confdef,force-confold} # not required. Add dpkg options to apt command. Defaults to '-o \"Dpkg::Options::=--force-confdef\" -o \"Dpkg::Options::=--force-confold\"',Options should be supplied as comma separated list | |
upgrade: ${9|dist,full,no,safe,yes|} # not required. choices: dist;full;no;safe;yes. If yes or safe, performs an aptitude safe-upgrade.,If full, performs an aptitude full-upgrade.,If dist, performs an apt-get dist-upgrade.,Note: This does not upgrade a specific package, use state=latest for that.,Note: Since 2.4, apt-get is used as a fall-back if aptitude is not present. | |
name: ${10:undefined} # not required. A list of package names, like C(foo), or package specifier with version, like C(foo=1.0). Name wildcards (fnmatch) like C(apt*) and version wildcards like C(foo=1.0*) are also supported. | |
autoclean: ${11:no} # not required. If C(yes), cleans the local repository of retrieved package files that can no longer be downloaded. | |
purge: ${12:no} # not required. Will force purging of configuration files if the module state is set to I(absent). | |
allow_unauthenticated: ${13:no} # not required. Ignore if packages cannot be authenticated. This is useful for bootstrapping environments that manage their own apt-key setup. | |
state: ${14|absent,build-dep,latest,present|} # not required. choices: absent;build-dep;latest;present. Indicates the desired package state. C(latest) ensures that the latest version is installed. C(build-dep) ensures the package build dependencies are installed. | |
default_release: ${15:undefined} # not required. Corresponds to the C(-t) option for I(apt) and sets pin priorities | |
install_recommends: ${16:undefined} # not required. Corresponds to the C(--no-install-recommends) option for I(apt). C(yes) installs recommended packages. C(no) does not install recommended packages. By default, Ansible will use the same defaults as the operating system. Suggested packages are never installed. | |
""" | |
'apt_key': | |
'prefix': "apt_key_snippet" | |
'description': "Add or remove an apt key" | |
'body': """ | |
apt_key: | |
keyserver: ${1:undefined} # not required. The keyserver to retrieve key from. | |
url: ${2:undefined} # not required. The URL to retrieve key from. | |
data: ${3:undefined} # not required. The keyfile contents to add to the keyring. | |
keyring: ${4:undefined} # not required. The path to specific keyring file in /etc/apt/trusted.gpg.d/ | |
state: ${5|absent,present|} # not required. choices: absent;present. Ensures that the key is present (added) or absent (revoked). | |
file: ${6:undefined} # not required. The path to a keyfile on the remote server to add to the keyring. | |
validate_certs: ${7:yes} # not required. If C(no), SSL certificates for the target url will not be validated. This should only be used on personally controlled sites using self-signed certificates. | |
id: ${8:undefined} # not required. The identifier of the key.,Including this allows check mode to correctly report the changed state.,If specifying a subkey's id be aware that apt-key does not understand how to remove keys via a subkey id. Specify the primary key's id instead.,This parameter is required when C(state) is set to C(absent). | |
""" | |
'apt_repository': | |
'prefix': "apt_repository_snippet" | |
'description': "Add and remove APT repositories" | |
'body': """ | |
apt_repository: | |
repo: ${1:undefined} # required. A source string for the repository. | |
state: ${2|absent,present|} # not required. choices: absent;present. A source string state. | |
update_cache: ${3:yes} # not required. Run the equivalent of C(apt-get update) when a change occurs. Cache updates are run after making changes. | |
mode: ${4:420} # not required. The octal mode for newly created files in sources.list.d | |
codename: ${5:undefined} # not required. Override the distribution codename to use for PPA repositories. Should usually only be set when working with a PPA on a non-Ubuntu target (e.g. Debian or Mint) | |
validate_certs: ${6:yes} # not required. If C(no), SSL certificates for the target repo will not be validated. This should only be used on personally controlled sites using self-signed certificates. | |
filename: ${7:undefined} # not required. Sets the name of the source list file in sources.list.d. Defaults to a file name based on the repository source url. The .list extension will be automatically added. | |
""" | |
'apt_rpm': | |
'prefix': "apt_rpm_snippet" | |
'description': "apt_rpm package manager" | |
'body': """ | |
apt_rpm: | |
pkg: ${1:undefined} # required. name of package to install, upgrade or remove. | |
state: ${2|absent,present|} # not required. choices: absent;present. Indicates the desired package state. | |
update_cache: ${3:no} # not required. update the package database first C(apt-get update). | |
""" | |
'archive': | |
'prefix': "archive_snippet" | |
'description': "Creates a compressed archive of one or more files or trees" | |
'body': """ | |
archive: | |
path: ${1:undefined} # required. Remote absolute path, glob, or list of paths or globs for the file or files to compress or archive. | |
group: ${2:null} # not required. Name of the group that should own the file/directory, as would be fed to I(chown). | |
format: ${3|bz2,gz,tar,xz,zip|} # not required. choices: bz2;gz;tar;xz;zip. The type of compression to use.,Support for xz was added in version 2.5. | |
dest: ${4:undefined} # not required. The file name of the destination archive. This is required when C(path) refers to multiple files by either specifying a glob, a directory or multiple paths in a list. | |
selevel: ${5:s0} # not required. Level part of the SELinux file context. This is the MLS/MCS attribute, sometimes known as the C(range). C(_default) feature works as for I(seuser). | |
seuser: ${6:null} # not required. User part of SELinux file context. Will default to system policy, if applicable. If set to C(_default), it will use the C(user) portion of the policy if available. | |
setype: ${7:null} # not required. Type part of SELinux file context, C(_default) feature works as for I(seuser). | |
remove: ${8:no} # not required. Remove any added source files and trees after adding to archive. | |
unsafe_writes: ${9:false} # not required. Normally this module uses atomic operations to prevent data corruption or inconsistent reads from the target files, sometimes systems are configured or just broken in ways that prevent this. One example are docker mounted files, they cannot be updated atomically and can only be done in an unsafe manner.,This boolean option allows ansible to fall back to unsafe methods of updating files for those cases in which you do not have any other choice. Be aware that this is subject to race conditions and can lead to data corruption. | |
serole: ${10:null} # not required. Role part of SELinux file context, C(_default) feature works as for I(seuser). | |
mode: ${11:null} # not required. Mode the file or directory should be. For those used to I(/usr/bin/chmod) remember that modes are actually octal numbers (like C(0644) or C(01777)). Leaving off the leading zero will likely have unexpected results. As of version 1.8, the mode may be specified as a symbolic mode (for example, C(u+rwx) or C(u=rw,g=r,o=r)). | |
attributes: ${12:None} # not required. Attributes the file or directory should have. To get supported flags look at the man page for I(chattr) on the target system. This string should contain the attributes in the same order as the one displayed by I(lsattr). | |
owner: ${13:null} # not required. Name of the user that should own the file/directory, as would be fed to I(chown). | |
exclude_path: ${14:undefined} # not required. Remote absolute path, glob, or list of paths or globs for the file or files to exclude from the archive | |
""" | |
'aruba_command': | |
'prefix': "aruba_command_snippet" | |
'description': "Run commands on remote devices running Aruba Mobility Controller" | |
'body': """ | |
aruba_command: | |
commands: ${1:undefined} # required. List of commands to send to the remote aruba device over the configured provider. The resulting output from the command is returned. If the I(wait_for) argument is provided, the module is not returned until the condition is satisfied or the number of retries has expired. | |
retries: ${2:10} # not required. Specifies the number of retries a command should by tried before it is considered failed. The command is run on the target device every retry and evaluated against the I(wait_for) conditions. | |
interval: ${3:1} # not required. Configures the interval in seconds to wait between retries of the command. If the command does not pass the specified conditions, the interval indicates how long to wait before trying the command again. | |
provider: ${4:null} # not required. A dict object containing connection details. | |
wait_for: ${5:null} # not required. List of conditions to evaluate against the output of the command. The task will wait for each condition to be true before moving forward. If the conditional is not true within the configured number of retries, the task fails. See examples. | |
match: ${6|any,all|} # not required. choices: any;all. The I(match) argument is used in conjunction with the I(wait_for) argument to specify the match policy. Valid values are C(all) or C(any). If the value is set to C(all) then all conditionals in the wait_for must be satisfied. If the value is set to C(any) then only one of the values must be satisfied. | |
""" | |
'aruba_config': | |
'prefix': "aruba_config_snippet" | |
'description': "Manage Aruba configuration sections" | |
'body': """ | |
aruba_config: | |
src: ${1:null} # not required. Specifies the source path to the file that contains the configuration or configuration template to load. The path to the source file can either be the full path on the Ansible control host or a relative path from the playbook or role root directory. This argument is mutually exclusive with I(lines), I(parents). | |
save_when: ${2|always,never,modified,changed|} # not required. choices: always;never;modified;changed. When changes are made to the device running-configuration, the changes are not copied to non-volatile storage by default. Using this argument will change that before. If the argument is set to I(always), then the running-config will always be copied to the startup-config and the I(modified) flag will always be set to True. If the argument is set to I(modified), then the running-config will only be copied to the startup-config if it has changed since the last save to startup-config. If the argument is set to I(never), the running-config will never be copied to the startup-config. If the argument is set to I(changed), then the running-config will only be copied to the startup-config if the task has made a change. | |
encrypt: ${3:true} # not required. This allows an Aruba controller's passwords and keys to be displayed in plain text when set to I(false) or encrypted when set to I(true). If set to I(false), the setting will re-encrypt at the end of the module run. Backups are still encrypted even when set to I(false). | |
after: ${4:null} # not required. The ordered set of commands to append to the end of the command stack if a change needs to be made. Just like with I(before) this allows the playbook designer to append a set of commands to be executed after the command set. | |
lines: ${5:null} # not required. The ordered set of commands that should be configured in the section. The commands must be the exact same commands as found in the device running-config. Be sure to note the configuration command syntax as some commands are automatically modified by the device config parser. | |
intended_config: ${6:undefined} # not required. The C(intended_config) provides the master configuration that the node should conform to and is used to check the final running-config against. This argument will not modify any settings on the remote device and is strictly used to check the compliance of the current device's configuration against. When specifying this argument, the task should also modify the C(diff_against) value and set it to I(intended). | |
diff_against: ${7|startup,intended,running|} # not required. choices: startup;intended;running. When using the C(ansible-playbook --diff) command line argument the module can generate diffs against different sources.,When this option is configure as I(startup), the module will return the diff of the running-config against the startup-config.,When this option is configured as I(intended), the module will return the diff of the running-config against the configuration provided in the C(intended_config) argument.,When this option is configured as I(running), the module will return the before and after diff of the running-config with respect to any changes made to the device configuration. | |
parents: ${8:null} # not required. The ordered set of parents that uniquely identify the section or hierarchy the commands should be checked against. If the parents argument is omitted, the commands are checked against the set of top level or global commands. | |
provider: ${9:null} # not required. A dict object containing connection details. | |
before: ${10:null} # not required. The ordered set of commands to push on to the command stack if a change needs to be made. This allows the playbook designer the opportunity to perform configuration commands prior to pushing any changes without affecting how the set of commands are matched against the system. | |
running_config: ${11:null} # not required. The module, by default, will connect to the remote device and retrieve the current running-config to use as a base for comparing against the contents of source. There are times when it is not desirable to have the task get the current running-config for every task in a playbook. The I(running_config) argument allows the implementer to pass in the configuration to use as the base config for comparison. | |
replace: ${12|line,block|} # not required. choices: line;block. Instructs the module on the way to perform the configuration on the device. If the replace argument is set to I(line) then the modified lines are pushed to the device in configuration mode. If the replace argument is set to I(block) then the entire command block is pushed to the device in configuration mode if any line is not correct. | |
backup: ${13:false} # not required. This argument will cause the module to create a full backup of the current C(running-config) from the remote device before any changes are made. The backup file is written to the C(backup) folder in the playbook root directory. If the directory does not exist, it is created. | |
match: ${14|line,strict,exact,none|} # not required. choices: line;strict;exact;none. Instructs the module on the way to perform the matching of the set of commands against the current device config. If match is set to I(line), commands are matched line by line. If match is set to I(strict), command lines are matched with respect to position. If match is set to I(exact), command lines must be an equal match. Finally, if match is set to I(none), the module will not attempt to compare the source configuration with the running configuration on the remote device. | |
diff_ignore_lines: ${15:undefined} # not required. Use this argument to specify one or more lines that should be ignored during the diff. This is used for lines in the configuration that are automatically updated by the system. This argument takes a list of regular expressions or exact line matches. | |
""" | |
'asa_acl': | |
'prefix': "asa_acl_snippet" | |
'description': "Manage access-lists on a Cisco ASA" | |
'body': """ | |
asa_acl: | |
lines: ${1:undefined} # required. The ordered set of commands that should be configured in the section. The commands must be the exact same commands as found in the device running-config. Be sure to note the configuration command syntax as some commands are automatically modified by the device config parser. | |
authorize: ${2|yes,no|} # not required. choices: yes;no. B(Deprecated),Starting with Ansible 2.5 we recommend using C(connection: network_cli) and C(become: yes).,For more information please see the L(Network Guide, ../network/getting_started/network_differences.html#multiple-communication-protocols).,HORIZONTALLINE,Instructs the module to enter privileged mode on the remote device before sending any commands. If not specified, the device will attempt to execute all commands in non-privileged mode. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_AUTHORIZE) will be used instead. | |
force: ${3|yes,no|} # not required. choices: yes;no. The force argument instructs the module to not consider the current devices running-config. When set to true, this will cause the module to push the contents of I(src) into the device without first checking if already configured. | |
context: ${4:null} # not required. Specifies which context to target if you are running in the ASA in multiple context mode. Defaults to the current context you login to. | |
provider: ${5:null} # not required. B(Deprecated),Starting with Ansible 2.5 we recommend using C(connection: network_cli).,For more information please see the L(Network Guide, ../network/getting_started/network_differences.html#multiple-communication-protocols).,HORIZONTALLINE,A dict object containing connection details. | |
before: ${6:null} # not required. The ordered set of commands to push on to the command stack if a change needs to be made. This allows the playbook designer the opportunity to perform configuration commands prior to pushing any changes without affecting how the set of commands are matched against the system. | |
config: ${7:null} # not required. The module, by default, will connect to the remote device and retrieve the current running-config to use as a base for comparing against the contents of source. There are times when it is not desirable to have the task get the current running-config for every task in a playbook. The I(config) argument allows the implementer to pass in the configuruation to use as the base config for comparison. | |
after: ${8:null} # not required. The ordered set of commands to append to the end of the command stack if a changed needs to be made. Just like with I(before) this allows the playbook designer to append a set of commands to be executed after the command set. | |
match: ${9|line,strict,exact|} # not required. choices: line;strict;exact. Instructs the module on the way to perform the matching of the set of commands against the current device config. If match is set to I(line), commands are matched line by line. If match is set to I(strict), command lines are matched with respect to position. Finally if match is set to I(exact), command lines must be an equal match. | |
replace: ${10|line,block|} # not required. choices: line;block. Instructs the module on the way to perform the configuration on the device. If the replace argument is set to I(line) then the modified lines are pushed to the device in configuration mode. If the replace argument is set to I(block) then the entire command block is pushed to the device in configuration mode if any line is not correct. | |
""" | |
'asa_command': | |
'prefix': "asa_command_snippet" | |
'description': "Run arbitrary commands on Cisco ASA devices" | |
'body': """ | |
asa_command: | |
commands: ${1:undefined} # required. List of commands to send to the remote device over the configured provider. The resulting output from the command is returned. If the I(wait_for) argument is provided, the module is not returned until the condition is satisfied or the number of retires as expired. | |
authorize: ${2|yes,no|} # not required. choices: yes;no. B(Deprecated),Starting with Ansible 2.5 we recommend using C(connection: network_cli) and C(become: yes).,For more information please see the L(Network Guide, ../network/getting_started/network_differences.html#multiple-communication-protocols).,HORIZONTALLINE,Instructs the module to enter privileged mode on the remote device before sending any commands. If not specified, the device will attempt to execute all commands in non-privileged mode. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_AUTHORIZE) will be used instead. | |
retries: ${3:10} # not required. Specifies the number of retries a command should by tried before it is considered failed. The command is run on the target device every retry and evaluated against the I(wait_for) conditions. | |
interval: ${4:1} # not required. Configures the interval in seconds to wait between retries of the command. If the command does not pass the specified conditions, the interval indicates how long to wait before trying the command again. | |
context: ${5:null} # not required. Specifies which context to target if you are running in the ASA in multiple context mode. Defaults to the current context you login to. | |
provider: ${6:null} # not required. B(Deprecated),Starting with Ansible 2.5 we recommend using C(connection: network_cli).,For more information please see the L(Network Guide, ../network/getting_started/network_differences.html#multiple-communication-protocols).,HORIZONTALLINE,A dict object containing connection details. | |
wait_for: ${7:null} # not required. List of conditions to evaluate against the output of the command. The task will wait for each condition to be true before moving forward. If the conditional is not true within the configured number of retries, the task fails. See examples. | |
match: ${8|any,all|} # not required. choices: any;all. The I(match) argument is used in conjunction with the I(wait_for) argument to specify the match policy. Valid values are C(all) or C(any). If the value is set to C(all) then all conditionals in the wait_for must be satisfied. If the value is set to C(any) then only one of the values must be satisfied. | |
""" | |
'asa_config': | |
'prefix': "asa_config_snippet" | |
'description': "Manage configuration sections on Cisco ASA devices" | |
'body': """ | |
asa_config: | |
authorize: ${1|yes,no|} # not required. choices: yes;no. B(Deprecated),Starting with Ansible 2.5 we recommend using C(connection: network_cli) and C(become: yes).,For more information please see the L(Network Guide, ../network/getting_started/network_differences.html#multiple-communication-protocols).,HORIZONTALLINE,Instructs the module to enter privileged mode on the remote device before sending any commands. If not specified, the device will attempt to execute all commands in non-privileged mode. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_AUTHORIZE) will be used instead. | |
src: ${2:null} # not required. Specifies the source path to the file that contains the configuration or configuration template to load. The path to the source file can either be the full path on the Ansible control host or a relative path from the playbook or role root directory. This argument is mutually exclusive with I(lines), I(parents). | |
passwords: ${3|yes,no|} # not required. choices: yes;no. This argument specifies to include passwords in the config when retrieving the running-config from the remote device. This includes passwords related to VPN endpoints. This argument is mutually exclusive with I(defaults). | |
context: ${4:null} # not required. Specifies which context to target if you are running in the ASA in multiple context mode. Defaults to the current context you login to. | |
backup: ${5|yes,no|} # not required. choices: yes;no. This argument will cause the module to create a full backup of the current C(running-config) from the remote device before any changes are made. The backup file is written to the C(backup) folder in the playbook root directory. If the directory does not exist, it is created. | |
after: ${6:null} # not required. The ordered set of commands to append to the end of the command stack if a change needs to be made. Just like with I(before) this allows the playbook designer to append a set of commands to be executed after the command set. | |
lines: ${7:null} # not required. The ordered set of commands that should be configured in the section. The commands must be the exact same commands as found in the device running-config. Be sure to note the configuration command syntax as some commands are automatically modified by the device config parser. | |
replace: ${8|line,block|} # not required. choices: line;block. Instructs the module on the way to perform the configuration on the device. If the replace argument is set to I(line) then the modified lines are pushed to the device in configuration mode. If the replace argument is set to I(block) then the entire command block is pushed to the device in configuration mode if any line is not correct | |
parents: ${9:null} # not required. The ordered set of parents that uniquely identify the section or hierarchy the commands should be checked against. If the parents argument is omitted, the commands are checked against the set of top level or global commands. | |
defaults: ${10|yes,no|} # not required. choices: yes;no. This argument specifies whether or not to collect all defaults when getting the remote device running config. When enabled, the module will get the current config by issuing the command C(show running-config all). | |
provider: ${11:null} # not required. B(Deprecated),Starting with Ansible 2.5 we recommend using C(connection: network_cli).,For more information please see the L(Network Guide, ../network/getting_started/network_differences.html#multiple-communication-protocols).,HORIZONTALLINE,A dict object containing connection details. | |
save: ${12|yes,no|} # not required. choices: yes;no. The C(save) argument instructs the module to save the running- config to the startup-config at the conclusion of the module running. If check mode is specified, this argument is ignored. | |
config: ${13:null} # not required. The C(config) argument allows the playbook designer to supply the base configuration to be used to validate configuration changes necessary. If this argument is provided, the module will not download the running-config from the remote node. | |
match: ${14|line,strict,exact,none|} # not required. choices: line;strict;exact;none. Instructs the module on the way to perform the matching of the set of commands against the current device config. If match is set to I(line), commands are matched line by line. If match is set to I(strict), command lines are matched with respect to position. If match is set to I(exact), command lines must be an equal match. Finally, if match is set to I(none), the module will not attempt to compare the source configuration with the running configuration on the remote device. | |
before: ${15:null} # not required. The ordered set of commands to push on to the command stack if a change needs to be made. This allows the playbook designer the opportunity to perform configuration commands prior to pushing any changes without affecting how the set of commands are matched against the system. | |
""" | |
'assemble': | |
'prefix': "assemble_snippet" | |
'description': "Assembles a configuration file from fragments" | |
'body': """ | |
assemble: | |
src: ${1:undefined} # required. An already existing directory full of source files. | |
dest: ${2:undefined} # required. A file to create using the concatenation of all of the source files. | |
ignore_hidden: ${3:no} # not required. A boolean that controls if files that start with a '.' will be included or not. | |
group: ${4:null} # not required. Name of the group that should own the file/directory, as would be fed to I(chown). | |
remote_src: ${5:yes} # not required. If False, it will search for src at originating/master machine, if True it will go to the remote/target machine for the src. Default is True. | |
selevel: ${6:s0} # not required. Level part of the SELinux file context. This is the MLS/MCS attribute, sometimes known as the C(range). C(_default) feature works as for I(seuser). | |
seuser: ${7:null} # not required. User part of SELinux file context. Will default to system policy, if applicable. If set to C(_default), it will use the C(user) portion of the policy if available. | |
decrypt: ${8:Yes} # not required. This option controls the autodecryption of source files using vault. | |
serole: ${9:null} # not required. Role part of SELinux file context, C(_default) feature works as for I(seuser). | |
unsafe_writes: ${10:false} # not required. Normally this module uses atomic operations to prevent data corruption or inconsistent reads from the target files, sometimes systems are configured or just broken in ways that prevent this. One example are docker mounted files, they cannot be updated atomically and can only be done in an unsafe manner.,This boolean option allows ansible to fall back to unsafe methods of updating files for those cases in which you do not have any other choice. Be aware that this is subject to race conditions and can lead to data corruption. | |
delimiter: ${11:undefined} # not required. A delimiter to separate the file contents. | |
mode: ${12:null} # not required. Mode the file or directory should be. For those used to I(/usr/bin/chmod) remember that modes are actually octal numbers (like C(0644) or C(01777)). Leaving off the leading zero will likely have unexpected results. As of version 1.8, the mode may be specified as a symbolic mode (for example, C(u+rwx) or C(u=rw,g=r,o=r)). | |
attributes: ${13:None} # not required. Attributes the file or directory should have. To get supported flags look at the man page for I(chattr) on the target system. This string should contain the attributes in the same order as the one displayed by I(lsattr). | |
owner: ${14:null} # not required. Name of the user that should own the file/directory, as would be fed to I(chown). | |
regexp: ${15:undefined} # not required. Assemble files only if C(regex) matches the filename. If not set, all files are assembled. All \"\\\" (backslash) must be escaped as \"\\\\\" to comply yaml syntax. Uses Python regular expressions; see U(http://docs.python.org/2/library/re.html). | |
validate: ${16:undefined} # not required. The validation command to run before copying into place. The path to the file to validate is passed in via '%s' which must be present as in the sshd example below. The command is passed securely so shell features like expansion and pipes won't work. | |
backup: ${17:no} # not required. Create a backup file (if C(yes)), including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly. | |
setype: ${18:null} # not required. Type part of SELinux file context, C(_default) feature works as for I(seuser). | |
""" | |
'assert': | |
'prefix': "assert_snippet" | |
'description': "Asserts given expressions are true" | |
'body': """ | |
assert: | |
that: ${1:undefined} # required. A string expression of the same form that can be passed to the 'when' statement,Alternatively, a list of string expressions | |
msg: ${2:undefined} # not required. The customized message used for a failing assertion | |
""" | |
'async_status': | |
'prefix': "async_status_snippet" | |
'description': "Obtain status of asynchronous task" | |
'body': """ | |
async_status: | |
jid: ${1:undefined} # required. Job or task identifier | |
mode: ${2|status,cleanup|} # not required. choices: status;cleanup. if C(status), obtain the status; if C(cleanup), clean up the async job cache (by default in C(~/.ansible_async/)) for the specified job I(jid). | |
""" | |
'at': | |
'prefix': "at_snippet" | |
'description': "Schedule the execution of a command or script file via the at command" | |
'body': """ | |
at: | |
count: ${1:undefined} # required. The count of units in the future to execute the command or script file. | |
units: ${2|minutes,hours,days,weeks|} # required. choices: minutes;hours;days;weeks. The type of units in the future to execute the command or script file. | |
state: ${3|absent,present|} # not required. choices: absent;present. The state dictates if the command or script file should be evaluated as present(added) or absent(deleted). | |
command: ${4:undefined} # not required. A command to be executed in the future. | |
unique: ${5:no} # not required. If a matching job is present a new job will not be added. | |
script_file: ${6:undefined} # not required. An existing script file to be executed in the future. | |
""" | |
'atomic_container': | |
'prefix': "atomic_container_snippet" | |
'description': "Manage the containers on the atomic host platform" | |
'body': """ | |
atomic_container: | |
state: ${1|latest,absent,rollback|} # required. choices: latest;absent;rollback. State of the container | |
name: ${2:null} # required. Name of the container | |
image: ${3:null} # required. The image to use to install the container | |
backend: ${4|docker,ostree|} # required. choices: docker;ostree. Define the backend to use for the container | |
mode: ${5|user,system|} # required. choices: user;system. Define if it is an user or a system container | |
values: ${6:None} # not required. Values for the installation of the container. This option is permitted only with mode 'user' or 'system'. The values specified here will be used at installation time as --set arguments for atomic install. | |
rootfs: ${7:null} # not required. Define the rootfs of the image | |
""" | |
'atomic_host': | |
'prefix': "atomic_host_snippet" | |
'description': "Manage the atomic host platform" | |
'body': """ | |
atomic_host: | |
revision: ${1:latest} # not required. The version number of the atomic host to be deployed. Providing C(latest) will upgrade to the latest available version. | |
""" | |
'atomic_image': | |
'prefix': "atomic_image_snippet" | |
'description': "Manage the container images on the atomic host platform" | |
'body': """ | |
atomic_image: | |
name: ${1:undefined} # required. Name of the container image. | |
started: ${2:yes} # not required. Start or Stop the container. | |
state: ${3|absent,latest,present|} # not required. choices: absent;latest;present. The state of the container image.,The state C(latest) will ensure container image is upgraded to the latest version and forcefully restart container, if running. | |
backend: ${4|docker,ostree|} # not required. choices: docker;ostree. Define the backend where the image is pulled. | |
""" | |
'authorized_key': | |
'prefix': "authorized_key_snippet" | |
'description': "Adds or removes an SSH authorized key" | |
'body': """ | |
authorized_key: | |
user: ${1:undefined} # required. The username on the remote host whose authorized_keys file will be modified | |
key: ${2:undefined} # required. The SSH public key(s), as a string or (since 1.9) url (https://github.com/username.keys) | |
comment: ${3:None} # not required. Change the comment on the public key. Rewriting the comment is useful in cases such as fetching it from GitHub or GitLab.,If no comment is specified, the existing comment will be kept. | |
exclusive: ${4|yes,no|} # not required. choices: yes;no. Whether to remove all other non-specified keys from the authorized_keys file. Multiple keys can be specified in a single C(key) string value by separating them by newlines.,This option is not loop aware, so if you use C(with_) , it will be exclusive per iteration of the loop, if you want multiple keys in the file you need to pass them all to C(key) in a single batch as mentioned above. | |
key_options: ${5:null} # not required. A string of ssh key options to be prepended to the key in the authorized_keys file | |
state: ${6|present,absent|} # not required. choices: present;absent. Whether the given key (with the given key_options) should or should not be in the file | |
path: ${7:(homedir)+/.ssh/authorized_keys} # not required. Alternate path to the authorized_keys file | |
validate_certs: ${8|yes,no|} # not required. choices: yes;no. This only applies if using a https url as the source of the keys. If set to C(no), the SSL certificates will not be validated.,This should only set to C(no) used on personally controlled sites using self-signed certificates as it avoids verifying the source site.,Prior to 2.1 the code worked as if this was set to C(yes). | |
manage_dir: ${9|yes,no|} # not required. choices: yes;no. Whether this module should manage the directory of the authorized key file. If set, the module will create the directory, as well as set the owner and permissions of an existing directory. Be sure to set C(manage_dir=no) if you are using an alternate directory for authorized_keys, as set with C(path), since you could lock yourself out of SSH access. See the example below. | |
""" | |
'avi_actiongroupconfig': | |
'prefix': "avi_actiongroupconfig_snippet" | |
'description': "Module for setup of ActionGroupConfig Avi RESTful Object" | |
'body': """ | |
avi_actiongroupconfig: | |
external_only: ${1:undefined} # required. Generate alert only to external destinations.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
name: ${2:undefined} # required. Name of the object. | |
level: ${3:undefined} # required. When an alert is generated, mark its priority via the alert level.,Enum options - ALERT_LOW, ALERT_MEDIUM, ALERT_HIGH.,Default value when not specified in API or module is interpreted by Avi Controller as ALERT_LOW. | |
email_config_ref: ${4:undefined} # not required. Select the email notification configuration to use when sending alerts via email.,It is a reference to an object of type alertemailconfig. | |
autoscale_trigger_notification: ${5:undefined} # not required. Trigger notification to autoscale manager.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
uuid: ${6:undefined} # not required. Unique object identifier of the object. | |
state: ${7|absent,present|} # not required. choices: absent;present. The state that should be applied on the entity. | |
avi_api_patch_op: ${8|add,replace,delete|} # not required. choices: add;replace;delete. Patch operation to use when using avi_api_update_method as patch. | |
avi_credentials: ${9:undefined} # not required. Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
avi_api_update_method: ${10|put,patch|} # not required. choices: put;patch. Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH. | |
api_version: ${11:16.4.4} # not required. Avi API version of to use for Avi API and objects. | |
username: ${12:} # not required. Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). | |
snmp_trap_profile_ref: ${13:undefined} # not required. Select the snmp trap notification to use when sending alerts via snmp trap.,It is a reference to an object of type snmptrapprofile. | |
description: ${14:undefined} # not required. User defined description for the object. | |
controller: ${15:} # not required. IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). | |
api_context: ${16:undefined} # not required. Avi API context that includes current session ID and CSRF Token.,This allows user to perform single login and re-use the session. | |
password: ${17:} # not required. Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). | |
tenant: ${18:admin} # not required. Name of tenant used for all Avi API calls and context of object. | |
url: ${19:undefined} # not required. Avi controller URL of the object. | |
syslog_config_ref: ${20:undefined} # not required. Select the syslog notification configuration to use when sending alerts via syslog.,It is a reference to an object of type alertsyslogconfig. | |
tenant_ref: ${21:undefined} # not required. It is a reference to an object of type tenant. | |
action_script_config_ref: ${22:undefined} # not required. Reference of the action script configuration to be used.,It is a reference to an object of type alertscriptconfig. | |
tenant_uuid: ${23:} # not required. UUID of tenant used for all Avi API calls and context of object. | |
""" | |
'avi_alertconfig': | |
'prefix': "avi_alertconfig_snippet" | |
'description': "Module for setup of AlertConfig Avi RESTful Object" | |
'body': """ | |
avi_alertconfig: | |
name: ${1:undefined} # required. Name of the alert configuration. | |
category: ${2:undefined} # required. Determines whether an alert is raised immediately when event occurs (realtime) or after specified number of events occurs within rolling time,window.,Enum options - REALTIME, ROLLINGWINDOW, WATERMARK.,Default value when not specified in API or module is interpreted by Avi Controller as REALTIME. | |
source: ${3:undefined} # required. Signifies system events or the type of client logsused in this alert configuration.,Enum options - CONN_LOGS, APP_LOGS, EVENT_LOGS, METRICS. | |
alert_rule: ${4:undefined} # required. List of filters matching on events or client logs used for triggering alerts. | |
username: ${5:} # not required. Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). | |
description: ${6:undefined} # not required. A custom description field. | |
tenant_ref: ${7:undefined} # not required. It is a reference to an object of type tenant. | |
object_type: ${8:undefined} # not required. The object type to which the alert config is associated with.,Valid object types are - virtual service, pool, service engine.,Enum options - VIRTUALSERVICE, POOL, HEALTHMONITOR, NETWORKPROFILE, APPLICATIONPROFILE, HTTPPOLICYSET, DNSPOLICY, IPADDRGROUP, STRINGGROUP,,SSLPROFILE, SSLKEYANDCERTIFICATE, NETWORKSECURITYPOLICY, APPLICATIONPERSISTENCEPROFILE, ANALYTICSPROFILE, VSDATASCRIPTSET, TENANT, PKIPROFILE,,AUTHPROFILE, CLOUD, SERVERAUTOSCALEPOLICY, AUTOSCALELAUNCHCONFIG, MICROSERVICEGROUP, IPAMPROFILE, HARDWARESECURITYMODULEGROUP, POOLGROUP,,PRIORITYLABELS, POOLGROUPDEPLOYMENTPOLICY, GSLBSERVICE, GSLBSERVICERUNTIME, SCHEDULER, GSLBGEODBPROFILE, GSLBAPPLICATIONPERSISTENCEPROFILE,,TRAFFICCLONEPROFILE, VSVIP, WAFPOLICY, WAFPROFILE, ERRORPAGEPROFILE, ERRORPAGEBODY, L4POLICYSET, SERVICEENGINE, DEBUGSERVICEENGINE,,DEBUGCONTROLLER, DEBUGVIRTUALSERVICE, SERVICEENGINEGROUP, SEPROPERTIES, NETWORK, CONTROLLERNODE, CONTROLLERPROPERTIES, SYSTEMCONFIGURATION,,VRFCONTEXT, USER, ALERTCONFIG, ALERTSYSLOGCONFIG, ALERTEMAILCONFIG, ALERTTYPECONFIG, APPLICATION, ROLE, CLOUDPROPERTIES, SNMPTRAPPROFILE,,ACTIONGROUPPROFILE, MICROSERVICE, ALERTPARAMS, ACTIONGROUPCONFIG, CLOUDCONNECTORUSER, GSLB, GSLBDNSUPDATE, GSLBSITEOPS, GLBMGRWARMSTART,,IPAMDNSRECORD, GSLBDNSGSSTATUS, GSLBDNSGEOFILEOPS, GSLBDNSGEOUPDATE, GSLBDNSGEOCLUSTEROPS, GSLBDNSCLEANUP, GSLBSITEOPSRESYNC, TCPSTATRUNTIME,,UDPSTATRUNTIME, IPSTATRUNTIME, ARPSTATRUNTIME, MBSTATRUNTIME, IPSTKQSTATSRUNTIME, MALLOCSTATRUNTIME, SHMALLOCSTATRUNTIME, CPUUSAGERUNTIME,,L7GLOBALSTATSRUNTIME, L7VIRTUALSERVICESTATSRUNTIME, SEAGENTVNICDBRUNTIME, SEAGENTGRAPHDBRUNTIME, SEAGENTSTATERUNTIME, INTERFACERUNTIME,,ARPTABLERUNTIME, DISPATCHERSTATRUNTIME, DISPATCHERSTATCLEARRUNTIME, DISPATCHERTABLEDUMPRUNTIME, DISPATCHERREMOTETIMERLISTDUMPRUNTIME,,METRICSAGENTMESSAGE, HEALTHMONITORSTATRUNTIME, METRICSENTITYRUNTIME, PERSISTENCEINTERNAL, HTTPPOLICYSETINTERNAL, DNSPOLICYINTERNAL,,CONNECTIONDUMPRUNTIME, SHAREDDBSTATS, SHAREDDBSTATSCLEAR, ICMPSTATRUNTIME, ROUTETABLERUNTIME, VIRTUALMACHINE, POOLSERVER, SEVSLIST,,MEMINFORUNTIME, RTERINGSTATRUNTIME, ALGOSTATRUNTIME, HEALTHMONITORRUNTIME, CPUSTATRUNTIME, SEVM, HOST, PORTGROUP, CLUSTER, DATACENTER, VCENTER,,HTTPPOLICYSETSTATS, DNSPOLICYSTATS, METRICSSESTATS, RATELIMITERSTATRUNTIME, NETWORKSECURITYPOLICYSTATS, TCPCONNRUNTIME, POOLSTATS,,CONNPOOLINTERNAL, CONNPOOLSTATS, VSHASHSHOWRUNTIME, SELOGSTATSRUNTIME, NETWORKSECURITYPOLICYDETAIL, LICENSERUNTIME, SERVERRUNTIME,,METRICSRUNTIMESUMMARY, METRICSRUNTIMEDETAIL, DISPATCHERSEHMPROBETEMPDISABLERUNTIME, POOLDEBUG, VSLOGMGRMAP, SERUMINSERTIONSTATS, HTTPCACHE,,HTTPCACHESTATS, SEDOSSTATRUNTIME, VSDOSSTATRUNTIME, SERVERUPDATEREQ, VSSCALEOUTLIST, SEMEMDISTRUNTIME, TCPCONNRUNTIMEDETAIL, SEUPGRADESTATUS,,SEUPGRADEPREVIEW, SEFAULTINJECTEXHAUSTM, SEFAULTINJECTEXHAUSTMCL, SEFAULTINJECTEXHAUSTMCLSMALL, SEFAULTINJECTEXHAUSTCONN, SEHEADLESSONLINEREQ,,SEUPGRADE, SEUPGRADESTATUSDETAIL, SERESERVEDVS, SERESERVEDVSCLEAR, VSCANDIDATESEHOSTLIST, SEGROUPUPGRADE, REBALANCE, SEGROUPREBALANCE,,SEAUTHSTATSRUNTIME, AUTOSCALESTATE, VIRTUALSERVICEAUTHSTATS, NETWORKSECURITYPOLICYDOS, KEYVALINTERNAL, KEYVALSUMMARYINTERNAL,,SERVERSTATEUPDATEINFO, CLTRACKINTERNAL, CLTRACKSUMMARYINTERNAL, MICROSERVICERUNTIME, SEMICROSERVICE, VIRTUALSERVICEANALYSIS, CLIENTINTERNAL,,CLIENTSUMMARYINTERNAL, MICROSERVICEGROUPRUNTIME, BGPRUNTIME, REQUESTQUEUERUNTIME, MIGRATEALL, MIGRATEALLSTATUSSUMMARY, MIGRATEALLSTATUSDETAIL,,INTERFACESUMMARYRUNTIME, INTERFACELACPRUNTIME, DNSTABLE, GSLBSERVICEDETAIL, GSLBSERVICEINTERNAL, GSLBSERVICEHMONSTAT, SETROLESREQUEST,,TRAFFICCLONERUNTIME, GEOLOCATIONINFO, SEVSHBSTATRUNTIME, GEODBINTERNAL, GSLBSITEINTERNAL, WAFSTATS, USERDEFINEDDATASCRIPTCOUNTERS, LLDPRUNTIME,,VSESSHARINGPOOL, SEVSSPLACEMENT, L4POLICYSETSTATS, L4POLICYSETINTERNAL, SERESOURCEPROTO, SECONSUMERPROTO, SECREATEPENDINGPROTO, PLACEMENTSTATS,,SEVIPPROTO, RMVRFPROTO, VCENTERMAP, VIMGRVCENTERRUNTIME, INTERESTEDVMS, INTERESTEDHOSTS, VCENTERSUPPORTEDCOUNTERS, ENTITYCOUNTERS,,TRANSACTIONSTATS, SEVMCREATEPROGRESS, PLACEMENTSTATUS, VISUBFOLDERS, VIDATASTORE, VIHOSTRESOURCES, CLOUDCONNECTOR, VINETWORKSUBNETVMS,,VIDATASTORECONTENTS, VIMGRVCENTERCLOUDRUNTIME, VIVCENTERPORTGROUPS, VIVCENTERDATACENTERS, VIMGRHOSTRUNTIME, PLACEMENTGLOBALS, APICCONFIGURATION,,CIFTABLE, APICTRANSACTION, VIRTUALSERVICESTATEDBCACHESUMMARY, POOLSTATEDBCACHESUMMARY, SERVERSTATEDBCACHESUMMARY, APICAGENTINTERNAL,,APICTRANSACTIONFLAP, APICGRAPHINSTANCES, APICEPGS, APICEPGEPS, APICDEVICEPKGVER, APICTENANTS, APICVMMDOMAINS, NSXCONFIGURATION, NSXSGTABLE,,NSXAGENTINTERNAL, NSXSGINFO, NSXSGIPS, NSXAGENTINTERNALCLI, MAXOBJECTS. | |
autoscale_alert: ${9:undefined} # not required. This alert config applies to auto scale alerts. | |
controller: ${10:} # not required. IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). | |
obj_uuid: ${11:undefined} # not required. Uuid of the resource for which alert was raised. | |
recommendation: ${12:undefined} # not required. Recommendation of alertconfig. | |
threshold: ${13:undefined} # not required. An alert is created only when the number of events meets or exceeds this number within the chosen time frame.,Allowed values are 1-65536.,Default value when not specified in API or module is interpreted by Avi Controller as 1. | |
throttle: ${14:undefined} # not required. Alerts are suppressed (throttled) for this duration of time since the last alert was raised for this alert config.,Allowed values are 0-31536000.,Default value when not specified in API or module is interpreted by Avi Controller as 600.,Units(SEC). | |
password: ${15:} # not required. Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). | |
avi_api_update_method: ${16|put,patch|} # not required. choices: put;patch. Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH. | |
expiry_time: ${17:undefined} # not required. An alert is expired and deleted after the expiry time has elapsed.,The original event triggering the alert remains in the event's log.,Allowed values are 1-31536000.,Default value when not specified in API or module is interpreted by Avi Controller as 86400.,Units(SEC). | |
uuid: ${18:undefined} # not required. Unique object identifier of the object. | |
url: ${19:undefined} # not required. Avi controller URL of the object. | |
avi_credentials: ${20:undefined} # not required. Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
enabled: ${21:undefined} # not required. Enable or disable this alert config from generating new alerts.,Default value when not specified in API or module is interpreted by Avi Controller as True. | |
avi_api_patch_op: ${22|add,replace,delete|} # not required. choices: add;replace;delete. Patch operation to use when using avi_api_update_method as patch. | |
summary: ${23:undefined} # not required. Summary of reason why alert is generated. | |
rolling_window: ${24:undefined} # not required. Only if the number of events is reached or exceeded within the time window will an alert be generated.,Allowed values are 1-31536000.,Default value when not specified in API or module is interpreted by Avi Controller as 300.,Units(SEC). | |
state: ${25|absent,present|} # not required. choices: absent;present. The state that should be applied on the entity. | |
api_context: ${26:undefined} # not required. Avi API context that includes current session ID and CSRF Token.,This allows user to perform single login and re-use the session. | |
action_group_ref: ${27:undefined} # not required. The alert config will trigger the selected alert action, which can send notifications and execute a controlscript.,It is a reference to an object of type actiongroupconfig. | |
tenant_uuid: ${28:} # not required. UUID of tenant used for all Avi API calls and context of object. | |
api_version: ${29:16.4.4} # not required. Avi API version of to use for Avi API and objects. | |
tenant: ${30:admin} # not required. Name of tenant used for all Avi API calls and context of object. | |
""" | |
'avi_alertemailconfig': | |
'prefix': "avi_alertemailconfig_snippet" | |
'description': "Module for setup of AlertEmailConfig Avi RESTful Object" | |
'body': """ | |
avi_alertemailconfig: | |
to_emails: ${1:undefined} # required. Alerts are sent to the comma separated list of email recipients. | |
name: ${2:undefined} # required. A user-friendly name of the email notification service. | |
username: ${3:} # not required. Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). | |
api_version: ${4:16.4.4} # not required. Avi API version of to use for Avi API and objects. | |
uuid: ${5:undefined} # not required. Unique object identifier of the object. | |
url: ${6:undefined} # not required. Avi controller URL of the object. | |
description: ${7:undefined} # not required. User defined description for the object. | |
cc_emails: ${8:undefined} # not required. Alerts are copied to the comma separated list of email recipients. | |
tenant_ref: ${9:undefined} # not required. It is a reference to an object of type tenant. | |
state: ${10|absent,present|} # not required. choices: absent;present. The state that should be applied on the entity. | |
tenant_uuid: ${11:} # not required. UUID of tenant used for all Avi API calls and context of object. | |
avi_api_patch_op: ${12|add,replace,delete|} # not required. choices: add;replace;delete. Patch operation to use when using avi_api_update_method as patch. | |
tenant: ${13:admin} # not required. Name of tenant used for all Avi API calls and context of object. | |
avi_credentials: ${14:undefined} # not required. Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
api_context: ${15:undefined} # not required. Avi API context that includes current session ID and CSRF Token.,This allows user to perform single login and re-use the session. | |
password: ${16:} # not required. Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). | |
controller: ${17:} # not required. IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). | |
avi_api_update_method: ${18|put,patch|} # not required. choices: put;patch. Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH. | |
""" | |
'avi_alertscriptconfig': | |
'prefix': "avi_alertscriptconfig_snippet" | |
'description': "Module for setup of AlertScriptConfig Avi RESTful Object" | |
'body': """ | |
avi_alertscriptconfig: | |
name: ${1:undefined} # required. A user-friendly name of the script. | |
username: ${2:} # not required. Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). | |
action_script: ${3:undefined} # not required. User defined alert action script.,Please refer to kb.avinetworks.com for more information. | |
api_version: ${4:16.4.4} # not required. Avi API version of to use for Avi API and objects. | |
uuid: ${5:undefined} # not required. Unique object identifier of the object. | |
url: ${6:undefined} # not required. Avi controller URL of the object. | |
avi_credentials: ${7:undefined} # not required. Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
tenant_ref: ${8:undefined} # not required. It is a reference to an object of type tenant. | |
state: ${9|absent,present|} # not required. choices: absent;present. The state that should be applied on the entity. | |
tenant_uuid: ${10:} # not required. UUID of tenant used for all Avi API calls and context of object. | |
avi_api_patch_op: ${11|add,replace,delete|} # not required. choices: add;replace;delete. Patch operation to use when using avi_api_update_method as patch. | |
tenant: ${12:admin} # not required. Name of tenant used for all Avi API calls and context of object. | |
api_context: ${13:undefined} # not required. Avi API context that includes current session ID and CSRF Token.,This allows user to perform single login and re-use the session. | |
password: ${14:} # not required. Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). | |
controller: ${15:} # not required. IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). | |
avi_api_update_method: ${16|put,patch|} # not required. choices: put;patch. Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH. | |
""" | |
'avi_alertsyslogconfig': | |
'prefix': "avi_alertsyslogconfig_snippet" | |
'description': "Module for setup of AlertSyslogConfig Avi RESTful Object" | |
'body': """ | |
avi_alertsyslogconfig: | |
name: ${1:undefined} # required. A user-friendly name of the syslog notification. | |
username: ${2:} # not required. Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). | |
api_version: ${3:16.4.4} # not required. Avi API version of to use for Avi API and objects. | |
syslog_servers: ${4:undefined} # not required. The list of syslog servers. | |
uuid: ${5:undefined} # not required. Unique object identifier of the object. | |
url: ${6:undefined} # not required. Avi controller URL of the object. | |
description: ${7:undefined} # not required. User defined description for alert syslog config. | |
avi_credentials: ${8:undefined} # not required. Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
tenant_ref: ${9:undefined} # not required. It is a reference to an object of type tenant. | |
state: ${10|absent,present|} # not required. choices: absent;present. The state that should be applied on the entity. | |
tenant_uuid: ${11:} # not required. UUID of tenant used for all Avi API calls and context of object. | |
avi_api_patch_op: ${12|add,replace,delete|} # not required. choices: add;replace;delete. Patch operation to use when using avi_api_update_method as patch. | |
tenant: ${13:admin} # not required. Name of tenant used for all Avi API calls and context of object. | |
api_context: ${14:undefined} # not required. Avi API context that includes current session ID and CSRF Token.,This allows user to perform single login and re-use the session. | |
password: ${15:} # not required. Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). | |
controller: ${16:} # not required. IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). | |
avi_api_update_method: ${17|put,patch|} # not required. choices: put;patch. Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH. | |
""" | |
'avi_analyticsprofile': | |
'prefix': "avi_analyticsprofile_snippet" | |
'description': "Module for setup of AnalyticsProfile Avi RESTful Object" | |
'body': """ | |
avi_analyticsprofile: | |
name: ${1:undefined} # required. The name of the analytics profile. | |
disable_se_analytics: ${2:undefined} # not required. Disable node (service engine) level analytics forvs metrics.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
apdex_server_rtt_tolerated_factor: ${3:undefined} # not required. Tolerated client to avi round trip time(rtt) factor.,It is a multiple of apdex_rtt_tolerated_factor.,Allowed values are 1-1000.,Default value when not specified in API or module is interpreted by Avi Controller as 4.0. | |
hs_security_tls12_score: ${4:undefined} # not required. Score assigned when supporting tls1.2 encryption protocol.,Allowed values are 0-5.,Default value when not specified in API or module is interpreted by Avi Controller as 5.0. | |
exclude_no_dns_record_as_error: ${5:undefined} # not required. Exclude queries to domains that did not have configured services/records from the list of errors.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
conn_server_lossy_zero_win_size_event_threshold: ${6:undefined} # not required. A server connection is considered lossy when percentage of times a packet could not be trasmitted due to tcp zero window is above this threshold.,Allowed values are 0-100.,Default value when not specified in API or module is interpreted by Avi Controller as 2.,Units(PERCENT). | |
conn_lossy_total_rexmt_threshold: ${7:undefined} # not required. A connection between client and avi is considered lossy when more than this percentage of packets are retransmitted.,Allowed values are 1-100.,Default value when not specified in API or module is interpreted by Avi Controller as 50.,Units(PERCENT). | |
hs_security_certscore_le07d: ${8:undefined} # not required. Score assigned when the certificate expires in less than or equal to 7 days.,Allowed values are 0-5.,Default value when not specified in API or module is interpreted by Avi Controller as 2.0. | |
hs_pscore_traffic_threshold_l4_client: ${9:undefined} # not required. Threshold number of connections in 5min, below which apdexr, apdexc, rum_apdex, and other network quality metrics are not computed.,Default value when not specified in API or module is interpreted by Avi Controller as 10.0. | |
exclude_no_valid_gs_member_as_error: ${10:undefined} # not required. Exclude queries to gslb services that have no available members from the list of errors.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
hs_security_cipherscore_ge128b: ${11:undefined} # not required. Score assigned when the minimum cipher strength is greater than equal to 128 bits.,Allowed values are 0-5.,Default value when not specified in API or module is interpreted by Avi Controller as 5.0. | |
uuid: ${12:undefined} # not required. Uuid of the analytics profile. | |
exclude_invalid_dns_domain_as_error: ${13:undefined} # not required. Exclude dns queries to domains outside the domains configured in the dns application profile from the list of errors.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
exclude_http_error_codes: ${14:undefined} # not required. List of http status codes to be excluded from being classified as an error.,Error connections or responses impacts health score, are included as significant logs, and may be classified as part of a dos attack. | |
hs_max_anomaly_penalty: ${15:undefined} # not required. Maximum penalty that may be deducted from health score for anomalies.,Allowed values are 0-100.,Default value when not specified in API or module is interpreted by Avi Controller as 10. | |
avi_api_patch_op: ${16|add,replace,delete|} # not required. choices: add;replace;delete. Patch operation to use when using avi_api_update_method as patch. | |
avi_credentials: ${17:undefined} # not required. Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
conn_server_lossy_ooo_threshold: ${18:undefined} # not required. A connection between avi and server is considered lossy when more than this percentage of out of order packets are received.,Allowed values are 1-100.,Default value when not specified in API or module is interpreted by Avi Controller as 50.,Units(PERCENT). | |
exclude_persistence_change_as_error: ${19:undefined} # not required. Exclude persistence server changed while load balancing' from the list of errors.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
hs_security_selfsignedcert_penalty: ${20:undefined} # not required. Deprecated.,Allowed values are 0-5.,Default value when not specified in API or module is interpreted by Avi Controller as 1.0. | |
conn_server_lossy_total_rexmt_threshold: ${21:undefined} # not required. A connection between avi and server is considered lossy when more than this percentage of packets are retransmitted.,Allowed values are 1-100.,Default value when not specified in API or module is interpreted by Avi Controller as 50.,Units(PERCENT). | |
username: ${22:} # not required. Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). | |
hs_security_certscore_le30d: ${23:undefined} # not required. Score assigned when the certificate expires in less than or equal to 30 days.,Allowed values are 0-5.,Default value when not specified in API or module is interpreted by Avi Controller as 4.0. | |
exclude_syn_retransmit_as_error: ${24:undefined} # not required. Exclude 'server unanswered syns' from the list of errors.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
controller: ${25:} # not required. IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). | |
hs_security_hsts_penalty: ${26:undefined} # not required. Penalty for not enabling hsts.,Allowed values are 0-5.,Default value when not specified in API or module is interpreted by Avi Controller as 1.0. | |
apdex_rum_threshold: ${27:undefined} # not required. If a client is able to load a page in less than the satisfactory latency threshold, the pageload is considered satisfied.,It is considered tolerated if it is greater than satisfied but less than the tolerated latency multiplied by satisifed latency.,Greater than this number and the client's request is considered frustrated.,A pageload includes the time for dns lookup, download of all http objects, and page render time.,Allowed values are 1-30000.,Default value when not specified in API or module is interpreted by Avi Controller as 5000.,Units(MILLISECONDS). | |
password: ${28:} # not required. Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). | |
avi_api_update_method: ${29|put,patch|} # not required. choices: put;patch. Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH. | |
conn_lossy_zero_win_size_event_threshold: ${30:undefined} # not required. A client connection is considered lossy when percentage of times a packet could not be trasmitted due to tcp zero window is above this threshold.,Allowed values are 0-100.,Default value when not specified in API or module is interpreted by Avi Controller as 2.,Units(PERCENT). | |
hs_security_encalgo_score_rc4: ${31:undefined} # not required. Score assigned when rc4 algorithm is used for encryption.,Allowed values are 0-5.,Default value when not specified in API or module is interpreted by Avi Controller as 2.5. | |
apdex_rtt_threshold: ${32:undefined} # not required. Satisfactory client to avi round trip time(rtt).,Allowed values are 1-2000.,Default value when not specified in API or module is interpreted by Avi Controller as 250.,Units(MILLISECONDS). | |
tenant_ref: ${33:undefined} # not required. It is a reference to an object of type tenant. | |
apdex_response_tolerated_factor: ${34:undefined} # not required. Client tolerated response latency factor.,Client must receive a response within this factor times the satisfactory threshold (apdex_response_threshold) to be considered tolerated.,Allowed values are 1-1000.,Default value when not specified in API or module is interpreted by Avi Controller as 4.0. | |
exclude_tcp_reset_as_error: ${35:undefined} # not required. Exclude tcp resets by client from the list of potential errors.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
hs_security_chain_invalidity_penalty: ${36:undefined} # not required. Penalty for allowing certificates with invalid chain.,Allowed values are 0-5.,Default value when not specified in API or module is interpreted by Avi Controller as 1.0. | |
exclude_invalid_dns_query_as_error: ${37:undefined} # not required. Exclude invalid dns queries from the list of errors.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
conn_lossy_ooo_threshold: ${38:undefined} # not required. A connection between client and avi is considered lossy when more than this percentage of out of order packets are received.,Allowed values are 1-100.,Default value when not specified in API or module is interpreted by Avi Controller as 50.,Units(PERCENT). | |
hs_security_cipherscore_lt128b: ${39:undefined} # not required. Score assigned when the minimum cipher strength is less than 128 bits.,Allowed values are 0-5.,Default value when not specified in API or module is interpreted by Avi Controller as 3.5. | |
hs_security_encalgo_score_none: ${40:undefined} # not required. Score assigned when no algorithm is used for encryption.,Allowed values are 0-5.,Default value when not specified in API or module is interpreted by Avi Controller as 0.0. | |
hs_event_throttle_window: ${41:undefined} # not required. Time window (in secs) within which only unique health change events should occur.,Default value when not specified in API or module is interpreted by Avi Controller as 1209600. | |
hs_security_nonpfs_penalty: ${42:undefined} # not required. Penalty for allowing non-pfs handshakes.,Allowed values are 0-5.,Default value when not specified in API or module is interpreted by Avi Controller as 1.0. | |
hs_security_certscore_gt30d: ${43:undefined} # not required. Score assigned when the certificate expires in more than 30 days.,Allowed values are 0-5.,Default value when not specified in API or module is interpreted by Avi Controller as 5.0. | |
exclude_server_tcp_reset_as_error: ${44:undefined} # not required. Exclude server tcp reset from errors.,It is common for applications like ms exchange.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
hs_min_dos_rate: ${45:undefined} # not required. Dos connection rate below which the dos security assessment will not kick in.,Default value when not specified in API or module is interpreted by Avi Controller as 1000. | |
hs_max_resources_penalty: ${46:undefined} # not required. Maximum penalty that may be deducted from health score for high resource utilization.,Allowed values are 0-100.,Default value when not specified in API or module is interpreted by Avi Controller as 25. | |
client_log_streaming_config: ${47:undefined} # not required. Configure to stream logs to an external server.,Field introduced in 17.1.1. | |
apdex_server_response_threshold: ${48:undefined} # not required. A server http response is considered satisfied if latency is less than the satisfactory latency threshold.,The response is considered tolerated when it is greater than satisfied but less than the tolerated latency factor * s_latency.,Greater than this number and the server response is considered frustrated.,Allowed values are 1-30000.,Default value when not specified in API or module is interpreted by Avi Controller as 400.,Units(MILLISECONDS). | |
hs_performance_boost: ${49:undefined} # not required. Adds free performance score credits to health score.,It can be used for compensating health score for known slow applications.,Allowed values are 0-100.,Default value when not specified in API or module is interpreted by Avi Controller as 0. | |
client_log_config: ${50:undefined} # not required. Configure which logs are sent to the avi controller from ses and how they are processed. | |
exclude_gs_down_as_error: ${51:undefined} # not required. Exclude queries to gslb services that are operationally down from the list of errors.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
apdex_server_response_tolerated_factor: ${52:undefined} # not required. Server tolerated response latency factor.,Servermust response within this factor times the satisfactory threshold (apdex_server_response_threshold) to be considered tolerated.,Allowed values are 1-1000.,Default value when not specified in API or module is interpreted by Avi Controller as 4.0. | |
state: ${53|absent,present|} # not required. choices: absent;present. The state that should be applied on the entity. | |
disable_server_analytics: ${54:undefined} # not required. Disable analytics on backend servers.,This may be desired in container environment when there are large number of ephemeral servers.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
conn_server_lossy_timeo_rexmt_threshold: ${55:undefined} # not required. A connection between avi and server is considered lossy when more than this percentage of packets are retransmitted due to timeout.,Allowed values are 1-100.,Default value when not specified in API or module is interpreted by Avi Controller as 20.,Units(PERCENT). | |
exclude_client_close_before_request_as_error: ${56:undefined} # not required. Exclude client closed connection before an http request could be completed from being classified as an error.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
hs_security_weak_signature_algo_penalty: ${57:undefined} # not required. Penalty for allowing weak signature algorithm(s).,Allowed values are 0-5.,Default value when not specified in API or module is interpreted by Avi Controller as 1.0. | |
conn_lossy_timeo_rexmt_threshold: ${58:undefined} # not required. A connection between client and avi is considered lossy when more than this percentage of packets are retransmitted due to timeout.,Allowed values are 1-100.,Default value when not specified in API or module is interpreted by Avi Controller as 20.,Units(PERCENT). | |
api_version: ${59:16.4.4} # not required. Avi API version of to use for Avi API and objects. | |
apdex_rtt_tolerated_factor: ${60:undefined} # not required. Tolerated client to avi round trip time(rtt) factor.,It is a multiple of apdex_rtt_tolerated_factor.,Allowed values are 1-1000.,Default value when not specified in API or module is interpreted by Avi Controller as 4.0. | |
description: ${61:undefined} # not required. User defined description for the object. | |
hs_security_ssl30_score: ${62:undefined} # not required. Score assigned when supporting ssl3.0 encryption protocol.,Allowed values are 0-5.,Default value when not specified in API or module is interpreted by Avi Controller as 3.5. | |
apdex_rum_tolerated_factor: ${63:undefined} # not required. Virtual service threshold factor for tolerated page load time (plt) as multiple of apdex_rum_threshold.,Allowed values are 1-1000.,Default value when not specified in API or module is interpreted by Avi Controller as 4.0. | |
hs_security_cipherscore_eq000b: ${64:undefined} # not required. Score assigned when the minimum cipher strength is 0 bits.,Allowed values are 0-5.,Default value when not specified in API or module is interpreted by Avi Controller as 0.0. | |
ranges: ${65:undefined} # not required. List of http status code ranges to be excluded from being classified as an error. | |
apdex_server_rtt_threshold: ${66:undefined} # not required. Satisfactory client to avi round trip time(rtt).,Allowed values are 1-2000.,Default value when not specified in API or module is interpreted by Avi Controller as 125.,Units(MILLISECONDS). | |
exclude_server_dns_error_as_error: ${67:undefined} # not required. Exclude server dns error response from the list of errors.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
hs_security_tls11_score: ${68:undefined} # not required. Score assigned when supporting tls1.1 encryption protocol.,Allowed values are 0-5.,Default value when not specified in API or module is interpreted by Avi Controller as 5.0. | |
resp_code_block: ${69:undefined} # not required. Block of http response codes to be excluded from being classified as an error.,Enum options - AP_HTTP_RSP_4XX, AP_HTTP_RSP_5XX. | |
tenant: ${70:admin} # not required. Name of tenant used for all Avi API calls and context of object. | |
hs_pscore_traffic_threshold_l4_server: ${71:undefined} # not required. Threshold number of connections in 5min, below which apdexr, apdexc, rum_apdex, and other network quality metrics are not computed.,Default value when not specified in API or module is interpreted by Avi Controller as 10.0. | |
hs_max_security_penalty: ${72:undefined} # not required. Maximum penalty that may be deducted from health score based on security assessment.,Allowed values are 0-100.,Default value when not specified in API or module is interpreted by Avi Controller as 100. | |
exclude_dns_policy_drop_as_significant: ${73:undefined} # not required. Exclude dns policy drops from the list of errors.,Field introduced in 17.2.2.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
tenant_uuid: ${74:} # not required. UUID of tenant used for all Avi API calls and context of object. | |
api_context: ${75:undefined} # not required. Avi API context that includes current session ID and CSRF Token.,This allows user to perform single login and re-use the session. | |
url: ${76:undefined} # not required. Avi controller URL of the object. | |
hs_security_tls10_score: ${77:undefined} # not required. Score assigned when supporting tls1.0 encryption protocol.,Allowed values are 0-5.,Default value when not specified in API or module is interpreted by Avi Controller as 5.0. | |
hs_security_certscore_expired: ${78:undefined} # not required. Score assigned when the certificate has expired.,Allowed values are 0-5.,Default value when not specified in API or module is interpreted by Avi Controller as 0.0. | |
apdex_response_threshold: ${79:undefined} # not required. If a client receives an http response in less than the satisfactory latency threshold, the request is considered satisfied.,It is considered tolerated if it is not satisfied and less than tolerated latency factor multiplied by the satisfactory latency threshold.,Greater than this number and the client's request is considered frustrated.,Allowed values are 1-30000.,Default value when not specified in API or module is interpreted by Avi Controller as 500.,Units(MILLISECONDS). | |
exclude_unsupported_dns_query_as_error: ${80:undefined} # not required. Exclude unsupported dns queries from the list of errors.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
""" | |
'avi_api_session': | |
'prefix': "avi_api_session_snippet" | |
'description': "Avi API Module" | |
'body': """ | |
avi_api_session: | |
http_method: ${1|get,put,post,patch,delete|} # required. choices: get;put;post;patch;delete. Allowed HTTP methods for RESTful services and are supported by Avi Controller. | |
username: ${2:} # not required. Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). | |
avi_credentials: ${3:undefined} # not required. Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
controller: ${4:} # not required. IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). | |
params: ${5:undefined} # not required. Query parameters passed to the HTTP API. | |
api_version: ${6:16.4.4} # not required. Avi API version of to use for Avi API and objects. | |
timeout: ${7:60} # not required. Timeout (in seconds) for Avi API calls. | |
api_context: ${8:undefined} # not required. Avi API context that includes current session ID and CSRF Token.,This allows user to perform single login and re-use the session. | |
path: ${9:undefined} # not required. Path for Avi API resource. For example, C(path: virtualservice) will translate to C(api/virtualserivce). | |
password: ${10:} # not required. Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). | |
data: ${11:undefined} # not required. HTTP body in YAML or JSON format. | |
tenant_uuid: ${12:} # not required. UUID of tenant used for all Avi API calls and context of object. | |
tenant: ${13:admin} # not required. Name of tenant used for all Avi API calls and context of object. | |
""" | |
'avi_api_version': | |
'prefix': "avi_api_version_snippet" | |
'description': "Avi API Version Module" | |
'body': """ | |
avi_api_version: | |
username: ${1:} # not required. Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). | |
avi_credentials: ${2:undefined} # not required. Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
controller: ${3:} # not required. IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). | |
api_version: ${4:16.4.4} # not required. Avi API version of to use for Avi API and objects. | |
api_context: ${5:undefined} # not required. Avi API context that includes current session ID and CSRF Token.,This allows user to perform single login and re-use the session. | |
password: ${6:} # not required. Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). | |
tenant_uuid: ${7:} # not required. UUID of tenant used for all Avi API calls and context of object. | |
tenant: ${8:admin} # not required. Name of tenant used for all Avi API calls and context of object. | |
""" | |
'avi_applicationpersistenceprofile': | |
'prefix': "avi_applicationpersistenceprofile_snippet" | |
'description': "Module for setup of ApplicationPersistenceProfile Avi RESTful Object" | |
'body': """ | |
avi_applicationpersistenceprofile: | |
persistence_type: ${1:undefined} # required. Method used to persist clients to the same server for a duration of time or a session.,Enum options - PERSISTENCE_TYPE_CLIENT_IP_ADDRESS, PERSISTENCE_TYPE_HTTP_COOKIE, PERSISTENCE_TYPE_TLS, PERSISTENCE_TYPE_CLIENT_IPV6_ADDRESS,,PERSISTENCE_TYPE_CUSTOM_HTTP_HEADER, PERSISTENCE_TYPE_APP_COOKIE, PERSISTENCE_TYPE_GSLB_SITE.,Default value when not specified in API or module is interpreted by Avi Controller as PERSISTENCE_TYPE_CLIENT_IP_ADDRESS. | |
name: ${2:undefined} # required. A user-friendly name for the persistence profile. | |
server_hm_down_recovery: ${3:undefined} # not required. Specifies behavior when a persistent server has been marked down by a health monitor.,Enum options - HM_DOWN_PICK_NEW_SERVER, HM_DOWN_ABORT_CONNECTION, HM_DOWN_CONTINUE_PERSISTENT_SERVER.,Default value when not specified in API or module is interpreted by Avi Controller as HM_DOWN_PICK_NEW_SERVER. | |
uuid: ${4:undefined} # not required. Uuid of the persistence profile. | |
avi_credentials: ${5:undefined} # not required. Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
avi_api_patch_op: ${6|add,replace,delete|} # not required. choices: add;replace;delete. Patch operation to use when using avi_api_update_method as patch. | |
http_cookie_persistence_profile: ${7:undefined} # not required. Specifies the http cookie persistence profile parameters. | |
state: ${8|absent,present|} # not required. choices: absent;present. The state that should be applied on the entity. | |
avi_api_update_method: ${9|put,patch|} # not required. choices: put;patch. Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH. | |
hdr_persistence_profile: ${10:undefined} # not required. Specifies the custom http header persistence profile parameters. | |
api_version: ${11:16.4.4} # not required. Avi API version of to use for Avi API and objects. | |
username: ${12:} # not required. Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). | |
description: ${13:undefined} # not required. User defined description for the object. | |
controller: ${14:} # not required. IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). | |
ip_persistence_profile: ${15:undefined} # not required. Specifies the client ip persistence profile parameters. | |
api_context: ${16:undefined} # not required. Avi API context that includes current session ID and CSRF Token.,This allows user to perform single login and re-use the session. | |
password: ${17:} # not required. Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). | |
tenant: ${18:admin} # not required. Name of tenant used for all Avi API calls and context of object. | |
app_cookie_persistence_profile: ${19:undefined} # not required. Specifies the application cookie persistence profile parameters. | |
url: ${20:undefined} # not required. Avi controller URL of the object. | |
tenant_ref: ${21:undefined} # not required. It is a reference to an object of type tenant. | |
is_federated: ${22:undefined} # not required. This field describes the object's replication scope.,If the field is set to false, then the object is visible within the controller-cluster and its associated service-engines.,If the field is set to true, then the object is replicated across the federation.,Field introduced in 17.1.3.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
tenant_uuid: ${23:} # not required. UUID of tenant used for all Avi API calls and context of object. | |
""" | |
'avi_applicationprofile': | |
'prefix': "avi_applicationprofile_snippet" | |
'description': "Module for setup of ApplicationProfile Avi RESTful Object" | |
'body': """ | |
avi_applicationprofile: | |
type: ${1:undefined} # required. Specifies which application layer proxy is enabled for the virtual service.,Enum options - APPLICATION_PROFILE_TYPE_L4, APPLICATION_PROFILE_TYPE_HTTP, APPLICATION_PROFILE_TYPE_SYSLOG, APPLICATION_PROFILE_TYPE_DNS,,APPLICATION_PROFILE_TYPE_SSL. | |
name: ${2:undefined} # required. The name of the application profile. | |
dos_rl_profile: ${3:undefined} # not required. Specifies various security related controls for virtual service. | |
preserve_client_ip: ${4:undefined} # not required. Specifies if client ip needs to be preserved for backend connection.,Not compatible with connection multiplexing.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
tcp_app_profile: ${5:undefined} # not required. Specifies the tcp application proxy profile parameters. | |
uuid: ${6:undefined} # not required. Uuid of the application profile. | |
dns_service_profile: ${7:undefined} # not required. Specifies various dns service related controls for virtual service. | |
state: ${8|absent,present|} # not required. choices: absent;present. The state that should be applied on the entity. | |
avi_api_patch_op: ${9|add,replace,delete|} # not required. choices: add;replace;delete. Patch operation to use when using avi_api_update_method as patch. | |
avi_credentials: ${10:undefined} # not required. Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
avi_api_update_method: ${11|put,patch|} # not required. choices: put;patch. Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH. | |
api_version: ${12:16.4.4} # not required. Avi API version of to use for Avi API and objects. | |
username: ${13:} # not required. Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). | |
description: ${14:undefined} # not required. User defined description for the object. | |
http_profile: ${15:undefined} # not required. Specifies the http application proxy profile parameters. | |
controller: ${16:} # not required. IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). | |
api_context: ${17:undefined} # not required. Avi API context that includes current session ID and CSRF Token.,This allows user to perform single login and re-use the session. | |
password: ${18:} # not required. Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). | |
tenant: ${19:admin} # not required. Name of tenant used for all Avi API calls and context of object. | |
url: ${20:undefined} # not required. Avi controller URL of the object. | |
tenant_ref: ${21:undefined} # not required. It is a reference to an object of type tenant. | |
tenant_uuid: ${22:} # not required. UUID of tenant used for all Avi API calls and context of object. | |
""" | |
'avi_authprofile': | |
'prefix': "avi_authprofile_snippet" | |
'description': "Module for setup of AuthProfile Avi RESTful Object" | |
'body': """ | |
avi_authprofile: | |
name: ${1:undefined} # required. Name of the auth profile. | |
type: ${2:undefined} # required. Type of the auth profile.,Enum options - AUTH_PROFILE_LDAP, AUTH_PROFILE_TACACS_PLUS, AUTH_PROFILE_SAML. | |
username: ${3:} # not required. Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). | |
api_version: ${4:16.4.4} # not required. Avi API version of to use for Avi API and objects. | |
http: ${5:undefined} # not required. Http user authentication params. | |
uuid: ${6:undefined} # not required. Uuid of the auth profile. | |
saml: ${7:undefined} # not required. Saml settings.,Field introduced in 17.2.3. | |
url: ${8:undefined} # not required. Avi controller URL of the object. | |
avi_credentials: ${9:undefined} # not required. Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
tenant_ref: ${10:undefined} # not required. It is a reference to an object of type tenant. | |
state: ${11|absent,present|} # not required. choices: absent;present. The state that should be applied on the entity. | |
api_context: ${12:undefined} # not required. Avi API context that includes current session ID and CSRF Token.,This allows user to perform single login and re-use the session. | |
avi_api_patch_op: ${13|add,replace,delete|} # not required. choices: add;replace;delete. Patch operation to use when using avi_api_update_method as patch. | |
tacacs_plus: ${14:undefined} # not required. Tacacs+ settings. | |
ldap: ${15:undefined} # not required. Ldap server and directory settings. | |
tenant: ${16:admin} # not required. Name of tenant used for all Avi API calls and context of object. | |
tenant_uuid: ${17:} # not required. UUID of tenant used for all Avi API calls and context of object. | |
password: ${18:} # not required. Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). | |
controller: ${19:} # not required. IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). | |
avi_api_update_method: ${20|put,patch|} # not required. choices: put;patch. Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH. | |
description: ${21:undefined} # not required. User defined description for the object. | |
""" | |
'avi_backup': | |
'prefix': "avi_backup_snippet" | |
'description': "Module for setup of Backup Avi RESTful Object" | |
'body': """ | |
avi_backup: | |
file_name: ${1:undefined} # required. The file name of backup. | |
scheduler_ref: ${2:undefined} # not required. Scheduler information.,It is a reference to an object of type scheduler. | |
username: ${3:} # not required. Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). | |
api_version: ${4:16.4.4} # not required. Avi API version of to use for Avi API and objects. | |
uuid: ${5:undefined} # not required. Unique object identifier of the object. | |
local_file_url: ${6:undefined} # not required. Url to download the backup file. | |
url: ${7:undefined} # not required. Avi controller URL of the object. | |
remote_file_url: ${8:undefined} # not required. Url to download the backup file. | |
avi_credentials: ${9:undefined} # not required. Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
tenant_ref: ${10:undefined} # not required. It is a reference to an object of type tenant. | |
state: ${11|absent,present|} # not required. choices: absent;present. The state that should be applied on the entity. | |
tenant_uuid: ${12:} # not required. UUID of tenant used for all Avi API calls and context of object. | |
backup_config_ref: ${13:undefined} # not required. Backupconfiguration information.,It is a reference to an object of type backupconfiguration. | |
api_context: ${14:undefined} # not required. Avi API context that includes current session ID and CSRF Token.,This allows user to perform single login and re-use the session. | |
avi_api_patch_op: ${15|add,replace,delete|} # not required. choices: add;replace;delete. Patch operation to use when using avi_api_update_method as patch. | |
tenant: ${16:admin} # not required. Name of tenant used for all Avi API calls and context of object. | |
timestamp: ${17:undefined} # not required. Unix timestamp of when the backup file is created. | |
password: ${18:} # not required. Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). | |
controller: ${19:} # not required. IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). | |
avi_api_update_method: ${20|put,patch|} # not required. choices: put;patch. Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH. | |
""" | |
'avi_backupconfiguration': | |
'prefix': "avi_backupconfiguration_snippet" | |
'description': "Module for setup of BackupConfiguration Avi RESTful Object" | |
'body': """ | |
avi_backupconfiguration: | |
name: ${1:undefined} # required. Name of backup configuration. | |
remote_hostname: ${2:undefined} # not required. Remote destination. | |
remote_directory: ${3:undefined} # not required. Directory at remote destination with write permission for ssh user. | |
uuid: ${4:undefined} # not required. Unique object identifier of the object. | |
avi_credentials: ${5:undefined} # not required. Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
avi_api_patch_op: ${6|add,replace,delete|} # not required. choices: add;replace;delete. Patch operation to use when using avi_api_update_method as patch. | |
state: ${7|absent,present|} # not required. choices: absent;present. The state that should be applied on the entity. | |
save_local: ${8:undefined} # not required. Local backup. | |
upload_to_remote_host: ${9:undefined} # not required. Remote backup. | |
backup_file_prefix: ${10:undefined} # not required. Prefix of the exported configuration file.,Field introduced in 17.1.1. | |
api_version: ${11:16.4.4} # not required. Avi API version of to use for Avi API and objects. | |
username: ${12:} # not required. Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). | |
backup_passphrase: ${13:undefined} # not required. Passphrase of backup configuration. | |
controller: ${14:} # not required. IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). | |
api_context: ${15:undefined} # not required. Avi API context that includes current session ID and CSRF Token.,This allows user to perform single login and re-use the session. | |
password: ${16:} # not required. Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). | |
avi_api_update_method: ${17|put,patch|} # not required. choices: put;patch. Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH. | |
tenant: ${18:admin} # not required. Name of tenant used for all Avi API calls and context of object. | |
ssh_user_ref: ${19:undefined} # not required. Access credentials for remote destination.,It is a reference to an object of type cloudconnectoruser. | |
url: ${20:undefined} # not required. Avi controller URL of the object. | |
tenant_ref: ${21:undefined} # not required. It is a reference to an object of type tenant. | |
maximum_backups_stored: ${22:undefined} # not required. Rotate the backup files based on this count.,Allowed values are 1-20.,Default value when not specified in API or module is interpreted by Avi Controller as 4. | |
tenant_uuid: ${23:} # not required. UUID of tenant used for all Avi API calls and context of object. | |
""" | |
'avi_certificatemanagementprofile': | |
'prefix': "avi_certificatemanagementprofile_snippet" | |
'description': "Module for setup of CertificateManagementProfile Avi RESTful Object" | |
'body': """ | |
avi_certificatemanagementprofile: | |
name: ${1:undefined} # required. Name of the pki profile. | |
script_path: ${2:undefined} # required. Script_path of certificatemanagementprofile. | |
username: ${3:} # not required. Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). | |
password: ${4:} # not required. Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). | |
api_version: ${5:16.4.4} # not required. Avi API version of to use for Avi API and objects. | |
url: ${6:undefined} # not required. Avi controller URL of the object. | |
avi_credentials: ${7:undefined} # not required. Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
tenant_ref: ${8:undefined} # not required. It is a reference to an object of type tenant. | |
state: ${9|absent,present|} # not required. choices: absent;present. The state that should be applied on the entity. | |
tenant_uuid: ${10:} # not required. UUID of tenant used for all Avi API calls and context of object. | |
avi_api_patch_op: ${11|add,replace,delete|} # not required. choices: add;replace;delete. Patch operation to use when using avi_api_update_method as patch. | |
tenant: ${12:admin} # not required. Name of tenant used for all Avi API calls and context of object. | |
api_context: ${13:undefined} # not required. Avi API context that includes current session ID and CSRF Token.,This allows user to perform single login and re-use the session. | |
script_params: ${14:undefined} # not required. List of customparams. | |
controller: ${15:} # not required. IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). | |
avi_api_update_method: ${16|put,patch|} # not required. choices: put;patch. Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH. | |
uuid: ${17:undefined} # not required. Unique object identifier of the object. | |
""" | |
'avi_cloud': | |
'prefix': "avi_cloud_snippet" | |
'description': "Module for setup of Cloud Avi RESTful Object" | |
'body': """ | |
avi_cloud: | |
vtype: ${1:undefined} # required. Cloud type.,Enum options - CLOUD_NONE, CLOUD_VCENTER, CLOUD_OPENSTACK, CLOUD_AWS, CLOUD_VCA, CLOUD_APIC, CLOUD_MESOS, CLOUD_LINUXSERVER, CLOUD_DOCKER_UCP,,CLOUD_RANCHER, CLOUD_OSHIFT_K8S, CLOUD_AZURE.,Default value when not specified in API or module is interpreted by Avi Controller as CLOUD_NONE. | |
name: ${2:undefined} # required. Name of the object. | |
vca_configuration: ${3:undefined} # not required. Vcloudairconfiguration settings for cloud. | |
proxy_configuration: ${4:undefined} # not required. Proxyconfiguration settings for cloud. | |
docker_configuration: ${5:undefined} # not required. Dockerconfiguration settings for cloud. | |
oshiftk8s_configuration: ${6:undefined} # not required. Oshiftk8sconfiguration settings for cloud. | |
mtu: ${7:undefined} # not required. Mtu setting for the cloud.,Default value when not specified in API or module is interpreted by Avi Controller as 1500.,Units(BYTES). | |
rancher_configuration: ${8:undefined} # not required. Rancherconfiguration settings for cloud. | |
uuid: ${9:undefined} # not required. Unique object identifier of the object. | |
linuxserver_configuration: ${10:undefined} # not required. Linuxserverconfiguration settings for cloud. | |
custom_tags: ${11:undefined} # not required. Custom tags for all avi created resources in the cloud infrastructure.,Field introduced in 17.1.5. | |
state: ${12|absent,present|} # not required. choices: absent;present. The state that should be applied on the entity. | |
nsx_configuration: ${13:undefined} # not required. Configuration parameters for nsx manager.,Field introduced in 17.1.1. | |
avi_api_patch_op: ${14|add,replace,delete|} # not required. choices: add;replace;delete. Patch operation to use when using avi_api_update_method as patch. | |
tenant: ${15:admin} # not required. Name of tenant used for all Avi API calls and context of object. | |
apic_mode: ${16:undefined} # not required. Boolean flag to set apic_mode.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
dns_provider_ref: ${17:undefined} # not required. Dns profile for the cloud.,It is a reference to an object of type ipamdnsproviderprofile. | |
api_version: ${18:16.4.4} # not required. Avi API version of to use for Avi API and objects. | |
username: ${19:} # not required. Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). | |
mesos_configuration: ${20:undefined} # not required. Mesosconfiguration settings for cloud. | |
openstack_configuration: ${21:undefined} # not required. Openstackconfiguration settings for cloud. | |
enable_vip_static_routes: ${22:undefined} # not required. Use static routes for vip side network resolution during virtualservice placement.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
controller: ${23:} # not required. IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). | |
aws_configuration: ${24:undefined} # not required. Awsconfiguration settings for cloud. | |
api_context: ${25:undefined} # not required. Avi API context that includes current session ID and CSRF Token.,This allows user to perform single login and re-use the session. | |
ipam_provider_ref: ${26:undefined} # not required. Ipam profile for the cloud.,It is a reference to an object of type ipamdnsproviderprofile. | |
cloudstack_configuration: ${27:undefined} # not required. Cloudstackconfiguration settings for cloud. | |
password: ${28:} # not required. Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). | |
avi_api_update_method: ${29|put,patch|} # not required. choices: put;patch. Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH. | |
azure_configuration: ${30:undefined} # not required. Field introduced in 17.2.1. | |
license_tier: ${31:undefined} # not required. Specifies the default license tier which would be used by new se groups.,This field by default inherits the value from system configuration.,Enum options - ENTERPRISE_16, ENTERPRISE_18.,Field introduced in 17.2.5. | |
state_based_dns_registration: ${32:undefined} # not required. Dns records for vips are added/deleted based on the operational state of the vips.,Field introduced in 17.1.12.,Default value when not specified in API or module is interpreted by Avi Controller as True. | |
url: ${33:undefined} # not required. Avi controller URL of the object. | |
avi_credentials: ${34:undefined} # not required. Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
tenant_ref: ${35:undefined} # not required. It is a reference to an object of type tenant. | |
dhcp_enabled: ${36:undefined} # not required. Select the ip address management scheme.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
east_west_ipam_provider_ref: ${37:undefined} # not required. Ipam profile for east-west services.,Warning - please use virtual subnets in this ipam profile that do not conflict with the underlay networks or any overlay networks in the cluster.,For example in aws and gcp, 169.254.0.0/16 is used for storing instance metadata.,Hence, it should not be used in this profile.,It is a reference to an object of type ipamdnsproviderprofile. | |
obj_name_prefix: ${38:undefined} # not required. Default prefix for all automatically created objects in this cloud.,This prefix can be overridden by the se-group template. | |
apic_configuration: ${39:undefined} # not required. Apicconfiguration settings for cloud. | |
prefer_static_routes: ${40:undefined} # not required. Prefer static routes over interface routes during virtualservice placement.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
license_type: ${41:undefined} # not required. If no license type is specified then default license enforcement for the cloud type is chosen.,The default mappings are container cloud is max ses, openstack and vmware is cores and linux it is sockets.,Enum options - LIC_BACKEND_SERVERS, LIC_SOCKETS, LIC_CORES, LIC_HOSTS, LIC_SE_BANDWIDTH. | |
vcenter_configuration: ${42:undefined} # not required. Vcenterconfiguration settings for cloud. | |
tenant_uuid: ${43:} # not required. UUID of tenant used for all Avi API calls and context of object. | |
east_west_dns_provider_ref: ${44:undefined} # not required. Dns profile for east-west services.,It is a reference to an object of type ipamdnsproviderprofile. | |
""" | |
'avi_cloudconnectoruser': | |
'prefix': "avi_cloudconnectoruser_snippet" | |
'description': "Module for setup of CloudConnectorUser Avi RESTful Object" | |
'body': """ | |
avi_cloudconnectoruser: | |
name: ${1:undefined} # required. Name of the object. | |
username: ${2:} # not required. Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). | |
public_key: ${3:undefined} # not required. Public_key of cloudconnectoruser. | |
private_key: ${4:undefined} # not required. Private_key of cloudconnectoruser. | |
api_version: ${5:16.4.4} # not required. Avi API version of to use for Avi API and objects. | |
url: ${6:undefined} # not required. Avi controller URL of the object. | |
avi_credentials: ${7:undefined} # not required. Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
tenant_ref: ${8:undefined} # not required. It is a reference to an object of type tenant. | |
state: ${9|absent,present|} # not required. choices: absent;present. The state that should be applied on the entity. | |
tenant_uuid: ${10:} # not required. UUID of tenant used for all Avi API calls and context of object. | |
avi_api_patch_op: ${11|add,replace,delete|} # not required. choices: add;replace;delete. Patch operation to use when using avi_api_update_method as patch. | |
azure_serviceprincipal: ${12:undefined} # not required. Field introduced in 17.2.1. | |
azure_userpass: ${13:undefined} # not required. Field introduced in 17.2.1. | |
tenant: ${14:admin} # not required. Name of tenant used for all Avi API calls and context of object. | |
api_context: ${15:undefined} # not required. Avi API context that includes current session ID and CSRF Token.,This allows user to perform single login and re-use the session. | |
password: ${16:} # not required. Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). | |
controller: ${17:} # not required. IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). | |
avi_api_update_method: ${18|put,patch|} # not required. choices: put;patch. Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH. | |
uuid: ${19:undefined} # not required. Unique object identifier of the object. | |
""" | |
'avi_cloudproperties': | |
'prefix': "avi_cloudproperties_snippet" | |
'description': "Module for setup of CloudProperties Avi RESTful Object" | |
'body': """ | |
avi_cloudproperties: | |
info: ${1:undefined} # not required. Properties specific to a cloud type. | |
hyp_props: ${2:undefined} # not required. Hypervisor properties. | |
api_version: ${3:16.4.4} # not required. Avi API version of to use for Avi API and objects. | |
uuid: ${4:undefined} # not required. Unique object identifier of the object. | |
url: ${5:undefined} # not required. Avi controller URL of the object. | |
avi_credentials: ${6:undefined} # not required. Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
controller: ${7:} # not required. IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). | |
state: ${8|absent,present|} # not required. choices: absent;present. The state that should be applied on the entity. | |
tenant_uuid: ${9:} # not required. UUID of tenant used for all Avi API calls and context of object. | |
username: ${10:} # not required. Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). | |
avi_api_patch_op: ${11|add,replace,delete|} # not required. choices: add;replace;delete. Patch operation to use when using avi_api_update_method as patch. | |
cc_props: ${12:undefined} # not required. Cloudconnector properties. | |
api_context: ${13:undefined} # not required. Avi API context that includes current session ID and CSRF Token.,This allows user to perform single login and re-use the session. | |
password: ${14:} # not required. Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). | |
cc_vtypes: ${15:undefined} # not required. Cloud types supported by cloudconnector.,Enum options - CLOUD_NONE, CLOUD_VCENTER, CLOUD_OPENSTACK, CLOUD_AWS, CLOUD_VCA, CLOUD_APIC, CLOUD_MESOS, CLOUD_LINUXSERVER, CLOUD_DOCKER_UCP,,CLOUD_RANCHER, CLOUD_OSHIFT_K8S, CLOUD_AZURE. | |
avi_api_update_method: ${16|put,patch|} # not required. choices: put;patch. Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH. | |
tenant: ${17:admin} # not required. Name of tenant used for all Avi API calls and context of object. | |
""" | |
'avi_cluster': | |
'prefix': "avi_cluster_snippet" | |
'description': "Module for setup of Cluster Avi RESTful Object" | |
'body': """ | |
avi_cluster: | |
name: ${1:undefined} # required. Name of the object. | |
username: ${2:} # not required. Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). | |
uuid: ${3:undefined} # not required. Unique object identifier of the object. | |
api_version: ${4:16.4.4} # not required. Avi API version of to use for Avi API and objects. | |
url: ${5:undefined} # not required. Avi controller URL of the object. | |
avi_credentials: ${6:undefined} # not required. Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
tenant_ref: ${7:undefined} # not required. It is a reference to an object of type tenant. | |
state: ${8|absent,present|} # not required. choices: absent;present. The state that should be applied on the entity. | |
tenant_uuid: ${9:} # not required. UUID of tenant used for all Avi API calls and context of object. | |
avi_api_patch_op: ${10|add,replace,delete|} # not required. choices: add;replace;delete. Patch operation to use when using avi_api_update_method as patch. | |
virtual_ip: ${11:undefined} # not required. A virtual ip address.,This ip address will be dynamically reconfigured so that it always is the ip of the cluster leader. | |
api_context: ${12:undefined} # not required. Avi API context that includes current session ID and CSRF Token.,This allows user to perform single login and re-use the session. | |
tenant: ${13:admin} # not required. Name of tenant used for all Avi API calls and context of object. | |
nodes: ${14:undefined} # not required. List of clusternode. | |
password: ${15:} # not required. Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). | |
controller: ${16:} # not required. IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). | |
avi_api_update_method: ${17|put,patch|} # not required. choices: put;patch. Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH. | |
rejoin_nodes_automatically: ${18:undefined} # not required. Re-join cluster nodes automatically in the event one of the node is reset to factory.,Default value when not specified in API or module is interpreted by Avi Controller as True. | |
""" | |
'avi_clusterclouddetails': | |
'prefix': "avi_clusterclouddetails_snippet" | |
'description': "Module for setup of ClusterCloudDetails Avi RESTful Object" | |
'body': """ | |
avi_clusterclouddetails: | |
name: ${1:undefined} # required. Field introduced in 17.2.5. | |
username: ${2:} # not required. Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). | |
api_version: ${3:16.4.4} # not required. Avi API version of to use for Avi API and objects. | |
url: ${4:undefined} # not required. Avi controller URL of the object. | |
avi_credentials: ${5:undefined} # not required. Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
tenant_ref: ${6:undefined} # not required. It is a reference to an object of type tenant.,Field introduced in 17.2.5. | |
state: ${7|absent,present|} # not required. choices: absent;present. The state that should be applied on the entity. | |
tenant_uuid: ${8:} # not required. UUID of tenant used for all Avi API calls and context of object. | |
avi_api_patch_op: ${9|add,replace,delete|} # not required. choices: add;replace;delete. Patch operation to use when using avi_api_update_method as patch. | |
tenant: ${10:admin} # not required. Name of tenant used for all Avi API calls and context of object. | |
azure_info: ${11:undefined} # not required. Azure info to configure cluster_vip on the controller.,Field introduced in 17.2.5. | |
api_context: ${12:undefined} # not required. Avi API context that includes current session ID and CSRF Token.,This allows user to perform single login and re-use the session. | |
password: ${13:} # not required. Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). | |
controller: ${14:} # not required. IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). | |
avi_api_update_method: ${15|put,patch|} # not required. choices: put;patch. Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH. | |
uuid: ${16:undefined} # not required. Field introduced in 17.2.5. | |
""" | |
'avi_controllerproperties': | |
'prefix': "avi_controllerproperties_snippet" | |
'description': "Module for setup of ControllerProperties Avi RESTful Object" | |
'body': """ | |
avi_controllerproperties: | |
vs_se_ping_fail: ${1:undefined} # not required. Number of vs_se_ping_fail.,Default value when not specified in API or module is interpreted by Avi Controller as 60.,Units(SEC). | |
portal_token: ${2:undefined} # not required. Token used for uploading tech-support to portal.,Field introduced in 16.4.6,17.1.2. | |
cluster_ip_gratuitous_arp_period: ${3:undefined} # not required. Number of cluster_ip_gratuitous_arp_period.,Default value when not specified in API or module is interpreted by Avi Controller as 60.,Units(MIN). | |
persistence_key_rotate_period: ${4:undefined} # not required. Allowed values are 1-1051200.,Special values are 0 - 'disabled'.,Default value when not specified in API or module is interpreted by Avi Controller as 60.,Units(MIN). | |
bm_use_ansible: ${5:undefined} # not required. Use ansible for se creation in baremetal.,Field introduced in 17.2.2.,Default value when not specified in API or module is interpreted by Avi Controller as True. | |
attach_ip_retry_interval: ${6:undefined} # not required. Number of attach_ip_retry_interval.,Default value when not specified in API or module is interpreted by Avi Controller as 360.,Units(SEC). | |
vs_se_vnic_fail: ${7:undefined} # not required. Number of vs_se_vnic_fail.,Default value when not specified in API or module is interpreted by Avi Controller as 300.,Units(SEC). | |
secure_channel_se_token_timeout: ${8:undefined} # not required. Number of secure_channel_se_token_timeout.,Default value when not specified in API or module is interpreted by Avi Controller as 60.,Units(MIN). | |
attach_ip_retry_limit: ${9:undefined} # not required. Number of attach_ip_retry_limit.,Default value when not specified in API or module is interpreted by Avi Controller as 4. | |
se_vnic_cooldown: ${10:undefined} # not required. Number of se_vnic_cooldown.,Default value when not specified in API or module is interpreted by Avi Controller as 120.,Units(SEC). | |
vnic_op_fail_time: ${11:undefined} # not required. Number of vnic_op_fail_time.,Default value when not specified in API or module is interpreted by Avi Controller as 180.,Units(SEC). | |
max_pcap_per_tenant: ${12:undefined} # not required. Maximum number of pcap files stored per tenant.,Default value when not specified in API or module is interpreted by Avi Controller as 4. | |
vs_se_bootup_fail: ${13:undefined} # not required. Number of vs_se_bootup_fail.,Default value when not specified in API or module is interpreted by Avi Controller as 480.,Units(SEC). | |
seupgrade_fabric_pool_size: ${14:undefined} # not required. Pool size used for all fabric commands during se upgrade.,Default value when not specified in API or module is interpreted by Avi Controller as 20. | |
vs_key_rotate_period: ${15:undefined} # not required. Allowed values are 1-1051200.,Special values are 0 - 'disabled'.,Default value when not specified in API or module is interpreted by Avi Controller as 60.,Units(MIN). | |
seupgrade_segroup_min_dead_timeout: ${16:undefined} # not required. Time to wait before marking segroup upgrade as stuck.,Default value when not specified in API or module is interpreted by Avi Controller as 360.,Units(SEC). | |
dns_refresh_period: ${17:undefined} # not required. Number of dns_refresh_period.,Default value when not specified in API or module is interpreted by Avi Controller as 60.,Units(MIN). | |
upgrade_lease_time: ${18:undefined} # not required. Number of upgrade_lease_time.,Default value when not specified in API or module is interpreted by Avi Controller as 360.,Units(SEC). | |
avi_api_patch_op: ${19|add,replace,delete|} # not required. choices: add;replace;delete. Patch operation to use when using avi_api_update_method as patch. | |
se_create_timeout: ${20:undefined} # not required. Number of se_create_timeout.,Default value when not specified in API or module is interpreted by Avi Controller as 900.,Units(SEC). | |
query_host_fail: ${21:undefined} # not required. Number of query_host_fail.,Default value when not specified in API or module is interpreted by Avi Controller as 180.,Units(SEC). | |
vs_apic_scaleout_timeout: ${22:undefined} # not required. Time to wait for the scaled out se to become ready before marking the scaleout done, applies to apic configuration only.,Default value when not specified in API or module is interpreted by Avi Controller as 360.,Units(SEC). | |
unresponsive_se_reboot: ${23:undefined} # not required. Number of unresponsive_se_reboot.,Default value when not specified in API or module is interpreted by Avi Controller as 300.,Units(SEC). | |
state: ${24|absent,present|} # not required. choices: absent;present. The state that should be applied on the entity. | |
se_offline_del: ${25:undefined} # not required. Number of se_offline_del.,Default value when not specified in API or module is interpreted by Avi Controller as 172000.,Units(SEC). | |
max_dead_se_in_grp: ${26:undefined} # not required. Number of max_dead_se_in_grp.,Default value when not specified in API or module is interpreted by Avi Controller as 1. | |
upgrade_dns_ttl: ${27:undefined} # not required. Time to account for dns ttl during upgrade.,This is in addition to vs_scalein_timeout_for_upgrade in se_group.,Field introduced in 17.1.1.,Default value when not specified in API or module is interpreted by Avi Controller as 5.,Units(SEC). | |
fatal_error_lease_time: ${28:undefined} # not required. Number of fatal_error_lease_time.,Default value when not specified in API or module is interpreted by Avi Controller as 120.,Units(SEC). | |
api_version: ${29:16.4.4} # not required. Avi API version of to use for Avi API and objects. | |
username: ${30:} # not required. Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). | |
allow_ip_forwarding: ${31:undefined} # not required. Field introduced in 17.1.1.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
vs_se_attach_ip_fail: ${32:undefined} # not required. Time to wait before marking attach ip operation on an se as failed.,Field introduced in 17.2.2.,Default value when not specified in API or module is interpreted by Avi Controller as 3600.,Units(SEC). | |
avi_credentials: ${33:undefined} # not required. Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
max_seq_vnic_failures: ${34:undefined} # not required. Number of max_seq_vnic_failures.,Default value when not specified in API or module is interpreted by Avi Controller as 3. | |
allow_unauthenticated_nodes: ${35:undefined} # not required. Boolean flag to set allow_unauthenticated_nodes.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
allow_unauthenticated_apis: ${36:undefined} # not required. Allow unauthenticated access for special apis.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
controller: ${37:} # not required. IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). | |
safenet_hsm_version: ${38:undefined} # not required. Version of the safenet package installed on the controller.,Field introduced in 16.5.2,17.2.3. | |
warmstart_se_reconnect_wait_time: ${39:undefined} # not required. Number of warmstart_se_reconnect_wait_time.,Default value when not specified in API or module is interpreted by Avi Controller as 300.,Units(SEC). | |
api_context: ${40:undefined} # not required. Avi API context that includes current session ID and CSRF Token.,This allows user to perform single login and re-use the session. | |
password: ${41:} # not required. Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). | |
avi_api_update_method: ${42|put,patch|} # not required. choices: put;patch. Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH. | |
uuid: ${43:undefined} # not required. Unique object identifier of the object. | |
tenant: ${44:admin} # not required. Name of tenant used for all Avi API calls and context of object. | |
dummy: ${45:undefined} # not required. Number of dummy. | |
max_seq_attach_ip_failures: ${46:undefined} # not required. Maximum number of consecutive attach ip failures that halts vs placement.,Field introduced in 17.2.2.,Default value when not specified in API or module is interpreted by Avi Controller as 3. | |
secure_channel_cleanup_timeout: ${47:undefined} # not required. Number of secure_channel_cleanup_timeout.,Default value when not specified in API or module is interpreted by Avi Controller as 60.,Units(MIN). | |
ssl_certificate_expiry_warning_days: ${48:undefined} # not required. Number of days for ssl certificate expiry warning.,Units(DAYS). | |
vs_se_vnic_ip_fail: ${49:undefined} # not required. Number of vs_se_vnic_ip_fail.,Default value when not specified in API or module is interpreted by Avi Controller as 120.,Units(SEC). | |
secure_channel_controller_token_timeout: ${50:undefined} # not required. Number of secure_channel_controller_token_timeout.,Default value when not specified in API or module is interpreted by Avi Controller as 60.,Units(MIN). | |
url: ${51:undefined} # not required. Avi controller URL of the object. | |
vs_se_create_fail: ${52:undefined} # not required. Number of vs_se_create_fail.,Default value when not specified in API or module is interpreted by Avi Controller as 1500.,Units(SEC). | |
api_idle_timeout: ${53:undefined} # not required. Allowed values are 0-1440.,Default value when not specified in API or module is interpreted by Avi Controller as 15.,Units(MIN). | |
crashed_se_reboot: ${54:undefined} # not required. Number of crashed_se_reboot.,Default value when not specified in API or module is interpreted by Avi Controller as 900.,Units(SEC). | |
appviewx_compat_mode: ${55:undefined} # not required. Export configuration in appviewx compatibility mode.,Field introduced in 17.1.1.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
vs_awaiting_se_timeout: ${56:undefined} # not required. Number of vs_awaiting_se_timeout.,Default value when not specified in API or module is interpreted by Avi Controller as 60.,Units(SEC). | |
se_failover_attempt_interval: ${57:undefined} # not required. Interval between attempting failovers to an se.,Default value when not specified in API or module is interpreted by Avi Controller as 300.,Units(SEC). | |
dead_se_detection_timer: ${58:undefined} # not required. Number of dead_se_detection_timer.,Default value when not specified in API or module is interpreted by Avi Controller as 360.,Units(SEC). | |
tenant_uuid: ${59:} # not required. UUID of tenant used for all Avi API calls and context of object. | |
""" | |
'avi_customipamdnsprofile': | |
'prefix': "avi_customipamdnsprofile_snippet" | |
'description': "Module for setup of CustomIpamDnsProfile Avi RESTful Object" | |
'body': """ | |
avi_customipamdnsprofile: | |
name: ${1:undefined} # required. Name of the custom ipam dns profile.,Field introduced in 17.1.1. | |
script_uri: ${2:undefined} # required. Script uri of form controller //ipamdnsscripts/<file-name>.,Field introduced in 17.1.1. | |
username: ${3:} # not required. Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). | |
password: ${4:} # not required. Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). | |
api_version: ${5:16.4.4} # not required. Avi API version of to use for Avi API and objects. | |
url: ${6:undefined} # not required. Avi controller URL of the object. | |
avi_credentials: ${7:undefined} # not required. Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
tenant_ref: ${8:undefined} # not required. It is a reference to an object of type tenant.,Field introduced in 17.1.1. | |
state: ${9|absent,present|} # not required. choices: absent;present. The state that should be applied on the entity. | |
tenant_uuid: ${10:} # not required. UUID of tenant used for all Avi API calls and context of object. | |
avi_api_patch_op: ${11|add,replace,delete|} # not required. choices: add;replace;delete. Patch operation to use when using avi_api_update_method as patch. | |
tenant: ${12:admin} # not required. Name of tenant used for all Avi API calls and context of object. | |
api_context: ${13:undefined} # not required. Avi API context that includes current session ID and CSRF Token.,This allows user to perform single login and re-use the session. | |
script_params: ${14:undefined} # not required. Parameters that are always passed to the ipam/dns script.,Field introduced in 17.1.1. | |
controller: ${15:} # not required. IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). | |
avi_api_update_method: ${16|put,patch|} # not required. choices: put;patch. Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH. | |
uuid: ${17:undefined} # not required. Field introduced in 17.1.1. | |
""" | |
'avi_dnspolicy': | |
'prefix': "avi_dnspolicy_snippet" | |
'description': "Module for setup of DnsPolicy Avi RESTful Object" | |
'body': """ | |
avi_dnspolicy: | |
name: ${1:undefined} # required. Name of the dns policy.,Field introduced in 17.1.1. | |
username: ${2:} # not required. Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). | |
api_version: ${3:16.4.4} # not required. Avi API version of to use for Avi API and objects. | |
uuid: ${4:undefined} # not required. Uuid of the dns policy.,Field introduced in 17.1.1. | |
url: ${5:undefined} # not required. Avi controller URL of the object. | |
description: ${6:undefined} # not required. Field introduced in 17.1.1. | |
avi_credentials: ${7:undefined} # not required. Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
tenant_ref: ${8:undefined} # not required. It is a reference to an object of type tenant.,Field introduced in 17.1.1. | |
state: ${9|absent,present|} # not required. choices: absent;present. The state that should be applied on the entity. | |
created_by: ${10:undefined} # not required. Creator name.,Field introduced in 17.1.1. | |
tenant_uuid: ${11:} # not required. UUID of tenant used for all Avi API calls and context of object. | |
avi_api_patch_op: ${12|add,replace,delete|} # not required. choices: add;replace;delete. Patch operation to use when using avi_api_update_method as patch. | |
rule: ${13:undefined} # not required. Dns rules.,Field introduced in 17.1.1. | |
api_context: ${14:undefined} # not required. Avi API context that includes current session ID and CSRF Token.,This allows user to perform single login and re-use the session. | |
tenant: ${15:admin} # not required. Name of tenant used for all Avi API calls and context of object. | |
password: ${16:} # not required. Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). | |
controller: ${17:} # not required. IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). | |
avi_api_update_method: ${18|put,patch|} # not required. choices: put;patch. Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH. | |
""" | |
'avi_errorpagebody': | |
'prefix': "avi_errorpagebody_snippet" | |
'description': "Module for setup of ErrorPageBody Avi RESTful Object" | |
'body': """ | |
avi_errorpagebody: | |
name: ${1:undefined} # required. Field introduced in 17.2.4. | |
username: ${2:} # not required. Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). | |
api_version: ${3:16.4.4} # not required. Avi API version of to use for Avi API and objects. | |
url: ${4:undefined} # not required. Avi controller URL of the object. | |
avi_credentials: ${5:undefined} # not required. Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
tenant_ref: ${6:undefined} # not required. It is a reference to an object of type tenant.,Field introduced in 17.2.4. | |
state: ${7|absent,present|} # not required. choices: absent;present. The state that should be applied on the entity. | |
tenant_uuid: ${8:} # not required. UUID of tenant used for all Avi API calls and context of object. | |
error_page_body: ${9:undefined} # not required. Error page body sent to client when match.,Field introduced in 17.2.4. | |
avi_api_patch_op: ${10|add,replace,delete|} # not required. choices: add;replace;delete. Patch operation to use when using avi_api_update_method as patch. | |
tenant: ${11:admin} # not required. Name of tenant used for all Avi API calls and context of object. | |
api_context: ${12:undefined} # not required. Avi API context that includes current session ID and CSRF Token.,This allows user to perform single login and re-use the session. | |
password: ${13:} # not required. Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). | |
controller: ${14:} # not required. IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). | |
avi_api_update_method: ${15|put,patch|} # not required. choices: put;patch. Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH. | |
uuid: ${16:undefined} # not required. Field introduced in 17.2.4. | |
""" | |
'avi_errorpageprofile': | |
'prefix': "avi_errorpageprofile_snippet" | |
'description': "Module for setup of ErrorPageProfile Avi RESTful Object" | |
'body': """ | |
avi_errorpageprofile: | |
name: ${1:undefined} # required. Field introduced in 17.2.4. | |
username: ${2:} # not required. Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). | |
api_version: ${3:16.4.4} # not required. Avi API version of to use for Avi API and objects. | |
uuid: ${4:undefined} # not required. Field introduced in 17.2.4. | |
tenant_uuid: ${5:} # not required. UUID of tenant used for all Avi API calls and context of object. | |
error_pages: ${6:undefined} # not required. Defined error pages for http status codes.,Field introduced in 17.2.4. | |
avi_credentials: ${7:undefined} # not required. Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
tenant_ref: ${8:undefined} # not required. It is a reference to an object of type tenant.,Field introduced in 17.2.4. | |
state: ${9|absent,present|} # not required. choices: absent;present. The state that should be applied on the entity. | |
tenant: ${10:admin} # not required. Name of tenant used for all Avi API calls and context of object. | |
url: ${11:undefined} # not required. Avi controller URL of the object. | |
avi_api_patch_op: ${12|add,replace,delete|} # not required. choices: add;replace;delete. Patch operation to use when using avi_api_update_method as patch. | |
company_name: ${13:undefined} # not required. Name of the company to show in error page.,Field introduced in 17.2.4.,Default value when not specified in API or module is interpreted by Avi Controller as Avi Networks. | |
api_context: ${14:undefined} # not required. Avi API context that includes current session ID and CSRF Token.,This allows user to perform single login and re-use the session. | |
host_name: ${15:undefined} # not required. Fully qualified domain name for which the error page is generated.,Field introduced in 17.2.4.,Default value when not specified in API or module is interpreted by Avi Controller as Host Header. | |
password: ${16:} # not required. Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). | |
controller: ${17:} # not required. IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). | |
avi_api_update_method: ${18|put,patch|} # not required. choices: put;patch. Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH. | |
app_name: ${19:undefined} # not required. Name of the virtual service which generated the error page.,Field introduced in 17.2.4.,Default value when not specified in API or module is interpreted by Avi Controller as VS Name. | |
""" | |
'avi_gslb': | |
'prefix': "avi_gslb_snippet" | |
'description': "Module for setup of Gslb Avi RESTful Object" | |
'body': """ | |
avi_gslb: | |
leader_cluster_uuid: ${1:undefined} # required. Mark this site as leader of gslb configuration.,This site is the one among the avi sites. | |
name: ${2:undefined} # required. Name for the gslb object. | |
username: ${3:} # not required. Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). | |
description: ${4:undefined} # not required. User defined description for the object. | |
state: ${5|absent,present|} # not required. choices: absent;present. The state that should be applied on the entity. | |
maintenance_mode: ${6:undefined} # not required. This field disables the configuration operations on the leader for all federated objects.,Cud operations on gslb, gslbservice, gslbgeodbprofile and other federated objects will be rejected.,The rest-api disabling helps in upgrade scenarios where we don't want configuration sync operations to the gslb member when the member is being,upgraded.,This configuration programmatically blocks the leader from accepting new gslb configuration when member sites are undergoing upgrade.,Field introduced in 17.2.1.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
third_party_sites: ${7:undefined} # not required. Third party site member belonging to this gslb.,Field introduced in 17.1.1. | |
sites: ${8:undefined} # not required. Select avi site member belonging to this gslb. | |
controller: ${9:} # not required. IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). | |
dns_configs: ${10:undefined} # not required. Sub domain configuration for the gslb.,Gslb service's fqdn must be a match one of these subdomains. | |
api_context: ${11:undefined} # not required. Avi API context that includes current session ID and CSRF Token.,This allows user to perform single login and re-use the session. | |
password: ${12:} # not required. Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). | |
avi_api_update_method: ${13|put,patch|} # not required. choices: put;patch. Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH. | |
uuid: ${14:undefined} # not required. Uuid of the gslb object. | |
url: ${15:undefined} # not required. Avi controller URL of the object. | |
avi_credentials: ${16:undefined} # not required. Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
tenant_ref: ${17:undefined} # not required. It is a reference to an object of type tenant. | |
is_federated: ${18:undefined} # not required. This field indicates that this object is replicated across gslb federation.,Field introduced in 17.1.3.,Default value when not specified in API or module is interpreted by Avi Controller as True. | |
clear_on_max_retries: ${19:undefined} # not required. Max retries after which the remote site is treated as a fresh start.,In fresh start all the configs are downloaded.,Allowed values are 1-1024.,Default value when not specified in API or module is interpreted by Avi Controller as 20. | |
avi_api_patch_op: ${20|add,replace,delete|} # not required. choices: add;replace;delete. Patch operation to use when using avi_api_update_method as patch. | |
send_interval: ${21:undefined} # not required. Frequency with which group members communicate.,Allowed values are 1-3600.,Default value when not specified in API or module is interpreted by Avi Controller as 15.,Units(SEC). | |
tenant: ${22:admin} # not required. Name of tenant used for all Avi API calls and context of object. | |
client_ip_addr_group: ${23:undefined} # not required. Group to specify if the client ip addresses are public or private.,Field introduced in 17.1.2. | |
view_id: ${24:undefined} # not required. The view-id is used in change-leader mode to differentiate partitioned groups while they have the same gslb namespace.,Each partitioned group will be able to operate independently by using the view-id.,Default value when not specified in API or module is interpreted by Avi Controller as 0. | |
api_version: ${25:16.4.4} # not required. Avi API version of to use for Avi API and objects. | |
tenant_uuid: ${26:} # not required. UUID of tenant used for all Avi API calls and context of object. | |
""" | |
'avi_gslbapplicationpersistenceprofile': | |
'prefix': "avi_gslbapplicationpersistenceprofile_snippet" | |
'description': "Module for setup of GslbApplicationPersistenceProfile Avi RESTful Object" | |
'body': """ | |
avi_gslbapplicationpersistenceprofile: | |
name: ${1:undefined} # required. A user-friendly name for the persistence profile.,Field introduced in 17.1.1. | |
username: ${2:} # not required. Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). | |
description: ${3:undefined} # not required. Field introduced in 17.1.1. | |
controller: ${4:} # not required. IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). | |
api_context: ${5:undefined} # not required. Avi API context that includes current session ID and CSRF Token.,This allows user to perform single login and re-use the session. | |
password: ${6:} # not required. Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). | |
tenant: ${7:admin} # not required. Name of tenant used for all Avi API calls and context of object. | |
uuid: ${8:undefined} # not required. Uuid of the persistence profile.,Field introduced in 17.1.1. | |
url: ${9:undefined} # not required. Avi controller URL of the object. | |
tenant_ref: ${10:undefined} # not required. It is a reference to an object of type tenant.,Field introduced in 17.1.1. | |
avi_credentials: ${11:undefined} # not required. Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
state: ${12|absent,present|} # not required. choices: absent;present. The state that should be applied on the entity. | |
tenant_uuid: ${13:} # not required. UUID of tenant used for all Avi API calls and context of object. | |
api_version: ${14:16.4.4} # not required. Avi API version of to use for Avi API and objects. | |
""" | |
'avi_gslbgeodbprofile': | |
'prefix': "avi_gslbgeodbprofile_snippet" | |
'description': "Module for setup of GslbGeoDbProfile Avi RESTful Object" | |
'body': """ | |
avi_gslbgeodbprofile: | |
name: ${1:undefined} # required. A user-friendly name for the geodb profile.,Field introduced in 17.1.1. | |
username: ${2:} # not required. Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). | |
api_version: ${3:16.4.4} # not required. Avi API version of to use for Avi API and objects. | |
uuid: ${4:undefined} # not required. Uuid of the geodb profile.,Field introduced in 17.1.1. | |
state: ${5|absent,present|} # not required. choices: absent;present. The state that should be applied on the entity. | |
url: ${6:undefined} # not required. Avi controller URL of the object. | |
avi_credentials: ${7:undefined} # not required. Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
tenant_ref: ${8:undefined} # not required. It is a reference to an object of type tenant.,Field introduced in 17.1.1. | |
is_federated: ${9:undefined} # not required. This field indicates that this object is replicated across gslb federation.,Field introduced in 17.1.3.,Default value when not specified in API or module is interpreted by Avi Controller as True. | |
api_context: ${10:undefined} # not required. Avi API context that includes current session ID and CSRF Token.,This allows user to perform single login and re-use the session. | |
avi_api_patch_op: ${11|add,replace,delete|} # not required. choices: add;replace;delete. Patch operation to use when using avi_api_update_method as patch. | |
tenant: ${12:admin} # not required. Name of tenant used for all Avi API calls and context of object. | |
entries: ${13:undefined} # not required. List of geodb entries.,An entry can either be a geodb file or an ip address group with geo properties.,Field introduced in 17.1.1. | |
password: ${14:} # not required. Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). | |
tenant_uuid: ${15:} # not required. UUID of tenant used for all Avi API calls and context of object. | |
controller: ${16:} # not required. IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). | |
avi_api_update_method: ${17|put,patch|} # not required. choices: put;patch. Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH. | |
description: ${18:undefined} # not required. Field introduced in 17.1.1. | |
""" | |
'avi_gslbhealthmonitor': | |
'prefix': "avi_gslbhealthmonitor_snippet" | |
'description': "Module for setup of GslbHealthMonitor Avi RESTful Object" | |
'body': """ | |
avi_gslbhealthmonitor: | |
name: ${1:undefined} # required. A user friendly name for this health monitor. | |
type: ${2:undefined} # required. Type of the health monitor.,Enum options - HEALTH_MONITOR_PING, HEALTH_MONITOR_TCP, HEALTH_MONITOR_HTTP, HEALTH_MONITOR_HTTPS, HEALTH_MONITOR_EXTERNAL, HEALTH_MONITOR_UDP,,HEALTH_MONITOR_DNS, HEALTH_MONITOR_GSLB. | |
username: ${3:} # not required. Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). | |
https_monitor: ${4:undefined} # not required. Healthmonitorhttp settings for gslbhealthmonitor. | |
receive_timeout: ${5:undefined} # not required. A valid response from the server is expected within the receive timeout window.,This timeout must be less than the send interval.,If server status is regularly flapping up and down, consider increasing this value.,Allowed values are 1-300.,Default value when not specified in API or module is interpreted by Avi Controller as 4. | |
description: ${6:undefined} # not required. User defined description for the object. | |
api_context: ${7:undefined} # not required. Avi API context that includes current session ID and CSRF Token.,This allows user to perform single login and re-use the session. | |
controller: ${8:} # not required. IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). | |
udp_monitor: ${9:undefined} # not required. Healthmonitorudp settings for gslbhealthmonitor. | |
http_monitor: ${10:undefined} # not required. Healthmonitorhttp settings for gslbhealthmonitor. | |
password: ${11:} # not required. Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). | |
tenant: ${12:admin} # not required. Name of tenant used for all Avi API calls and context of object. | |
successful_checks: ${13:undefined} # not required. Number of continuous successful health checks before server is marked up.,Allowed values are 1-50.,Default value when not specified in API or module is interpreted by Avi Controller as 2. | |
monitor_port: ${14:undefined} # not required. Use this port instead of the port defined for the server in the pool.,If the monitor succeeds to this port, the load balanced traffic will still be sent to the port of the server defined within the pool.,Allowed values are 1-65535.,Special values are 0 - 'use server port'. | |
uuid: ${15:undefined} # not required. Uuid of the health monitor. | |
url: ${16:undefined} # not required. Avi controller URL of the object. | |
dns_monitor: ${17:undefined} # not required. Healthmonitordns settings for gslbhealthmonitor. | |
tenant_ref: ${18:undefined} # not required. It is a reference to an object of type tenant. | |
avi_credentials: ${19:undefined} # not required. Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
failed_checks: ${20:undefined} # not required. Number of continuous failed health checks before the server is marked down.,Allowed values are 1-50.,Default value when not specified in API or module is interpreted by Avi Controller as 2. | |
tcp_monitor: ${21:undefined} # not required. Healthmonitortcp settings for gslbhealthmonitor. | |
state: ${22|absent,present|} # not required. choices: absent;present. The state that should be applied on the entity. | |
send_interval: ${23:undefined} # not required. Frequency, in seconds, that monitors are sent to a server.,Allowed values are 1-3600.,Default value when not specified in API or module is interpreted by Avi Controller as 5. | |
external_monitor: ${24:undefined} # not required. Healthmonitorexternal settings for gslbhealthmonitor. | |
tenant_uuid: ${25:} # not required. UUID of tenant used for all Avi API calls and context of object. | |
api_version: ${26:16.4.4} # not required. Avi API version of to use for Avi API and objects. | |
""" | |
'avi_gslbservice': | |
'prefix': "avi_gslbservice_snippet" | |
'description': "Module for setup of GslbService Avi RESTful Object" | |
'body': """ | |
avi_gslbservice: | |
name: ${1:undefined} # required. Name for the gslb service. | |
username: ${2:} # not required. Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). | |
application_persistence_profile_ref: ${3:undefined} # not required. The federated application persistence associated with gslbservice site persistence functionality.,It is a reference to an object of type applicationpersistenceprofile.,Field introduced in 17.2.1. | |
avi_credentials: ${4:undefined} # not required. Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
description: ${5:undefined} # not required. User defined description for the object. | |
wildcard_match: ${6:undefined} # not required. Enable wild-card match of fqdn if an exact match is not found in the dns table, the longest match is chosen by wild-carding the fqdn in the dns,request.,Default is false.,Field introduced in 17.1.1.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
enabled: ${7:undefined} # not required. Enable or disable the gslb service.,If the gslb service is enabled, then the vips are sent in the dns responses based on reachability and configured algorithm.,If the gslb service is disabled, then the vips are no longer available in the dns response.,Default value when not specified in API or module is interpreted by Avi Controller as True. | |
api_context: ${8:undefined} # not required. Avi API context that includes current session ID and CSRF Token.,This allows user to perform single login and re-use the session. | |
controller: ${9:} # not required. IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). | |
domain_names: ${10:undefined} # not required. Fully qualified domain name of the gslb service. | |
is_federated: ${11:undefined} # not required. This field indicates that this object is replicated across gslb federation.,Field introduced in 17.1.3.,Default value when not specified in API or module is interpreted by Avi Controller as True. | |
use_edns_client_subnet: ${12:undefined} # not required. Use the client ip subnet from the edns option as source ipaddress for client geo-location and consistent hash algorithm.,Default is true.,Field introduced in 17.1.1.,Default value when not specified in API or module is interpreted by Avi Controller as True. | |
groups: ${13:undefined} # not required. Select list of pools belonging to this gslb service. | |
ttl: ${14:undefined} # not required. Ttl value (in seconds) for records served for this gslb service by the dns service.,Allowed values are 1-86400.,Units(SEC). | |
password: ${15:} # not required. Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). | |
health_monitor_scope: ${16:undefined} # not required. Health monitor probe can be executed for all the members or it can be executed only for third-party members.,This operational mode is useful to reduce the number of health monitor probes in case of a hybrid scenario.,In such a case, avi members can have controller derived status while non-avi members can be probed by via health monitor probes in dataplane.,Enum options - GSLB_SERVICE_HEALTH_MONITOR_ALL_MEMBERS, GSLB_SERVICE_HEALTH_MONITOR_ONLY_NON_AVI_MEMBERS.,Default value when not specified in API or module is interpreted by Avi Controller as GSLB_SERVICE_HEALTH_MONITOR_ALL_MEMBERS. | |
avi_api_update_method: ${17|put,patch|} # not required. choices: put;patch. Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH. | |
controller_health_status_enabled: ${18:undefined} # not required. Gs member's overall health status is derived based on a combination of controller and datapath health-status inputs.,Note that the datapath status is determined by the association of health monitor profiles.,Only the controller provided status is determined through this configuration.,Default value when not specified in API or module is interpreted by Avi Controller as True. | |
uuid: ${19:undefined} # not required. Uuid of the gslb service. | |
url: ${20:undefined} # not required. Avi controller URL of the object. | |
down_response: ${21:undefined} # not required. Response to the client query when the gslb service is down. | |
tenant_ref: ${22:undefined} # not required. It is a reference to an object of type tenant. | |
avi_api_patch_op: ${23|add,replace,delete|} # not required. choices: add;replace;delete. Patch operation to use when using avi_api_update_method as patch. | |
created_by: ${24:undefined} # not required. Creator name.,Field introduced in 17.1.2. | |
api_version: ${25:16.4.4} # not required. Avi API version of to use for Avi API and objects. | |
health_monitor_refs: ${26:undefined} # not required. Verify vs health by applying one or more health monitors.,Active monitors generate synthetic traffic from dns service engine and to mark a vs up or down based on the response.,It is a reference to an object of type healthmonitor. | |
state: ${27|absent,present|} # not required. choices: absent;present. The state that should be applied on the entity. | |
tenant: ${28:admin} # not required. Name of tenant used for all Avi API calls and context of object. | |
site_persistence_enabled: ${29:undefined} # not required. Enable site-persistence for the gslbservice.,Field introduced in 17.2.1.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
min_members: ${30:undefined} # not required. The minimum number of members to distribute traffic to.,Allowed values are 1-65535.,Special values are 0 - 'disable'.,Field introduced in 17.2.4.,Default value when not specified in API or module is interpreted by Avi Controller as 0. | |
tenant_uuid: ${31:} # not required. UUID of tenant used for all Avi API calls and context of object. | |
pool_algorithm: ${32:undefined} # not required. The load balancing algorithm will pick a gslb pool within the gslb service list of available pools.,Enum options - GSLB_SERVICE_ALGORITHM_PRIORITY, GSLB_SERVICE_ALGORITHM_GEO.,Field introduced in 17.2.3.,Default value when not specified in API or module is interpreted by Avi Controller as GSLB_SERVICE_ALGORITHM_PRIORITY. | |
num_dns_ip: ${33:undefined} # not required. Number of ip addresses of this gslb service to be returned by the dns service.,Enter 0 to return all ip addresses.,Allowed values are 1-20.,Special values are 0- 'return all ip addresses'. | |
""" | |
'avi_gslbservice_patch_member': | |
'prefix': "avi_gslbservice_patch_member_snippet" | |
'description': "Avi API Module" | |
'body': """ | |
avi_gslbservice_patch_member: | |
name: ${1:undefined} # required. Name of the GSLB Service | |
username: ${2:} # not required. Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). | |
avi_credentials: ${3:undefined} # not required. Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
controller: ${4:} # not required. IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). | |
state: ${5|absent,present|} # not required. choices: absent;present. The state that should be applied to the member. Member is,identified using field member.ip.addr. | |
params: ${6:undefined} # not required. Query parameters passed to the HTTP API. | |
api_version: ${7:16.4.4} # not required. Avi API version of to use for Avi API and objects. | |
api_context: ${8:undefined} # not required. Avi API context that includes current session ID and CSRF Token.,This allows user to perform single login and re-use the session. | |
password: ${9:} # not required. Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). | |
data: ${10:undefined} # not required. HTTP body of GSLB Service Member in YAML or JSON format. | |
tenant_uuid: ${11:} # not required. UUID of tenant used for all Avi API calls and context of object. | |
tenant: ${12:admin} # not required. Name of tenant used for all Avi API calls and context of object. | |
""" | |
'avi_hardwaresecuritymodulegroup': | |
'prefix': "avi_hardwaresecuritymodulegroup_snippet" | |
'description': "Module for setup of HardwareSecurityModuleGroup Avi RESTful Object" | |
'body': """ | |
avi_hardwaresecuritymodulegroup: | |
name: ${1:undefined} # required. Name of the hsm group configuration object. | |
hsm: ${2:undefined} # required. Hardware security module configuration. | |
username: ${3:} # not required. Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). | |
api_version: ${4:16.4.4} # not required. Avi API version of to use for Avi API and objects. | |
tenant_uuid: ${5:} # not required. UUID of tenant used for all Avi API calls and context of object. | |
url: ${6:undefined} # not required. Avi controller URL of the object. | |
avi_credentials: ${7:undefined} # not required. Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
tenant_ref: ${8:undefined} # not required. It is a reference to an object of type tenant. | |
state: ${9|absent,present|} # not required. choices: absent;present. The state that should be applied on the entity. | |
avi_api_patch_op: ${10|add,replace,delete|} # not required. choices: add;replace;delete. Patch operation to use when using avi_api_update_method as patch. | |
tenant: ${11:admin} # not required. Name of tenant used for all Avi API calls and context of object. | |
api_context: ${12:undefined} # not required. Avi API context that includes current session ID and CSRF Token.,This allows user to perform single login and re-use the session. | |
password: ${13:} # not required. Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). | |
controller: ${14:} # not required. IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). | |
avi_api_update_method: ${15|put,patch|} # not required. choices: put;patch. Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH. | |
uuid: ${16:undefined} # not required. Uuid of the hsm group configuration object. | |
""" | |
'avi_healthmonitor': | |
'prefix': "avi_healthmonitor_snippet" | |
'description': "Module for setup of HealthMonitor Avi RESTful Object" | |
'body': """ | |
avi_healthmonitor: | |
name: ${1:undefined} # required. A user friendly name for this health monitor. | |
type: ${2:undefined} # required. Type of the health monitor.,Enum options - HEALTH_MONITOR_PING, HEALTH_MONITOR_TCP, HEALTH_MONITOR_HTTP, HEALTH_MONITOR_HTTPS, HEALTH_MONITOR_EXTERNAL, HEALTH_MONITOR_UDP,,HEALTH_MONITOR_DNS, HEALTH_MONITOR_GSLB. | |
username: ${3:} # not required. Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). | |
https_monitor: ${4:undefined} # not required. Healthmonitorhttp settings for healthmonitor. | |
receive_timeout: ${5:undefined} # not required. A valid response from the server is expected within the receive timeout window.,This timeout must be less than the send interval.,If server status is regularly flapping up and down, consider increasing this value.,Allowed values are 1-2400.,Default value when not specified in API or module is interpreted by Avi Controller as 4.,Units(SEC). | |
description: ${6:undefined} # not required. User defined description for the object. | |
state: ${7|absent,present|} # not required. choices: absent;present. The state that should be applied on the entity. | |
api_context: ${8:undefined} # not required. Avi API context that includes current session ID and CSRF Token.,This allows user to perform single login and re-use the session. | |
controller: ${9:} # not required. IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). | |
udp_monitor: ${10:undefined} # not required. Healthmonitorudp settings for healthmonitor. | |
http_monitor: ${11:undefined} # not required. Healthmonitorhttp settings for healthmonitor. | |
password: ${12:} # not required. Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). | |
avi_api_update_method: ${13|put,patch|} # not required. choices: put;patch. Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH. | |
successful_checks: ${14:undefined} # not required. Number of continuous successful health checks before server is marked up.,Allowed values are 1-50.,Default value when not specified in API or module is interpreted by Avi Controller as 2. | |
monitor_port: ${15:undefined} # not required. Use this port instead of the port defined for the server in the pool.,If the monitor succeeds to this port, the load balanced traffic will still be sent to the port of the server defined within the pool.,Allowed values are 1-65535.,Special values are 0 - 'use server port'. | |
uuid: ${16:undefined} # not required. Uuid of the health monitor. | |
url: ${17:undefined} # not required. Avi controller URL of the object. | |
dns_monitor: ${18:undefined} # not required. Healthmonitordns settings for healthmonitor. | |
avi_credentials: ${19:undefined} # not required. Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
tenant_ref: ${20:undefined} # not required. It is a reference to an object of type tenant. | |
is_federated: ${21:undefined} # not required. This field describes the object's replication scope.,If the field is set to false, then the object is visible within the controller-cluster and its associated service-engines.,If the field is set to true, then the object is replicated across the federation.,Field introduced in 17.1.3.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
failed_checks: ${22:undefined} # not required. Number of continuous failed health checks before the server is marked down.,Allowed values are 1-50.,Default value when not specified in API or module is interpreted by Avi Controller as 2. | |
tcp_monitor: ${23:undefined} # not required. Healthmonitortcp settings for healthmonitor. | |
avi_api_patch_op: ${24|add,replace,delete|} # not required. choices: add;replace;delete. Patch operation to use when using avi_api_update_method as patch. | |
send_interval: ${25:undefined} # not required. Frequency, in seconds, that monitors are sent to a server.,Allowed values are 1-3600.,Default value when not specified in API or module is interpreted by Avi Controller as 10.,Units(SEC). | |
tenant: ${26:admin} # not required. Name of tenant used for all Avi API calls and context of object. | |
external_monitor: ${27:undefined} # not required. Healthmonitorexternal settings for healthmonitor. | |
tenant_uuid: ${28:} # not required. UUID of tenant used for all Avi API calls and context of object. | |
api_version: ${29:16.4.4} # not required. Avi API version of to use for Avi API and objects. | |
""" | |
'avi_httppolicyset': | |
'prefix': "avi_httppolicyset_snippet" | |
'description': "Module for setup of HTTPPolicySet Avi RESTful Object" | |
'body': """ | |
avi_httppolicyset: | |
name: ${1:undefined} # required. Name of the http policy set. | |
http_security_policy: ${2:undefined} # not required. Http security policy for the virtual service. | |
uuid: ${3:undefined} # not required. Uuid of the http policy set. | |
state: ${4|absent,present|} # not required. choices: absent;present. The state that should be applied on the entity. | |
created_by: ${5:undefined} # not required. Creator name. | |
avi_api_patch_op: ${6|add,replace,delete|} # not required. choices: add;replace;delete. Patch operation to use when using avi_api_update_method as patch. | |
avi_credentials: ${7:undefined} # not required. Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
avi_api_update_method: ${8|put,patch|} # not required. choices: put;patch. Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH. | |
http_request_policy: ${9:undefined} # not required. Http request policy for the virtual service. | |
api_version: ${10:16.4.4} # not required. Avi API version of to use for Avi API and objects. | |
username: ${11:} # not required. Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). | |
description: ${12:undefined} # not required. User defined description for the object. | |
controller: ${13:} # not required. IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). | |
api_context: ${14:undefined} # not required. Avi API context that includes current session ID and CSRF Token.,This allows user to perform single login and re-use the session. | |
password: ${15:} # not required. Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). | |
tenant: ${16:admin} # not required. Name of tenant used for all Avi API calls and context of object. | |
url: ${17:undefined} # not required. Avi controller URL of the object. | |
tenant_ref: ${18:undefined} # not required. It is a reference to an object of type tenant. | |
cloud_config_cksum: ${19:undefined} # not required. Checksum of cloud configuration for pool.,Internally set by cloud connector. | |
http_response_policy: ${20:undefined} # not required. Http response policy for the virtual service. | |
tenant_uuid: ${21:} # not required. UUID of tenant used for all Avi API calls and context of object. | |
is_internal_policy: ${22:undefined} # not required. Boolean flag to set is_internal_policy.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
""" | |
'avi_ipaddrgroup': | |
'prefix': "avi_ipaddrgroup_snippet" | |
'description': "Module for setup of IpAddrGroup Avi RESTful Object" | |
'body': """ | |
avi_ipaddrgroup: | |
name: ${1:undefined} # required. Name of the ip address group. | |
username: ${2:} # not required. Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). | |
description: ${3:undefined} # not required. User defined description for the object. | |
marathon_service_port: ${4:undefined} # not required. Task port associated with marathon service port.,If marathon app has multiple service ports, this is required.,Else, the first task port is used. | |
ranges: ${5:undefined} # not required. Configure ip address range(s). | |
controller: ${6:} # not required. IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). | |
addrs: ${7:undefined} # not required. Configure ip address(es). | |
api_context: ${8:undefined} # not required. Avi API context that includes current session ID and CSRF Token.,This allows user to perform single login and re-use the session. | |
password: ${9:} # not required. Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). | |
avi_api_update_method: ${10|put,patch|} # not required. choices: put;patch. Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH. | |
uuid: ${11:undefined} # not required. Uuid of the ip address group. | |
country_codes: ${12:undefined} # not required. Populate the ip address ranges from the geo database for this country. | |
api_version: ${13:16.4.4} # not required. Avi API version of to use for Avi API and objects. | |
url: ${14:undefined} # not required. Avi controller URL of the object. | |
avi_credentials: ${15:undefined} # not required. Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
tenant_ref: ${16:undefined} # not required. It is a reference to an object of type tenant. | |
state: ${17|absent,present|} # not required. choices: absent;present. The state that should be applied on the entity. | |
apic_epg_name: ${18:undefined} # not required. Populate ip addresses from members of this cisco apic epg. | |
prefixes: ${19:undefined} # not required. Configure ip address prefix(es). | |
avi_api_patch_op: ${20|add,replace,delete|} # not required. choices: add;replace;delete. Patch operation to use when using avi_api_update_method as patch. | |
tenant: ${21:admin} # not required. Name of tenant used for all Avi API calls and context of object. | |
marathon_app_name: ${22:undefined} # not required. Populate ip addresses from tasks of this marathon app. | |
ip_ports: ${23:undefined} # not required. Configure (ip address, port) tuple(s). | |
tenant_uuid: ${24:} # not required. UUID of tenant used for all Avi API calls and context of object. | |
""" | |
'avi_ipamdnsproviderprofile': | |
'prefix': "avi_ipamdnsproviderprofile_snippet" | |
'description': "Module for setup of IpamDnsProviderProfile Avi RESTful Object" | |
'body': """ | |
avi_ipamdnsproviderprofile: | |
name: ${1:undefined} # required. Name for the ipam/dns provider profile. | |
type: ${2:undefined} # required. Provider type for the ipam/dns provider profile.,Enum options - IPAMDNS_TYPE_INFOBLOX, IPAMDNS_TYPE_AWS, IPAMDNS_TYPE_OPENSTACK, IPAMDNS_TYPE_GCP, IPAMDNS_TYPE_INFOBLOX_DNS, IPAMDNS_TYPE_CUSTOM,,IPAMDNS_TYPE_CUSTOM_DNS, IPAMDNS_TYPE_AZURE, IPAMDNS_TYPE_INTERNAL, IPAMDNS_TYPE_INTERNAL_DNS, IPAMDNS_TYPE_AWS_DNS, IPAMDNS_TYPE_AZURE_DNS. | |
username: ${3:} # not required. Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). | |
state: ${4|absent,present|} # not required. choices: absent;present. The state that should be applied on the entity. | |
proxy_configuration: ${5:undefined} # not required. Field introduced in 17.1.1. | |
infoblox_profile: ${6:undefined} # not required. Provider details if type is infoblox. | |
controller: ${7:} # not required. IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). | |
allocate_ip_in_vrf: ${8:undefined} # not required. If this flag is set, only allocate ip from networks in the virtual service vrf.,Applicable for avi vantage ipam only.,Field introduced in 17.2.4.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
internal_profile: ${9:undefined} # not required. Provider details if type is avi. | |
aws_profile: ${10:undefined} # not required. Provider details if type is aws. | |
api_context: ${11:undefined} # not required. Avi API context that includes current session ID and CSRF Token.,This allows user to perform single login and re-use the session. | |
password: ${12:} # not required. Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). | |
avi_api_update_method: ${13|put,patch|} # not required. choices: put;patch. Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH. | |
uuid: ${14:undefined} # not required. Uuid of the ipam/dns provider profile. | |
azure_profile: ${15:undefined} # not required. Provider details if type is microsoft azure.,Field introduced in 17.2.1. | |
openstack_profile: ${16:undefined} # not required. Provider details if type is openstack. | |
gcp_profile: ${17:undefined} # not required. Provider details if type is google cloud. | |
url: ${18:undefined} # not required. Avi controller URL of the object. | |
avi_credentials: ${19:undefined} # not required. Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
tenant_ref: ${20:undefined} # not required. It is a reference to an object of type tenant. | |
custom_profile: ${21:undefined} # not required. Provider details if type is custom.,Field introduced in 17.1.1. | |
avi_api_patch_op: ${22|add,replace,delete|} # not required. choices: add;replace;delete. Patch operation to use when using avi_api_update_method as patch. | |
tenant: ${23:admin} # not required. Name of tenant used for all Avi API calls and context of object. | |
tenant_uuid: ${24:} # not required. UUID of tenant used for all Avi API calls and context of object. | |
api_version: ${25:16.4.4} # not required. Avi API version of to use for Avi API and objects. | |
""" | |
'avi_microservicegroup': | |
'prefix': "avi_microservicegroup_snippet" | |
'description': "Module for setup of MicroServiceGroup Avi RESTful Object" | |
'body': """ | |
avi_microservicegroup: | |
name: ${1:undefined} # required. Name of the microservice group. | |
username: ${2:} # not required. Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). | |
api_version: ${3:16.4.4} # not required. Avi API version of to use for Avi API and objects. | |
uuid: ${4:undefined} # not required. Uuid of the microservice group. | |
url: ${5:undefined} # not required. Avi controller URL of the object. | |
description: ${6:undefined} # not required. User defined description for the object. | |
avi_credentials: ${7:undefined} # not required. Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
tenant_ref: ${8:undefined} # not required. It is a reference to an object of type tenant. | |
state: ${9|absent,present|} # not required. choices: absent;present. The state that should be applied on the entity. | |
created_by: ${10:undefined} # not required. Creator name. | |
tenant_uuid: ${11:} # not required. UUID of tenant used for all Avi API calls and context of object. | |
avi_api_patch_op: ${12|add,replace,delete|} # not required. choices: add;replace;delete. Patch operation to use when using avi_api_update_method as patch. | |
tenant: ${13:admin} # not required. Name of tenant used for all Avi API calls and context of object. | |
service_refs: ${14:undefined} # not required. Configure microservice(es).,It is a reference to an object of type microservice. | |
api_context: ${15:undefined} # not required. Avi API context that includes current session ID and CSRF Token.,This allows user to perform single login and re-use the session. | |
password: ${16:} # not required. Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). | |
controller: ${17:} # not required. IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). | |
avi_api_update_method: ${18|put,patch|} # not required. choices: put;patch. Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH. | |
""" | |
'avi_network': | |
'prefix': "avi_network_snippet" | |
'description': "Module for setup of Network Avi RESTful Object" | |
'body': """ | |
avi_network: | |
name: ${1:undefined} # required. Name of the object. | |
dhcp_enabled: ${2:undefined} # not required. Select the ip address management scheme for this network.,Default value when not specified in API or module is interpreted by Avi Controller as True. | |
vcenter_dvs: ${3:undefined} # not required. Boolean flag to set vcenter_dvs.,Default value when not specified in API or module is interpreted by Avi Controller as True. | |
configured_subnets: ${4:undefined} # not required. List of subnet. | |
vrf_context_ref: ${5:undefined} # not required. It is a reference to an object of type vrfcontext. | |
uuid: ${6:undefined} # not required. Unique object identifier of the object. | |
cloud_ref: ${7:undefined} # not required. It is a reference to an object of type cloud. | |
state: ${8|absent,present|} # not required. choices: absent;present. The state that should be applied on the entity. | |
avi_api_patch_op: ${9|add,replace,delete|} # not required. choices: add;replace;delete. Patch operation to use when using avi_api_update_method as patch. | |
avi_credentials: ${10:undefined} # not required. Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
tenant: ${11:admin} # not required. Name of tenant used for all Avi API calls and context of object. | |
api_version: ${12:16.4.4} # not required. Avi API version of to use for Avi API and objects. | |
username: ${13:} # not required. Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). | |
exclude_discovered_subnets: ${14:undefined} # not required. When selected, excludes all discovered subnets in this network from consideration for virtual service placement.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
controller: ${15:} # not required. IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). | |
api_context: ${16:undefined} # not required. Avi API context that includes current session ID and CSRF Token.,This allows user to perform single login and re-use the session. | |
password: ${17:} # not required. Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). | |
avi_api_update_method: ${18|put,patch|} # not required. choices: put;patch. Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH. | |
url: ${19:undefined} # not required. Avi controller URL of the object. | |
tenant_ref: ${20:undefined} # not required. It is a reference to an object of type tenant. | |
synced_from_se: ${21:undefined} # not required. Boolean flag to set synced_from_se.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
vimgrnw_ref: ${22:undefined} # not required. It is a reference to an object of type vimgrnwruntime. | |
tenant_uuid: ${23:} # not required. UUID of tenant used for all Avi API calls and context of object. | |
""" | |
'avi_networkprofile': | |
'prefix': "avi_networkprofile_snippet" | |
'description': "Module for setup of NetworkProfile Avi RESTful Object" | |
'body': """ | |
avi_networkprofile: | |
profile: ${1:undefined} # required. Networkprofileunion settings for networkprofile. | |
name: ${2:undefined} # required. The name of the network profile. | |
username: ${3:} # not required. Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). | |
api_version: ${4:16.4.4} # not required. Avi API version of to use for Avi API and objects. | |
uuid: ${5:undefined} # not required. Uuid of the network profile. | |
url: ${6:undefined} # not required. Avi controller URL of the object. | |
description: ${7:undefined} # not required. User defined description for the object. | |
avi_credentials: ${8:undefined} # not required. Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
tenant_ref: ${9:undefined} # not required. It is a reference to an object of type tenant. | |
state: ${10|absent,present|} # not required. choices: absent;present. The state that should be applied on the entity. | |
tenant_uuid: ${11:} # not required. UUID of tenant used for all Avi API calls and context of object. | |
avi_api_patch_op: ${12|add,replace,delete|} # not required. choices: add;replace;delete. Patch operation to use when using avi_api_update_method as patch. | |
tenant: ${13:admin} # not required. Name of tenant used for all Avi API calls and context of object. | |
api_context: ${14:undefined} # not required. Avi API context that includes current session ID and CSRF Token.,This allows user to perform single login and re-use the session. | |
password: ${15:} # not required. Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). | |
controller: ${16:} # not required. IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). | |
avi_api_update_method: ${17|put,patch|} # not required. choices: put;patch. Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH. | |
""" | |
'avi_networksecuritypolicy': | |
'prefix': "avi_networksecuritypolicy_snippet" | |
'description': "Module for setup of NetworkSecurityPolicy Avi RESTful Object" | |
'body': """ | |
avi_networksecuritypolicy: | |
username: ${1:} # not required. Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). | |
api_version: ${2:16.4.4} # not required. Avi API version of to use for Avi API and objects. | |
uuid: ${3:undefined} # not required. Unique object identifier of the object. | |
tenant_uuid: ${4:} # not required. UUID of tenant used for all Avi API calls and context of object. | |
rules: ${5:undefined} # not required. List of networksecurityrule. | |
avi_credentials: ${6:undefined} # not required. Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
tenant_ref: ${7:undefined} # not required. It is a reference to an object of type tenant. | |
state: ${8|absent,present|} # not required. choices: absent;present. The state that should be applied on the entity. | |
created_by: ${9:undefined} # not required. Creator name. | |
name: ${10:undefined} # not required. Name of the object. | |
url: ${11:undefined} # not required. Avi controller URL of the object. | |
avi_api_patch_op: ${12|add,replace,delete|} # not required. choices: add;replace;delete. Patch operation to use when using avi_api_update_method as patch. | |
cloud_config_cksum: ${13:undefined} # not required. Checksum of cloud configuration for network sec policy.,Internally set by cloud connector. | |
tenant: ${14:admin} # not required. Name of tenant used for all Avi API calls and context of object. | |
api_context: ${15:undefined} # not required. Avi API context that includes current session ID and CSRF Token.,This allows user to perform single login and re-use the session. | |
password: ${16:} # not required. Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). | |
controller: ${17:} # not required. IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). | |
avi_api_update_method: ${18|put,patch|} # not required. choices: put;patch. Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH. | |
description: ${19:undefined} # not required. User defined description for the object. | |
""" | |
'avi_pkiprofile': | |
'prefix': "avi_pkiprofile_snippet" | |
'description': "Module for setup of PKIProfile Avi RESTful Object" | |
'body': """ | |
avi_pkiprofile: | |
name: ${1:undefined} # required. Name of the pki profile. | |
username: ${2:} # not required. Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). | |
uuid: ${3:undefined} # not required. Unique object identifier of the object. | |
avi_credentials: ${4:undefined} # not required. Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
created_by: ${5:undefined} # not required. Creator name. | |
avi_api_patch_op: ${6|add,replace,delete|} # not required. choices: add;replace;delete. Patch operation to use when using avi_api_update_method as patch. | |
state: ${7|absent,present|} # not required. choices: absent;present. The state that should be applied on the entity. | |
avi_api_update_method: ${8|put,patch|} # not required. choices: put;patch. Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH. | |
validate_only_leaf_crl: ${9:undefined} # not required. When enabled, avi will only validate the revocation status of the leaf certificate using crl.,To enable validation for the entire chain, disable this option and provide all the relevant crls.,Default value when not specified in API or module is interpreted by Avi Controller as True. | |
api_version: ${10:16.4.4} # not required. Avi API version of to use for Avi API and objects. | |
crls: ${11:undefined} # not required. Certificate revocation lists. | |
ignore_peer_chain: ${12:undefined} # not required. When enabled, avi will not trust intermediate and root certs presented by a client.,Instead, only the chain certs configured in the certificate authority section will be used to verify trust of the client's cert.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
controller: ${13:} # not required. IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). | |
api_context: ${14:undefined} # not required. Avi API context that includes current session ID and CSRF Token.,This allows user to perform single login and re-use the session. | |
password: ${15:} # not required. Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). | |
tenant: ${16:admin} # not required. Name of tenant used for all Avi API calls and context of object. | |
url: ${17:undefined} # not required. Avi controller URL of the object. | |
tenant_ref: ${18:undefined} # not required. It is a reference to an object of type tenant. | |
is_federated: ${19:undefined} # not required. This field describes the object's replication scope.,If the field is set to false, then the object is visible within the controller-cluster and its associated service-engines.,If the field is set to true, then the object is replicated across the federation.,Field introduced in 17.1.3.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
ca_certs: ${20:undefined} # not required. List of certificate authorities (root and intermediate) trusted that is used for certificate validation. | |
crl_check: ${21:undefined} # not required. When enabled, avi will verify via crl checks that certificates in the trust chain have not been revoked.,Default value when not specified in API or module is interpreted by Avi Controller as True. | |
tenant_uuid: ${22:} # not required. UUID of tenant used for all Avi API calls and context of object. | |
""" | |
'avi_pool': | |
'prefix': "avi_pool_snippet" | |
'description': "Module for setup of Pool Avi RESTful Object" | |
'body': """ | |
avi_pool: | |
name: ${1:undefined} # required. The name of the pool. | |
lb_algorithm: ${2:undefined} # not required. The load balancing algorithm will pick a server within the pool's list of available servers.,Enum options - LB_ALGORITHM_LEAST_CONNECTIONS, LB_ALGORITHM_ROUND_ROBIN, LB_ALGORITHM_FASTEST_RESPONSE, LB_ALGORITHM_CONSISTENT_HASH,,LB_ALGORITHM_LEAST_LOAD, LB_ALGORITHM_FEWEST_SERVERS, LB_ALGORITHM_RANDOM, LB_ALGORITHM_FEWEST_TASKS, LB_ALGORITHM_NEAREST_SERVER,,LB_ALGORITHM_CORE_AFFINITY.,Default value when not specified in API or module is interpreted by Avi Controller as LB_ALGORITHM_LEAST_CONNECTIONS. | |
use_service_port: ${3:undefined} # not required. Do not translate the client's destination port when sending the connection to the server.,The pool or servers specified service port will still be used for health monitoring.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
rewrite_host_header_to_server_name: ${4:undefined} # not required. Rewrite incoming host header to server name of the server to which the request is proxied.,Enabling this feature rewrites host header for requests to all servers in the pool.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
host_check_enabled: ${5:undefined} # not required. Enable common name check for server certificate.,If enabled and no explicit domain name is specified, avi will use the incoming host header to do the match.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
enabled: ${6:undefined} # not required. Enable or disable the pool.,Disabling will terminate all open connections and pause health monitors.,Default value when not specified in API or module is interpreted by Avi Controller as True. | |
rewrite_host_header_to_sni: ${7:undefined} # not required. If sni server name is specified, rewrite incoming host header to the sni server name.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
capacity_estimation: ${8:undefined} # not required. Inline estimation of capacity of servers.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
max_conn_rate_per_server: ${9:undefined} # not required. Rate limit connections to each server. | |
servers: ${10:undefined} # not required. The pool directs load balanced traffic to this list of destination servers.,The servers can be configured by ip address, name, network or via ip address group. | |
apic_epg_name: ${11:undefined} # not required. Synchronize cisco apic epg members with pool servers. | |
fewest_tasks_feedback_delay: ${12:undefined} # not required. Periodicity of feedback for fewest tasks server selection algorithm.,Allowed values are 1-300.,Default value when not specified in API or module is interpreted by Avi Controller as 10.,Units(SEC). | |
server_auto_scale: ${13:undefined} # not required. Server autoscale.,Not used anymore.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
ipaddrgroup_ref: ${14:undefined} # not required. Use list of servers from ip address group.,It is a reference to an object of type ipaddrgroup. | |
avi_credentials: ${15:undefined} # not required. Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
capacity_estimation_ttfb_thresh: ${16:undefined} # not required. The maximum time-to-first-byte of a server.,Allowed values are 1-5000.,Special values are 0 - 'automatic'.,Default value when not specified in API or module is interpreted by Avi Controller as 0.,Units(MILLISECONDS). | |
ab_pool: ${17:undefined} # not required. A/b pool configuration. | |
fail_action: ${18:undefined} # not required. Enable an action - close connection, http redirect or local http response - when a pool failure happens.,By default, a connection will be closed, in case the pool experiences a failure. | |
lookup_server_by_name: ${19:undefined} # not required. Allow server lookup by name.,Field introduced in 17.1.11,17.2.4.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
networks: ${20:undefined} # not required. (internal-use) networks designated as containing servers for this pool.,The servers may be further narrowed down by a filter.,This field is used internally by avi, not editable by the user. | |
lb_algorithm_hash: ${21:undefined} # not required. Criteria used as a key for determining the hash between the client and server.,Enum options - LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS, LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS_AND_PORT,,LB_ALGORITHM_CONSISTENT_HASH_URI, LB_ALGORITHM_CONSISTENT_HASH_CUSTOM_HEADER, LB_ALGORITHM_CONSISTENT_HASH_CUSTOM_STRING.,Default value when not specified in API or module is interpreted by Avi Controller as LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS. | |
health_monitor_refs: ${22:undefined} # not required. Verify server health by applying one or more health monitors.,Active monitors generate synthetic traffic from each service engine and mark a server up or down based on the response.,The passive monitor listens only to client to server communication.,It raises or lowers the ratio of traffic destined to a server based on successful responses.,It is a reference to an object of type healthmonitor. | |
sni_enabled: ${23:undefined} # not required. Enable tls sni for server connections.,If disabled, avi will not send the sni extension as part of the handshake.,Default value when not specified in API or module is interpreted by Avi Controller as True. | |
server_name: ${24:undefined} # not required. Fully qualified dns hostname which will be used in the tls sni extension in server connections if sni is enabled.,If no value is specified, avi will use the incoming host header instead. | |
lb_algorithm_consistent_hash_hdr: ${25:undefined} # not required. Http header name to be used for the hash key. | |
cloud_ref: ${26:undefined} # not required. It is a reference to an object of type cloud. | |
lb_algorithm_core_nonaffinity: ${27:undefined} # not required. Degree of non-affinity for core afffinity based server selection.,Allowed values are 1-65535.,Field introduced in 17.1.3.,Default value when not specified in API or module is interpreted by Avi Controller as 2. | |
autoscale_policy_ref: ${28:undefined} # not required. Reference to server autoscale policy.,It is a reference to an object of type serverautoscalepolicy. | |
ssl_profile_ref: ${29:undefined} # not required. When enabled, avi re-encrypts traffic to the backend servers.,The specific ssl profile defines which ciphers and ssl versions will be supported.,It is a reference to an object of type sslprofile. | |
east_west: ${30:undefined} # not required. Inherited config from virtualservice. | |
placement_networks: ${31:undefined} # not required. Manually select the networks and subnets used to provide reachability to the pool's servers.,Specify the subnet using the following syntax 10-1-1-0/24.,Use static routes in vrf configuration when pool servers are not directly connected butroutable from the service engine. | |
graceful_disable_timeout: ${32:undefined} # not required. Used to gracefully disable a server.,Virtual service waits for the specified time before terminating the existing connections to the servers that are disabled.,Allowed values are 1-7200.,Special values are 0 - 'immediate', -1 - 'infinite'.,Default value when not specified in API or module is interpreted by Avi Controller as 1.,Units(MIN). | |
avi_api_patch_op: ${33|add,replace,delete|} # not required. choices: add;replace;delete. Patch operation to use when using avi_api_update_method as patch. | |
nsx_securitygroup: ${34:undefined} # not required. A list of nsx service groups where the servers for the pool are created.,Field introduced in 17.1.1. | |
tenant: ${35:admin} # not required. Name of tenant used for all Avi API calls and context of object. | |
a_pool: ${36:undefined} # not required. Name of container cloud application that constitutes a pool in a a-b pool configuration, if different from vs app. | |
pki_profile_ref: ${37:undefined} # not required. Avi will validate the ssl certificate present by a server against the selected pki profile.,It is a reference to an object of type pkiprofile. | |
api_version: ${38:16.4.4} # not required. Avi API version of to use for Avi API and objects. | |
vrf_ref: ${39:undefined} # not required. Virtual routing context that the pool is bound to.,This is used to provide the isolation of the set of networks the pool is attached to.,The pool inherits the virtual routing conext of the virtual service, and this field is used only internally, and is set by pb-transform.,It is a reference to an object of type vrfcontext. | |
username: ${40:} # not required. Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). | |
application_persistence_profile_ref: ${41:undefined} # not required. Persistence will ensure the same user sticks to the same server for a desired duration of time.,It is a reference to an object of type applicationpersistenceprofile. | |
inline_health_monitor: ${42:undefined} # not required. The passive monitor will monitor client to server connections and requests and adjust traffic load to servers based on successful responses.,This may alter the expected behavior of the lb method, such as round robin.,Default value when not specified in API or module is interpreted by Avi Controller as True. | |
default_server_port: ${43:undefined} # not required. Traffic sent to servers will use this destination server port unless overridden by the server's specific port attribute.,The ssl checkbox enables avi to server encryption.,Allowed values are 1-65535.,Default value when not specified in API or module is interpreted by Avi Controller as 80. | |
description: ${44:undefined} # not required. A description of the pool. | |
request_queue_depth: ${45:undefined} # not required. Minimum number of requests to be queued when pool is full.,Default value when not specified in API or module is interpreted by Avi Controller as 128. | |
state: ${46|absent,present|} # not required. choices: absent;present. The state that should be applied on the entity. | |
server_reselect: ${47:undefined} # not required. Server reselect configuration for http requests. | |
ab_priority: ${48:undefined} # not required. Priority of this pool in a a-b pool pair.,Internally used. | |
controller: ${49:} # not required. IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). | |
api_context: ${50:undefined} # not required. Avi API context that includes current session ID and CSRF Token.,This allows user to perform single login and re-use the session. | |
password: ${51:} # not required. Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). | |
ssl_key_and_certificate_ref: ${52:undefined} # not required. Service engines will present a client ssl certificate to the server.,It is a reference to an object of type sslkeyandcertificate. | |
avi_api_update_method: ${53|put,patch|} # not required. choices: put;patch. Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH. | |
uuid: ${54:undefined} # not required. Uuid of the pool. | |
autoscale_launch_config_ref: ${55:undefined} # not required. If configured then avi will trigger orchestration of pool server creation and deletion.,It is only supported for container clouds like mesos, opensift, kubernates, docker etc.,It is a reference to an object of type autoscalelaunchconfig. | |
request_queue_enabled: ${56:undefined} # not required. Enable request queue when pool is full.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
max_concurrent_connections_per_server: ${57:undefined} # not required. The maximum number of concurrent connections allowed to each server within the pool.,Note applied value will be no less than the number of service engines that the pool is placed on.,If set to 0, no limit is applied.,Default value when not specified in API or module is interpreted by Avi Controller as 0. | |
url: ${58:undefined} # not required. Avi controller URL of the object. | |
prst_hdr_name: ${59:undefined} # not required. Header name for custom header persistence. | |
tenant_ref: ${60:undefined} # not required. It is a reference to an object of type tenant. | |
server_count: ${61:undefined} # not required. Number of server_count.,Default value when not specified in API or module is interpreted by Avi Controller as 0. | |
autoscale_networks: ${62:undefined} # not required. Network ids for the launch configuration. | |
domain_name: ${63:undefined} # not required. Comma separated list of domain names which will be used to verify the common names or subject alternative names presented by server certificates.,It is performed only when common name check host_check_enabled is enabled. | |
connection_ramp_duration: ${64:undefined} # not required. Duration for which new connections will be gradually ramped up to a server recently brought online.,Useful for lb algorithms that are least connection based.,Allowed values are 1-300.,Special values are 0 - 'immediate'.,Default value when not specified in API or module is interpreted by Avi Controller as 10.,Units(MIN). | |
cloud_config_cksum: ${65:undefined} # not required. Checksum of cloud configuration for pool.,Internally set by cloud connector. | |
external_autoscale_groups: ${66:undefined} # not required. Names of external auto-scale groups for pool servers.,Currently available only for aws and azure.,Field introduced in 17.1.2. | |
tenant_uuid: ${67:} # not required. UUID of tenant used for all Avi API calls and context of object. | |
created_by: ${68:undefined} # not required. Creator name. | |
gslb_sp_enabled: ${69:undefined} # not required. Indicates if the pool is a site-persistence pool.,Field introduced in 17.2.1. | |
""" | |
'avi_poolgroup': | |
'prefix': "avi_poolgroup_snippet" | |
'description': "Module for setup of PoolGroup Avi RESTful Object" | |
'body': """ | |
avi_poolgroup: | |
name: ${1:undefined} # required. The name of the pool group. | |
username: ${2:} # not required. Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). | |
description: ${3:undefined} # not required. Description of pool group. | |
implicit_priority_labels: ${4:undefined} # not required. Whether an implicit set of priority labels is generated.,Field introduced in 17.1.9,17.2.3.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
controller: ${5:} # not required. IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). | |
members: ${6:undefined} # not required. List of pool group members object of type poolgroupmember. | |
api_context: ${7:undefined} # not required. Avi API context that includes current session ID and CSRF Token.,This allows user to perform single login and re-use the session. | |
fail_action: ${8:undefined} # not required. Enable an action - close connection, http redirect, or local http response - when a pool group failure happens.,By default, a connection will be closed, in case the pool group experiences a failure. | |
password: ${9:} # not required. Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). | |
avi_api_update_method: ${10|put,patch|} # not required. choices: put;patch. Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH. | |
priority_labels_ref: ${11:undefined} # not required. Uuid of the priority labels.,If not provided, pool group member priority label will be interpreted as a number with a larger number considered higher priority.,It is a reference to an object of type prioritylabels. | |
uuid: ${12:undefined} # not required. Uuid of the pool group. | |
cloud_ref: ${13:undefined} # not required. It is a reference to an object of type cloud. | |
avi_credentials: ${14:undefined} # not required. Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
tenant_ref: ${15:undefined} # not required. It is a reference to an object of type tenant. | |
state: ${16|absent,present|} # not required. choices: absent;present. The state that should be applied on the entity. | |
created_by: ${17:undefined} # not required. Name of the user who created the object. | |
tenant_uuid: ${18:} # not required. UUID of tenant used for all Avi API calls and context of object. | |
url: ${19:undefined} # not required. Avi controller URL of the object. | |
avi_api_patch_op: ${20|add,replace,delete|} # not required. choices: add;replace;delete. Patch operation to use when using avi_api_update_method as patch. | |
cloud_config_cksum: ${21:undefined} # not required. Checksum of cloud configuration for poolgroup.,Internally set by cloud connector. | |
tenant: ${22:admin} # not required. Name of tenant used for all Avi API calls and context of object. | |
min_servers: ${23:undefined} # not required. The minimum number of servers to distribute traffic to.,Allowed values are 1-65535.,Special values are 0 - 'disable'.,Default value when not specified in API or module is interpreted by Avi Controller as 0. | |
deployment_policy_ref: ${24:undefined} # not required. When setup autoscale manager will automatically promote new pools into production when deployment goals are met.,It is a reference to an object of type poolgroupdeploymentpolicy. | |
api_version: ${25:16.4.4} # not required. Avi API version of to use for Avi API and objects. | |
""" | |
'avi_poolgroupdeploymentpolicy': | |
'prefix': "avi_poolgroupdeploymentpolicy_snippet" | |
'description': "Module for setup of PoolGroupDeploymentPolicy Avi RESTful Object" | |
'body': """ | |
avi_poolgroupdeploymentpolicy: | |
name: ${1:undefined} # required. The name of the pool group deployment policy. | |
username: ${2:} # not required. Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). | |
target_test_traffic_ratio: ${3:undefined} # not required. Target traffic ratio before pool is made production.,Allowed values are 1-100.,Default value when not specified in API or module is interpreted by Avi Controller as 100.,Units(RATIO). | |
evaluation_duration: ${4:undefined} # not required. Duration of evaluation period for automatic deployment.,Allowed values are 60-86400.,Default value when not specified in API or module is interpreted by Avi Controller as 300.,Units(SEC). | |
description: ${5:undefined} # not required. User defined description for the object. | |
test_traffic_ratio_rampup: ${6:undefined} # not required. Ratio of the traffic that is sent to the pool under test.,Test ratio of 100 means blue green.,Allowed values are 1-100.,Default value when not specified in API or module is interpreted by Avi Controller as 100. | |
rules: ${7:undefined} # not required. List of pgdeploymentrule. | |
auto_disable_old_prod_pools: ${8:undefined} # not required. It will automatically disable old production pools once there is a new production candidate.,Default value when not specified in API or module is interpreted by Avi Controller as True. | |
controller: ${9:} # not required. IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). | |
api_context: ${10:undefined} # not required. Avi API context that includes current session ID and CSRF Token.,This allows user to perform single login and re-use the session. | |
webhook_ref: ${11:undefined} # not required. Webhook configured with url that avi controller will pass back information about pool group, old and new pool information and current deployment,rule results.,It is a reference to an object of type webhook.,Field introduced in 17.1.1. | |
password: ${12:} # not required. Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). | |
avi_api_update_method: ${13|put,patch|} # not required. choices: put;patch. Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH. | |
uuid: ${14:undefined} # not required. Uuid of the pool group deployment policy. | |
cloud_ref: ${15:undefined} # not required. It is a reference to an object of type cloud. | |
avi_credentials: ${16:undefined} # not required. Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
tenant_ref: ${17:undefined} # not required. It is a reference to an object of type tenant. | |
state: ${18|absent,present|} # not required. choices: absent;present. The state that should be applied on the entity. | |
url: ${19:undefined} # not required. Avi controller URL of the object. | |
avi_api_patch_op: ${20|add,replace,delete|} # not required. choices: add;replace;delete. Patch operation to use when using avi_api_update_method as patch. | |
tenant: ${21:admin} # not required. Name of tenant used for all Avi API calls and context of object. | |
scheme: ${22:undefined} # not required. Deployment scheme.,Enum options - BLUE_GREEN, CANARY.,Default value when not specified in API or module is interpreted by Avi Controller as BLUE_GREEN. | |
tenant_uuid: ${23:} # not required. UUID of tenant used for all Avi API calls and context of object. | |
api_version: ${24:16.4.4} # not required. Avi API version of to use for Avi API and objects. | |
""" | |
'avi_prioritylabels': | |
'prefix': "avi_prioritylabels_snippet" | |
'description': "Module for setup of PriorityLabels Avi RESTful Object" | |
'body': """ | |
avi_prioritylabels: | |
name: ${1:undefined} # required. The name of the priority labels. | |
username: ${2:} # not required. Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). | |
api_version: ${3:16.4.4} # not required. Avi API version of to use for Avi API and objects. | |
uuid: ${4:undefined} # not required. Uuid of the priority labels. | |
tenant_uuid: ${5:} # not required. UUID of tenant used for all Avi API calls and context of object. | |
cloud_ref: ${6:undefined} # not required. It is a reference to an object of type cloud. | |
avi_credentials: ${7:undefined} # not required. Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
tenant_ref: ${8:undefined} # not required. It is a reference to an object of type tenant. | |
state: ${9|absent,present|} # not required. choices: absent;present. The state that should be applied on the entity. | |
url: ${10:undefined} # not required. Avi controller URL of the object. | |
avi_api_patch_op: ${11|add,replace,delete|} # not required. choices: add;replace;delete. Patch operation to use when using avi_api_update_method as patch. | |
tenant: ${12:admin} # not required. Name of tenant used for all Avi API calls and context of object. | |
equivalent_labels: ${13:undefined} # not required. Equivalent priority labels in descending order. | |
api_context: ${14:undefined} # not required. Avi API context that includes current session ID and CSRF Token.,This allows user to perform single login and re-use the session. | |
password: ${15:} # not required. Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). | |
controller: ${16:} # not required. IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). | |
avi_api_update_method: ${17|put,patch|} # not required. choices: put;patch. Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH. | |
description: ${18:undefined} # not required. A description of the priority labels. | |
""" | |
'avi_role': | |
'prefix': "avi_role_snippet" | |
'description': "Module for setup of Role Avi RESTful Object" | |
'body': """ | |
avi_role: | |
name: ${1:undefined} # required. Name of the object. | |
username: ${2:} # not required. Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). | |
api_version: ${3:16.4.4} # not required. Avi API version of to use for Avi API and objects. | |
url: ${4:undefined} # not required. Avi controller URL of the object. | |
privileges: ${5:undefined} # not required. List of permission. | |
avi_credentials: ${6:undefined} # not required. Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
tenant_ref: ${7:undefined} # not required. It is a reference to an object of type tenant. | |
state: ${8|absent,present|} # not required. choices: absent;present. The state that should be applied on the entity. | |
tenant_uuid: ${9:} # not required. UUID of tenant used for all Avi API calls and context of object. | |
avi_api_patch_op: ${10|add,replace,delete|} # not required. choices: add;replace;delete. Patch operation to use when using avi_api_update_method as patch. | |
tenant: ${11:admin} # not required. Name of tenant used for all Avi API calls and context of object. | |
api_context: ${12:undefined} # not required. Avi API context that includes current session ID and CSRF Token.,This allows user to perform single login and re-use the session. | |
password: ${13:} # not required. Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). | |
controller: ${14:} # not required. IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). | |
avi_api_update_method: ${15|put,patch|} # not required. choices: put;patch. Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH. | |
uuid: ${16:undefined} # not required. Unique object identifier of the object. | |
""" | |
'avi_scheduler': | |
'prefix': "avi_scheduler_snippet" | |
'description': "Module for setup of Scheduler Avi RESTful Object" | |
'body': """ | |
avi_scheduler: | |
name: ${1:undefined} # required. Name of scheduler. | |
username: ${2:} # not required. Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). | |
state: ${3|absent,present|} # not required. choices: absent;present. The state that should be applied on the entity. | |
enabled: ${4:undefined} # not required. Boolean flag to set enabled.,Default value when not specified in API or module is interpreted by Avi Controller as True. | |
api_context: ${5:undefined} # not required. Avi API context that includes current session ID and CSRF Token.,This allows user to perform single login and re-use the session. | |
backup_config_ref: ${6:undefined} # not required. Backup configuration to be executed by this scheduler.,It is a reference to an object of type backupconfiguration. | |
controller: ${7:} # not required. IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). | |
frequency: ${8:undefined} # not required. Frequency at which custom scheduler will run.,Allowed values are 0-60. | |
scheduler_action: ${9:undefined} # not required. Define scheduler action.,Enum options - SCHEDULER_ACTION_RUN_A_SCRIPT, SCHEDULER_ACTION_BACKUP.,Default value when not specified in API or module is interpreted by Avi Controller as SCHEDULER_ACTION_BACKUP. | |
end_date_time: ${10:undefined} # not required. Scheduler end date and time. | |
password: ${11:} # not required. Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). | |
avi_api_update_method: ${12|put,patch|} # not required. choices: put;patch. Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH. | |
uuid: ${13:undefined} # not required. Unique object identifier of the object. | |
start_date_time: ${14:undefined} # not required. Scheduler start date and time. | |
url: ${15:undefined} # not required. Avi controller URL of the object. | |
avi_credentials: ${16:undefined} # not required. Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
tenant_ref: ${17:undefined} # not required. It is a reference to an object of type tenant. | |
frequency_unit: ${18:undefined} # not required. Unit at which custom scheduler will run.,Enum options - SCHEDULER_FREQUENCY_UNIT_MIN, SCHEDULER_FREQUENCY_UNIT_HOUR, SCHEDULER_FREQUENCY_UNIT_DAY, SCHEDULER_FREQUENCY_UNIT_WEEK,,SCHEDULER_FREQUENCY_UNIT_MONTH. | |
avi_api_patch_op: ${19|add,replace,delete|} # not required. choices: add;replace;delete. Patch operation to use when using avi_api_update_method as patch. | |
run_script_ref: ${20:undefined} # not required. Control script to be executed by this scheduler.,It is a reference to an object of type alertscriptconfig. | |
tenant: ${21:admin} # not required. Name of tenant used for all Avi API calls and context of object. | |
tenant_uuid: ${22:} # not required. UUID of tenant used for all Avi API calls and context of object. | |
api_version: ${23:16.4.4} # not required. Avi API version of to use for Avi API and objects. | |
run_mode: ${24:undefined} # not required. Scheduler run mode.,Enum options - RUN_MODE_PERIODIC, RUN_MODE_AT, RUN_MODE_NOW. | |
""" | |
'avi_seproperties': | |
'prefix': "avi_seproperties_snippet" | |
'description': "Module for setup of SeProperties Avi RESTful Object" | |
'body': """ | |
avi_seproperties: | |
username: ${1:} # not required. Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). | |
se_agent_properties: ${2:undefined} # not required. Seagentproperties settings for seproperties. | |
uuid: ${3:undefined} # not required. Unique object identifier of the object.,Default value when not specified in API or module is interpreted by Avi Controller as default. | |
url: ${4:undefined} # not required. Avi controller URL of the object. | |
se_runtime_properties: ${5:undefined} # not required. Seruntimeproperties settings for seproperties. | |
avi_credentials: ${6:undefined} # not required. Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
controller: ${7:} # not required. IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). | |
state: ${8|absent,present|} # not required. choices: absent;present. The state that should be applied on the entity. | |
api_version: ${9:16.4.4} # not required. Avi API version of to use for Avi API and objects. | |
avi_api_patch_op: ${10|add,replace,delete|} # not required. choices: add;replace;delete. Patch operation to use when using avi_api_update_method as patch. | |
se_bootup_properties: ${11:undefined} # not required. Sebootupproperties settings for seproperties. | |
tenant: ${12:admin} # not required. Name of tenant used for all Avi API calls and context of object. | |
api_context: ${13:undefined} # not required. Avi API context that includes current session ID and CSRF Token.,This allows user to perform single login and re-use the session. | |
password: ${14:} # not required. Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). | |
tenant_uuid: ${15:} # not required. UUID of tenant used for all Avi API calls and context of object. | |
avi_api_update_method: ${16|put,patch|} # not required. choices: put;patch. Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH. | |
""" | |
'avi_serverautoscalepolicy': | |
'prefix': "avi_serverautoscalepolicy_snippet" | |
'description': "Module for setup of ServerAutoScalePolicy Avi RESTful Object" | |
'body': """ | |
avi_serverautoscalepolicy: | |
name: ${1:undefined} # required. Name of the object. | |
username: ${2:} # not required. Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). | |
use_predicted_load: ${3:undefined} # not required. Use predicted load rather than current load.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
intelligent_autoscale: ${4:undefined} # not required. Use avi intelligent autoscale algorithm where autoscale is performed by comparing load on the pool against estimated capacity of all the servers.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
description: ${5:undefined} # not required. User defined description for the object. | |
intelligent_scaleout_margin: ${6:undefined} # not required. Minimum extra capacity as percentage of load used by the intelligent scheme.,Scaleout is triggered when available capacity is less than this margin.,Allowed values are 1-99.,Default value when not specified in API or module is interpreted by Avi Controller as 20. | |
scaleout_alertconfig_refs: ${7:undefined} # not required. Trigger scaleout when alerts due to any of these alert configurations are raised.,It is a reference to an object of type alertconfig. | |
min_size: ${8:undefined} # not required. No scale-in happens once number of operationally up servers reach min_servers.,Allowed values are 0-400. | |
controller: ${9:} # not required. IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). | |
scalein_cooldown: ${10:undefined} # not required. Cooldown period during which no new scalein is triggered to allow previous scalein to successfully complete.,Default value when not specified in API or module is interpreted by Avi Controller as 300.,Units(SEC). | |
api_context: ${11:undefined} # not required. Avi API context that includes current session ID and CSRF Token.,This allows user to perform single login and re-use the session. | |
scaleout_cooldown: ${12:undefined} # not required. Cooldown period during which no new scaleout is triggered to allow previous scaleout to successfully complete.,Default value when not specified in API or module is interpreted by Avi Controller as 300.,Units(SEC). | |
max_size: ${13:undefined} # not required. Maximum number of servers after scaleout.,Allowed values are 0-400. | |
tenant: ${14:admin} # not required. Name of tenant used for all Avi API calls and context of object. | |
password: ${15:} # not required. Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). | |
intelligent_scalein_margin: ${16:undefined} # not required. Maximum extra capacity as percentage of load used by the intelligent scheme.,Scalein is triggered when available capacity is more than this margin.,Allowed values are 1-99.,Default value when not specified in API or module is interpreted by Avi Controller as 40. | |
uuid: ${17:undefined} # not required. Unique object identifier of the object. | |
url: ${18:undefined} # not required. Avi controller URL of the object. | |
avi_credentials: ${19:undefined} # not required. Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
tenant_ref: ${20:undefined} # not required. It is a reference to an object of type tenant. | |
state: ${21|absent,present|} # not required. choices: absent;present. The state that should be applied on the entity. | |
max_scalein_adjustment_step: ${22:undefined} # not required. Maximum number of servers to scalein simultaneously.,The actual number of servers to scalein is chosen such that target number of servers is always more than or equal to the min_size.,Default value when not specified in API or module is interpreted by Avi Controller as 1. | |
avi_api_patch_op: ${23|add,replace,delete|} # not required. choices: add;replace;delete. Patch operation to use when using avi_api_update_method as patch. | |
scalein_alertconfig_refs: ${24:undefined} # not required. Trigger scalein when alerts due to any of these alert configurations are raised.,It is a reference to an object of type alertconfig. | |
avi_api_update_method: ${25|put,patch|} # not required. choices: put;patch. Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH. | |
max_scaleout_adjustment_step: ${26:undefined} # not required. Maximum number of servers to scaleout simultaneously.,The actual number of servers to scaleout is chosen such that target number of servers is always less than or equal to the max_size.,Default value when not specified in API or module is interpreted by Avi Controller as 1. | |
tenant_uuid: ${27:} # not required. UUID of tenant used for all Avi API calls and context of object. | |
api_version: ${28:16.4.4} # not required. Avi API version of to use for Avi API and objects. | |
""" | |
'avi_serviceengine': | |
'prefix': "avi_serviceengine_snippet" | |
'description': "Module for setup of ServiceEngine Avi RESTful Object" | |
'body': """ | |
avi_serviceengine: | |
username: ${1:} # not required. Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). | |
enable_state: ${2:undefined} # not required. Inorder to disable se set this field appropriately.,Enum options - SE_STATE_ENABLED, SE_STATE_DISABLED_FOR_PLACEMENT, SE_STATE_DISABLED, SE_STATE_DISABLED_FORCE.,Default value when not specified in API or module is interpreted by Avi Controller as SE_STATE_ENABLED. | |
avi_credentials: ${3:undefined} # not required. Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
mgmt_vnic: ${4:undefined} # not required. Vnic settings for serviceengine. | |
tenant_ref: ${5:undefined} # not required. It is a reference to an object of type tenant. | |
controller_created: ${6:undefined} # not required. Boolean flag to set controller_created.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
controller: ${7:} # not required. IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). | |
api_context: ${8:undefined} # not required. Avi API context that includes current session ID and CSRF Token.,This allows user to perform single login and re-use the session. | |
flavor: ${9:undefined} # not required. Flavor of serviceengine. | |
password: ${10:} # not required. Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). | |
avi_api_update_method: ${11|put,patch|} # not required. choices: put;patch. Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH. | |
uuid: ${12:undefined} # not required. Unique object identifier of the object. | |
name: ${13:undefined} # not required. Name of the object.,Default value when not specified in API or module is interpreted by Avi Controller as VM name unknown. | |
cloud_ref: ${14:undefined} # not required. It is a reference to an object of type cloud. | |
hypervisor: ${15:undefined} # not required. Enum options - default, vmware_esx, kvm, vmware_vsan, xen. | |
se_group_ref: ${16:undefined} # not required. It is a reference to an object of type serviceenginegroup. | |
container_mode: ${17:undefined} # not required. Boolean flag to set container_mode.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
data_vnics: ${18:undefined} # not required. List of vnic. | |
state: ${19|absent,present|} # not required. choices: absent;present. The state that should be applied on the entity. | |
container_type: ${20:undefined} # not required. Enum options - container_type_bridge, container_type_host, container_type_host_dpdk.,Default value when not specified in API or module is interpreted by Avi Controller as CONTAINER_TYPE_HOST. | |
api_version: ${21:16.4.4} # not required. Avi API version of to use for Avi API and objects. | |
host_ref: ${22:undefined} # not required. It is a reference to an object of type vimgrhostruntime. | |
url: ${23:undefined} # not required. Avi controller URL of the object. | |
avi_api_patch_op: ${24|add,replace,delete|} # not required. choices: add;replace;delete. Patch operation to use when using avi_api_update_method as patch. | |
tenant: ${25:admin} # not required. Name of tenant used for all Avi API calls and context of object. | |
availability_zone: ${26:undefined} # not required. Availability_zone of serviceengine. | |
controller_ip: ${27:undefined} # not required. Controller_ip of serviceengine. | |
tenant_uuid: ${28:} # not required. UUID of tenant used for all Avi API calls and context of object. | |
resources: ${29:undefined} # not required. Seresources settings for serviceengine. | |
""" | |
'avi_serviceenginegroup': | |
'prefix': "avi_serviceenginegroup_snippet" | |
'description': "Module for setup of ServiceEngineGroup Avi RESTful Object" | |
'body': """ | |
avi_serviceenginegroup: | |
name: ${1:undefined} # required. Name of the object. | |
se_vs_hb_max_vs_in_pkt: ${2:undefined} # not required. Maximum number of virtualservices for which heartbeat messages are aggregated in one packet.,Allowed values are 1-1024.,Field introduced in 17.1.1.,Default value when not specified in API or module is interpreted by Avi Controller as 256. | |
disable_tso: ${3:undefined} # not required. Disable tcp segmentation offload (tso) in dpdk poll-mode driver packet transmit path.,Tso is on by default on nics that support it.,Field introduced in 17.2.5.,Default value when not specified in API or module is interpreted by Avi Controller as True. | |
host_attribute_value: ${4:undefined} # not required. Value of a (key, value) pair identifying a label for a set of nodes usually in container clouds.,Needs to be specified together with host_attribute_key. | |
async_ssl: ${5:undefined} # not required. Ssl handshakes will be handled by dedicated ssl threads.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
api_context: ${6:undefined} # not required. Avi API context that includes current session ID and CSRF Token.,This allows user to perform single login and re-use the session. | |
instance_flavor: ${7:undefined} # not required. Instance/flavor type for se instance. | |
auto_redistribute_active_standby_load: ${8:undefined} # not required. Redistribution of virtual services from the takeover se to the replacement se can cause momentary traffic loss.,If the auto-redistribute load option is left in its default off state, any desired rebalancing requires calls to rest api.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
auto_rebalance: ${9:undefined} # not required. If set, virtual services will be automatically migrated when load on an se is less than minimum or more than maximum thresholds.,Only alerts are generated when the auto_rebalance is not set.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
disk_per_se: ${10:undefined} # not required. Amount of disk space for each of the service engine virtual machines.,Default value when not specified in API or module is interpreted by Avi Controller as 10.,Units(GB). | |
se_tunnel_mode: ${11:undefined} # not required. Determines if dsr from secondary se is active or not 0 automatically determine based on hypervisor type.,1 disable dsr unconditionally.,~[0,1] enable dsr unconditionally.,Field introduced in 17.1.1.,Default value when not specified in API or module is interpreted by Avi Controller as 0. | |
uuid: ${12:undefined} # not required. Unique object identifier of the object. | |
se_tunnel_udp_port: ${13:undefined} # not required. Udp port for tunneled packets from secondary to primary se in docker bridge mode.,Field introduced in 17.1.3.,Default value when not specified in API or module is interpreted by Avi Controller as 1550. | |
disable_gro: ${14:undefined} # not required. Disable generic receive offload (gro) in dpdk poll-mode driver packet receive path.,Gro is on by default on nics that do not support lro (large receive offload) or do not gain performance boost from lro.,Field introduced in 17.2.5.,Default value when not specified in API or module is interpreted by Avi Controller as True. | |
vs_scalein_timeout: ${15:undefined} # not required. Time to wait for the scaled in se to drain existing flows before marking the scalein done.,Default value when not specified in API or module is interpreted by Avi Controller as 30.,Units(SEC). | |
mgmt_subnet: ${16:undefined} # not required. Management subnet to use for avi service engines. | |
cloud_ref: ${17:undefined} # not required. It is a reference to an object of type cloud. | |
se_remote_punt_udp_port: ${18:undefined} # not required. Udp port for punted packets in docker bridge mode.,Field introduced in 17.1.2.,Default value when not specified in API or module is interpreted by Avi Controller as 1501. | |
se_udp_encap_ipc: ${19:undefined} # not required. Determines if se-se ipc messages are encapsulated in an udp header 0 automatically determine based on hypervisor type.,1 use udp encap unconditionally.,~[0,1] don't use udp encap.,Field introduced in 17.1.2.,Default value when not specified in API or module is interpreted by Avi Controller as 0. | |
min_cpu_usage: ${20:undefined} # not required. When cpu usage on an se falls below the minimum threshold, virtual services hosted on the se may be consolidated onto other underutilized ses.,After consolidation, unused service engines may then be eligible for deletion.,Allowed values are 20-60.,Default value when not specified in API or module is interpreted by Avi Controller as 30.,Units(PERCENT). | |
custom_securitygroups_data: ${21:undefined} # not required. Custom security groups to be associated with data vnics for se instances in openstack and aws clouds.,Field introduced in 17.1.3. | |
ingress_access_data: ${22:undefined} # not required. Program se security group ingress rules to allow vip data access from remote cidr type.,Enum options - SG_INGRESS_ACCESS_NONE, SG_INGRESS_ACCESS_ALL, SG_INGRESS_ACCESS_VPC.,Field introduced in 17.1.5.,Default value when not specified in API or module is interpreted by Avi Controller as SG_INGRESS_ACCESS_ALL. | |
vcenter_clusters: ${23:undefined} # not required. Vcenterclusters settings for serviceenginegroup. | |
enable_vip_on_all_interfaces: ${24:undefined} # not required. Enable vip on all interfaces of se.,Field introduced in 17.1.1.,Default value when not specified in API or module is interpreted by Avi Controller as True. | |
ingress_access_mgmt: ${25:undefined} # not required. Program se security group ingress rules to allow ssh/icmp management access from remote cidr type.,Enum options - SG_INGRESS_ACCESS_NONE, SG_INGRESS_ACCESS_ALL, SG_INGRESS_ACCESS_VPC.,Field introduced in 17.1.5.,Default value when not specified in API or module is interpreted by Avi Controller as SG_INGRESS_ACCESS_ALL. | |
iptables: ${26:undefined} # not required. Iptable rules. | |
max_vs_per_se: ${27:undefined} # not required. Maximum number of virtual services that can be placed on a single service engine.,East west virtual services are excluded from this limit.,Allowed values are 1-1000.,Default value when not specified in API or module is interpreted by Avi Controller as 10. | |
connection_memory_percentage: ${28:undefined} # not required. Percentage of memory for connection state.,This will come at the expense of memory used for http in-memory cache.,Allowed values are 10-90.,Default value when not specified in API or module is interpreted by Avi Controller as 50.,Units(PERCENT). | |
service_ip_subnets: ${29:undefined} # not required. Subnets assigned to the se group.,Required for vs group placement.,Field introduced in 17.1.1. | |
placement_mode: ${30:undefined} # not required. If placement mode is 'auto', virtual services are automatically placed on service engines.,Enum options - PLACEMENT_MODE_AUTO.,Default value when not specified in API or module is interpreted by Avi Controller as PLACEMENT_MODE_AUTO. | |
max_scaleout_per_vs: ${31:undefined} # not required. Maximum number of active service engines for the virtual service.,Allowed values are 1-64.,Default value when not specified in API or module is interpreted by Avi Controller as 4. | |
os_reserved_memory: ${32:undefined} # not required. Amount of extra memory to be reserved for use by the operating system on a service engine.,Default value when not specified in API or module is interpreted by Avi Controller as 0. | |
enable_routing: ${33:undefined} # not required. Enable routing for this serviceenginegroup .,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
waf_mempool: ${34:undefined} # not required. Enable memory pool for waf.,Field introduced in 17.2.3.,Default value when not specified in API or module is interpreted by Avi Controller as True. | |
controller: ${35:} # not required. IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). | |
per_app: ${36:undefined} # not required. Per-app se mode is designed for deploying dedicated load balancers per app (vs).,In this mode, each se is limited to a max of 2 vss.,Vcpus in per-app ses count towards licensing usage at 25% rate.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
openstack_availability_zones: ${37:undefined} # not required. Field introduced in 17.1.1. | |
vcenter_datastores_include: ${38:undefined} # not required. Boolean flag to set vcenter_datastores_include.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
se_name_prefix: ${39:undefined} # not required. Prefix to use for virtual machine name of service engines.,Default value when not specified in API or module is interpreted by Avi Controller as Avi. | |
avi_api_update_method: ${40|put,patch|} # not required. choices: put;patch. Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH. | |
flow_table_new_syn_max_entries: ${41:undefined} # not required. Maximum number of flow table entries that have not completed tcp three-way handshake yet.,Field introduced in 17.2.5.,Default value when not specified in API or module is interpreted by Avi Controller as 0. | |
se_vs_hb_max_pkts_in_batch: ${42:undefined} # not required. Maximum number of aggregated vs heartbeat packets to send in a batch.,Allowed values are 1-256.,Field introduced in 17.1.1.,Default value when not specified in API or module is interpreted by Avi Controller as 8. | |
ignore_rtt_threshold: ${43:undefined} # not required. Ignore rtt samples if it is above threshold.,Field introduced in 17.1.6,17.2.2.,Default value when not specified in API or module is interpreted by Avi Controller as 5000.,Units(MILLISECONDS). | |
avi_credentials: ${44:undefined} # not required. Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
tenant_ref: ${45:undefined} # not required. It is a reference to an object of type tenant. | |
host_attribute_key: ${46:undefined} # not required. Key of a (key, value) pair identifying a label for a set of nodes usually in container clouds.,Needs to be specified together with host_attribute_value.,Ses can be configured differently including ha modes across different se groups.,May also be used for isolation between different classes of virtualservices.,Virtualservices' se group may be specified via annotations/labels.,A openshift/kubernetes namespace maybe annotated with a matching se group label as openshift.io/node-selector apptype=prod.,When multiple se groups are used in a cloud with host attributes specified,just a single se group can exist as a match-all se group without a,host_attribute_key. | |
username: ${47:} # not required. Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). | |
url: ${48:undefined} # not required. Avi controller URL of the object. | |
dedicated_dispatcher_core: ${49:undefined} # not required. Dedicate the core that handles packet receive/transmit from the network to just the dispatching function.,Don't use it for tcp/ip and ssl functions.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
max_se: ${50:undefined} # not required. Maximum number of services engines in this group.,Allowed values are 0-1000.,Default value when not specified in API or module is interpreted by Avi Controller as 10. | |
api_version: ${51:16.4.4} # not required. Avi API version of to use for Avi API and objects. | |
mem_reserve: ${52:undefined} # not required. Boolean flag to set mem_reserve.,Default value when not specified in API or module is interpreted by Avi Controller as True. | |
license_type: ${53:undefined} # not required. If no license type is specified then default license enforcement for the cloud type is chosen.,Enum options - LIC_BACKEND_SERVERS, LIC_SOCKETS, LIC_CORES, LIC_HOSTS, LIC_SE_BANDWIDTH.,Field introduced in 17.2.5. | |
se_dos_profile: ${54:undefined} # not required. Dosthresholdprofile settings for serviceenginegroup. | |
enable_vmac: ${55:undefined} # not required. Use virtual mac address for interfaces on which floating interface ips are placed.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
tenant_uuid: ${56:} # not required. UUID of tenant used for all Avi API calls and context of object. | |
disable_csum_offloads: ${57:undefined} # not required. Stop using tcp/udp and ip checksum offload features of nics.,Field introduced in 17.1.14, 17.2.5.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
openstack_mgmt_network_name: ${58:undefined} # not required. Avi management network name. | |
udf_log_throttle: ${59:undefined} # not required. This setting limits the number of udf logs generated per second per core on this se.,Udf logs are generated due to the configured client log filters or the rules with logging enabled.,Default is 100 logs per second.,Set it to zero (0) to disable throttling.,Field introduced in 17.1.3.,Default value when not specified in API or module is interpreted by Avi Controller as 100.,Units(PER_SECOND). | |
vcenter_hosts: ${60:undefined} # not required. Vcenterhosts settings for serviceenginegroup. | |
se_ipc_udp_port: ${61:undefined} # not required. Udp port for se_dp ipc in docker bridge mode.,Field introduced in 17.1.2.,Default value when not specified in API or module is interpreted by Avi Controller as 1500. | |
vcpus_per_se: ${62:undefined} # not required. Number of vcpus for each of the service engine virtual machines.,Default value when not specified in API or module is interpreted by Avi Controller as 1. | |
hm_on_standby: ${63:undefined} # not required. Enable active health monitoring from the standby se for all placed virtual services.,Default value when not specified in API or module is interpreted by Avi Controller as True. | |
se_sb_dedicated_core: ${64:undefined} # not required. Sideband traffic will be handled by a dedicated core.,Field introduced in 16.5.2, 17.1.9, 17.2.3.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
cpu_socket_affinity: ${65:undefined} # not required. Allocate all the cpu cores for the service engine virtual machines on the same cpu socket.,Applicable only for vcenter cloud.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
realtime_se_metrics: ${66:undefined} # not required. Enable or disable real time se metrics. | |
archive_shm_limit: ${67:undefined} # not required. Amount of se memory in gb until which shared memory is collected in core archive.,Field introduced in 17.1.3.,Default value when not specified in API or module is interpreted by Avi Controller as 8.,Units(GB). | |
hardwaresecuritymodulegroup_ref: ${68:undefined} # not required. It is a reference to an object of type hardwaresecuritymodulegroup. | |
custom_securitygroups_mgmt: ${69:undefined} # not required. Custom security groups to be associated with management vnic for se instances in openstack and aws clouds.,Field introduced in 17.1.3. | |
custom_tag: ${70:undefined} # not required. Custom tag will be used to create the tags for se instance in aws.,Note this is not the same as the prefix for se name. | |
floating_intf_ip_se_2: ${71:undefined} # not required. If serviceenginegroup is configured for legacy 1+1 active standby ha mode, floating ip's will be advertised only by the active se in the pair.,Virtual services in this group must be disabled/enabled for any changes to the floating ip's to take effect.,Only active se hosting vs tagged with active standby se 2 tag will advertise this floating ip when manual load distribution is enabled. | |
se_deprovision_delay: ${72:undefined} # not required. Duration to preserve unused service engine virtual machines before deleting them.,If traffic to a virtual service were to spike up abruptly, this se would still be available to be utilized again rather than creating a new se.,If this value is set to 0, controller will never delete any ses and administrator has to manually cleanup unused ses.,Allowed values are 0-525600.,Default value when not specified in API or module is interpreted by Avi Controller as 120.,Units(MIN). | |
log_disksz: ${73:undefined} # not required. Maximum disk capacity (in mb) to be allocated to an se.,This is exclusively used for debug and log data.,Default value when not specified in API or module is interpreted by Avi Controller as 10000.,Units(MB). | |
password: ${74:} # not required. Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). | |
non_significant_log_throttle: ${75:undefined} # not required. This setting limits the number of non-significant logs generated per second per core on this se.,Default is 100 logs per second.,Set it to zero (0) to disable throttling.,Field introduced in 17.1.3.,Default value when not specified in API or module is interpreted by Avi Controller as 100.,Units(PER_SECOND). | |
openstack_availability_zone: ${76:undefined} # not required. Field deprecated in 17.1.1. | |
extra_shared_config_memory: ${77:undefined} # not required. Extra config memory to support large geo db configuration.,Field introduced in 17.1.1.,Default value when not specified in API or module is interpreted by Avi Controller as 0.,Units(MB). | |
auto_rebalance_interval: ${78:undefined} # not required. Frequency of rebalance, if 'auto rebalance' is enabled.,Default value when not specified in API or module is interpreted by Avi Controller as 300.,Units(SEC). | |
avi_api_patch_op: ${79|add,replace,delete|} # not required. choices: add;replace;delete. Patch operation to use when using avi_api_update_method as patch. | |
vcenter_datastores: ${80:undefined} # not required. List of vcenterdatastore. | |
state: ${81|absent,present|} # not required. choices: absent;present. The state that should be applied on the entity. | |
se_sb_threads: ${82:undefined} # not required. Number of sideband threads per se.,Allowed values are 1-128.,Field introduced in 16.5.2, 17.1.9, 17.2.3.,Default value when not specified in API or module is interpreted by Avi Controller as 1. | |
vs_scaleout_timeout: ${83:undefined} # not required. Time to wait for the scaled out se to become ready before marking the scaleout done.,Default value when not specified in API or module is interpreted by Avi Controller as 30.,Units(SEC). | |
active_standby: ${84:undefined} # not required. Service engines in active/standby mode for ha failover.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
auto_rebalance_capacity_per_se: ${85:undefined} # not required. Capacities of se for auto rebalance for each criteria.,Field introduced in 17.2.4. | |
num_flow_cores_sum_changes_to_ignore: ${86:undefined} # not required. Number of changes in num flow cores sum to ignore.,Default value when not specified in API or module is interpreted by Avi Controller as 8. | |
se_probe_port: ${87:undefined} # not required. Tcp port on se where echo service will be run.,Field introduced in 17.2.2.,Default value when not specified in API or module is interpreted by Avi Controller as 7. | |
algo: ${88:undefined} # not required. In compact placement, virtual services are placed on existing ses until max_vs_per_se limit is reached.,Enum options - PLACEMENT_ALGO_PACKED, PLACEMENT_ALGO_DISTRIBUTED.,Default value when not specified in API or module is interpreted by Avi Controller as PLACEMENT_ALGO_PACKED. | |
extra_config_multiplier: ${89:undefined} # not required. Multiplier for extra config to support large vs/pool config.,Default value when not specified in API or module is interpreted by Avi Controller as 0.0. | |
async_ssl_threads: ${90:undefined} # not required. Number of async ssl threads per se_dp.,Allowed values are 1-16.,Default value when not specified in API or module is interpreted by Avi Controller as 1. | |
description: ${91:undefined} # not required. User defined description for the object. | |
openstack_mgmt_network_uuid: ${92:undefined} # not required. Management network uuid. | |
vcenter_folder: ${93:undefined} # not required. Folder to place all the service engine virtual machines in vcenter.,Default value when not specified in API or module is interpreted by Avi Controller as AviSeFolder. | |
vs_scalein_timeout_for_upgrade: ${94:undefined} # not required. During se upgrade, time to wait for the scaled-in se to drain existing flows before marking the scalein done.,Default value when not specified in API or module is interpreted by Avi Controller as 30.,Units(SEC). | |
cpu_reserve: ${95:undefined} # not required. Boolean flag to set cpu_reserve.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
allow_burst: ${96:undefined} # not required. Allow ses to be created using burst license.,Field introduced in 17.2.5. | |
floating_intf_ip: ${97:undefined} # not required. If serviceenginegroup is configured for legacy 1+1 active standby ha mode, floating ip's will be advertised only by the active se in the pair.,Virtual services in this group must be disabled/enabled for any changes to the floating ip's to take effect.,Only active se hosting vs tagged with active standby se 1 tag will advertise this floating ip when manual load distribution is enabled. | |
advertise_backend_networks: ${98:undefined} # not required. Advertise reach-ability of backend server networks via adc through bgp for default gateway feature.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
mgmt_network_ref: ${99:undefined} # not required. Management network to use for avi service engines.,It is a reference to an object of type network. | |
memory_per_se: ${100:undefined} # not required. Amount of memory for each of the service engine virtual machines.,Default value when not specified in API or module is interpreted by Avi Controller as 2048. | |
max_cpu_usage: ${101:undefined} # not required. When cpu usage on an se exceeds this threshold, virtual services hosted on this se may be rebalanced to other ses to reduce load.,A new se may be created as part of this process.,Allowed values are 40-90.,Default value when not specified in API or module is interpreted by Avi Controller as 80.,Units(PERCENT). | |
min_scaleout_per_vs: ${102:undefined} # not required. Minimum number of active service engines for the virtual service.,Allowed values are 1-64.,Default value when not specified in API or module is interpreted by Avi Controller as 1. | |
license_tier: ${103:undefined} # not required. Specifies the license tier which would be used.,This field by default inherits the value from cloud.,Enum options - ENTERPRISE_16, ENTERPRISE_18.,Field introduced in 17.2.5. | |
vss_placement: ${104:undefined} # not required. If set, virtual services will be placed on only a subset of the cores of an se.,Field introduced in 17.2.5. | |
host_gateway_monitor: ${105:undefined} # not required. Enable the host gateway monitor when service engine is deployed as docker container.,Disabled by default.,Field introduced in 17.2.4.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
buffer_se: ${106:undefined} # not required. Excess service engine capacity provisioned for ha failover.,Default value when not specified in API or module is interpreted by Avi Controller as 1. | |
hypervisor: ${107:undefined} # not required. Override default hypervisor.,Enum options - DEFAULT, VMWARE_ESX, KVM, VMWARE_VSAN, XEN. | |
ha_mode: ${108:undefined} # not required. High availability mode for all the virtual services using this service engine group.,Enum options - HA_MODE_SHARED_PAIR, HA_MODE_SHARED, HA_MODE_LEGACY_ACTIVE_STANDBY.,Default value when not specified in API or module is interpreted by Avi Controller as HA_MODE_SHARED. | |
vcenter_datastore_mode: ${109:undefined} # not required. Enum options - vcenter_datastore_any, vcenter_datastore_local, vcenter_datastore_shared.,Default value when not specified in API or module is interpreted by Avi Controller as VCENTER_DATASTORE_ANY. | |
auto_rebalance_criteria: ${110:undefined} # not required. Set of criteria for se auto rebalance.,Enum options - SE_AUTO_REBALANCE_CPU, SE_AUTO_REBALANCE_PPS, SE_AUTO_REBALANCE_MBPS, SE_AUTO_REBALANCE_OPEN_CONNS, SE_AUTO_REBALANCE_CPS.,Field introduced in 17.2.3. | |
distribute_load_active_standby: ${111:undefined} # not required. Use both the active and standby service engines for virtual service placement in the legacy active standby ha mode.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
least_load_core_selection: ${112:undefined} # not required. Select core with least load for new flow.,Default value when not specified in API or module is interpreted by Avi Controller as True. | |
aggressive_failure_detection: ${113:undefined} # not required. Enable aggressive failover configuration for ha.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
significant_log_throttle: ${114:undefined} # not required. This setting limits the number of significant logs generated per second per core on this se.,Default is 100 logs per second.,Set it to zero (0) to disable throttling.,Field introduced in 17.1.3.,Default value when not specified in API or module is interpreted by Avi Controller as 100.,Units(PER_SECOND). | |
waf_mempool_size: ${115:undefined} # not required. Memory pool size used for waf.,Field introduced in 17.2.3.,Default value when not specified in API or module is interpreted by Avi Controller as 64.,Units(KB). | |
se_bandwidth_type: ${116:undefined} # not required. Select the se bandwidth for the bandwidth license.,Enum options - SE_BANDWIDTH_UNLIMITED, SE_BANDWIDTH_25M, SE_BANDWIDTH_200M, SE_BANDWIDTH_1000M, SE_BANDWIDTH_10000M.,Field introduced in 17.2.5. | |
se_thread_multiplier: ${117:undefined} # not required. Multiplier for se threads based on vcpu.,Allowed values are 1-10.,Default value when not specified in API or module is interpreted by Avi Controller as 1. | |
vs_host_redundancy: ${118:undefined} # not required. Ensure primary and secondary service engines are deployed on different physical hosts.,Default value when not specified in API or module is interpreted by Avi Controller as True. | |
tenant: ${119:admin} # not required. Name of tenant used for all Avi API calls and context of object. | |
""" | |
'avi_snmptrapprofile': | |
'prefix': "avi_snmptrapprofile_snippet" | |
'description': "Module for setup of SnmpTrapProfile Avi RESTful Object" | |
'body': """ | |
avi_snmptrapprofile: | |
name: ${1:undefined} # required. A user-friendly name of the snmp trap configuration. | |
username: ${2:} # not required. Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). | |
api_version: ${3:16.4.4} # not required. Avi API version of to use for Avi API and objects. | |
trap_servers: ${4:undefined} # not required. The ip address or hostname of the snmp trap destination server. | |
avi_credentials: ${5:undefined} # not required. Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
tenant_ref: ${6:undefined} # not required. It is a reference to an object of type tenant. | |
state: ${7|absent,present|} # not required. choices: absent;present. The state that should be applied on the entity. | |
tenant_uuid: ${8:} # not required. UUID of tenant used for all Avi API calls and context of object. | |
url: ${9:undefined} # not required. Avi controller URL of the object. | |
avi_api_patch_op: ${10|add,replace,delete|} # not required. choices: add;replace;delete. Patch operation to use when using avi_api_update_method as patch. | |
tenant: ${11:admin} # not required. Name of tenant used for all Avi API calls and context of object. | |
api_context: ${12:undefined} # not required. Avi API context that includes current session ID and CSRF Token.,This allows user to perform single login and re-use the session. | |
password: ${13:} # not required. Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). | |
controller: ${14:} # not required. IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). | |
avi_api_update_method: ${15|put,patch|} # not required. choices: put;patch. Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH. | |
uuid: ${16:undefined} # not required. Uuid of the snmp trap profile object. | |
""" | |
'avi_sslkeyandcertificate': | |
'prefix': "avi_sslkeyandcertificate_snippet" | |
'description': "Module for setup of SSLKeyAndCertificate Avi RESTful Object" | |
'body': """ | |
avi_sslkeyandcertificate: | |
name: ${1:undefined} # required. Name of the object. | |
certificate: ${2:undefined} # required. Sslcertificate settings for sslkeyandcertificate. | |
status: ${3:undefined} # not required. Enum options - ssl_certificate_finished, ssl_certificate_pending.,Default value when not specified in API or module is interpreted by Avi Controller as SSL_CERTIFICATE_FINISHED. | |
username: ${4:} # not required. Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). | |
certificate_management_profile_ref: ${5:undefined} # not required. It is a reference to an object of type certificatemanagementprofile. | |
controller: ${6:} # not required. IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). | |
hardwaresecuritymodulegroup_ref: ${7:undefined} # not required. It is a reference to an object of type hardwaresecuritymodulegroup. | |
key: ${8:undefined} # not required. Private key. | |
api_context: ${9:undefined} # not required. Avi API context that includes current session ID and CSRF Token.,This allows user to perform single login and re-use the session. | |
key_params: ${10:undefined} # not required. Sslkeyparams settings for sslkeyandcertificate. | |
password: ${11:} # not required. Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). | |
avi_api_update_method: ${12|put,patch|} # not required. choices: put;patch. Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH. | |
enckey_base64: ${13:undefined} # not required. Encrypted private key corresponding to the private key (e.g.,Those generated by an hsm such as thales nshield). | |
uuid: ${14:undefined} # not required. Unique object identifier of the object. | |
dynamic_params: ${15:undefined} # not required. Dynamic parameters needed for certificate management profile. | |
url: ${16:undefined} # not required. Avi controller URL of the object. | |
enckey_name: ${17:undefined} # not required. Name of the encrypted private key (e.g.,Those generated by an hsm such as thales nshield). | |
avi_credentials: ${18:undefined} # not required. Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
tenant_ref: ${19:undefined} # not required. It is a reference to an object of type tenant. | |
state: ${20|absent,present|} # not required. choices: absent;present. The state that should be applied on the entity. | |
created_by: ${21:undefined} # not required. Creator name. | |
avi_api_patch_op: ${22|add,replace,delete|} # not required. choices: add;replace;delete. Patch operation to use when using avi_api_update_method as patch. | |
tenant: ${23:admin} # not required. Name of tenant used for all Avi API calls and context of object. | |
ca_certs: ${24:undefined} # not required. Ca certificates in certificate chain. | |
type: ${25:undefined} # not required. Enum options - ssl_certificate_type_virtualservice, ssl_certificate_type_system, ssl_certificate_type_ca.,Default value when not specified in API or module is interpreted by Avi Controller as SSL_CERTIFICATE_TYPE_VIRTUALSERVICE. | |
tenant_uuid: ${26:} # not required. UUID of tenant used for all Avi API calls and context of object. | |
api_version: ${27:16.4.4} # not required. Avi API version of to use for Avi API and objects. | |
""" | |
'avi_sslprofile': | |
'prefix': "avi_sslprofile_snippet" | |
'description': "Module for setup of SSLProfile Avi RESTful Object" | |
'body': """ | |
avi_sslprofile: | |
name: ${1:undefined} # required. Name of the object. | |
username: ${2:} # not required. Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). | |
accepted_ciphers: ${3:undefined} # not required. Ciphers suites represented as defined by U(http://www.openssl.org/docs/apps/ciphers.html).,Default value when not specified in API or module is interpreted by Avi Controller as AES:3DES:RC4. | |
prefer_client_cipher_ordering: ${4:undefined} # not required. Prefer the ssl cipher ordering presented by the client during the ssl handshake over the one specified in the ssl profile.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
description: ${5:undefined} # not required. User defined description for the object. | |
tags: ${6:undefined} # not required. List of tag. | |
accepted_versions: ${7:undefined} # not required. Set of versions accepted by the server. | |
controller: ${8:} # not required. IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). | |
state: ${9|absent,present|} # not required. choices: absent;present. The state that should be applied on the entity. | |
api_context: ${10:undefined} # not required. Avi API context that includes current session ID and CSRF Token.,This allows user to perform single login and re-use the session. | |
password: ${11:} # not required. Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). | |
avi_api_update_method: ${12|put,patch|} # not required. choices: put;patch. Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH. | |
ssl_session_timeout: ${13:undefined} # not required. The amount of time before an ssl session expires.,Default value when not specified in API or module is interpreted by Avi Controller as 86400.,Units(SEC). | |
uuid: ${14:undefined} # not required. Unique object identifier of the object. | |
url: ${15:undefined} # not required. Avi controller URL of the object. | |
avi_credentials: ${16:undefined} # not required. Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
tenant_ref: ${17:undefined} # not required. It is a reference to an object of type tenant. | |
avi_api_patch_op: ${18|add,replace,delete|} # not required. choices: add;replace;delete. Patch operation to use when using avi_api_update_method as patch. | |
enable_ssl_session_reuse: ${19:undefined} # not required. Enable ssl session re-use.,Default value when not specified in API or module is interpreted by Avi Controller as True. | |
cipher_enums: ${20:undefined} # not required. Enum options - tls_ecdhe_ecdsa_with_aes_128_gcm_sha256, tls_ecdhe_ecdsa_with_aes_256_gcm_sha384, tls_ecdhe_rsa_with_aes_128_gcm_sha256,,tls_ecdhe_rsa_with_aes_256_gcm_sha384, tls_ecdhe_ecdsa_with_aes_128_cbc_sha256, tls_ecdhe_ecdsa_with_aes_256_cbc_sha384,,tls_ecdhe_rsa_with_aes_128_cbc_sha256, tls_ecdhe_rsa_with_aes_256_cbc_sha384, tls_rsa_with_aes_128_gcm_sha256, tls_rsa_with_aes_256_gcm_sha384,,tls_rsa_with_aes_128_cbc_sha256, tls_rsa_with_aes_256_cbc_sha256, tls_ecdhe_ecdsa_with_aes_128_cbc_sha, tls_ecdhe_ecdsa_with_aes_256_cbc_sha,,tls_ecdhe_rsa_with_aes_128_cbc_sha, tls_ecdhe_rsa_with_aes_256_cbc_sha, tls_rsa_with_aes_128_cbc_sha, tls_rsa_with_aes_256_cbc_sha,,tls_rsa_with_3des_ede_cbc_sha, tls_rsa_with_rc4_128_sha. | |
send_close_notify: ${21:undefined} # not required. Send 'close notify' alert message for a clean shutdown of the ssl connection.,Default value when not specified in API or module is interpreted by Avi Controller as True. | |
tenant: ${22:admin} # not required. Name of tenant used for all Avi API calls and context of object. | |
dhparam: ${23:undefined} # not required. Dh parameters used in ssl.,At this time, it is not configurable and is set to 2048 bits. | |
ssl_rating: ${24:undefined} # not required. Sslrating settings for sslprofile. | |
tenant_uuid: ${25:} # not required. UUID of tenant used for all Avi API calls and context of object. | |
api_version: ${26:16.4.4} # not required. Avi API version of to use for Avi API and objects. | |
""" | |
'avi_stringgroup': | |
'prefix': "avi_stringgroup_snippet" | |
'description': "Module for setup of StringGroup Avi RESTful Object" | |
'body': """ | |
avi_stringgroup: | |
type: ${1:undefined} # required. Type of stringgroup.,Enum options - SG_TYPE_STRING, SG_TYPE_KEYVAL.,Default value when not specified in API or module is interpreted by Avi Controller as SG_TYPE_STRING. | |
name: ${2:undefined} # required. Name of the string group. | |
username: ${3:} # not required. Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). | |
api_version: ${4:16.4.4} # not required. Avi API version of to use for Avi API and objects. | |
uuid: ${5:undefined} # not required. Uuid of the string group. | |
url: ${6:undefined} # not required. Avi controller URL of the object. | |
description: ${7:undefined} # not required. User defined description for the object. | |
avi_credentials: ${8:undefined} # not required. Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
tenant_ref: ${9:undefined} # not required. It is a reference to an object of type tenant. | |
state: ${10|absent,present|} # not required. choices: absent;present. The state that should be applied on the entity. | |
tenant_uuid: ${11:} # not required. UUID of tenant used for all Avi API calls and context of object. | |
avi_api_patch_op: ${12|add,replace,delete|} # not required. choices: add;replace;delete. Patch operation to use when using avi_api_update_method as patch. | |
kv: ${13:undefined} # not required. Configure key value in the string group. | |
api_context: ${14:undefined} # not required. Avi API context that includes current session ID and CSRF Token.,This allows user to perform single login and re-use the session. | |
tenant: ${15:admin} # not required. Name of tenant used for all Avi API calls and context of object. | |
password: ${16:} # not required. Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). | |
controller: ${17:} # not required. IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). | |
avi_api_update_method: ${18|put,patch|} # not required. choices: put;patch. Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH. | |
""" | |
'avi_systemconfiguration': | |
'prefix': "avi_systemconfiguration_snippet" | |
'description': "Module for setup of SystemConfiguration Avi RESTful Object" | |
'body': """ | |
avi_systemconfiguration: | |
username: ${1:} # not required. Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). | |
docker_mode: ${2:undefined} # not required. Boolean flag to set docker_mode.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
dns_configuration: ${3:undefined} # not required. Dnsconfiguration settings for systemconfiguration. | |
proxy_configuration: ${4:undefined} # not required. Proxyconfiguration settings for systemconfiguration. | |
ssh_hmacs: ${5:undefined} # not required. Allowed hmac list for ssh to the management interface on the controller and service engines.,If this is not specified, all the default hmacs are allowed.,Ssh -q mac provides the list of default hmacs supported. | |
controller: ${6:} # not required. IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). | |
linux_configuration: ${7:undefined} # not required. Linuxconfiguration settings for systemconfiguration. | |
url: ${8:undefined} # not required. Avi controller URL of the object. | |
api_context: ${9:undefined} # not required. Avi API context that includes current session ID and CSRF Token.,This allows user to perform single login and re-use the session. | |
password: ${10:} # not required. Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). | |
avi_api_update_method: ${11|put,patch|} # not required. choices: put;patch. Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH. | |
email_configuration: ${12:undefined} # not required. Emailconfiguration settings for systemconfiguration. | |
uuid: ${13:undefined} # not required. Unique object identifier of the object. | |
dns_virtualservice_refs: ${14:undefined} # not required. Dns virtualservices hosting fqdn records for applications across avi vantage.,If no virtualservices are provided, avi vantage will provide dns services for configured applications.,Switching back to avi vantage from dns virtualservices is not allowed.,It is a reference to an object of type virtualservice. | |
default_license_tier: ${15:undefined} # not required. Specifies the default license tier which would be used by new clouds.,Enum options - ENTERPRISE_16, ENTERPRISE_18.,Field introduced in 17.2.5.,Default value when not specified in API or module is interpreted by Avi Controller as ENTERPRISE_18. | |
avi_credentials: ${16:undefined} # not required. Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
state: ${17|absent,present|} # not required. choices: absent;present. The state that should be applied on the entity. | |
global_tenant_config: ${18:undefined} # not required. Tenantconfiguration settings for systemconfiguration. | |
snmp_configuration: ${19:undefined} # not required. Snmpconfiguration settings for systemconfiguration. | |
avi_api_patch_op: ${20|add,replace,delete|} # not required. choices: add;replace;delete. Patch operation to use when using avi_api_update_method as patch. | |
tenant: ${21:admin} # not required. Name of tenant used for all Avi API calls and context of object. | |
ntp_configuration: ${22:undefined} # not required. Ntpconfiguration settings for systemconfiguration. | |
admin_auth_configuration: ${23:undefined} # not required. Adminauthconfiguration settings for systemconfiguration. | |
mgmt_ip_access_control: ${24:undefined} # not required. Configure ip access control for controller to restrict open access. | |
ssh_ciphers: ${25:undefined} # not required. Allowed ciphers list for ssh to the management interface on the controller and service engines.,If this is not specified, all the default ciphers are allowed.,Ssh -q cipher provides the list of default ciphers supported. | |
tenant_uuid: ${26:} # not required. UUID of tenant used for all Avi API calls and context of object. | |
api_version: ${27:16.4.4} # not required. Avi API version of to use for Avi API and objects. | |
portal_configuration: ${28:undefined} # not required. Portalconfiguration settings for systemconfiguration. | |
""" | |
'avi_tenant': | |
'prefix': "avi_tenant_snippet" | |
'description': "Module for setup of Tenant Avi RESTful Object" | |
'body': """ | |
avi_tenant: | |
name: ${1:undefined} # required. Name of the object. | |
username: ${2:} # not required. Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). | |
password: ${3:} # not required. Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). | |
uuid: ${4:undefined} # not required. Unique object identifier of the object. | |
api_version: ${5:16.4.4} # not required. Avi API version of to use for Avi API and objects. | |
url: ${6:undefined} # not required. Avi controller URL of the object. | |
avi_credentials: ${7:undefined} # not required. Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
controller: ${8:} # not required. IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). | |
state: ${9|absent,present|} # not required. choices: absent;present. The state that should be applied on the entity. | |
created_by: ${10:undefined} # not required. Creator of this tenant. | |
avi_api_patch_op: ${11|add,replace,delete|} # not required. choices: add;replace;delete. Patch operation to use when using avi_api_update_method as patch. | |
tenant: ${12:admin} # not required. Name of tenant used for all Avi API calls and context of object. | |
api_context: ${13:undefined} # not required. Avi API context that includes current session ID and CSRF Token.,This allows user to perform single login and re-use the session. | |
config_settings: ${14:undefined} # not required. Tenantconfiguration settings for tenant. | |
local: ${15:undefined} # not required. Boolean flag to set local.,Default value when not specified in API or module is interpreted by Avi Controller as True. | |
tenant_uuid: ${16:} # not required. UUID of tenant used for all Avi API calls and context of object. | |
avi_api_update_method: ${17|put,patch|} # not required. choices: put;patch. Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH. | |
description: ${18:undefined} # not required. User defined description for the object. | |
""" | |
'avi_trafficcloneprofile': | |
'prefix': "avi_trafficcloneprofile_snippet" | |
'description': "Module for setup of TrafficCloneProfile Avi RESTful Object" | |
'body': """ | |
avi_trafficcloneprofile: | |
name: ${1:undefined} # required. Name for the traffic clone profile.,Field introduced in 17.1.1. | |
username: ${2:} # not required. Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). | |
password: ${3:} # not required. Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). | |
uuid: ${4:undefined} # not required. Uuid of the traffic clone profile.,Field introduced in 17.1.1. | |
api_version: ${5:16.4.4} # not required. Avi API version of to use for Avi API and objects. | |
cloud_ref: ${6:undefined} # not required. It is a reference to an object of type cloud.,Field introduced in 17.1.1. | |
avi_credentials: ${7:undefined} # not required. Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
tenant_ref: ${8:undefined} # not required. It is a reference to an object of type tenant.,Field introduced in 17.1.1. | |
state: ${9|absent,present|} # not required. choices: absent;present. The state that should be applied on the entity. | |
tenant_uuid: ${10:} # not required. UUID of tenant used for all Avi API calls and context of object. | |
url: ${11:undefined} # not required. Avi controller URL of the object. | |
avi_api_patch_op: ${12|add,replace,delete|} # not required. choices: add;replace;delete. Patch operation to use when using avi_api_update_method as patch. | |
tenant: ${13:admin} # not required. Name of tenant used for all Avi API calls and context of object. | |
api_context: ${14:undefined} # not required. Avi API context that includes current session ID and CSRF Token.,This allows user to perform single login and re-use the session. | |
clone_servers: ${15:undefined} # not required. Field introduced in 17.1.1. | |
preserve_client_ip: ${16:undefined} # not required. Specifies if client ip needs to be preserved to clone destination.,Field introduced in 17.1.1.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
controller: ${17:} # not required. IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). | |
avi_api_update_method: ${18|put,patch|} # not required. choices: put;patch. Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH. | |
""" | |
'avi_useraccountprofile': | |
'prefix': "avi_useraccountprofile_snippet" | |
'description': "Module for setup of UserAccountProfile Avi RESTful Object" | |
'body': """ | |
avi_useraccountprofile: | |
name: ${1:undefined} # required. Name of the object. | |
username: ${2:} # not required. Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). | |
max_concurrent_sessions: ${3:undefined} # not required. Maximum number of concurrent sessions allowed.,There are unlimited sessions by default.,Default value when not specified in API or module is interpreted by Avi Controller as 0. | |
password: ${4:} # not required. Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). | |
uuid: ${5:undefined} # not required. Unique object identifier of the object. | |
state: ${6|absent,present|} # not required. choices: absent;present. The state that should be applied on the entity. | |
url: ${7:undefined} # not required. Avi controller URL of the object. | |
avi_credentials: ${8:undefined} # not required. Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
controller: ${9:} # not required. IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). | |
account_lock_timeout: ${10:undefined} # not required. Lock timeout period (in minutes).,Default is 30 minutes.,Default value when not specified in API or module is interpreted by Avi Controller as 30.,Units(MIN). | |
api_version: ${11:16.4.4} # not required. Avi API version of to use for Avi API and objects. | |
avi_api_patch_op: ${12|add,replace,delete|} # not required. choices: add;replace;delete. Patch operation to use when using avi_api_update_method as patch. | |
max_login_failure_count: ${13:undefined} # not required. Number of login attempts before lockout.,Default is 3 attempts.,Default value when not specified in API or module is interpreted by Avi Controller as 3. | |
tenant: ${14:admin} # not required. Name of tenant used for all Avi API calls and context of object. | |
api_context: ${15:undefined} # not required. Avi API context that includes current session ID and CSRF Token.,This allows user to perform single login and re-use the session. | |
max_password_history_count: ${16:undefined} # not required. Maximum number of passwords to be maintained in the password history.,Default is 4 passwords.,Default value when not specified in API or module is interpreted by Avi Controller as 4. | |
credentials_timeout_threshold: ${17:undefined} # not required. The time period after which credentials expire.,Default is 180 days.,Default value when not specified in API or module is interpreted by Avi Controller as 180.,Units(DAYS). | |
tenant_uuid: ${18:} # not required. UUID of tenant used for all Avi API calls and context of object. | |
avi_api_update_method: ${19|put,patch|} # not required. choices: put;patch. Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH. | |
""" | |
'avi_virtualservice': | |
'prefix': "avi_virtualservice_snippet" | |
'description': "Module for setup of VirtualService Avi RESTful Object" | |
'body': """ | |
avi_virtualservice: | |
name: ${1:undefined} # required. Name for the virtual service. | |
client_auth: ${2:undefined} # not required. Http authentication configuration for protected resources. | |
port_uuid: ${3:undefined} # not required. (internal-use) network port assigned to the virtual service ip address.,Field deprecated in 17.1.1. | |
availability_zone: ${4:undefined} # not required. Availability-zone to place the virtual service.,Field deprecated in 17.1.1. | |
error_page_profile_ref: ${5:undefined} # not required. Error page profile to be used for this virtualservice.this profile is used to send the custom error page to the client generated by the proxy.,It is a reference to an object of type errorpageprofile.,Field introduced in 17.2.4. | |
subnet_uuid: ${6:undefined} # not required. It represents subnet for the virtual service ip address allocation when auto_allocate_ip is true.it is only applicable in openstack or aws cloud.,This field is required if auto_allocate_ip is true.,Field deprecated in 17.1.1. | |
delay_fairness: ${7:undefined} # not required. Select the algorithm for qos fairness.,This determines how multiple virtual services sharing the same service engines will prioritize traffic over a congested network.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
vip: ${8:undefined} # not required. List of virtual service ips.,While creating a 'shared vs',please use vsvip_ref to point to the shared entities.,Field introduced in 17.1.1. | |
static_dns_records: ${9:undefined} # not required. List of static dns records applied to this virtual service.,These are static entries and no health monitoring is performed against the ip addresses. | |
enable_rhi_snat: ${10:undefined} # not required. Enable route health injection for source nat'ted floating ip address using the bgp config in the vrf context. | |
sideband_profile: ${11:undefined} # not required. Sideband configuration to be used for this virtualservice.it can be used for sending traffic to sideband vips for external inspection etc. | |
requests_rate_limit: ${12:undefined} # not required. Rate limit the incoming requests to this virtual service. | |
analytics_profile_ref: ${13:undefined} # not required. Specifies settings related to analytics.,It is a reference to an object of type analyticsprofile. | |
uuid: ${14:undefined} # not required. Uuid of the virtualservice. | |
ipam_network_subnet: ${15:undefined} # not required. Subnet and/or network for allocating virtualservice ip by ipam provider module.,Field deprecated in 17.1.1. | |
avi_allocated_fip: ${16:undefined} # not required. (internal-use) fip allocated by avi in the cloud infrastructure.,Field deprecated in 17.1.1.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
ssl_profile_ref: ${17:undefined} # not required. Determines the set of ssl versions and ciphers to accept for ssl/tls terminated connections.,It is a reference to an object of type sslprofile. | |
created_by: ${18:undefined} # not required. Creator name. | |
discovered_network_ref: ${19:undefined} # not required. (internal-use) discovered networks providing reachability for client facing virtual service ip.,This field is deprecated.,It is a reference to an object of type network.,Field deprecated in 17.1.1. | |
max_cps_per_client: ${20:undefined} # not required. Maximum connections per second per client ip.,Allowed values are 10-1000.,Special values are 0- 'unlimited'.,Default value when not specified in API or module is interpreted by Avi Controller as 0. | |
avi_credentials: ${21:undefined} # not required. Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
pool_group_ref: ${22:undefined} # not required. The pool group is an object that contains pools.,It is a reference to an object of type poolgroup. | |
ssl_sess_cache_avg_size: ${23:undefined} # not required. Expected number of ssl session cache entries (may be exceeded).,Allowed values are 1024-16383.,Default value when not specified in API or module is interpreted by Avi Controller as 1024. | |
vs_datascripts: ${24:undefined} # not required. Datascripts applied on the data traffic of the virtual service. | |
username: ${25:} # not required. Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). | |
flow_dist: ${26:undefined} # not required. Criteria for flow distribution among ses.,Enum options - LOAD_AWARE, CONSISTENT_HASH_SOURCE_IP_ADDRESS, CONSISTENT_HASH_SOURCE_IP_ADDRESS_AND_PORT.,Default value when not specified in API or module is interpreted by Avi Controller as LOAD_AWARE. | |
http_policies: ${27:undefined} # not required. Http policies applied on the data traffic of the virtual service. | |
application_profile_ref: ${28:undefined} # not required. Enable application layer specific features for the virtual service.,It is a reference to an object of type applicationprofile. | |
microservice_ref: ${29:undefined} # not required. Microservice representing the virtual service.,It is a reference to an object of type microservice. | |
controller: ${30:} # not required. IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). | |
use_vip_as_snat: ${31:undefined} # not required. Use the virtual ip as the snat ip for health monitoring and sending traffic to the backend servers instead of the service engine interface ip.,The caveat of enabling this option is that the virtualservice cannot be configued in an active-active ha mode.,Dns based multi vip solution has to be used for ha & non-disruptive upgrade purposes.,Field introduced in 17.1.9,17.2.3.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
api_context: ${32:undefined} # not required. Avi API context that includes current session ID and CSRF Token.,This allows user to perform single login and re-use the session. | |
password: ${33:} # not required. Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). | |
ip_address: ${34:undefined} # not required. Ip address of the virtual service.,Field deprecated in 17.1.1. | |
avi_api_update_method: ${35|put,patch|} # not required. choices: put;patch. Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH. | |
east_west_placement: ${36:undefined} # not required. Force placement on all se's in service group (mesos mode only).,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
floating_subnet_uuid: ${37:undefined} # not required. If auto_allocate_floating_ip is true and more than one floating-ip subnets exist, then the subnet for the floating ip address allocation.,This field is applicable only if the virtualservice belongs to an openstack or aws cloud.,In openstack or aws cloud it is required when auto_allocate_floating_ip is selected.,Field deprecated in 17.1.1. | |
service_pool_select: ${38:undefined} # not required. Select pool based on destination port. | |
close_client_conn_on_config_update: ${39:undefined} # not required. Close client connection on vs config update.,Field introduced in 17.2.4.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
type: ${40:undefined} # not required. Specify if this is a normal virtual service, or if it is the parent or child of an sni-enabled virtual hosted virtual service.,Enum options - VS_TYPE_NORMAL, VS_TYPE_VH_PARENT, VS_TYPE_VH_CHILD.,Default value when not specified in API or module is interpreted by Avi Controller as VS_TYPE_NORMAL. | |
enable_autogw: ${41:undefined} # not required. Response traffic to clients will be sent back to the source mac address of the connection, rather than statically sent to a default gateway.,Default value when not specified in API or module is interpreted by Avi Controller as True. | |
discovered_networks: ${42:undefined} # not required. (internal-use) discovered networks providing reachability for client facing virtual service ip.,This field is used internally by avi, not editable by the user.,Field deprecated in 17.1.1. | |
tenant_ref: ${43:undefined} # not required. It is a reference to an object of type tenant. | |
remove_listening_port_on_vs_down: ${44:undefined} # not required. Remove listening port if virtualservice is down.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
ssl_key_and_certificate_refs: ${45:undefined} # not required. Select or create one or two certificates, ec and/or rsa, that will be presented to ssl/tls terminated connections.,It is a reference to an object of type sslkeyandcertificate. | |
snat_ip: ${46:undefined} # not required. Nat'ted floating source ip address(es) for upstream connection to servers. | |
host_name_xlate: ${47:undefined} # not required. Translate the host name sent to the servers to this value.,Translate the host name sent from servers back to the value used by the client. | |
analytics_policy: ${48:undefined} # not required. Determines analytics settings for the application. | |
sp_pool_refs: ${49:undefined} # not required. Gslb pools used to manage site-persistence functionality.,Each site-persistence pool contains the virtualservices in all the other sites, that is auto-generated by the gslb manager.,This is a read-only field for the user.,It is a reference to an object of type pool.,Field introduced in 17.2.2. | |
flow_label_type: ${50:undefined} # not required. Criteria for flow labelling.,Enum options - NO_LABEL, APPLICATION_LABEL, SERVICE_LABEL.,Default value when not specified in API or module is interpreted by Avi Controller as NO_LABEL. | |
network_profile_ref: ${51:undefined} # not required. Determines network settings such as protocol, tcp or udp, and related options for the protocol.,It is a reference to an object of type networkprofile. | |
weight: ${52:undefined} # not required. The quality of service weight to assign to traffic transmitted from this virtual service.,A higher weight will prioritize traffic versus other virtual services sharing the same service engines.,Allowed values are 1-128.,Default value when not specified in API or module is interpreted by Avi Controller as 1. | |
dns_info: ${53:undefined} # not required. Service discovery specific data including fully qualified domain name, type and time-to-live of the dns record.,Note that only one of fqdn and dns_info setting is allowed. | |
content_rewrite: ${54:undefined} # not required. Profile used to match and rewrite strings in request and/or response body. | |
traffic_clone_profile_ref: ${55:undefined} # not required. Server network or list of servers for cloning traffic.,It is a reference to an object of type trafficcloneprofile.,Field introduced in 17.1.1. | |
avi_allocated_vip: ${56:undefined} # not required. (internal-use) vip allocated by avi in the cloud infrastructure.,Field deprecated in 17.1.1.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
vrf_context_ref: ${57:undefined} # not required. Virtual routing context that the virtual service is bound to.,This is used to provide the isolation of the set of networks the application is attached to.,It is a reference to an object of type vrfcontext. | |
description: ${58:undefined} # not required. User defined description for the object. | |
subnet: ${59:undefined} # not required. Subnet providing reachability for client facing virtual service ip.,Field deprecated in 17.1.1. | |
service_metadata: ${60:undefined} # not required. Metadata pertaining to the service provided by this virtual service.,In openshift/kubernetes environments, egress pod info is stored.,Any user input to this field will be overwritten by avi vantage. | |
cloud_type: ${61:undefined} # not required. Enum options - cloud_none, cloud_vcenter, cloud_openstack, cloud_aws, cloud_vca, cloud_apic, cloud_mesos, cloud_linuxserver, cloud_docker_ucp,,cloud_rancher, cloud_oshift_k8s, cloud_azure.,Default value when not specified in API or module is interpreted by Avi Controller as CLOUD_NONE. | |
vh_domain_name: ${62:undefined} # not required. The exact name requested from the client's sni-enabled tls hello domain name field.,If this is a match, the parent vs will forward the connection to this child vs. | |
cloud_ref: ${63:undefined} # not required. It is a reference to an object of type cloud. | |
enable_rhi: ${64:undefined} # not required. Enable route health injection using the bgp config in the vrf context. | |
se_group_ref: ${65:undefined} # not required. The service engine group to use for this virtual service.,Moving to a new se group is disruptive to existing connections for this vs.,It is a reference to an object of type serviceenginegroup. | |
waf_policy_ref: ${66:undefined} # not required. Waf policy for the virtual service.,It is a reference to an object of type wafpolicy.,Field introduced in 17.2.1. | |
network_ref: ${67:undefined} # not required. Manually override the network on which the virtual service is placed.,It is a reference to an object of type network.,Field deprecated in 17.1.1. | |
scaleout_ecmp: ${68:undefined} # not required. Disable re-distribution of flows across service engines for a virtual service.,Enable if the network itself performs flow hashing with ecmp in environments such as gcp.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
state: ${69|absent,present|} # not required. choices: absent;present. The state that should be applied on the entity. | |
nsx_securitygroup: ${70:undefined} # not required. A list of nsx service groups representing the clients which can access the virtual ip of the virtual service.,Field introduced in 17.1.1. | |
cloud_config_cksum: ${71:undefined} # not required. Checksum of cloud configuration for vs.,Internally set by cloud connector. | |
api_version: ${72:16.4.4} # not required. Avi API version of to use for Avi API and objects. | |
tenant_uuid: ${73:} # not required. UUID of tenant used for all Avi API calls and context of object. | |
vsvip_ref: ${74:undefined} # not required. Mostly used during the creation of shared vs, this field refers to entities that can be shared across virtual services.,It is a reference to an object of type vsvip.,Field introduced in 17.1.1. | |
performance_limits: ${75:undefined} # not required. Optional settings that determine performance limits like max connections or bandwdith etc. | |
use_bridge_ip_as_vip: ${76:undefined} # not required. Use bridge ip as vip on each host in mesos deployments.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
enabled: ${77:undefined} # not required. Enable or disable the virtual service.,Default value when not specified in API or module is interpreted by Avi Controller as True. | |
floating_ip: ${78:undefined} # not required. Floating ip to associate with this virtual service.,Field deprecated in 17.1.1. | |
auto_allocate_floating_ip: ${79:undefined} # not required. Auto-allocate floating/elastic ip from the cloud infrastructure.,Field deprecated in 17.1.1.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
avi_api_patch_op: ${80|add,replace,delete|} # not required. choices: add;replace;delete. Patch operation to use when using avi_api_update_method as patch. | |
vh_parent_vs_uuid: ${81:undefined} # not required. Specifies the virtual service acting as virtual hosting (sni) parent. | |
services: ${82:undefined} # not required. List of services defined for this virtual service. | |
connections_rate_limit: ${83:undefined} # not required. Rate limit the incoming connections to this virtual service. | |
active_standby_se_tag: ${84:undefined} # not required. This configuration only applies if the virtualservice is in legacy active standby ha mode and load distribution among active standby is enabled.,This field is used to tag the virtualservice so that virtualservices with the same tag will share the same active serviceengine.,Virtualservices with different tags will have different active serviceengines.,If one of the serviceengine's in the serviceenginegroup fails, all virtualservices will end up using the same active serviceengine.,Redistribution of the virtualservices can be either manual or automated when the failed serviceengine recovers.,Redistribution is based on the auto redistribute property of the serviceenginegroup.,Enum options - ACTIVE_STANDBY_SE_1, ACTIVE_STANDBY_SE_2.,Default value when not specified in API or module is interpreted by Avi Controller as ACTIVE_STANDBY_SE_1. | |
pool_ref: ${85:undefined} # not required. The pool is an object that contains destination servers and related attributes such as load-balancing and persistence.,It is a reference to an object of type pool. | |
ign_pool_net_reach: ${86:undefined} # not required. Ignore pool servers network reachability constraints for virtual service placement.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
tenant: ${87:admin} # not required. Name of tenant used for all Avi API calls and context of object. | |
limit_doser: ${88:undefined} # not required. Limit potential dos attackers who exceed max_cps_per_client significantly to a fraction of max_cps_per_client for a while.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
url: ${89:undefined} # not required. Avi controller URL of the object. | |
auto_allocate_ip: ${90:undefined} # not required. Auto-allocate vip from the provided subnet.,Field deprecated in 17.1.1.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
fqdn: ${91:undefined} # not required. Dns resolvable, fully qualified domain name of the virtualservice.,Only one of 'fqdn' and 'dns_info' configuration is allowed. | |
network_security_policy_ref: ${92:undefined} # not required. Network security policies for the virtual service.,It is a reference to an object of type networksecuritypolicy. | |
dns_policies: ${93:undefined} # not required. Dns policies applied on the dns traffic of the virtual service.,Field introduced in 17.1.1. | |
server_network_profile_ref: ${94:undefined} # not required. Determines the network settings profile for the server side of tcp proxied connections.,Leave blank to use the same settings as the client to vs side of the connection.,It is a reference to an object of type networkprofile. | |
discovered_subnet: ${95:undefined} # not required. (internal-use) discovered subnets providing reachability for client facing virtual service ip.,This field is deprecated.,Field deprecated in 17.1.1. | |
""" | |
'avi_vrfcontext': | |
'prefix': "avi_vrfcontext_snippet" | |
'description': "Module for setup of VrfContext Avi RESTful Object" | |
'body': """ | |
avi_vrfcontext: | |
name: ${1:undefined} # required. Name of the object. | |
system_default: ${2:undefined} # not required. Boolean flag to set system_default.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
uuid: ${3:undefined} # not required. Unique object identifier of the object. | |
cloud_ref: ${4:undefined} # not required. It is a reference to an object of type cloud. | |
state: ${5|absent,present|} # not required. choices: absent;present. The state that should be applied on the entity. | |
avi_api_patch_op: ${6|add,replace,delete|} # not required. choices: add;replace;delete. Patch operation to use when using avi_api_update_method as patch. | |
avi_credentials: ${7:undefined} # not required. Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
tenant: ${8:admin} # not required. Name of tenant used for all Avi API calls and context of object. | |
gateway_mon: ${9:undefined} # not required. Configure ping based heartbeat check for gateway in service engines of vrf. | |
bgp_profile: ${10:undefined} # not required. Bgp local and peer info. | |
username: ${11:} # not required. Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). | |
description: ${12:undefined} # not required. User defined description for the object. | |
controller: ${13:} # not required. IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). | |
api_context: ${14:undefined} # not required. Avi API context that includes current session ID and CSRF Token.,This allows user to perform single login and re-use the session. | |
password: ${15:} # not required. Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). | |
avi_api_update_method: ${16|put,patch|} # not required. choices: put;patch. Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH. | |
internal_gateway_monitor: ${17:undefined} # not required. Configure ping based heartbeat check for all default gateways in service engines of vrf.,Field introduced in 17.1.1. | |
static_routes: ${18:undefined} # not required. List of staticroute. | |
url: ${19:undefined} # not required. Avi controller URL of the object. | |
tenant_ref: ${20:undefined} # not required. It is a reference to an object of type tenant. | |
debugvrfcontext: ${21:undefined} # not required. Configure debug flags for vrf.,Field introduced in 17.1.1. | |
api_version: ${22:16.4.4} # not required. Avi API version of to use for Avi API and objects. | |
tenant_uuid: ${23:} # not required. UUID of tenant used for all Avi API calls and context of object. | |
""" | |
'avi_vsdatascriptset': | |
'prefix': "avi_vsdatascriptset_snippet" | |
'description': "Module for setup of VSDataScriptSet Avi RESTful Object" | |
'body': """ | |
avi_vsdatascriptset: | |
name: ${1:undefined} # required. Name for the virtual service datascript collection. | |
pool_refs: ${2:undefined} # not required. Uuid of pools that could be referred by vsdatascriptset objects.,It is a reference to an object of type pool. | |
pool_group_refs: ${3:undefined} # not required. Uuid of pool groups that could be referred by vsdatascriptset objects.,It is a reference to an object of type poolgroup. | |
string_group_refs: ${4:undefined} # not required. Uuid of string groups that could be referred by vsdatascriptset objects.,It is a reference to an object of type stringgroup. | |
ipgroup_refs: ${5:undefined} # not required. Uuid of ip groups that could be referred by vsdatascriptset objects.,It is a reference to an object of type ipaddrgroup. | |
uuid: ${6:undefined} # not required. Uuid of the virtual service datascript collection. | |
avi_credentials: ${7:undefined} # not required. Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
created_by: ${8:undefined} # not required. Creator name.,Field introduced in 17.1.11,17.2.4. | |
avi_api_patch_op: ${9|add,replace,delete|} # not required. choices: add;replace;delete. Patch operation to use when using avi_api_update_method as patch. | |
state: ${10|absent,present|} # not required. choices: absent;present. The state that should be applied on the entity. | |
avi_api_update_method: ${11|put,patch|} # not required. choices: put;patch. Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH. | |
api_version: ${12:16.4.4} # not required. Avi API version of to use for Avi API and objects. | |
username: ${13:} # not required. Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). | |
description: ${14:undefined} # not required. User defined description for the object. | |
controller: ${15:} # not required. IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). | |
api_context: ${16:undefined} # not required. Avi API context that includes current session ID and CSRF Token.,This allows user to perform single login and re-use the session. | |
password: ${17:} # not required. Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). | |
tenant: ${18:admin} # not required. Name of tenant used for all Avi API calls and context of object. | |
datascript: ${19:undefined} # not required. Datascripts to execute. | |
url: ${20:undefined} # not required. Avi controller URL of the object. | |
tenant_ref: ${21:undefined} # not required. It is a reference to an object of type tenant. | |
tenant_uuid: ${22:} # not required. UUID of tenant used for all Avi API calls and context of object. | |
""" | |
'avi_vsvip': | |
'prefix': "avi_vsvip_snippet" | |
'description': "Module for setup of VsVip Avi RESTful Object" | |
'body': """ | |
avi_vsvip: | |
name: ${1:undefined} # required. Name for the vsvip object.,Field introduced in 17.1.1. | |
east_west_placement: ${2:undefined} # not required. Force placement on all service engines in the service engine group (container clouds only).,Field introduced in 17.1.1.,Default value when not specified in API or module is interpreted by Avi Controller as False. | |
username: ${3:} # not required. Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). | |
password: ${4:} # not required. Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). | |
api_version: ${5:16.4.4} # not required. Avi API version of to use for Avi API and objects. | |
state: ${6|absent,present|} # not required. choices: absent;present. The state that should be applied on the entity. | |
cloud_ref: ${7:undefined} # not required. It is a reference to an object of type cloud.,Field introduced in 17.1.1. | |
dns_info: ${8:undefined} # not required. Service discovery specific data including fully qualified domain name, type and time-to-live of the dns record.,Field introduced in 17.1.1. | |
avi_credentials: ${9:undefined} # not required. Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
tenant_ref: ${10:undefined} # not required. It is a reference to an object of type tenant.,Field introduced in 17.1.1. | |
avi_api_patch_op: ${11|add,replace,delete|} # not required. choices: add;replace;delete. Patch operation to use when using avi_api_update_method as patch. | |
tenant_uuid: ${12:} # not required. UUID of tenant used for all Avi API calls and context of object. | |
url: ${13:undefined} # not required. Avi controller URL of the object. | |
vip: ${14:undefined} # not required. List of virtual service ips and other shareable entities.,Field introduced in 17.1.1. | |
tenant: ${15:admin} # not required. Name of tenant used for all Avi API calls and context of object. | |
api_context: ${16:undefined} # not required. Avi API context that includes current session ID and CSRF Token.,This allows user to perform single login and re-use the session. | |
vrf_context_ref: ${17:undefined} # not required. Virtual routing context that the virtual service is bound to.,This is used to provide the isolation of the set of networks the application is attached to.,It is a reference to an object of type vrfcontext.,Field introduced in 17.1.1. | |
controller: ${18:} # not required. IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). | |
avi_api_update_method: ${19|put,patch|} # not required. choices: put;patch. Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH. | |
uuid: ${20:undefined} # not required. Uuid of the vsvip object.,Field introduced in 17.1.1. | |
""" | |
'avi_wafpolicy': | |
'prefix': "avi_wafpolicy_snippet" | |
'description': "Module for setup of WafPolicy Avi RESTful Object" | |
'body': """ | |
avi_wafpolicy: | |
name: ${1:undefined} # required. Field introduced in 17.2.1. | |
waf_profile_ref: ${2:undefined} # required. Waf profile for waf policy.,It is a reference to an object of type wafprofile.,Field introduced in 17.2.1. | |
mode: ${3:undefined} # required. Waf policy mode.,This can be detection or enforcement.,Enum options - WAF_MODE_DETECTION_ONLY, WAF_MODE_ENFORCEMENT.,Field introduced in 17.2.1.,Default value when not specified in API or module is interpreted by Avi Controller as WAF_MODE_DETECTION_ONLY. | |
pre_crs_groups: ${4:undefined} # not required. Waf rules are categorized in to groups based on their characterization.,These groups are created by the user and will be enforced before the crs groups.,Field introduced in 17.2.1. | |
uuid: ${5:undefined} # not required. Field introduced in 17.2.1. | |
post_crs_groups: ${6:undefined} # not required. Waf rules are categorized in to groups based on their characterization.,These groups are created by the user and will be enforced after the crs groups.,Field introduced in 17.2.1. | |
state: ${7|absent,present|} # not required. choices: absent;present. The state that should be applied on the entity. | |
created_by: ${8:undefined} # not required. Creator name.,Field introduced in 17.2.4. | |
avi_api_patch_op: ${9|add,replace,delete|} # not required. choices: add;replace;delete. Patch operation to use when using avi_api_update_method as patch. | |
avi_credentials: ${10:undefined} # not required. Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
avi_api_update_method: ${11|put,patch|} # not required. choices: put;patch. Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH. | |
api_version: ${12:16.4.4} # not required. Avi API version of to use for Avi API and objects. | |
username: ${13:} # not required. Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). | |
description: ${14:undefined} # not required. Field introduced in 17.2.1. | |
crs_groups: ${15:undefined} # not required. Waf rules are categorized in to groups based on their characterization.,These groups are system created with crs groups.,Field introduced in 17.2.1. | |
controller: ${16:} # not required. IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). | |
api_context: ${17:undefined} # not required. Avi API context that includes current session ID and CSRF Token.,This allows user to perform single login and re-use the session. | |
password: ${18:} # not required. Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). | |
paranoia_level: ${19:undefined} # not required. Waf ruleset paranoia mode.,This is used to select rules based on the paranoia-level tag.,Enum options - WAF_PARANOIA_LEVEL_LOW, WAF_PARANOIA_LEVEL_MEDIUM, WAF_PARANOIA_LEVEL_HIGH, WAF_PARANOIA_LEVEL_EXTREME.,Field introduced in 17.2.1.,Default value when not specified in API or module is interpreted by Avi Controller as WAF_PARANOIA_LEVEL_LOW. | |
tenant: ${20:admin} # not required. Name of tenant used for all Avi API calls and context of object. | |
url: ${21:undefined} # not required. Avi controller URL of the object. | |
tenant_ref: ${22:undefined} # not required. It is a reference to an object of type tenant.,Field introduced in 17.2.1. | |
tenant_uuid: ${23:} # not required. UUID of tenant used for all Avi API calls and context of object. | |
""" | |
'avi_wafprofile': | |
'prefix': "avi_wafprofile_snippet" | |
'description': "Module for setup of WafProfile Avi RESTful Object" | |
'body': """ | |
avi_wafprofile: | |
name: ${1:undefined} # required. Field introduced in 17.2.1. | |
config: ${2:undefined} # required. Config params for waf.,Field introduced in 17.2.1. | |
files: ${3:undefined} # not required. List of data files used for waf rules.,Field introduced in 17.2.1. | |
username: ${4:} # not required. Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). | |
api_version: ${5:16.4.4} # not required. Avi API version of to use for Avi API and objects. | |
uuid: ${6:undefined} # not required. Field introduced in 17.2.1. | |
tenant_uuid: ${7:} # not required. UUID of tenant used for all Avi API calls and context of object. | |
url: ${8:undefined} # not required. Avi controller URL of the object. | |
avi_credentials: ${9:undefined} # not required. Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
tenant_ref: ${10:undefined} # not required. It is a reference to an object of type tenant.,Field introduced in 17.2.1. | |
state: ${11|absent,present|} # not required. choices: absent;present. The state that should be applied on the entity. | |
avi_api_patch_op: ${12|add,replace,delete|} # not required. choices: add;replace;delete. Patch operation to use when using avi_api_update_method as patch. | |
tenant: ${13:admin} # not required. Name of tenant used for all Avi API calls and context of object. | |
api_context: ${14:undefined} # not required. Avi API context that includes current session ID and CSRF Token.,This allows user to perform single login and re-use the session. | |
password: ${15:} # not required. Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). | |
controller: ${16:} # not required. IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). | |
avi_api_update_method: ${17|put,patch|} # not required. choices: put;patch. Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH. | |
description: ${18:undefined} # not required. Field introduced in 17.2.1. | |
""" | |
'avi_webhook': | |
'prefix': "avi_webhook_snippet" | |
'description': "Module for setup of Webhook Avi RESTful Object" | |
'body': """ | |
avi_webhook: | |
name: ${1:undefined} # required. The name of the webhook profile.,Field introduced in 17.1.1. | |
username: ${2:} # not required. Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). | |
password: ${3:} # not required. Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). | |
uuid: ${4:undefined} # not required. Uuid of the webhook profile.,Field introduced in 17.1.1. | |
api_version: ${5:16.4.4} # not required. Avi API version of to use for Avi API and objects. | |
url: ${6:undefined} # not required. Avi controller URL of the object. | |
description: ${7:undefined} # not required. Field introduced in 17.1.1. | |
avi_credentials: ${8:undefined} # not required. Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
tenant_ref: ${9:undefined} # not required. It is a reference to an object of type tenant.,Field introduced in 17.1.1. | |
state: ${10|absent,present|} # not required. choices: absent;present. The state that should be applied on the entity. | |
tenant_uuid: ${11:} # not required. UUID of tenant used for all Avi API calls and context of object. | |
verification_token: ${12:undefined} # not required. Verification token sent back with the callback asquery parameters.,Field introduced in 17.1.1. | |
avi_api_patch_op: ${13|add,replace,delete|} # not required. choices: add;replace;delete. Patch operation to use when using avi_api_update_method as patch. | |
tenant: ${14:admin} # not required. Name of tenant used for all Avi API calls and context of object. | |
api_context: ${15:undefined} # not required. Avi API context that includes current session ID and CSRF Token.,This allows user to perform single login and re-use the session. | |
callback_url: ${16:undefined} # not required. Callback url for the webhook.,Field introduced in 17.1.1. | |
controller: ${17:} # not required. IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). | |
avi_api_update_method: ${18|put,patch|} # not required. choices: put;patch. Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH. | |
""" | |
'awall': | |
'prefix': "awall_snippet" | |
'description': "Manage awall policies" | |
'body': """ | |
awall: | |
state: ${1|enabled,disabled|} # not required. choices: enabled;disabled. The policy(ies) will be C(enabled),The policy(ies) will be C(disabled) | |
activate: ${2:false} # not required. Activate the new firewall rules. Can be run with other steps or on it's own. | |
name: ${3:null} # not required. A policy name, like C(foo), or multiple policies, like C(foo, bar). | |
""" | |
'aws_acm_facts': | |
'prefix': "aws_acm_facts_snippet" | |
'description': "Retrieve certificate facts from AWS Certificate Manager service" | |
'body': """ | |
aws_acm_facts: | |
status: ${1|PENDING_VALIDATION,ISSUED,INACTIVE,EXPIRED,VALIDATION_TIMED_OUT|} # not required. choices: PENDING_VALIDATION;ISSUED;INACTIVE;EXPIRED;VALIDATION_TIMED_OUT. Status to filter the certificate results | |
aws_secret_key: ${2:null} # not required. AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used. | |
aws_access_key: ${3:null} # not required. AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used. | |
name: ${4:undefined} # not required. The name of an ACM certificate | |
security_token: ${5:null} # not required. AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used. | |
region: ${6:undefined} # not required. The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region) | |
profile: ${7:null} # not required. Uses a boto profile. Only works with boto >= 2.24.0. | |
ec2_url: ${8:null} # not required. Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used. | |
validate_certs: ${9:yes} # not required. When set to \"no\", SSL certificates will not be validated for boto versions >= 2.6.0. | |
""" | |
'aws_api_gateway': | |
'prefix': "aws_api_gateway_snippet" | |
'description': "Manage AWS API Gateway APIs" | |
'body': """ | |
aws_api_gateway: | |
profile: ${1:null} # not required. Uses a boto profile. Only works with boto >= 2.24.0. | |
swagger_file: ${2:undefined} # not required. JSON or YAML file containing swagger definitions for API. Exactly one of swagger_file, swagger_text or swagger_dict must be present. | |
api_id: ${3:undefined} # not required. The ID of the API you want to manage. | |
ec2_url: ${4:null} # not required. Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used. | |
stage: ${5:undefined} # not required. The name of the stage the API should be deployed to. | |
aws_secret_key: ${6:null} # not required. AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used. | |
aws_access_key: ${7:null} # not required. AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used. | |
security_token: ${8:null} # not required. AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used. | |
region: ${9:undefined} # not required. The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region) | |
swagger_dict: ${10:undefined} # not required. Swagger definitions API ansible dictionary which will be converted to JSON and uploaded. | |
deploy_desc: ${11:Automatic deployment by Ansible.} # not required. Description of the deployment - recorded and visible in the AWS console. | |
state: ${12|present,absent|} # not required. choices: present;absent. NOT IMPLEMENTED Create or delete API - currently we always create. | |
swagger_text: ${13:undefined} # not required. Swagger definitions for API in JSON or YAML as a string direct from playbook. | |
validate_certs: ${14:yes} # not required. When set to \"no\", SSL certificates will not be validated for boto versions >= 2.6.0. | |
""" | |
'aws_application_scaling_policy': | |
'prefix': "aws_application_scaling_policy_snippet" | |
'description': "Manage Application Auto Scaling Scaling Policies" | |
'body': """ | |
aws_application_scaling_policy: | |
resource_id: ${1:undefined} # required. The identifier of the resource associated with the scalable target. | |
policy_name: ${2:undefined} # required. The name of the scaling policy. | |
scalable_dimension: ${3|ecs:service:DesiredCount,ec2:spot-fleet-request:TargetCapacity,elasticmapreduce:instancegroup:InstanceCount,appstream:fleet:DesiredCapacity,dynamodb:table:ReadCapacityUnits,dynamodb:table:WriteCapacityUnits,dynamodb:index:ReadCapacityUnits,dynamodb:index:WriteCapacityUnits|} # required. choices: ecs:service:DesiredCount;ec2:spot-fleet-request:TargetCapacity;elasticmapreduce:instancegroup:InstanceCount;appstream:fleet:DesiredCapacity;dynamodb:table:ReadCapacityUnits;dynamodb:table:WriteCapacityUnits;dynamodb:index:ReadCapacityUnits;dynamodb:index:WriteCapacityUnits. The scalable dimension associated with the scalable target. | |
service_namespace: ${4|ecs,elasticmapreduce,ec2,appstream,dynamodb|} # required. choices: ecs;elasticmapreduce;ec2;appstream;dynamodb. The namespace of the AWS service. | |
policy_type: ${5|StepScaling,TargetTrackingScaling|} # required. choices: StepScaling;TargetTrackingScaling. The policy type. | |
profile: ${6:null} # not required. Uses a boto profile. Only works with boto >= 2.24.0. | |
ec2_url: ${7:null} # not required. Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used. | |
step_scaling_policy_configuration: ${8:undefined} # not required. A step scaling policy. This parameter is required if you are creating a policy and the policy type is StepScaling. | |
aws_secret_key: ${9:null} # not required. AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used. | |
aws_access_key: ${10:null} # not required. AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used. | |
security_token: ${11:null} # not required. AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used. | |
region: ${12:undefined} # not required. The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region) | |
target_tracking_scaling_policy_configuration: ${13:undefined} # not required. A target tracking policy. This parameter is required if you are creating a new policy and the policy type is TargetTrackingScaling. | |
validate_certs: ${14:yes} # not required. When set to \"no\", SSL certificates will not be validated for boto versions >= 2.6.0. | |
""" | |
'aws_az_facts': | |
'prefix': "aws_az_facts_snippet" | |
'description': "Gather facts about availability zones in AWS." | |
'body': """ | |
aws_az_facts: | |
aws_secret_key: ${1:null} # not required. AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used. | |
profile: ${2:null} # not required. Uses a boto profile. Only works with boto >= 2.24.0. | |
aws_access_key: ${3:null} # not required. AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used. | |
security_token: ${4:null} # not required. AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used. | |
region: ${5:undefined} # not required. The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region) | |
filters: ${6:[object Object]} # not required. A dict of filters to apply. Each dict item consists of a filter key and a filter value. See U(https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeAvailabilityZones.html) for possible filters. Filter names and values are case sensitive. You can also use underscores instead of dashes (-) in the filter keys, which will take precedence in case of conflict. | |
ec2_url: ${7:null} # not required. Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used. | |
validate_certs: ${8:yes} # not required. When set to \"no\", SSL certificates will not be validated for boto versions >= 2.6.0. | |
""" | |
'aws_batch_compute_environment': | |
'prefix': "aws_batch_compute_environment_snippet" | |
'description': "Manage AWS Batch Compute Environments" | |
'body': """ | |
aws_batch_compute_environment: | |
subnets: ${1:undefined} # required. The VPC subnets into which the compute resources are launched. | |
instance_types: ${2:undefined} # required. The instance types that may be launched. | |
maxv_cpus: ${3:undefined} # required. The maximum number of EC2 vCPUs that an environment can reach. | |
security_group_ids: ${4:undefined} # required. The EC2 security groups that are associated with instances launched in the compute environment. | |
instance_role: ${5:undefined} # required. The Amazon ECS instance role applied to Amazon EC2 instances in a compute environment. | |
minv_cpus: ${6:undefined} # required. The minimum number of EC2 vCPUs that an environment should maintain. | |
compute_resource_type: ${7|EC2,SPOT|} # required. choices: EC2;SPOT. The type of compute resource. | |
state: ${8|present,absent|} # required. choices: present;absent. Describes the desired state. | |
service_role: ${9:undefined} # required. The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf. | |
compute_environment_name: ${10:undefined} # required. The name for your compute environment. Up to 128 letters (uppercase and lowercase), numbers, and underscores are allowed. | |
type: ${11|MANAGED,UNMANAGED|} # required. choices: MANAGED;UNMANAGED. The type of the compute environment. | |
profile: ${12:null} # not required. Uses a boto profile. Only works with boto >= 2.24.0. | |
tags: ${13:undefined} # not required. Key-value pair tags to be applied to resources that are launched in the compute environment. | |
bid_percentage: ${14:undefined} # not required. The minimum percentage that a Spot Instance price must be when compared with the On-Demand price for that instance type before instances are launched. For example, if your bid percentage is 20%, then the Spot price must be below 20% of the current On-Demand price for that EC2 instance. | |
image_id: ${15:undefined} # not required. The Amazon Machine Image (AMI) ID used for instances launched in the compute environment. | |
ec2_url: ${16:null} # not required. Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used. | |
aws_secret_key: ${17:null} # not required. AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used. | |
aws_access_key: ${18:null} # not required. AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used. | |
desiredv_cpus: ${19:undefined} # not required. The desired number of EC2 vCPUS in the compute environment. | |
security_token: ${20:null} # not required. AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used. | |
validate_certs: ${21:yes} # not required. When set to \"no\", SSL certificates will not be validated for boto versions >= 2.6.0. | |
region: ${22:undefined} # not required. The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region) | |
compute_environment_state: ${23|ENABLED,DISABLED|} # not required. choices: ENABLED;DISABLED. The state of the compute environment. If the state is ENABLED, then the compute environment accepts jobs from a queue and can scale out automatically based on queues. | |
spot_iam_fleet_role: ${24:undefined} # not required. The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a SPOT compute environment. | |
ec2_key_pair: ${25:undefined} # not required. The EC2 key pair that is used for instances launched in the compute environment. | |
""" | |
'aws_batch_job_definition': | |
'prefix': "aws_batch_job_definition_snippet" | |
'description': "Manage AWS Batch Job Definitions" | |
'body': """ | |
aws_batch_job_definition: | |
state: ${1|present,absent|} # required. choices: present;absent. Describes the desired state. | |
job_definition_name: ${2:undefined} # required. The name for the job definition | |
type: ${3:undefined} # required. The type of job definition | |
profile: ${4:null} # not required. Uses a boto profile. Only works with boto >= 2.24.0. | |
readonly_root_filesystem: ${5:undefined} # not required. When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the --read-only option to docker run. | |
mount_points: ${6:undefined} # not required. The mount points for data volumes in your container. This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run. List of dictionaries. | |
image: ${7:undefined} # not required. The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with `` repository-url /image <colon>tag ``. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run. | |
job_role_arn: ${8:undefined} # not required. The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions. | |
attempts: ${9:undefined} # not required. Retry strategy - The number of times to move a job to the RUNNABLE status. You may specify between 1 and 10 attempts. If attempts is greater than one, the job is retried if it fails until it has moved to RUNNABLE that many times. | |
user: ${10:undefined} # not required. The user name to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run. | |
ec2_url: ${11:null} # not required. Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used. | |
job_definition_arn: ${12:undefined} # not required. The arn for the job definition | |
aws_secret_key: ${13:null} # not required. AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used. | |
aws_access_key: ${14:null} # not required. AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used. | |
security_token: ${15:null} # not required. AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used. | |
parameters: ${16:undefined} # not required. Default parameter substitution placeholders to set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition. | |
validate_certs: ${17:yes} # not required. When set to \"no\", SSL certificates will not be validated for boto versions >= 2.6.0. | |
region: ${18:undefined} # not required. The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region) | |
environment: ${19:undefined} # not required. The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the --env option to docker run. List of dictionaries. | |
vcpus: ${20:undefined} # not required. The number of vCPUs reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. | |
command: ${21:undefined} # not required. The command that is passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd. | |
volumes: ${22:undefined} # not required. A list of data volumes used in a job. List of dictionaries. | |
memory: ${23:undefined} # not required. The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run. | |
privileged: ${24:undefined} # not required. When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the --privileged option to docker run. | |
ulimits: ${25:undefined} # not required. A list of ulimits to set in the container. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run. List of dictionaries. | |
""" | |
'aws_batch_job_queue': | |
'prefix': "aws_batch_job_queue_snippet" | |
'description': "Manage AWS Batch Job Queues" | |
'body': """ | |
aws_batch_job_queue: | |
compute_environment_order: ${1:undefined} # required. The set of compute environments mapped to a job queue and their order relative to each other. The job scheduler uses this parameter to determine which compute environment should execute a given job. Compute environments must be in the VALID state before you can associate them with a job queue. You can associate up to 3 compute environments with a job queue. | |
job_queue_name: ${2:undefined} # required. The name for the job queue | |
priority: ${3:undefined} # required. The priority of the job queue. Job queues with a higher priority (or a lower integer value for the priority parameter) are evaluated first when associated with same compute environment. Priority is determined in ascending order, for example, a job queue with a priority value of 1 is given scheduling preference over a job queue with a priority value of 10. | |
state: ${4|present,absent|} # required. choices: present;absent. Describes the desired state. | |
aws_secret_key: ${5:null} # not required. AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used. | |
aws_access_key: ${6:null} # not required. AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used. | |
job_queue_state: ${7|ENABLED,DISABLED|} # not required. choices: ENABLED;DISABLED. The state of the job queue. If the job queue state is ENABLED , it is able to accept jobs. | |
security_token: ${8:null} # not required. AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used. | |
region: ${9:undefined} # not required. The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region) | |
profile: ${10:null} # not required. Uses a boto profile. Only works with boto >= 2.24.0. | |
ec2_url: ${11:null} # not required. Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used. | |
validate_certs: ${12:yes} # not required. When set to \"no\", SSL certificates will not be validated for boto versions >= 2.6.0. | |
""" | |
'aws_direct_connect_connection': | |
'prefix': "aws_direct_connect_connection_snippet" | |
'description': "Creates, deletes, modifies a DirectConnect connection" | |
'body': """ | |
aws_direct_connect_connection: | |
profile: ${1:null} # not required. Uses a boto profile. Only works with boto >= 2.24.0. | |
aws_secret_key: ${2:null} # not required. AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used. | |
connection_id: ${3:undefined} # not required. The ID of the Direct Connect connection. I(name) or I(connection_id) is required to recreate or delete a connection. Modifying attributes of a connection with I(forced_update) will result in a new Direct Connect connection ID. | |
bandwidth: ${4|1Gbps,10Gbps|} # not required. choices: 1Gbps;10Gbps. The bandwidth of the Direct Connect connection. Required when I(state=present). | |
link_aggregation_group: ${5:undefined} # not required. The ID of the link aggregation group you want to associate with the connection. This is optional in case a stand-alone connection is desired. | |
ec2_url: ${6:null} # not required. Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used. | |
forced_update: ${7:undefined} # not required. To modify bandwidth or location the connection will need to be deleted and recreated. By default this will not happen - this option must be set to True. | |
aws_access_key: ${8:null} # not required. AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used. | |
name: ${9:undefined} # not required. The name of the Direct Connect connection. This is required to create a new connection. To recreate or delete a connection I(name) or I(connection_id) is required. | |
security_token: ${10:null} # not required. AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used. | |
region: ${11:undefined} # not required. The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region) | |
state: ${12|present,absent|} # not required. choices: present;absent. The state of the Direct Connect connection. | |
location: ${13:undefined} # not required. Where the Direct Connect connection is located. Required when I(state=present). | |
validate_certs: ${14:yes} # not required. When set to \"no\", SSL certificates will not be validated for boto versions >= 2.6.0. | |
""" | |
'aws_direct_connect_gateway': | |
'prefix': "aws_direct_connect_gateway_snippet" | |
'description': "Manage AWS Direct Connect Gateway." | |
'body': """ | |
aws_direct_connect_gateway: | |
amazon_asn: ${1:undefined} # required. amazon side asn | |
aws_secret_key: ${2:null} # not required. AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used. | |
profile: ${3:null} # not required. Uses a boto profile. Only works with boto >= 2.24.0. | |
aws_access_key: ${4:null} # not required. AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used. | |
name: ${5:undefined} # not required. name of the dxgw to be created or deleted | |
security_token: ${6:null} # not required. AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used. | |
virtual_gateway_id: ${7:undefined} # not required. vpn gateway id of an existing virtual gateway | |
region: ${8:undefined} # not required. The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region) | |
validate_certs: ${9:yes} # not required. When set to \"no\", SSL certificates will not be validated for boto versions >= 2.6.0. | |
state: ${10|present,absent|} # not required. choices: present;absent. present to ensure resource is created.,absent to remove resource | |
ec2_url: ${11:null} # not required. Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used. | |
direct_connect_gateway_id: ${12:undefined} # not required. id of an existing direct connect gateway | |
""" | |
'aws_direct_connect_link_aggregation_group': | |
'prefix': "aws_direct_connect_link_aggregation_group_snippet" | |
'description': "Manage Direct Connect LAG bundles." | |
'body': """ | |
aws_direct_connect_link_aggregation_group: | |
aws_secret_key: ${1:null} # not required. AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used. | |
profile: ${2:null} # not required. Uses a boto profile. Only works with boto >= 2.24.0. | |
aws_access_key: ${3:null} # not required. AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used. | |
name: ${4:undefined} # not required. The name of the Direct Connect link aggregation group. | |
security_token: ${5:null} # not required. AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used. | |
state: ${6|present,absent|} # not required. choices: present;absent. The state of the Direct Connect link aggregation group. | |
delete_with_disassociation: ${7:undefined} # not required. To be used with I(state=absent) to delete connections after disassociating them with the LAG. | |
force_delete: ${8:undefined} # not required. This allows the minimum number of links to be set to 0, any hosted connections disassociated, and any virtual interfaces associated to the LAG deleted. | |
region: ${9:undefined} # not required. The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region) | |
ec2_url: ${10:null} # not required. Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used. | |
num_connections: ${11:undefined} # not required. The number of connections with which to intialize the link aggregation group. | |
connection_id: ${12:undefined} # not required. A connection ID to link with the link aggregation group upon creation. | |
validate_certs: ${13:yes} # not required. When set to \"no\", SSL certificates will not be validated for boto versions >= 2.6.0. | |
bandwidth: ${14:undefined} # not required. The bandwidth of the link aggregation group. | |
wait_timeout: ${15:120} # not required. The duration in seconds to wait if I(wait) is True. | |
location: ${16:undefined} # not required. The location of the link aggregation group. | |
min_links: ${17:undefined} # not required. The minimum number of physical connections that must be operational for the LAG itself to be operational. | |
link_aggregation_group_id: ${18:undefined} # not required. The ID of the Direct Connect link aggregation group. | |
wait: ${19:undefined} # not required. Whether or not to wait for the operation to complete. May be useful when waiting for virtual interfaces to be deleted. May modify the time of waiting with C(wait_timeout). | |
""" | |
'aws_direct_connect_virtual_interface': | |
'prefix': "aws_direct_connect_virtual_interface_snippet" | |
'description': "Manage Direct Connect virtual interfaces." | |
'body': """ | |
aws_direct_connect_virtual_interface: | |
aws_secret_key: ${1:null} # not required. AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used. | |
profile: ${2:null} # not required. Uses a boto profile. Only works with boto >= 2.24.0. | |
aws_access_key: ${3:null} # not required. AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used. | |
vlan: ${4:100} # not required. The VLAN ID. | |
name: ${5:undefined} # not required. The name of the virtual interface. | |
security_token: ${6:null} # not required. AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used. | |
validate_certs: ${7:yes} # not required. When set to \"no\", SSL certificates will not be validated for boto versions >= 2.6.0. | |
region: ${8:undefined} # not required. The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region) | |
virtual_interface_id: ${9:undefined} # not required. The virtual interface ID. | |
ec2_url: ${10:null} # not required. Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used. | |
id_to_associate: ${11:undefined} # not required. The ID of the link aggrecation group or connection to associate with the virtual interface. | |
customer_address: ${12:undefined} # not required. The customer address CIDR with which to create the virtual interface. | |
state: ${13|present,absent|} # not required. choices: present;absent. The desired state of the Direct Connect virtual interface. | |
amazon_address: ${14:undefined} # not required. The amazon address CIDR with which to create the virtual interface. | |
authentication_key: ${15:undefined} # not required. The authentication key for BGP configuration. | |
bgp_asn: ${16:65000} # not required. The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration. | |
cidr: ${17:undefined} # not required. A list of route filter prefix CIDRs with which to create the public virtual interface. | |
address_type: ${18:undefined} # not required. The type of IP address for the BGP peer. | |
virtual_gateway_id: ${19:undefined} # not required. The virtual gateway ID required for creating a private virtual interface. | |
public: ${20:undefined} # not required. The type of virtual interface. | |
""" | |
'aws_elasticbeanstalk_app': | |
'prefix': "aws_elasticbeanstalk_app_snippet" | |
'description': "create, update, and delete an elastic beanstalk application" | |
'body': """ | |
aws_elasticbeanstalk_app: | |
aws_secret_key: ${1:null} # not required. AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used. | |
profile: ${2:null} # not required. Uses a boto profile. Only works with boto >= 2.24.0. | |
aws_access_key: ${3:null} # not required. AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used. | |
description: ${4:undefined} # not required. the description of the application | |
security_token: ${5:null} # not required. AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used. | |
region: ${6:undefined} # not required. The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region) | |
state: ${7|absent,present|} # not required. choices: absent;present. whether to ensure the application is present or absent | |
ec2_url: ${8:null} # not required. Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used. | |
validate_certs: ${9:yes} # not required. When set to \"no\", SSL certificates will not be validated for boto versions >= 2.6.0. | |
terminate_by_force: ${10:false} # not required. when set to true, running environments will be terminated before deleting the application | |
app_name: ${11:undefined} # not required. name of the beanstalk application you wish to manage | |
""" | |
'aws_kms': | |
'prefix': "aws_kms_snippet" | |
'description': "Perform various KMS management tasks." | |
'body': """ | |
aws_kms: | |
mode: ${1|grant,deny|} # required. choices: grant;deny. Grant or deny access. | |
profile: ${2:null} # not required. Uses a boto profile. Only works with boto >= 2.24.0. | |
role_name: ${3:undefined} # not required. Role to allow/deny access. One of C(role_name) or C(role_arn) are required. | |
ec2_url: ${4:null} # not required. Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used. | |
key_alias: ${5:undefined} # not required. Alias label to the key. One of C(key_alias) or C(key_arn) are required. | |
aws_secret_key: ${6:null} # not required. AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used. | |
aws_access_key: ${7:null} # not required. AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used. | |
role_arn: ${8:undefined} # not required. ARN of role to allow/deny access. One of C(role_name) or C(role_arn) are required. | |
security_token: ${9:null} # not required. AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used. | |
region: ${10:undefined} # not required. The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region) | |
grant_types: ${11:undefined} # not required. List of grants to give to user/role. Likely \"role,role grant\" or \"role,role grant,admin\". Required when C(mode=grant). | |
key_arn: ${12:undefined} # not required. Full ARN to the key. One of C(key_alias) or C(key_arn) are required. | |
clean_invalid_entries: ${13:true} # not required. If adding/removing a role and invalid grantees are found, remove them. These entries will cause an update to fail in all known cases.,Only cleans if changes are being made. | |
validate_certs: ${14:yes} # not required. When set to \"no\", SSL certificates will not be validated for boto versions >= 2.6.0. | |
""" | |
'aws_kms_facts': | |
'prefix': "aws_kms_facts_snippet" | |
'description': "Gather facts about AWS KMS keys" | |
'body': """ | |
aws_kms_facts: | |
aws_secret_key: ${1:null} # not required. AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used. | |
profile: ${2:null} # not required. Uses a boto profile. Only works with boto >= 2.24.0. | |
aws_access_key: ${3:null} # not required. AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used. | |
security_token: ${4:null} # not required. AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used. | |
region: ${5:undefined} # not required. The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region) | |
filters: ${6:undefined} # not required. A dict of filters to apply. Each dict item consists of a filter key and a filter value. The filters aren't natively supported by boto3, but are supported to provide similar functionality to other modules. Standard tag filters (C(tag-key), C(tag-value) and C(tag:tagName)) are available, as are C(key-id) and C(alias) | |
ec2_url: ${7:null} # not required. Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used. | |
pending_deletion: ${8:false} # not required. Whether to get full details (tags, grants etc.) of keys pending deletion | |
validate_certs: ${9:yes} # not required. When set to \"no\", SSL certificates will not be validated for boto versions >= 2.6.0. | |
""" | |
'aws_region_facts': | |
'prefix': "aws_region_facts_snippet" | |
'description': "Gather facts about AWS regions." | |
'body': """ | |
aws_region_facts: | |
aws_secret_key: ${1:null} # not required. AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used. | |
profile: ${2:null} # not required. Uses a boto profile. Only works with boto >= 2.24.0. | |
aws_access_key: ${3:null} # not required. AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used. | |
security_token: ${4:null} # not required. AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used. | |
region: ${5:undefined} # not required. The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region) | |
filters: ${6:[object Object]} # not required. A dict of filters to apply. Each dict item consists of a filter key and a filter value. See U(https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeRegions.html) for possible filters. Filter names and values are case sensitive. You can also use underscores instead of dashes (-) in the filter keys, which will take precedence in case of conflict. | |
ec2_url: ${7:null} # not required. Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used. | |
validate_certs: ${8:yes} # not required. When set to \"no\", SSL certificates will not be validated for boto versions >= 2.6.0. | |
""" | |
'aws_s3': | |
'prefix': "aws_s3_snippet" | |
'description': "manage objects in S3." | |
'body': """ | |
aws_s3: | |
bucket: ${1:undefined} # required. Bucket name. | |
mode: ${2|get,put,delete,create,geturl,getstr,delobj,list|} # required. choices: get;put;delete;create;geturl;getstr;delobj;list. Switches the module behaviour between put (upload), get (download), geturl (return download url, Ansible 1.3+), getstr (download object as string (1.3+)), list (list keys, Ansible 2.0+), create (bucket), delete (bucket), and delobj (delete object, Ansible 2.0+). | |
profile: ${3:null} # not required. Uses a boto profile. Only works with boto >= 2.24.0. | |
permission: ${4:private} # not required. This option lets the user set the canned permissions on the object/bucket that are created. The permissions that can be set are 'private', 'public-read', 'public-read-write', 'authenticated-read' for a bucket or 'private', 'public-read', 'public-read-write', 'aws-exec-read', 'authenticated-read', 'bucket-owner-read', 'bucket-owner-full-control' for an object. Multiple permissions can be specified as a list. | |
dest: ${5:undefined} # not required. The destination file path when downloading an object/key with a GET operation. | |
object: ${6:undefined} # not required. Keyname of the object inside the bucket. Can be used to create \"virtual directories\", see examples. | |
prefix: ${7:} # not required. Limits the response to keys that begin with the specified prefix for list mode | |
ec2_url: ${8:null} # not required. Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used. | |
marker: ${9:undefined} # not required. Specifies the key to start with when using list mode. Object keys are returned in alphabetical order, starting with key after the marker in order. | |
ignore_nonexistent_bucket: ${10:undefined} # not required. Overrides initial bucket lookups in case bucket or iam policies are restrictive. Example: a user may have the GetObject permission but no other permissions. In this case using the option mode: get will fail without specifying ignore_nonexistent_bucket: True. | |
overwrite: ${11:always} # not required. Force overwrite either locally on the filesystem or remotely with the object/key. Used with PUT and GET operations. Boolean or one of [always, never, different], true is equal to 'always' and false is equal to 'never', new in 2.0. When this is set to 'different', the md5 sum of the local file is compared with the 'ETag' of the object/key in S3. The ETag may or may not be an MD5 digest of the object data. See the ETag response header here U(http://docs.aws.amazon.com/AmazonS3/latest/API/RESTCommonResponseHeaders.html) | |
headers: ${12:undefined} # not required. Custom headers for PUT operation, as a dictionary of 'key=value' and 'key=value,key=value'. | |
aws_secret_key: ${13:null} # not required. AWS secret key. If not set then the value of the AWS_SECRET_KEY environment variable is used. | |
src: ${14:undefined} # not required. The source file path when performing a PUT operation. | |
aws_access_key: ${15:null} # not required. AWS access key id. If not set then the value of the AWS_ACCESS_KEY environment variable is used. | |
encrypt: ${16:true} # not required. When set for PUT mode, asks for server-side encryption. | |
security_token: ${17:null} # not required. AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used. | |
rgw: ${18:false} # not required. Enable Ceph RGW S3 support. This option requires an explicit url via s3_url. | |
region: ${19:undefined} # not required. AWS region to create the bucket in. If not set then the value of the AWS_REGION and EC2_REGION environment variables are checked, followed by the aws_region and ec2_region settings in the Boto config file. If none of those are set the region defaults to the S3 Location: US Standard. Prior to ansible 1.8 this parameter could be specified but had no effect. | |
retries: ${20:0} # not required. On recoverable failure, how many times to retry before actually failing. | |
max_keys: ${21:1000} # not required. Max number of results to return in list mode, set this if you want to retrieve fewer than the default 1000 keys. | |
version: ${22:undefined} # not required. Version ID of the object inside the bucket. Can be used to get a specific version of a file if versioning is enabled in the target bucket. | |
expiration: ${23:600} # not required. Time limit (in seconds) for the URL generated and returned by S3/Walrus when performing a mode=put or mode=geturl operation. | |
s3_url: ${24:undefined} # not required. S3 URL endpoint for usage with Ceph, Eucalypus, fakes3, etc. Otherwise assumes AWS | |
metadata: ${25:undefined} # not required. Metadata for PUT operation, as a dictionary of 'key=value' and 'key=value,key=value'. | |
validate_certs: ${26:yes} # not required. When set to \"no\", SSL certificates will not be validated for boto versions >= 2.6.0. | |
""" | |
'aws_s3_bucket_facts': | |
'prefix': "aws_s3_bucket_facts_snippet" | |
'description': "Lists S3 buckets in AWS" | |
'body': """ | |
aws_s3_bucket_facts: | |
aws_secret_key: ${1:null} # not required. AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used. | |
profile: ${2:null} # not required. Uses a boto profile. Only works with boto >= 2.24.0. | |
aws_access_key: ${3:null} # not required. AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used. | |
security_token: ${4:null} # not required. AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used. | |
ec2_url: ${5:null} # not required. Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used. | |
region: ${6:undefined} # not required. The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region) | |
validate_certs: ${7:yes} # not required. When set to \"no\", SSL certificates will not be validated for boto versions >= 2.6.0. | |
""" | |
'aws_s3_cors': | |
'prefix': "aws_s3_cors_snippet" | |
'description': "Manage CORS for S3 buckets in AWS" | |
'body': """ | |
aws_s3_cors: | |
name: ${1:null} # required. Name of the s3 bucket | |
state: ${2|present,absent|} # required. choices: present;absent. Create or remove cors on the s3 bucket | |
aws_secret_key: ${3:null} # not required. AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used. | |
profile: ${4:null} # not required. Uses a boto profile. Only works with boto >= 2.24.0. | |
aws_access_key: ${5:null} # not required. AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used. | |
security_token: ${6:null} # not required. AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used. | |
rules: ${7:undefined} # not required. Cors rules to put on the s3 bucket | |
region: ${8:undefined} # not required. The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region) | |
ec2_url: ${9:null} # not required. Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used. | |
validate_certs: ${10:yes} # not required. When set to \"no\", SSL certificates will not be validated for boto versions >= 2.6.0. | |
""" | |
'aws_ses_identity': | |
'prefix': "aws_ses_identity_snippet" | |
'description': "Manages SES email and domain identity" | |
'body': """ | |
aws_ses_identity: | |
identity: ${1:undefined} # required. This is the email address or domain to verify / delete.,If this contains an '@' then it will be considered an email. Otherwise it will be considered a domain. | |
profile: ${2:null} # not required. Uses a boto profile. Only works with boto >= 2.24.0. | |
bounce_notifications: ${3:undefined} # not required. Setup the SNS topic used to report bounce notifications.,If omitted, bounce notifications will not be delivered to a SNS topic.,If bounce notifications are not delivered to a SNS topic, I(feedback_forwarding) must be enabled. | |
feedback_forwarding: ${4:true} # not required. Whether or not to enable feedback forwarding.,This can only be false if both I(bounce_notifications) and I(complaint_notifications) specify SNS topics. | |
ec2_url: ${5:null} # not required. Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used. | |
complaint_notifications: ${6:undefined} # not required. Setup the SNS topic used to report complaint notifications.,If omitted, complaint notifications will not be delivered to a SNS topic.,If complaint notifications are not delivered to a SNS topic, I(feedback_forwarding) must be enabled. | |
aws_secret_key: ${7:null} # not required. AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used. | |
aws_access_key: ${8:null} # not required. AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used. | |
security_token: ${9:null} # not required. AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used. | |
region: ${10:undefined} # not required. The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region) | |
state: ${11|present,absent|} # not required. choices: present;absent. Whether to create(or update) or delete the identity. | |
delivery_notifications: ${12:undefined} # not required. Setup the SNS topic used to report delivery notifications.,If omitted, delivery notifications will not be delivered to a SNS topic. | |
validate_certs: ${13:yes} # not required. When set to \"no\", SSL certificates will not be validated for boto versions >= 2.6.0. | |
""" | |
'aws_ssm_parameter_store': | |
'prefix': "aws_ssm_parameter_store_snippet" | |
'description': "Manage key-value pairs in aws parameter store." | |
'body': """ | |
aws_ssm_parameter_store: | |
name: ${1:undefined} # required. parameter key name. | |
aws_secret_key: ${2:null} # not required. AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used. | |
decryption: ${3:true} # not required. Work with SecureString type to get plain text secrets,Boolean | |
aws_access_key: ${4:null} # not required. AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used. | |
security_token: ${5:null} # not required. AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used. | |
region: ${6:undefined} # not required. region. | |
string_type: ${7|String,StringList,SecureString|} # not required. choices: String;StringList;SecureString. Parameter String type | |
value: ${8:undefined} # not required. Parameter value. | |
state: ${9|present,absent|} # not required. choices: present;absent. Creates or modifies an existing parameter,Deletes a parameter | |
profile: ${10:null} # not required. Uses a boto profile. Only works with boto >= 2.24.0. | |
ec2_url: ${11:null} # not required. Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used. | |
key_id: ${12:aws/ssm (this key is automatically generated at the first parameter created).} # not required. aws KMS key to decrypt the secrets. | |
validate_certs: ${13:yes} # not required. When set to \"no\", SSL certificates will not be validated for boto versions >= 2.6.0. | |
overwrite: ${14:true} # not required. Overwrite the value when create or update parameter,Boolean | |
description: ${15:undefined} # not required. parameter key desciption. | |
""" | |
'aws_waf_condition': | |
'prefix': "aws_waf_condition_snippet" | |
'description': "create and delete WAF Conditions" | |
'body': """ | |
aws_waf_condition: | |
name: ${1:undefined} # required. Name of the Web Application Firewall condition to manage | |
aws_secret_key: ${2:null} # not required. AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used. | |
profile: ${3:null} # not required. Uses a boto profile. Only works with boto >= 2.24.0. | |
aws_access_key: ${4:null} # not required. AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used. | |
security_token: ${5:null} # not required. AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used. | |
purge_filters: ${6:undefined} # not required. Whether to remove existing filters from a condition if not passed in I(filters). Defaults to false | |
region: ${7:undefined} # not required. The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region) | |
validate_certs: ${8:yes} # not required. When set to \"no\", SSL certificates will not be validated for boto versions >= 2.6.0. | |
state: ${9|present,absent|} # not required. choices: present;absent. Whether the condition should be C(present) or C(absent) | |
filters: ${10:undefined} # not required. A list of the filters against which to match,For I(type)=C(byte), valid keys are C(field_to_match), C(position), C(header), C(transformation),For I(type)=C(geo), the only valid key is C(country),For I(type)=C(ip), the only valid key is C(ip_address),For I(type)=C(regex), valid keys are C(field_to_match), C(transformation) and C(regex_pattern),For I(type)=C(size), valid keys are C(field_to_match), C(transformation), C(comparison) and C(size),For I(type)=C(sql), valid keys are C(field_to_match) and C(transformation),For I(type)=C(xss), valid keys are C(field_to_match) and C(transformation),I(field_to_match) can be one of C(uri), C(query_string), C(header) C(method) and C(body),If I(field_to_match) is C(header), then C(header) must also be specified,I(transformation) can be one of C(none), C(compress_white_space), C(html_entity_decode), C(lowercase), C(cmd_line), C(url_decode),I(position), can be one of C(exactly), C(starts_with), C(ends_with), C(contains), C(contains_word),,I(comparison) can be one of C(EQ), C(NE), C(LE), C(LT), C(GE), C(GT),,I(target_string) is a maximum of 50 bytes,I(regex_pattern) is a dict with a C(name) key and C(regex_strings) list of strings to match | |
ec2_url: ${11:null} # not required. Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used. | |
type: ${12|byte,geo,ip,regex,size,sql,xss|} # not required. choices: byte;geo;ip;regex;size;sql;xss. the type of matching to perform | |
""" | |
'aws_waf_facts': | |
'prefix': "aws_waf_facts_snippet" | |
'description': "Retrieve facts for WAF ACLs, Rule , Conditions and Filters." | |
'body': """ | |
aws_waf_facts: | |
aws_secret_key: ${1:null} # not required. AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used. | |
profile: ${2:null} # not required. Uses a boto profile. Only works with boto >= 2.24.0. | |
aws_access_key: ${3:null} # not required. AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used. | |
name: ${4:undefined} # not required. The name of a Web Application Firewall | |
security_token: ${5:null} # not required. AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used. | |
region: ${6:undefined} # not required. The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region) | |
ec2_url: ${7:null} # not required. Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used. | |
validate_certs: ${8:yes} # not required. When set to \"no\", SSL certificates will not be validated for boto versions >= 2.6.0. | |
""" | |
'aws_waf_rule': | |
'prefix': "aws_waf_rule_snippet" | |
'description': "create and delete WAF Rules" | |
'body': """ | |
aws_waf_rule: | |
name: ${1:undefined} # required. Name of the Web Application Firewall rule | |
aws_secret_key: ${2:null} # not required. AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used. | |
profile: ${3:null} # not required. Uses a boto profile. Only works with boto >= 2.24.0. | |
aws_access_key: ${4:null} # not required. AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used. | |
purge_conditions: ${5:undefined} # not required. Whether or not to remove conditions that are not passed when updating `conditions`. Defaults to false. | |
validate_certs: ${6:yes} # not required. When set to \"no\", SSL certificates will not be validated for boto versions >= 2.6.0. | |
region: ${7:undefined} # not required. The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region) | |
state: ${8|present,absent|} # not required. choices: present;absent. whether the rule should be present or absent | |
ec2_url: ${9:null} # not required. Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used. | |
security_token: ${10:null} # not required. AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used. | |
conditions: ${11:undefined} # not required. list of conditions used in the rule. Each condition should contain I(type): which is one of [C(byte), C(geo), C(ip), C(size), C(sql) or C(xss)] I(negated): whether the condition should be negated, and C(condition), the name of the existing condition. M(aws_waf_condition) can be used to create new conditions\n | |
metric_name: ${12:undefined} # not required. A friendly name or description for the metrics for the rule,The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace.,You can't change metric_name after you create the rule,Defaults to the same as name with disallowed characters removed | |
""" | |
'aws_waf_web_acl': | |
'prefix': "aws_waf_web_acl_snippet" | |
'description': "create and delete WAF Web ACLs" | |
'body': """ | |
aws_waf_web_acl: | |
name: ${1:undefined} # required. Name of the Web Application Firewall ACL to manage | |
profile: ${2:null} # not required. Uses a boto profile. Only works with boto >= 2.24.0. | |
purge_rules: ${3:undefined} # not required. Whether to remove rules that aren't passed with C(rules). Defaults to false | |
rules: ${4:undefined} # not required. A list of rules that the Web ACL will enforce.,Each rule must contain I(name), I(action), I(priority) keys.,Priorities must be unique, but not necessarily consecutive. Lower numbered priorities are evalauted first.,The I(type) key can be passed as C(rate_based), it defaults to C(regular) | |
ec2_url: ${5:null} # not required. Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used. | |
aws_secret_key: ${6:null} # not required. AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used. | |
aws_access_key: ${7:null} # not required. AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used. | |
metric_name: ${8:undefined} # not required. A friendly name or description for the metrics for this WebACL,The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace.,You can't change metric_name after you create the WebACL,Metric name will default to I(name) with disallowed characters stripped out | |
security_token: ${9:null} # not required. AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used. | |
region: ${10:undefined} # not required. The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region) | |
state: ${11|present,absent|} # not required. choices: present;absent. whether the Web ACL should be present or absent | |
default_action: ${12|block,allow,count|} # not required. choices: block;allow;count. The action that you want AWS WAF to take when a request doesn't match the criteria specified in any of the Rule objects that are associated with the WebACL | |
validate_certs: ${13:yes} # not required. When set to \"no\", SSL certificates will not be validated for boto versions >= 2.6.0. | |
""" | |
'azure': | |
'prefix': "azure_snippet" | |
'description': "create or terminate a virtual machine in azure" | |
'body': """ | |
azure: | |
image: ${1:null} # required. system image for creating the virtual machine (e.g., b39f27a8b8c64d52b05eac6a62ebad85__Ubuntu_DAILY_BUILD-precise-12_04_3-LTS-amd64-server-20131205-en-us-30GB) | |
storage_account: ${2:undefined} # required. the azure storage account in which to store the data disks. | |
name: ${3:null} # required. name of the virtual machine and associated cloud service. | |
location: ${4:null} # required. the azure location to use (e.g. 'East US') | |
role_size: ${5:Small} # not required. azure role size for the new virtual machine (e.g., Small, ExtraLarge, A6). You have to pay attention to the fact that instances of type G and DS are not available in all regions (locations). Make sure if you selected the size and type of instance available in your chosen location. | |
virtual_network_name: ${6:null} # not required. Name of virtual network. | |
wait_timeout_redirects: ${7:300} # not required. how long before wait gives up for redirects, in seconds | |
wait_timeout: ${8:600} # not required. how long before wait gives up, in seconds | |
user: ${9:null} # not required. the unix username for the new virtual machine. | |
auto_updates: ${10|yes,no|} # not required. choices: yes;no. Enable Auto Updates on Windows Machines | |
password: ${11:null} # not required. the unix password for the new virtual machine. | |
os_type: ${12|windows,linux|} # not required. choices: windows;linux. The type of the os that is gettings provisioned | |
wait: ${13|yes,no|} # not required. choices: yes;no. wait for the instance to be in state 'running' before returning | |
management_cert_path: ${14:null} # not required. path to an azure management certificate associated with the subscription id. Overrides the AZURE_CERT_PATH environment variable. | |
hostname: ${15:null} # not required. hostname to write /etc/hostname. Defaults to <name>.cloudapp.net. | |
ssh_cert_path: ${16:null} # not required. path to an X509 certificate containing the public ssh key to install in the virtual machine. See http://www.windowsazure.com/en-us/manage/linux/tutorials/intro-to-linux/ for more details.,if this option is specified, password-based ssh authentication will be disabled. | |
state: ${17:present} # not required. create or terminate instances | |
subscription_id: ${18:null} # not required. azure subscription id. Overrides the AZURE_SUBSCRIPTION_ID environment variable. | |
endpoints: ${19:22} # not required. a comma-separated list of TCP ports to expose on the virtual machine (e.g., \"22,80\") | |
enable_winrm: ${20|yes,no|} # not required. choices: yes;no. Enable winrm on Windows Machines | |
""" | |
'azure_rm_acs': | |
'prefix': "azure_rm_acs_snippet" | |
'description': "Manage an Azure Container Service Instance (ACS)." | |
'body': """ | |
azure_rm_acs: | |
resource_group: ${1:undefined} # required. Name of a resource group where the Container Services exists or will be created. | |
diagnostics_profile: ${2:undefined} # required. Should VM Diagnostics be enabled for the Container Service VM's. | |
master_profile: ${3:undefined} # required. Master profile suboptions. | |
orchestration_platform: ${4:undefined} # required. Specifies the Container Orchestration Platform to use. Currently can be either DCOS, Kubernetes or Swarm. | |
linux_profile: ${5:undefined} # required. The linux profile suboptions. | |
agent_pool_profiles: ${6:undefined} # required. The agent pool profile suboptions. | |
name: ${7:undefined} # required. Name of the Container Services instance. | |
ad_user: ${8:null} # not required. Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | |
cert_validation_mode: ${9|validate,ignore|} # not required. choices: validate;ignore. Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. | |
append_tags: ${10:true} # not required. Use to control if tags field is canonical or just appends to existing tags. When canonical, any tags not found in the tags parameter will be removed from the object's metadata. | |
cloud_environment: ${11:AzureCloud} # not required. For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable. | |
secret: ${12:null} # not required. Azure client secret. Use when authenticating with a Service Principal. | |
tags: ${13:null} # not required. Dictionary of string:string pairs to assign as metadata to the object. Metadata tags on the object will be updated with any provided values. To remove tags set append_tags option to false.\n | |
location: ${14:resource_group location} # not required. Valid azure location. Defaults to location of the resource group. | |
subscription_id: ${15:null} # not required. Your Azure subscription Id. | |
service_principal: ${16:null} # not required. The service principal suboptions. | |
profile: ${17:null} # not required. Security profile found in ~/.azure/credentials file. | |
state: ${18|absent,present|} # not required. choices: absent;present. Assert the state of the ACS. Use 'present' to create or update an ACS and 'absent' to delete it. | |
client_id: ${19:null} # not required. Azure client ID. Use when authenticating with a Service Principal. | |
auth_source: ${20|auto,cli,credential_file,env|} # not required. choices: auto;cli;credential_file;env. Controls the source of the credentials to use for authentication.,C(auto) will follow the default precedence of module parameters -> environment variables -> default profile in credential file C(~/.azure/credentials).,When set to C(cli), the credentials will be sources from the default Azure CLI profile.,Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. | |
password: ${21:null} # not required. Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | |
tenant: ${22:null} # not required. Azure tenant ID. Use when authenticating with a Service Principal. | |
api_profile: ${23|latest|} # not required. choices: latest. Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack. | |
""" | |
'azure_rm_availabilityset': | |
'prefix': "azure_rm_availabilityset_snippet" | |
'description': "Manage Azure availability set." | |
'body': """ | |
azure_rm_availabilityset: | |
resource_group: ${1:undefined} # required. Name of a resource group where the availability set exists or will be created. | |
name: ${2:undefined} # required. Name of the availability set. | |
profile: ${3:null} # not required. Security profile found in ~/.azure/credentials file. | |
tags: ${4:null} # not required. Dictionary of string:string pairs to assign as metadata to the object. Metadata tags on the object will be updated with any provided values. To remove tags set append_tags option to false.\n | |
ad_user: ${5:null} # not required. Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | |
client_id: ${6:null} # not required. Azure client ID. Use when authenticating with a Service Principal. | |
cert_validation_mode: ${7|validate,ignore|} # not required. choices: validate;ignore. Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. | |
password: ${8:null} # not required. Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | |
tenant: ${9:null} # not required. Azure tenant ID. Use when authenticating with a Service Principal. | |
api_profile: ${10|latest|} # not required. choices: latest. Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack. | |
sku: ${11|Classic,Aligned|} # not required. choices: Classic;Aligned. Define if the availability set supports managed disks. | |
append_tags: ${12:true} # not required. Use to control if tags field is canonical or just appends to existing tags. When canonical, any tags not found in the tags parameter will be removed from the object's metadata. | |
cloud_environment: ${13:AzureCloud} # not required. For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable. | |
secret: ${14:null} # not required. Azure client secret. Use when authenticating with a Service Principal. | |
platform_update_domain_count: ${15:5} # not required. Update domains indicate groups of virtual machines and underlying physical hardware that can be rebooted at the same time. Default is 5. | |
platform_fault_domain_count: ${16:3} # not required. Fault domains define the group of virtual machines that share a common power source and network switch. Should be between 1 and 3. Default is 3 | |
state: ${17|absent,present|} # not required. choices: absent;present. Assert the state of the availability set. Use 'present' to create or update a availability set and 'absent' to delete a availability set. | |
location: ${18:resource_group location} # not required. Valid azure location. Defaults to location of the resource group. | |
auth_source: ${19|auto,cli,credential_file,env|} # not required. choices: auto;cli;credential_file;env. Controls the source of the credentials to use for authentication.,C(auto) will follow the default precedence of module parameters -> environment variables -> default profile in credential file C(~/.azure/credentials).,When set to C(cli), the credentials will be sources from the default Azure CLI profile.,Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. | |
subscription_id: ${20:null} # not required. Your Azure subscription Id. | |
""" | |
'azure_rm_availabilityset_facts': | |
'prefix': "azure_rm_availabilityset_facts_snippet" | |
'description': "Get availability set facts." | |
'body': """ | |
azure_rm_availabilityset_facts: | |
profile: ${1:null} # not required. Security profile found in ~/.azure/credentials file. | |
name: ${2:null} # not required. Limit results to a specific availability set | |
resource_group: ${3:null} # not required. The resource group to search for the desired availability set | |
ad_user: ${4:null} # not required. Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | |
cloud_environment: ${5:AzureCloud} # not required. For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable. | |
cert_validation_mode: ${6|validate,ignore|} # not required. choices: validate;ignore. Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. | |
secret: ${7:null} # not required. Azure client secret. Use when authenticating with a Service Principal. | |
client_id: ${8:null} # not required. Azure client ID. Use when authenticating with a Service Principal. | |
api_profile: ${9|latest|} # not required. choices: latest. Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack. | |
auth_source: ${10|auto,cli,credential_file,env|} # not required. choices: auto;cli;credential_file;env. Controls the source of the credentials to use for authentication.,C(auto) will follow the default precedence of module parameters -> environment variables -> default profile in credential file C(~/.azure/credentials).,When set to C(cli), the credentials will be sources from the default Azure CLI profile.,Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. | |
subscription_id: ${11:null} # not required. Your Azure subscription Id. | |
password: ${12:null} # not required. Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | |
tenant: ${13:null} # not required. Azure tenant ID. Use when authenticating with a Service Principal. | |
""" | |
'azure_rm_containerinstance': | |
'prefix': "azure_rm_containerinstance_snippet" | |
'description': "Manage an Azure Container Instance." | |
'body': """ | |
azure_rm_containerinstance: | |
resource_group: ${1:undefined} # required. Name of resource group. | |
name: ${2:undefined} # required. The name of the container group. | |
ad_user: ${3:null} # not required. Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | |
cert_validation_mode: ${4|validate,ignore|} # not required. choices: validate;ignore. Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. | |
registry_password: ${5:undefined} # not required. The password to log in container image registry server. | |
cloud_environment: ${6:AzureCloud} # not required. For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable. | |
state: ${7|absent,present|} # not required. choices: absent;present. Assert the state of the container instance. Use 'present' to create or update an container instance and 'absent' to delete it. | |
secret: ${8:null} # not required. Azure client secret. Use when authenticating with a Service Principal. | |
location: ${9:undefined} # not required. Valid azure location. Defaults to location of the resource group. | |
subscription_id: ${10:null} # not required. Your Azure subscription Id. | |
containers: ${11:undefined} # not required. List of containers. | |
profile: ${12:null} # not required. Security profile found in ~/.azure/credentials file. | |
registry_login_server: ${13:undefined} # not required. The container image registry login server. | |
client_id: ${14:null} # not required. Azure client ID. Use when authenticating with a Service Principal. | |
api_profile: ${15|latest|} # not required. choices: latest. Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack. | |
password: ${16:null} # not required. Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | |
ip_address: ${17|public,none|} # not required. choices: public;none. The IP address type of the container group (default is 'none') | |
tenant: ${18:null} # not required. Azure tenant ID. Use when authenticating with a Service Principal. | |
registry_username: ${19:undefined} # not required. The username to log in container image registry server. | |
force_update: ${20:false} # not required. Force update of existing container instance. Any update will result in deletion and recreation of existing containers. | |
auth_source: ${21|auto,cli,credential_file,env|} # not required. choices: auto;cli;credential_file;env. Controls the source of the credentials to use for authentication.,C(auto) will follow the default precedence of module parameters -> environment variables -> default profile in credential file C(~/.azure/credentials).,When set to C(cli), the credentials will be sources from the default Azure CLI profile.,Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. | |
os_type: ${22|linux,windows|} # not required. choices: linux;windows. The OS type of containers. | |
ports: ${23:undefined} # not required. List of ports exposed within the container group. | |
""" | |
'azure_rm_containerregistry': | |
'prefix': "azure_rm_containerregistry_snippet" | |
'description': "Manage an Azure Container Registry." | |
'body': """ | |
azure_rm_containerregistry: | |
resource_group: ${1:undefined} # required. Name of a resource group where the Container Registry exists or will be created. | |
name: ${2:null} # required. Name of the Container Registry. | |
profile: ${3:null} # not required. Security profile found in ~/.azure/credentials file. | |
tags: ${4:null} # not required. Dictionary of string:string pairs to assign as metadata to the object. Metadata tags on the object will be updated with any provided values. To remove tags set append_tags option to false.\n | |
ad_user: ${5:null} # not required. Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | |
secret: ${6:null} # not required. Azure client secret. Use when authenticating with a Service Principal. | |
admin_user_enabled: ${7:false} # not required. If enabled, you can use the registry name as username and admin user access key as password to docker login to your container registry. | |
client_id: ${8:null} # not required. Azure client ID. Use when authenticating with a Service Principal. | |
api_profile: ${9|latest|} # not required. choices: latest. Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack. | |
password: ${10:null} # not required. Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | |
tenant: ${11:null} # not required. Azure tenant ID. Use when authenticating with a Service Principal. | |
sku: ${12|Basic,Standard,Premium|} # not required. choices: Basic;Standard;Premium. Specifies the SKU to use. Currently can be either Basic, Standard or Premium. | |
append_tags: ${13:true} # not required. Use to control if tags field is canonical or just appends to existing tags. When canonical, any tags not found in the tags parameter will be removed from the object's metadata. | |
cloud_environment: ${14:AzureCloud} # not required. For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable. | |
cert_validation_mode: ${15|validate,ignore|} # not required. choices: validate;ignore. Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. | |
state: ${16|absent,present|} # not required. choices: absent;present. Assert the state of the container registry. Use 'present' to create or update an container registry and 'absent' to delete it. | |
location: ${17:resource_group location} # not required. Valid azure location. Defaults to location of the resource group. | |
auth_source: ${18|auto,cli,credential_file,env|} # not required. choices: auto;cli;credential_file;env. Controls the source of the credentials to use for authentication.,C(auto) will follow the default precedence of module parameters -> environment variables -> default profile in credential file C(~/.azure/credentials).,When set to C(cli), the credentials will be sources from the default Azure CLI profile.,Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. | |
subscription_id: ${19:null} # not required. Your Azure subscription Id. | |
""" | |
'azure_rm_deployment': | |
'prefix': "azure_rm_deployment_snippet" | |
'description': "Create or destroy Azure Resource Manager template deployments" | |
'body': """ | |
azure_rm_deployment: | |
resource_group_name: ${1:undefined} # required. The resource group name to use or create to host the deployed template | |
deployment_name: ${2:ansible-arm} # not required. The name of the deployment to be tracked in the resource group deployment history. Re-using a deployment name will overwrite the previous value in the resource group's deployment history. | |
wait_for_deployment_polling_period: ${3:10} # not required. Time (in seconds) to wait between polls when waiting for deployment completion. | |
cloud_environment: ${4:AzureCloud} # not required. For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable. | |
wait_for_deployment_completion: ${5|yes,no|} # not required. choices: yes;no. Whether or not to block until the deployment has completed. | |
cert_validation_mode: ${6|validate,ignore|} # not required. choices: validate;ignore. Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. | |
parameters: ${7:null} # not required. A hash of all the required template variables for the deployment template. This parameter is mutually exclusive with 'parameters_link'. Either one of them is required if \"state\" parameter is \"present\". | |
ad_user: ${8:null} # not required. Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | |
state: ${9|present,absent|} # not required. choices: present;absent. If state is \"present\", template will be created. If state is \"present\" and if deployment exists, it will be updated. If state is \"absent\", stack will be removed. | |
secret: ${10:null} # not required. Azure client secret. Use when authenticating with a Service Principal. | |
location: ${11:westus} # not required. The geo-locations in which the resource group will be located. | |
template: ${12:null} # not required. A hash containing the templates inline. This parameter is mutually exclusive with 'template_link'. Either one of them is required if \"state\" parameter is \"present\". | |
subscription_id: ${13:null} # not required. Your Azure subscription Id. | |
profile: ${14:null} # not required. Security profile found in ~/.azure/credentials file. | |
template_link: ${15:null} # not required. Uri of file containing the template body. This parameter is mutually exclusive with 'template'. Either one of them is required if \"state\" parameter is \"present\". | |
client_id: ${16:null} # not required. Azure client ID. Use when authenticating with a Service Principal. | |
api_profile: ${17|latest|} # not required. choices: latest. Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack. | |
password: ${18:null} # not required. Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | |
tenant: ${19:null} # not required. Azure tenant ID. Use when authenticating with a Service Principal. | |
deployment_mode: ${20|complete,incremental|} # not required. choices: complete;incremental. In incremental mode, resources are deployed without deleting existing resources that are not included in the template. In complete mode resources are deployed and existing resources in the resource group not included in the template are deleted. | |
parameters_link: ${21:null} # not required. Uri of file containing the parameters body. This parameter is mutually exclusive with 'parameters'. Either one of them is required if \"state\" parameter is \"present\". | |
auth_source: ${22|auto,cli,credential_file,env|} # not required. choices: auto;cli;credential_file;env. Controls the source of the credentials to use for authentication.,C(auto) will follow the default precedence of module parameters -> environment variables -> default profile in credential file C(~/.azure/credentials).,When set to C(cli), the credentials will be sources from the default Azure CLI profile.,Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. | |
""" | |
'azure_rm_dnsrecordset': | |
'prefix': "azure_rm_dnsrecordset_snippet" | |
'description': "Create, delete and update DNS record sets and records." | |
'body': """ | |
azure_rm_dnsrecordset: | |
resource_group: ${1:undefined} # required. name of resource group | |
record_type: ${2|A,AAAA,CNAME,MX,NS,SRV,TXT,PTR|} # required. choices: A;AAAA;CNAME;MX;NS;SRV;TXT;PTR. the type of record set to create or delete | |
relative_name: ${3:undefined} # required. relative name of the record set | |
zone_name: ${4:undefined} # required. name of the existing DNS zone in which to manage the record set | |
profile: ${5:null} # not required. Security profile found in ~/.azure/credentials file. | |
api_profile: ${6|latest|} # not required. choices: latest. Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack. | |
ad_user: ${7:null} # not required. Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | |
cloud_environment: ${8:AzureCloud} # not required. For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable. | |
record_mode: ${9|append,purge|} # not required. choices: append;purge. whether existing record values not sent to the module should be purged | |
state: ${10|absent,present|} # not required. choices: absent;present. Assert the state of the record set. Use C(present) to create or update and C(absent) to delete. | |
records: ${11:undefined} # not required. list of records to be created depending on the type of record (set) | |
time_to_live: ${12:3600} # not required. time to live of the record set in seconds | |
auth_source: ${13|auto,cli,credential_file,env|} # not required. choices: auto;cli;credential_file;env. Controls the source of the credentials to use for authentication.,C(auto) will follow the default precedence of module parameters -> environment variables -> default profile in credential file C(~/.azure/credentials).,When set to C(cli), the credentials will be sources from the default Azure CLI profile.,Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. | |
client_id: ${14:null} # not required. Azure client ID. Use when authenticating with a Service Principal. | |
cert_validation_mode: ${15|validate,ignore|} # not required. choices: validate;ignore. Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. | |
subscription_id: ${16:null} # not required. Your Azure subscription Id. | |
password: ${17:null} # not required. Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | |
tenant: ${18:null} # not required. Azure tenant ID. Use when authenticating with a Service Principal. | |
secret: ${19:null} # not required. Azure client secret. Use when authenticating with a Service Principal. | |
""" | |
'azure_rm_dnsrecordset_facts': | |
'prefix': "azure_rm_dnsrecordset_facts_snippet" | |
'description': "Get DNS Record Set facts." | |
'body': """ | |
azure_rm_dnsrecordset_facts: | |
profile: ${1:null} # not required. Security profile found in ~/.azure/credentials file. | |
resource_group: ${2:undefined} # not required. Limit results by resource group. Required when filtering by name or type. | |
cloud_environment: ${3:AzureCloud} # not required. For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable. | |
top: ${4:100} # not required. Limit the maximum number of record sets to return | |
ad_user: ${5:null} # not required. Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | |
cert_validation_mode: ${6|validate,ignore|} # not required. choices: validate;ignore. Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. | |
relative_name: ${7:undefined} # not required. Only show results for a Record Set. | |
record_type: ${8:undefined} # not required. Limit record sets by record type. | |
secret: ${9:null} # not required. Azure client secret. Use when authenticating with a Service Principal. | |
client_id: ${10:null} # not required. Azure client ID. Use when authenticating with a Service Principal. | |
auth_source: ${11|auto,cli,credential_file,env|} # not required. choices: auto;cli;credential_file;env. Controls the source of the credentials to use for authentication.,C(auto) will follow the default precedence of module parameters -> environment variables -> default profile in credential file C(~/.azure/credentials).,When set to C(cli), the credentials will be sources from the default Azure CLI profile.,Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. | |
zone_name: ${12:undefined} # not required. Limit results by zones. Required when filtering by name or type. | |
subscription_id: ${13:null} # not required. Your Azure subscription Id. | |
password: ${14:null} # not required. Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | |
tenant: ${15:null} # not required. Azure tenant ID. Use when authenticating with a Service Principal. | |
api_profile: ${16|latest|} # not required. choices: latest. Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack. | |
""" | |
'azure_rm_dnszone': | |
'prefix': "azure_rm_dnszone_snippet" | |
'description': "Manage Azure DNS zones." | |
'body': """ | |
azure_rm_dnszone: | |
name: ${1:undefined} # required. name of the DNS Zone. | |
resource_group: ${2:undefined} # required. name of resource group. | |
profile: ${3:null} # not required. Security profile found in ~/.azure/credentials file. | |
tags: ${4:null} # not required. Dictionary of string:string pairs to assign as metadata to the object. Metadata tags on the object will be updated with any provided values. To remove tags set append_tags option to false.\n | |
ad_user: ${5:null} # not required. Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | |
append_tags: ${6:true} # not required. Use to control if tags field is canonical or just appends to existing tags. When canonical, any tags not found in the tags parameter will be removed from the object's metadata. | |
cloud_environment: ${7:AzureCloud} # not required. For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable. | |
secret: ${8:null} # not required. Azure client secret. Use when authenticating with a Service Principal. | |
state: ${9|absent,present|} # not required. choices: absent;present. Assert the state of the zone. Use 'present' to create or update and 'absent' to delete. | |
client_id: ${10:null} # not required. Azure client ID. Use when authenticating with a Service Principal. | |
cert_validation_mode: ${11|validate,ignore|} # not required. choices: validate;ignore. Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. | |
auth_source: ${12|auto,cli,credential_file,env|} # not required. choices: auto;cli;credential_file;env. Controls the source of the credentials to use for authentication.,C(auto) will follow the default precedence of module parameters -> environment variables -> default profile in credential file C(~/.azure/credentials).,When set to C(cli), the credentials will be sources from the default Azure CLI profile.,Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. | |
subscription_id: ${13:null} # not required. Your Azure subscription Id. | |
password: ${14:null} # not required. Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | |
tenant: ${15:null} # not required. Azure tenant ID. Use when authenticating with a Service Principal. | |
api_profile: ${16|latest|} # not required. choices: latest. Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack. | |
""" | |
'azure_rm_dnszone_facts': | |
'prefix': "azure_rm_dnszone_facts_snippet" | |
'description': "Get DNS zone facts." | |
'body': """ | |
azure_rm_dnszone_facts: | |
profile: ${1:null} # not required. Security profile found in ~/.azure/credentials file. | |
name: ${2:undefined} # not required. Only show results for a specific zone. | |
resource_group: ${3:undefined} # not required. Limit results by resource group. Required when filtering by name. | |
tags: ${4:null} # not required. Limit results by providing a list of tags. Format tags as 'key' or 'key:value'. | |
ad_user: ${5:null} # not required. Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | |
append_tags: ${6:true} # not required. Use to control if tags field is canonical or just appends to existing tags. When canonical, any tags not found in the tags parameter will be removed from the object's metadata. | |
cloud_environment: ${7:AzureCloud} # not required. For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable. | |
cert_validation_mode: ${8|validate,ignore|} # not required. choices: validate;ignore. Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. | |
secret: ${9:null} # not required. Azure client secret. Use when authenticating with a Service Principal. | |
client_id: ${10:null} # not required. Azure client ID. Use when authenticating with a Service Principal. | |
api_profile: ${11|latest|} # not required. choices: latest. Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack. | |
auth_source: ${12|auto,cli,credential_file,env|} # not required. choices: auto;cli;credential_file;env. Controls the source of the credentials to use for authentication.,C(auto) will follow the default precedence of module parameters -> environment variables -> default profile in credential file C(~/.azure/credentials).,When set to C(cli), the credentials will be sources from the default Azure CLI profile.,Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. | |
subscription_id: ${13:null} # not required. Your Azure subscription Id. | |
password: ${14:null} # not required. Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | |
tenant: ${15:null} # not required. Azure tenant ID. Use when authenticating with a Service Principal. | |
""" | |
'azure_rm_functionapp': | |
'prefix': "azure_rm_functionapp_snippet" | |
'description': "Manage Azure Function Apps" | |
'body': """ | |
azure_rm_functionapp: | |
name: ${1:undefined} # required. Name of the Azure Function App | |
resource_group: ${2:undefined} # required. Name of resource group | |
profile: ${3:null} # not required. Security profile found in ~/.azure/credentials file. | |
ad_user: ${4:null} # not required. Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | |
cloud_environment: ${5:AzureCloud} # not required. For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable. | |
secret: ${6:null} # not required. Azure client secret. Use when authenticating with a Service Principal. | |
state: ${7|absent,present|} # not required. choices: absent;present. Assert the state of the Function App. Use 'present' to create or update a Function App and 'absent' to delete. | |
client_id: ${8:null} # not required. Azure client ID. Use when authenticating with a Service Principal. | |
cert_validation_mode: ${9|validate,ignore|} # not required. choices: validate;ignore. Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. | |
auth_source: ${10|auto,cli,credential_file,env|} # not required. choices: auto;cli;credential_file;env. Controls the source of the credentials to use for authentication.,C(auto) will follow the default precedence of module parameters -> environment variables -> default profile in credential file C(~/.azure/credentials).,When set to C(cli), the credentials will be sources from the default Azure CLI profile.,Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. | |
subscription_id: ${11:null} # not required. Your Azure subscription Id. | |
password: ${12:null} # not required. Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | |
tenant: ${13:null} # not required. Azure tenant ID. Use when authenticating with a Service Principal. | |
api_profile: ${14|latest|} # not required. choices: latest. Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack. | |
""" | |
'azure_rm_functionapp_facts': | |
'prefix': "azure_rm_functionapp_facts_snippet" | |
'description': "Get Azure Function App facts" | |
'body': """ | |
azure_rm_functionapp_facts: | |
profile: ${1:null} # not required. Security profile found in ~/.azure/credentials file. | |
name: ${2:null} # not required. Only show results for a specific Function App | |
resource_group: ${3:null} # not required. Limit results to a resource group. Required when filtering by name | |
tags: ${4:null} # not required. Limit results by providing a list of tags. Format tags as 'key' or 'key:value'. | |
ad_user: ${5:null} # not required. Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | |
cloud_environment: ${6:AzureCloud} # not required. For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable. | |
cert_validation_mode: ${7|validate,ignore|} # not required. choices: validate;ignore. Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. | |
secret: ${8:null} # not required. Azure client secret. Use when authenticating with a Service Principal. | |
client_id: ${9:null} # not required. Azure client ID. Use when authenticating with a Service Principal. | |
api_profile: ${10|latest|} # not required. choices: latest. Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack. | |
auth_source: ${11|auto,cli,credential_file,env|} # not required. choices: auto;cli;credential_file;env. Controls the source of the credentials to use for authentication.,C(auto) will follow the default precedence of module parameters -> environment variables -> default profile in credential file C(~/.azure/credentials).,When set to C(cli), the credentials will be sources from the default Azure CLI profile.,Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. | |
subscription_id: ${12:null} # not required. Your Azure subscription Id. | |
password: ${13:null} # not required. Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | |
tenant: ${14:null} # not required. Azure tenant ID. Use when authenticating with a Service Principal. | |
""" | |
'azure_rm_image': | |
'prefix': "azure_rm_image_snippet" | |
'description': "Manage Azure image." | |
'body': """ | |
azure_rm_image: | |
resource_group: ${1:undefined} # required. Name of resource group. | |
name: ${2:undefined} # required. Name of the image. | |
source: ${3:undefined} # required. OS disk source from the same region, including a virtual machine id or name, OS disk blob uri, managed OS disk id or name, or OS snapshot id or name. | |
profile: ${4:null} # not required. Security profile found in ~/.azure/credentials file. | |
tags: ${5:null} # not required. Dictionary of string:string pairs to assign as metadata to the object. Metadata tags on the object will be updated with any provided values. To remove tags set append_tags option to false.\n | |
ad_user: ${6:null} # not required. Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | |
client_id: ${7:null} # not required. Azure client ID. Use when authenticating with a Service Principal. | |
cert_validation_mode: ${8|validate,ignore|} # not required. choices: validate;ignore. Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. | |
password: ${9:null} # not required. Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | |
subscription_id: ${10:null} # not required. Your Azure subscription Id. | |
tenant: ${11:null} # not required. Azure tenant ID. Use when authenticating with a Service Principal. | |
api_profile: ${12|latest|} # not required. choices: latest. Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack. | |
append_tags: ${13:true} # not required. Use to control if tags field is canonical or just appends to existing tags. When canonical, any tags not found in the tags parameter will be removed from the object's metadata. | |
cloud_environment: ${14:AzureCloud} # not required. For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable. | |
secret: ${15:null} # not required. Azure client secret. Use when authenticating with a Service Principal. | |
data_disk_sources: ${16:undefined} # not required. List of data disk sources, including unmanaged blob uri, managed disk id or name, or snapshot id or name. | |
state: ${17|absent,present|} # not required. choices: absent;present. Assert the state of the image. Use C(present) to create or update a image and C(absent) to delete an image. | |
location: ${18:undefined} # not required. Location of the image. Derived from I(resource_group) if not specified. | |
auth_source: ${19|auto,cli,credential_file,env|} # not required. choices: auto;cli;credential_file;env. Controls the source of the credentials to use for authentication.,C(auto) will follow the default precedence of module parameters -> environment variables -> default profile in credential file C(~/.azure/credentials).,When set to C(cli), the credentials will be sources from the default Azure CLI profile.,Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. | |
os_type: ${20|Windows,Linux|} # not required. choices: Windows;Linux. The OS type of image. | |
""" | |
'azure_rm_keyvault': | |
'prefix': "azure_rm_keyvault_snippet" | |
'description': "Manage Key Vault instance." | |
'body': """ | |
azure_rm_keyvault: | |
resource_group: ${1:undefined} # required. The name of the Resource Group to which the server belongs. | |
vault_name: ${2:undefined} # required. Name of the vault | |
ad_user: ${3:null} # not required. Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | |
enabled_for_deployment: ${4:undefined} # not required. Property to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault. | |
cert_validation_mode: ${5|validate,ignore|} # not required. choices: validate;ignore. Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. | |
access_policies: ${6:undefined} # not required. An array of 0 to 16 identities that have access to the key vault. All identities in the array must use the same tenant ID as the key vault's tenant ID. | |
sku: ${7:undefined} # not required. SKU details | |
cloud_environment: ${8:AzureCloud} # not required. For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable. | |
state: ${9|absent,present|} # not required. choices: absent;present. Assert the state of the KeyVault. Use 'present' to create or update an KeyVault and 'absent' to delete it. | |
enabled_for_template_deployment: ${10:undefined} # not required. Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault. | |
secret: ${11:null} # not required. Azure client secret. Use when authenticating with a Service Principal. | |
location: ${12:undefined} # not required. Resource location. If not set, location from the resource group will be used as default. | |
subscription_id: ${13:null} # not required. Your Azure subscription Id. | |
profile: ${14:null} # not required. Security profile found in ~/.azure/credentials file. | |
client_id: ${15:null} # not required. Azure client ID. Use when authenticating with a Service Principal. | |
auth_source: ${16|auto,cli,credential_file,env|} # not required. choices: auto;cli;credential_file;env. Controls the source of the credentials to use for authentication.,C(auto) will follow the default precedence of module parameters -> environment variables -> default profile in credential file C(~/.azure/credentials).,When set to C(cli), the credentials will be sources from the default Azure CLI profile.,Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. | |
password: ${17:null} # not required. Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | |
tenant: ${18:null} # not required. Azure tenant ID. Use when authenticating with a Service Principal. | |
vault_tenant: ${19:undefined} # not required. The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault. | |
recover_mode: ${20:undefined} # not required. Create vault in recovery mode. | |
enabled_for_disk_encryption: ${21:undefined} # not required. Property to specify whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys. | |
api_profile: ${22|latest|} # not required. choices: latest. Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack. | |
enable_soft_delete: ${23:undefined} # not required. Property to specify whether the soft delete functionality is enabled for this key vault. | |
""" | |
'azure_rm_keyvaultkey': | |
'prefix': "azure_rm_keyvaultkey_snippet" | |
'description': "Use Azure KeyVault keys." | |
'body': """ | |
azure_rm_keyvaultkey: | |
key_name: ${1:undefined} # required. Name of the keyvault key. | |
keyvault_uri: ${2:undefined} # required. URI of the keyvault endpoint. | |
profile: ${3:null} # not required. Security profile found in ~/.azure/credentials file. | |
pem_password: ${4:undefined} # not required. PEM password. | |
state: ${5|absent,present|} # not required. choices: absent;present. Assert the state of the key. Use 'present' to create a key and 'absent' to delete a key. | |
pem_file: ${6:undefined} # not required. PEM file. | |
client_id: ${7:null} # not required. Azure client ID. Use when authenticating with a Service Principal. | |
api_profile: ${8|latest|} # not required. choices: latest. Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack. | |
tags: ${9:null} # not required. Dictionary of string:string pairs to assign as metadata to the object. Metadata tags on the object will be updated with any provided values. To remove tags set append_tags option to false.\n | |
password: ${10:null} # not required. Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | |
tenant: ${11:null} # not required. Azure tenant ID. Use when authenticating with a Service Principal. | |
ad_user: ${12:null} # not required. Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | |
append_tags: ${13:true} # not required. Use to control if tags field is canonical or just appends to existing tags. When canonical, any tags not found in the tags parameter will be removed from the object's metadata. | |
cloud_environment: ${14:AzureCloud} # not required. For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable. | |
cert_validation_mode: ${15|validate,ignore|} # not required. choices: validate;ignore. Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. | |
secret: ${16:null} # not required. Azure client secret. Use when authenticating with a Service Principal. | |
byok_file: ${17:undefined} # not required. BYOK file. | |
auth_source: ${18|auto,cli,credential_file,env|} # not required. choices: auto;cli;credential_file;env. Controls the source of the credentials to use for authentication.,C(auto) will follow the default precedence of module parameters -> environment variables -> default profile in credential file C(~/.azure/credentials).,When set to C(cli), the credentials will be sources from the default Azure CLI profile.,Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. | |
subscription_id: ${19:null} # not required. Your Azure subscription Id. | |
""" | |
'azure_rm_keyvaultsecret': | |
'prefix': "azure_rm_keyvaultsecret_snippet" | |
'description': "Use Azure KeyVault Secrets." | |
'body': """ | |
azure_rm_keyvaultsecret: | |
keyvault_uri: ${1:undefined} # required. URI of the keyvault endpoint. | |
secret_name: ${2:undefined} # required. Name of the keyvault secret. | |
profile: ${3:null} # not required. Security profile found in ~/.azure/credentials file. | |
tags: ${4:null} # not required. Dictionary of string:string pairs to assign as metadata to the object. Metadata tags on the object will be updated with any provided values. To remove tags set append_tags option to false.\n | |
cloud_environment: ${5:AzureCloud} # not required. For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable. | |
append_tags: ${6:true} # not required. Use to control if tags field is canonical or just appends to existing tags. When canonical, any tags not found in the tags parameter will be removed from the object's metadata. | |
ad_user: ${7:null} # not required. Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | |
secret: ${8:null} # not required. Azure client secret. Use when authenticating with a Service Principal. | |
state: ${9|absent,present|} # not required. choices: absent;present. Assert the state of the subnet. Use 'present' to create or update a secret and 'absent' to delete a secret . | |
tenant: ${10:null} # not required. Azure tenant ID. Use when authenticating with a Service Principal. | |
client_id: ${11:null} # not required. Azure client ID. Use when authenticating with a Service Principal. | |
cert_validation_mode: ${12|validate,ignore|} # not required. choices: validate;ignore. Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. | |
auth_source: ${13|auto,cli,credential_file,env|} # not required. choices: auto;cli;credential_file;env. Controls the source of the credentials to use for authentication.,C(auto) will follow the default precedence of module parameters -> environment variables -> default profile in credential file C(~/.azure/credentials).,When set to C(cli), the credentials will be sources from the default Azure CLI profile.,Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. | |
subscription_id: ${14:null} # not required. Your Azure subscription Id. | |
password: ${15:null} # not required. Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | |
secret_value: ${16:undefined} # not required. Secret to be secured by keyvault. | |
api_profile: ${17|latest|} # not required. choices: latest. Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack. | |
""" | |
'azure_rm_loadbalancer': | |
'prefix': "azure_rm_loadbalancer_snippet" | |
'description': "Manage Azure load balancers." | |
'body': """ | |
azure_rm_loadbalancer: | |
resource_group: ${1:undefined} # required. Name of a resource group where the load balancer exists or will be created. | |
name: ${2:undefined} # required. Name of the load balancer. | |
profile: ${3:null} # not required. Security profile found in ~/.azure/credentials file. | |
probe_port: ${4:undefined} # not required. (deprecated) The port that the health probe will use.,This option has been deprecated, and will be removed in 2.9. Use I(probes) instead. | |
append_tags: ${5:true} # not required. Use to control if tags field is canonical or just appends to existing tags. When canonical, any tags not found in the tags parameter will be removed from the object's metadata. | |
load_balancing_rules: ${6:undefined} # not required. Object collection representing the load balancing rules Gets the provisioning. | |
tags: ${7:null} # not required. Dictionary of string:string pairs to assign as metadata to the object. Metadata tags on the object will be updated with any provided values. To remove tags set append_tags option to false.\n | |
ad_user: ${8:null} # not required. Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | |
cloud_environment: ${9:AzureCloud} # not required. For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable. | |
natpool_protocol: ${10:undefined} # not required. (deprecated) The protocol for the NAT pool.,This option has been deprecated, and will be removed in 2.9. Use I(inbound_nat_pools) instead. | |
inbound_nat_pools: ${11:undefined} # not required. Defines an external port range for inbound NAT to a single backend port on NICs associated with a load balancer.,Inbound NAT rules are created automatically for each NIC associated with the Load Balancer using an external port from this range.,Defining an Inbound NAT pool on your Load Balancer is mutually exclusive with defining inbound Nat rules.,Inbound NAT pools are referenced from virtual machine scale sets.,NICs that are associated with individual virtual machines cannot reference an inbound NAT pool.,They have to reference individual inbound NAT rules. | |
idle_timeout: ${12:4} # not required. (deprecated) Timeout for TCP idle connection in minutes.,This option has been deprecated, and will be removed in 2.9. Use I(load_balancing_rules) instead. | |
probe_interval: ${13:15} # not required. (deprecated) Time (in seconds) between endpoint health probes.,This option has been deprecated, and will be removed in 2.9. Use I(probes) instead. | |
client_id: ${14:null} # not required. Azure client ID. Use when authenticating with a Service Principal. | |
probe_protocol: ${15|Tcp,Http|} # not required. choices: Tcp;Http. (deprecated) The protocol to use for the health probe.,This option has been deprecated, and will be removed in 2.9. Use I(probes) instead. | |
load_distribution: ${16|Default,SourceIP,SourceIPProtocol|} # not required. choices: Default;SourceIP;SourceIPProtocol. (deprecated) The type of load distribution that the load balancer will employ.,This option has been deprecated, and will be removed in 2.9. Use I(load_balancing_rules) instead. | |
frontend_port: ${17:undefined} # not required. (deprecated) Frontend port that will be exposed for the load balancer.,This option has been deprecated, and will be removed in 2.9. Use I(load_balancing_rules) instead. | |
backend_port: ${18:undefined} # not required. (deprecated) Backend port that will be exposed for the load balancer.,This option has been deprecated, and will be removed in 2.9. Use I(load_balancing_rules) instead. | |
probes: ${19:undefined} # not required. List of probe definitions used to check endpoint health. | |
public_ip_address_name: ${20:undefined} # not required. (deprecated) Name of an existing public IP address object to associate with the security group.,This option has been deprecated, and will be removed in 2.9. Use I(frontend_ip_configurations) instead. | |
probe_fail_count: ${21:3} # not required. (deprecated) The amount of probe failures for the load balancer to make a health determination.,This option has been deprecated, and will be removed in 2.9. Use I(probes) instead. | |
password: ${22:null} # not required. Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | |
natpool_frontend_port_end: ${23:undefined} # not required. (deprecated) End of the port range for a NAT pool.,This option has been deprecated, and will be removed in 2.9. Use I(inbound_nat_pools) instead. | |
natpool_backend_port: ${24:undefined} # not required. (deprecated) Backend port used by the NAT pool.,This option has been deprecated, and will be removed in 2.9. Use I(inbound_nat_pools) instead. | |
tenant: ${25:null} # not required. Azure tenant ID. Use when authenticating with a Service Principal. | |
secret: ${26:null} # not required. Azure client secret. Use when authenticating with a Service Principal. | |
backend_address_pools: ${27:undefined} # not required. List of backend address pools | |
natpool_frontend_port_start: ${28:undefined} # not required. (deprecated) Start of the port range for a NAT pool.,This option has been deprecated, and will be removed in 2.9. Use I(inbound_nat_pools) instead. | |
protocol: ${29|Tcp,Udp|} # not required. choices: Tcp;Udp. (deprecated) The protocol (TCP or UDP) that the load balancer will use.,This option has been deprecated, and will be removed in 2.9. Use I(load_balancing_rules) instead. | |
frontend_ip_configurations: ${30:undefined} # not required. List of frontend IPs to be used | |
cert_validation_mode: ${31|validate,ignore|} # not required. choices: validate;ignore. Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. | |
state: ${32|absent,present|} # not required. choices: absent;present. Assert the state of the load balancer. Use C(present) to create/update a load balancer, or C(absent) to delete one. | |
location: ${33:resource_group location} # not required. Valid azure location. Defaults to location of the resource group. | |
probe_request_path: ${34:undefined} # not required. (deprecated) The URL that an HTTP probe will use (only relevant if probe_protocol is set to Http).,This option has been deprecated, and will be removed in 2.9. Use I(probes) instead. | |
auth_source: ${35|auto,cli,credential_file,env|} # not required. choices: auto;cli;credential_file;env. Controls the source of the credentials to use for authentication.,C(auto) will follow the default precedence of module parameters -> environment variables -> default profile in credential file C(~/.azure/credentials).,When set to C(cli), the credentials will be sources from the default Azure CLI profile.,Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. | |
subscription_id: ${36:null} # not required. Your Azure subscription Id. | |
api_profile: ${37|latest|} # not required. choices: latest. Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack. | |
""" | |
'azure_rm_loadbalancer_facts': | |
'prefix': "azure_rm_loadbalancer_facts_snippet" | |
'description': "Get load balancer facts." | |
'body': """ | |
azure_rm_loadbalancer_facts: | |
profile: ${1:null} # not required. Security profile found in ~/.azure/credentials file. | |
name: ${2:null} # not required. Limit results to a specific resource group. | |
resource_group: ${3:null} # not required. The resource group to search for the desired load balancer | |
tags: ${4:null} # not required. Limit results by providing a list of tags. Format tags as 'key' or 'key:value'. | |
ad_user: ${5:null} # not required. Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | |
cloud_environment: ${6:AzureCloud} # not required. For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable. | |
cert_validation_mode: ${7|validate,ignore|} # not required. choices: validate;ignore. Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. | |
secret: ${8:null} # not required. Azure client secret. Use when authenticating with a Service Principal. | |
client_id: ${9:null} # not required. Azure client ID. Use when authenticating with a Service Principal. | |
api_profile: ${10|latest|} # not required. choices: latest. Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack. | |
auth_source: ${11|auto,cli,credential_file,env|} # not required. choices: auto;cli;credential_file;env. Controls the source of the credentials to use for authentication.,C(auto) will follow the default precedence of module parameters -> environment variables -> default profile in credential file C(~/.azure/credentials).,When set to C(cli), the credentials will be sources from the default Azure CLI profile.,Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. | |
subscription_id: ${12:null} # not required. Your Azure subscription Id. | |
password: ${13:null} # not required. Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | |
tenant: ${14:null} # not required. Azure tenant ID. Use when authenticating with a Service Principal. | |
""" | |
'azure_rm_managed_disk': | |
'prefix': "azure_rm_managed_disk_snippet" | |
'description': "Manage Azure Manage Disks" | |
'body': """ | |
azure_rm_managed_disk: | |
resource_group: ${1:undefined} # required. Name of a resource group where the managed disk exists or will be created. | |
name: ${2:undefined} # required. Name of the managed disk. | |
ad_user: ${3:null} # not required. Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | |
managed_by: ${4:undefined} # not required. Name of an existing virtual machine with which the disk is or will be associated, this VM should be in the same resource group.,To detach a disk from a vm, keep undefined. | |
cert_validation_mode: ${5|validate,ignore|} # not required. choices: validate;ignore. Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. | |
source_resource_uri: ${6:undefined} # not required. The resource ID of the managed disk to copy when I(create_option) is C(copy). | |
append_tags: ${7:true} # not required. Use to control if tags field is canonical or just appends to existing tags. When canonical, any tags not found in the tags parameter will be removed from the object's metadata. | |
cloud_environment: ${8:AzureCloud} # not required. For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable. | |
state: ${9|absent,present|} # not required. choices: absent;present. Assert the state of the managed disk. Use C(present) to create or update a managed disk and 'absent' to delete a managed disk. | |
storage_account_type: ${10|Standard_LRS,Premium_LRS|} # not required. choices: Standard_LRS;Premium_LRS. Type of storage for the managed disk: C(Standard_LRS) or C(Premium_LRS). If not specified the disk is created C(Standard_LRS). | |
secret: ${11:null} # not required. Azure client secret. Use when authenticating with a Service Principal. | |
location: ${12:resource_group location} # not required. Valid Azure location. Defaults to location of the resource group. | |
subscription_id: ${13:null} # not required. Your Azure subscription Id. | |
profile: ${14:null} # not required. Security profile found in ~/.azure/credentials file. | |
tags: ${15:null} # not required. Tags to assign to the managed disk. | |
source_uri: ${16:undefined} # not required. URI to a valid VHD file to be used when I(create_option) is C(import). | |
client_id: ${17:null} # not required. Azure client ID. Use when authenticating with a Service Principal. | |
api_profile: ${18|latest|} # not required. choices: latest. Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack. | |
password: ${19:null} # not required. Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | |
create_option: ${20|empty,import,copy|} # not required. choices: empty;import;copy. Allowed values: empty, import, copy. C(import) from a VHD file in I(source_uri) and C(copy) from previous managed disk I(source_resource_uri). | |
tenant: ${21:null} # not required. Azure tenant ID. Use when authenticating with a Service Principal. | |
disk_size_gb: ${22:undefined} # not required. Size in GB of the managed disk to be created. If I(create_option) is C(copy) then the value must be greater than or equal to the source's size. | |
auth_source: ${23|auto,cli,credential_file,env|} # not required. choices: auto;cli;credential_file;env. Controls the source of the credentials to use for authentication.,C(auto) will follow the default precedence of module parameters -> environment variables -> default profile in credential file C(~/.azure/credentials).,When set to C(cli), the credentials will be sources from the default Azure CLI profile.,Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. | |
os_type: ${24|linux,windows|} # not required. choices: linux;windows. Type of Operating System: C(linux) or C(windows). Used when I(create_option) is either C(copy) or C(import) and the source is an OS disk. | |
""" | |
'azure_rm_managed_disk_facts': | |
'prefix': "azure_rm_managed_disk_facts_snippet" | |
'description': "Get managed disk facts." | |
'body': """ | |
azure_rm_managed_disk_facts: | |
profile: ${1:null} # not required. Security profile found in ~/.azure/credentials file. | |
name: ${2:null} # not required. Limit results to a specific managed disk | |
resource_group: ${3:null} # not required. Limit results to a specific resource group | |
tags: ${4:null} # not required. Limit results by providing a list of tags. Format tags as 'key' or 'key:value'. | |
ad_user: ${5:null} # not required. Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | |
cloud_environment: ${6:AzureCloud} # not required. For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable. | |
cert_validation_mode: ${7|validate,ignore|} # not required. choices: validate;ignore. Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. | |
secret: ${8:null} # not required. Azure client secret. Use when authenticating with a Service Principal. | |
client_id: ${9:null} # not required. Azure client ID. Use when authenticating with a Service Principal. | |
api_profile: ${10|latest|} # not required. choices: latest. Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack. | |
auth_source: ${11|auto,cli,credential_file,env|} # not required. choices: auto;cli;credential_file;env. Controls the source of the credentials to use for authentication.,C(auto) will follow the default precedence of module parameters -> environment variables -> default profile in credential file C(~/.azure/credentials).,When set to C(cli), the credentials will be sources from the default Azure CLI profile.,Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. | |
subscription_id: ${12:null} # not required. Your Azure subscription Id. | |
password: ${13:null} # not required. Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | |
tenant: ${14:null} # not required. Azure tenant ID. Use when authenticating with a Service Principal. | |
""" | |
'azure_rm_mysqldatabase': | |
'prefix': "azure_rm_mysqldatabase_snippet" | |
'description': "Manage MySQL Database instance." | |
'body': """ | |
azure_rm_mysqldatabase: | |
resource_group: ${1:undefined} # required. The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. | |
name: ${2:undefined} # required. The name of the database. | |
server_name: ${3:undefined} # required. The name of the server. | |
profile: ${4:null} # not required. Security profile found in ~/.azure/credentials file. | |
force_update: ${5:no} # not required. When set to C(true), will delete and recreate the existing MySQL database if any of the properties don't match what is set.,When set to C(false), no change will occur to the database even if any of the properties do not match. | |
ad_user: ${6:null} # not required. Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | |
client_id: ${7:null} # not required. Azure client ID. Use when authenticating with a Service Principal. | |
api_profile: ${8|latest|} # not required. choices: latest. Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack. | |
collation: ${9:undefined} # not required. The collation of the database. Check MySQL documentation for possible values.,This is only set on creation, use I(force_update) to recreate a database if the values don't match. | |
password: ${10:null} # not required. Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | |
tenant: ${11:null} # not required. Azure tenant ID. Use when authenticating with a Service Principal. | |
charset: ${12:undefined} # not required. The charset of the database. Check MySQL documentation for possible values.,This is only set on creation, use I(force_update) to recreate a database if the values don't match. | |
cloud_environment: ${13:AzureCloud} # not required. For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable. | |
cert_validation_mode: ${14|validate,ignore|} # not required. choices: validate;ignore. Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. | |
secret: ${15:null} # not required. Azure client secret. Use when authenticating with a Service Principal. | |
auth_source: ${16|auto,cli,credential_file,env|} # not required. choices: auto;cli;credential_file;env. Controls the source of the credentials to use for authentication.,C(auto) will follow the default precedence of module parameters -> environment variables -> default profile in credential file C(~/.azure/credentials).,When set to C(cli), the credentials will be sources from the default Azure CLI profile.,Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. | |
subscription_id: ${17:null} # not required. Your Azure subscription Id. | |
""" | |
'azure_rm_mysqlserver': | |
'prefix': "azure_rm_mysqlserver_snippet" | |
'description': "Manage MySQL Server instance." | |
'body': """ | |
azure_rm_mysqlserver: | |
name: ${1:undefined} # required. The name of the server. | |
resource_group: ${2:undefined} # required. The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. | |
sku: ${3:undefined} # not required. The SKU (pricing tier) of the server. | |
profile: ${4:null} # not required. Security profile found in ~/.azure/credentials file. | |
cloud_environment: ${5:AzureCloud} # not required. For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable. | |
ad_user: ${6:null} # not required. Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | |
storage_mb: ${7:undefined} # not required. The maximum storage allowed for a server. | |
admin_username: ${8:undefined} # not required. The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation). | |
api_profile: ${9|latest|} # not required. choices: latest. Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack. | |
secret: ${10:null} # not required. Azure client secret. Use when authenticating with a Service Principal. | |
version: ${11|5.6,5.7|} # not required. choices: 5.6;5.7. Server version. | |
location: ${12:undefined} # not required. Resource location. If not set, location from the resource group will be used as default. | |
client_id: ${13:null} # not required. Azure client ID. Use when authenticating with a Service Principal. | |
cert_validation_mode: ${14|validate,ignore|} # not required. choices: validate;ignore. Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. | |
tenant: ${15:null} # not required. Azure tenant ID. Use when authenticating with a Service Principal. | |
auth_source: ${16|auto,cli,credential_file,env|} # not required. choices: auto;cli;credential_file;env. Controls the source of the credentials to use for authentication.,C(auto) will follow the default precedence of module parameters -> environment variables -> default profile in credential file C(~/.azure/credentials).,When set to C(cli), the credentials will be sources from the default Azure CLI profile.,Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. | |
subscription_id: ${17:null} # not required. Your Azure subscription Id. | |
password: ${18:null} # not required. Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | |
enforce_ssl: ${19:false} # not required. Enable SSL enforcement. | |
admin_password: ${20:undefined} # not required. The password of the administrator login. | |
""" | |
'azure_rm_networkinterface': | |
'prefix': "azure_rm_networkinterface_snippet" | |
'description': "Manage Azure network interfaces." | |
'body': """ | |
azure_rm_networkinterface: | |
resource_group: ${1:undefined} # required. Name of a resource group where the network interface exists or will be created. | |
subnet_name: ${2:null} # required. Name of an existing subnet within the specified virtual network. Required when creating a network interface | |
virtual_network_name: ${3:undefined} # required. Name or id of an existing virtual network with which the network interface will be associated. Required when creating a network interface. | |
name: ${4:undefined} # required. Name of the network interface. | |
public_ip_allocation_method: ${5|Dynamic,Static|} # not required. choices: Dynamic;Static. (Deprecate) If a public_ip_address_name is not provided, a default public IP address will be created. The allocation method determines whether or not the public IP address assigned to the network interface is permanent.,This option will be deprecated in 2.9, use I(ip_configurations) instead. | |
public_ip: ${6:true} # not required. (Deprecate) When creating a network interface, if no public IP address name is provided a default public IP address will be created. Set to false, if you do not want a public IP address automatically created.,This option will be deprecated in 2.9, use I(ip_configurations) instead. | |
cert_validation_mode: ${7|validate,ignore|} # not required. choices: validate;ignore. Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. | |
ip_configurations: ${8:undefined} # not required. List of ip configuration if contains mutilple configuration, should contain configuration object include field private_ip_address, private_ip_allocation_method, public_ip_address_name, public_ip, subnet_name, virtual_network_name, public_ip_allocation_method, name | |
public_ip_address_name: ${9:null} # not required. (Deprecate) Name of an existing public IP address object to associate with the security group.,This option will be deprecated in 2.9, use I(ip_configurations) instead. | |
password: ${10:null} # not required. Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | |
append_tags: ${11:true} # not required. Use to control if tags field is canonical or just appends to existing tags. When canonical, any tags not found in the tags parameter will be removed from the object's metadata. | |
cloud_environment: ${12:AzureCloud} # not required. For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable. | |
state: ${13|absent,present|} # not required. choices: absent;present. Assert the state of the network interface. Use 'present' to create or update an interface and 'absent' to delete an interface. | |
secret: ${14:null} # not required. Azure client secret. Use when authenticating with a Service Principal. | |
location: ${15:resource_group location} # not required. Valid azure location. Defaults to location of the resource group. | |
subscription_id: ${16:null} # not required. Your Azure subscription Id. | |
profile: ${17:null} # not required. Security profile found in ~/.azure/credentials file. | |
tags: ${18:null} # not required. Dictionary of string:string pairs to assign as metadata to the object. Metadata tags on the object will be updated with any provided values. To remove tags set append_tags option to false.\n | |
security_group_name: ${19:null} # not required. Name of an existing security group with which to associate the network interface. If not provided, a default security group will be created. | |
private_ip_allocation_method: ${20|Dynamic,Static|} # not required. choices: Dynamic;Static. (Deprecate) Specify whether or not the assigned IP address is permanent. NOTE: when creating a network interface specifying a value of 'Static' requires that a private_ip_address value be provided. You can update the allocation method to 'Static' after a dynamic private ip address has been assigned.,This option will be deprecated in 2.9, use I(ip_configurations) instead. | |
client_id: ${21:null} # not required. Azure client ID. Use when authenticating with a Service Principal. | |
api_profile: ${22|latest|} # not required. choices: latest. Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack. | |
open_ports: ${23:null} # not required. When a default security group is created for a Linux host a rule will be added allowing inbound TCP connections to the default SSH port 22, and for a Windows host rules will be added allowing inbound access to RDP ports 3389 and 5986. Override the default ports by providing a list of open ports. | |
tenant: ${24:null} # not required. Azure tenant ID. Use when authenticating with a Service Principal. | |
ad_user: ${25:null} # not required. Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | |
private_ip_address: ${26:undefined} # not required. (Deprecate) Valid IPv4 address that falls within the specified subnet.,This option will be deprecated in 2.9, use I(ip_configurations) instead. | |
auth_source: ${27|auto,cli,credential_file,env|} # not required. choices: auto;cli;credential_file;env. Controls the source of the credentials to use for authentication.,C(auto) will follow the default precedence of module parameters -> environment variables -> default profile in credential file C(~/.azure/credentials).,When set to C(cli), the credentials will be sources from the default Azure CLI profile.,Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. | |
os_type: ${28|Windows,Linux|} # not required. choices: Windows;Linux. Determines any rules to be added to a default security group. When creating a network interface, if no security group name is provided, a default security group will be created. If the os_type is 'Windows', a rule will be added allowing RDP access. If the os_type is 'Linux', a rule allowing SSH access will be added. | |
""" | |
'azure_rm_networkinterface_facts': | |
'prefix': "azure_rm_networkinterface_facts_snippet" | |
'description': "Get network interface facts." | |
'body': """ | |
azure_rm_networkinterface_facts: | |
profile: ${1:null} # not required. Security profile found in ~/.azure/credentials file. | |
name: ${2:null} # not required. Only show results for a specific network interface. | |
resource_group: ${3:null} # not required. Name of the resource group containing the network interface(s). Required when searching by name. | |
tags: ${4:null} # not required. Limit results by providing a list of tags. Format tags as 'key' or 'key:value'. | |
ad_user: ${5:null} # not required. Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | |
cloud_environment: ${6:AzureCloud} # not required. For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable. | |
cert_validation_mode: ${7|validate,ignore|} # not required. choices: validate;ignore. Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. | |
secret: ${8:null} # not required. Azure client secret. Use when authenticating with a Service Principal. | |
client_id: ${9:null} # not required. Azure client ID. Use when authenticating with a Service Principal. | |
api_profile: ${10|latest|} # not required. choices: latest. Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack. | |
auth_source: ${11|auto,cli,credential_file,env|} # not required. choices: auto;cli;credential_file;env. Controls the source of the credentials to use for authentication.,C(auto) will follow the default precedence of module parameters -> environment variables -> default profile in credential file C(~/.azure/credentials).,When set to C(cli), the credentials will be sources from the default Azure CLI profile.,Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. | |
subscription_id: ${12:null} # not required. Your Azure subscription Id. | |
password: ${13:null} # not required. Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | |
tenant: ${14:null} # not required. Azure tenant ID. Use when authenticating with a Service Principal. | |
""" | |
'azure_rm_postgresqldatabase': | |
'prefix': "azure_rm_postgresqldatabase_snippet" | |
'description': "Manage PostgreSQL Database instance." | |
'body': """ | |
azure_rm_postgresqldatabase: | |
resource_group: ${1:undefined} # required. The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. | |
name: ${2:undefined} # required. The name of the database. | |
server_name: ${3:undefined} # required. The name of the server. | |
profile: ${4:null} # not required. Security profile found in ~/.azure/credentials file. | |
force_update: ${5:no} # not required. When set to C(true), will delete and recreate the existing PostgreSQL database if any of the properties don't match what is set.,When set to C(false), no change will occur to the database even if any of the properties do not match. | |
ad_user: ${6:null} # not required. Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | |
client_id: ${7:null} # not required. Azure client ID. Use when authenticating with a Service Principal. | |
api_profile: ${8|latest|} # not required. choices: latest. Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack. | |
collation: ${9:undefined} # not required. The collation of the database. Check PostgreSQL documentation for possible values.,This is only set on creation, use I(force_update) to recreate a database if the values don't match. | |
password: ${10:null} # not required. Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | |
tenant: ${11:null} # not required. Azure tenant ID. Use when authenticating with a Service Principal. | |
charset: ${12:undefined} # not required. The charset of the database. Check PostgreSQL documentation for possible values.,This is only set on creation, use I(force_update) to recreate a database if the values don't match. | |
cloud_environment: ${13:AzureCloud} # not required. For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable. | |
cert_validation_mode: ${14|validate,ignore|} # not required. choices: validate;ignore. Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. | |
secret: ${15:null} # not required. Azure client secret. Use when authenticating with a Service Principal. | |
auth_source: ${16|auto,cli,credential_file,env|} # not required. choices: auto;cli;credential_file;env. Controls the source of the credentials to use for authentication.,C(auto) will follow the default precedence of module parameters -> environment variables -> default profile in credential file C(~/.azure/credentials).,When set to C(cli), the credentials will be sources from the default Azure CLI profile.,Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. | |
subscription_id: ${17:null} # not required. Your Azure subscription Id. | |
""" | |
'azure_rm_postgresqlserver': | |
'prefix': "azure_rm_postgresqlserver_snippet" | |
'description': "Manage PostgreSQL Server instance." | |
'body': """ | |
azure_rm_postgresqlserver: | |
name: ${1:undefined} # required. The name of the server. | |
resource_group: ${2:undefined} # required. The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. | |
sku: ${3:undefined} # not required. The SKU (pricing tier) of the server. | |
profile: ${4:null} # not required. Security profile found in ~/.azure/credentials file. | |
cloud_environment: ${5:AzureCloud} # not required. For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable. | |
ad_user: ${6:null} # not required. Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | |
storage_mb: ${7:undefined} # not required. The maximum storage allowed for a server. | |
admin_username: ${8:undefined} # not required. The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation). | |
api_profile: ${9|latest|} # not required. choices: latest. Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack. | |
secret: ${10:null} # not required. Azure client secret. Use when authenticating with a Service Principal. | |
version: ${11|9.5,9.6|} # not required. choices: 9.5;9.6. Server version. | |
location: ${12:undefined} # not required. Resource location. If not set, location from the resource group will be used as default. | |
client_id: ${13:null} # not required. Azure client ID. Use when authenticating with a Service Principal. | |
cert_validation_mode: ${14|validate,ignore|} # not required. choices: validate;ignore. Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. | |
tenant: ${15:null} # not required. Azure tenant ID. Use when authenticating with a Service Principal. | |
auth_source: ${16|auto,cli,credential_file,env|} # not required. choices: auto;cli;credential_file;env. Controls the source of the credentials to use for authentication.,C(auto) will follow the default precedence of module parameters -> environment variables -> default profile in credential file C(~/.azure/credentials).,When set to C(cli), the credentials will be sources from the default Azure CLI profile.,Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. | |
subscription_id: ${17:null} # not required. Your Azure subscription Id. | |
password: ${18:null} # not required. Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | |
enforce_ssl: ${19:false} # not required. Enable SSL enforcement. | |
admin_password: ${20:undefined} # not required. The password of the administrator login. | |
""" | |
'azure_rm_publicipaddress': | |
'prefix': "azure_rm_publicipaddress_snippet" | |
'description': "Manage Azure Public IP Addresses." | |
'body': """ | |
azure_rm_publicipaddress: | |
resource_group: ${1:undefined} # required. Name of resource group with which the Public IP is associated. | |
name: ${2:undefined} # required. Name of the Public IP. | |
profile: ${3:null} # not required. Security profile found in ~/.azure/credentials file. | |
tags: ${4:null} # not required. Dictionary of string:string pairs to assign as metadata to the object. Metadata tags on the object will be updated with any provided values. To remove tags set append_tags option to false.\n | |
ad_user: ${5:null} # not required. Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | |
secret: ${6:null} # not required. Azure client secret. Use when authenticating with a Service Principal. | |
domain_name_label: ${7:null} # not required. The customizable portion of the FQDN assigned to public IP address. This is an explicit setting. If no value is provided, any existing value will be removed on an existing public IP. | |
client_id: ${8:null} # not required. Azure client ID. Use when authenticating with a Service Principal. | |
allocation_method: ${9|Dynamic,Static|} # not required. choices: Dynamic;Static. Control whether the assigned Public IP remains permanently assigned to the object. If not set to 'Static', the IP address my changed anytime an associated virtual machine is power cycled. | |
password: ${10:null} # not required. Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | |
tenant: ${11:null} # not required. Azure tenant ID. Use when authenticating with a Service Principal. | |
api_profile: ${12|latest|} # not required. choices: latest. Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack. | |
append_tags: ${13:true} # not required. Use to control if tags field is canonical or just appends to existing tags. When canonical, any tags not found in the tags parameter will be removed from the object's metadata. | |
cloud_environment: ${14:AzureCloud} # not required. For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable. | |
state: ${15|absent,present|} # not required. choices: absent;present. Assert the state of the Public IP. Use 'present' to create or update a and 'absent' to delete. | |
cert_validation_mode: ${16|validate,ignore|} # not required. choices: validate;ignore. Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. | |
location: ${17:resource_group location} # not required. Valid azure location. Defaults to location of the resource group. | |
auth_source: ${18|auto,cli,credential_file,env|} # not required. choices: auto;cli;credential_file;env. Controls the source of the credentials to use for authentication.,C(auto) will follow the default precedence of module parameters -> environment variables -> default profile in credential file C(~/.azure/credentials).,When set to C(cli), the credentials will be sources from the default Azure CLI profile.,Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. | |
subscription_id: ${19:null} # not required. Your Azure subscription Id. | |
""" | |
'azure_rm_publicipaddress_facts': | |
'prefix': "azure_rm_publicipaddress_facts_snippet" | |
'description': "Get public IP facts." | |
'body': """ | |
azure_rm_publicipaddress_facts: | |
profile: ${1:null} # not required. Security profile found in ~/.azure/credentials file. | |
name: ${2:null} # not required. Only show results for a specific Public IP. | |
resource_group: ${3:null} # not required. Limit results by resource group. Required when using name parameter. | |
tags: ${4:null} # not required. Limit results by providing a list of tags. Format tags as 'key' or 'key:value'. | |
ad_user: ${5:null} # not required. Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | |
cloud_environment: ${6:AzureCloud} # not required. For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable. | |
cert_validation_mode: ${7|validate,ignore|} # not required. choices: validate;ignore. Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. | |
secret: ${8:null} # not required. Azure client secret. Use when authenticating with a Service Principal. | |
client_id: ${9:null} # not required. Azure client ID. Use when authenticating with a Service Principal. | |
api_profile: ${10|latest|} # not required. choices: latest. Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack. | |
auth_source: ${11|auto,cli,credential_file,env|} # not required. choices: auto;cli;credential_file;env. Controls the source of the credentials to use for authentication.,C(auto) will follow the default precedence of module parameters -> environment variables -> default profile in credential file C(~/.azure/credentials).,When set to C(cli), the credentials will be sources from the default Azure CLI profile.,Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. | |
subscription_id: ${12:null} # not required. Your Azure subscription Id. | |
password: ${13:null} # not required. Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | |
tenant: ${14:null} # not required. Azure tenant ID. Use when authenticating with a Service Principal. | |
""" | |
'azure_rm_resourcegroup': | |
'prefix': "azure_rm_resourcegroup_snippet" | |
'description': "Manage Azure resource groups." | |
'body': """ | |
azure_rm_resourcegroup: | |
name: ${1:undefined} # required. Name of the resource group. | |
profile: ${2:null} # not required. Security profile found in ~/.azure/credentials file. | |
force: ${3:false} # not required. Remove a resource group and all associated resources. Use with state 'absent' to delete a resource group that contains resources. | |
tags: ${4:null} # not required. Dictionary of string:string pairs to assign as metadata to the object. Metadata tags on the object will be updated with any provided values. To remove tags set append_tags option to false.\n | |
cloud_environment: ${5:AzureCloud} # not required. For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable. | |
append_tags: ${6:true} # not required. Use to control if tags field is canonical or just appends to existing tags. When canonical, any tags not found in the tags parameter will be removed from the object's metadata. | |
ad_user: ${7:null} # not required. Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | |
secret: ${8:null} # not required. Azure client secret. Use when authenticating with a Service Principal. | |
state: ${9|absent,present|} # not required. choices: absent;present. Assert the state of the resource group. Use 'present' to create or update and 'absent' to delete. When 'absent' a resource group containing resources will not be removed unless the force option is used. | |
location: ${10:null} # not required. Azure location for the resource group. Required when creating a new resource group. Cannot be changed once resource group is created. | |
client_id: ${11:null} # not required. Azure client ID. Use when authenticating with a Service Principal. | |
cert_validation_mode: ${12|validate,ignore|} # not required. choices: validate;ignore. Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. | |
auth_source: ${13|auto,cli,credential_file,env|} # not required. choices: auto;cli;credential_file;env. Controls the source of the credentials to use for authentication.,C(auto) will follow the default precedence of module parameters -> environment variables -> default profile in credential file C(~/.azure/credentials).,When set to C(cli), the credentials will be sources from the default Azure CLI profile.,Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. | |
subscription_id: ${14:null} # not required. Your Azure subscription Id. | |
password: ${15:null} # not required. Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | |
tenant: ${16:null} # not required. Azure tenant ID. Use when authenticating with a Service Principal. | |
api_profile: ${17|latest|} # not required. choices: latest. Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack. | |
""" | |
'azure_rm_resourcegroup_facts': | |
'prefix': "azure_rm_resourcegroup_facts_snippet" | |
'description': "Get resource group facts." | |
'body': """ | |
azure_rm_resourcegroup_facts: | |
profile: ${1:null} # not required. Security profile found in ~/.azure/credentials file. | |
name: ${2:null} # not required. Limit results to a specific resource group. | |
tags: ${3:null} # not required. Limit results by providing a list of tags. Format tags as 'key' or 'key:value'. | |
ad_user: ${4:null} # not required. Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | |
cloud_environment: ${5:AzureCloud} # not required. For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable. | |
cert_validation_mode: ${6|validate,ignore|} # not required. choices: validate;ignore. Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. | |
secret: ${7:null} # not required. Azure client secret. Use when authenticating with a Service Principal. | |
client_id: ${8:null} # not required. Azure client ID. Use when authenticating with a Service Principal. | |
api_profile: ${9|latest|} # not required. choices: latest. Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack. | |
auth_source: ${10|auto,cli,credential_file,env|} # not required. choices: auto;cli;credential_file;env. Controls the source of the credentials to use for authentication.,C(auto) will follow the default precedence of module parameters -> environment variables -> default profile in credential file C(~/.azure/credentials).,When set to C(cli), the credentials will be sources from the default Azure CLI profile.,Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. | |
subscription_id: ${11:null} # not required. Your Azure subscription Id. | |
password: ${12:null} # not required. Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | |
tenant: ${13:null} # not required. Azure tenant ID. Use when authenticating with a Service Principal. | |
""" | |
'azure_rm_securitygroup': | |
'prefix': "azure_rm_securitygroup_snippet" | |
'description': "Manage Azure network security groups." | |
'body': """ | |
azure_rm_securitygroup: | |
resource_group: ${1:undefined} # required. Name of the resource group the security group belongs to. | |
profile: ${2:null} # not required. Security profile found in ~/.azure/credentials file. | |
purge_rules: ${3:false} # not required. Remove any existing rules not matching those defined in the rules parameters. | |
tags: ${4:null} # not required. Dictionary of string:string pairs to assign as metadata to the object. Metadata tags on the object will be updated with any provided values. To remove tags set append_tags option to false.\n | |
rules: ${5:null} # not required. Set of rules shaping traffic flow to or from a subnet or NIC. Each rule is a dictionary. | |
cloud_environment: ${6:AzureCloud} # not required. For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable. | |
append_tags: ${7:true} # not required. Use to control if tags field is canonical or just appends to existing tags. When canonical, any tags not found in the tags parameter will be removed from the object's metadata. | |
ad_user: ${8:null} # not required. Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | |
secret: ${9:null} # not required. Azure client secret. Use when authenticating with a Service Principal. | |
default_rules: ${10:null} # not required. The set of default rules automatically added to a security group at creation. In general default rules will not be modified. Modify rules to shape the flow of traffic to or from a subnet or NIC. See rules below for the makeup of a rule dict. | |
api_profile: ${11|latest|} # not required. choices: latest. Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack. | |
purge_default_rules: ${12:false} # not required. Remove any existing rules not matching those defined in the default_rules parameter. | |
state: ${13|absent,present|} # not required. choices: absent;present. Assert the state of the security group. Set to 'present' to create or update a security group. Set to 'absent' to remove a security group. | |
location: ${14:resource_group location} # not required. Valid azure location. Defaults to location of the resource group. | |
client_id: ${15:null} # not required. Azure client ID. Use when authenticating with a Service Principal. | |
cert_validation_mode: ${16|validate,ignore|} # not required. choices: validate;ignore. Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. | |
auth_source: ${17|auto,cli,credential_file,env|} # not required. choices: auto;cli;credential_file;env. Controls the source of the credentials to use for authentication.,C(auto) will follow the default precedence of module parameters -> environment variables -> default profile in credential file C(~/.azure/credentials).,When set to C(cli), the credentials will be sources from the default Azure CLI profile.,Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. | |
subscription_id: ${18:null} # not required. Your Azure subscription Id. | |
password: ${19:null} # not required. Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | |
tenant: ${20:null} # not required. Azure tenant ID. Use when authenticating with a Service Principal. | |
name: ${21:null} # not required. Name of the security group to operate on. | |
""" | |
'azure_rm_securitygroup_facts': | |
'prefix': "azure_rm_securitygroup_facts_snippet" | |
'description': "Get security group facts." | |
'body': """ | |
azure_rm_securitygroup_facts: | |
resource_group: ${1:undefined} # required. Name of the resource group to use. | |
profile: ${2:null} # not required. Security profile found in ~/.azure/credentials file. | |
name: ${3:null} # not required. Only show results for a specific security group. | |
tags: ${4:null} # not required. Limit results by providing a list of tags. Format tags as 'key' or 'key:value'. | |
ad_user: ${5:null} # not required. Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | |
cloud_environment: ${6:AzureCloud} # not required. For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable. | |
cert_validation_mode: ${7|validate,ignore|} # not required. choices: validate;ignore. Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. | |
secret: ${8:null} # not required. Azure client secret. Use when authenticating with a Service Principal. | |
client_id: ${9:null} # not required. Azure client ID. Use when authenticating with a Service Principal. | |
api_profile: ${10|latest|} # not required. choices: latest. Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack. | |
auth_source: ${11|auto,cli,credential_file,env|} # not required. choices: auto;cli;credential_file;env. Controls the source of the credentials to use for authentication.,C(auto) will follow the default precedence of module parameters -> environment variables -> default profile in credential file C(~/.azure/credentials).,When set to C(cli), the credentials will be sources from the default Azure CLI profile.,Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. | |
subscription_id: ${12:null} # not required. Your Azure subscription Id. | |
password: ${13:null} # not required. Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | |
tenant: ${14:null} # not required. Azure tenant ID. Use when authenticating with a Service Principal. | |
""" | |
'azure_rm_sqldatabase': | |
'prefix': "azure_rm_sqldatabase_snippet" | |
'description': "Manage SQL Database instance." | |
'body': """ | |
azure_rm_sqldatabase: | |
resource_group: ${1:undefined} # required. The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. | |
name: ${2:undefined} # required. The name of the database to be operated on (updated or created). | |
server_name: ${3:undefined} # required. The name of the server. | |
profile: ${4:null} # not required. Security profile found in ~/.azure/credentials file. | |
ad_user: ${5:null} # not required. Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | |
cloud_environment: ${6:AzureCloud} # not required. For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable. | |
recovery_services_recovery_point_resource_id: ${7:undefined} # not required. Required if I(create_mode) is C(restore_long_term_retention_backup), then this value is required. Specifies the resource ID of the recovery point to restore from. | |
edition: ${8|web,business,basic,standard,premium,free,stretch,data_warehouse,system,system2|} # not required. choices: web;business;basic;standard;premium;free;stretch;data_warehouse;system;system2. The edition of the database. The DatabaseEditions enumeration contains all the valid editions. If I(create_mode) is C(non_readable_secondary) or C(online_secondary), this value is ignored. To see possible values, query the capabilities API (/subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationID}/capabilities) referred to by operationId: 'Capabilities_ListByLocation.'. | |
elastic_pool_name: ${9:undefined} # not required. The name of the elastic pool the database is in. Not supported for C(data_warehouse) edition. | |
client_id: ${10:null} # not required. Azure client ID. Use when authenticating with a Service Principal. | |
cert_validation_mode: ${11|validate,ignore|} # not required. choices: validate;ignore. Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. | |
max_size_bytes: ${12:undefined} # not required. The max size of the database expressed in bytes. If I(create_mode) is not C(default), this value is ignored. To see possible values, query the capabilities API (/subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationID}/capabilities) referred to by operationId: 'Capabilities_ListByLocation." | |
password: ${13:null} # not required. Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | |
zone_redundant: ${14:false} # not required. Is this database is zone redundant? It means the replicas of this database will be spread across multiple availability zones. | |
tenant: ${15:null} # not required. Azure tenant ID. Use when authenticating with a Service Principal. | |
restore_point_in_time: ${16:undefined} # not required. Required if I(create_mode) is C(point_in_time_restore), this value is required. If I(create_mode) is C(restore), this value is optional. Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. Must be greater than or equal to the source database's earliestRestoreDate value. | |
create_mode: ${17|copy,default,non_readable_secondary,online_secondary,point_in_time_restore,recovery,restore,restore_long_term_retention_backup|} # not required. choices: copy;default;non_readable_secondary;online_secondary;point_in_time_restore;recovery;restore;restore_long_term_retention_backup. Specifies the mode of database creation.,C(default): regular database creation.,C(copy): creates a database as a copy of an existing database.,C(online_secondary)/C(non_readable_secondary): creates a database as a (readable or nonreadable) secondary replica of an existing database.,C(point_in_time_restore): Creates a database by restoring a point in time backup of an existing database.,C(recovery): Creates a database by restoring a geo-replicated backup.,C(restore): Creates a database by restoring a backup of a deleted database.,C(restore_long_term_retention_backup): Creates a database by restoring from a long term retention vault.,C(copy), C(non_readable_secondary), C(online_secondary) and C(restore_long_term_retention_backup) are not supported for C(data_warehouse) edition. | |
source_database_deletion_date: ${18:undefined} # not required. Required if I(create_mode) is C(restore) and I(source_database_id) is the deleted database's original resource id when it existed (as opposed to its current restorable dropped database id), then this value is required. Specifies the time that the database was deleted. | |
force_update: ${19:undefined} # not required. SQL Database will be updated if given parameters differ from existing resource state.,To force SQL Database update in any circumstances set this parameter to True. | |
collation: ${20:undefined} # not required. The collation of the database. If I(create_mode) is not C(default), this value is ignored. | |
secret: ${21:null} # not required. Azure client secret. Use when authenticating with a Service Principal. | |
source_database_id: ${22:undefined} # not required. Required unless I(create_mode) is C(default) or C(restore_long_term_retention_backup).,Specifies the resource ID of the source database | |
state: ${23|absent,present|} # not required. choices: absent;present. Assert the state of the SQL Database. Use 'present' to create or update an SQL Database and 'absent' to delete it. | |
location: ${24:undefined} # not required. Resource location. If not set, location from the resource group will be used as C(default). | |
sample_name: ${25|adventure_works_lt|} # not required. choices: adventure_works_lt. Indicates the name of the sample schema to apply when creating this database. If I(create_mode) is not C(default), this value is ignored. Not supported for C(data_warehouse) edition. | |
auth_source: ${26|auto,cli,credential_file,env|} # not required. choices: auto;cli;credential_file;env. Controls the source of the credentials to use for authentication.,C(auto) will follow the default precedence of module parameters -> environment variables -> default profile in credential file C(~/.azure/credentials).,When set to C(cli), the credentials will be sources from the default Azure CLI profile.,Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. | |
subscription_id: ${27:null} # not required. Your Azure subscription Id. | |
read_scale: ${28:false} # not required. If the database is a geo-secondary, indicates whether read-only connections are allowed to this database or not. Not supported for C(data_warehouse) edition. | |
api_profile: ${29|latest|} # not required. choices: latest. Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack. | |
""" | |
'azure_rm_sqlserver': | |
'prefix': "azure_rm_sqlserver_snippet" | |
'description': "Manage SQL Server instance" | |
'body': """ | |
azure_rm_sqlserver: | |
resource_group: ${1:undefined} # required. The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. | |
name: ${2:undefined} # required. The name of the server. | |
profile: ${3:null} # not required. Security profile found in ~/.azure/credentials file. | |
tags: ${4:null} # not required. Dictionary of string:string pairs to assign as metadata to the object. Metadata tags on the object will be updated with any provided values. To remove tags set append_tags option to false.\n | |
ad_user: ${5:null} # not required. Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | |
client_id: ${6:null} # not required. Azure client ID. Use when authenticating with a Service Principal. | |
api_profile: ${7|latest|} # not required. choices: latest. Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack. | |
password: ${8:null} # not required. Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | |
identity: ${9:undefined} # not required. The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resour ce. Possible values include: 'SystemAssigned" | |
tenant: ${10:null} # not required. Azure tenant ID. Use when authenticating with a Service Principal. | |
append_tags: ${11:true} # not required. Use to control if tags field is canonical or just appends to existing tags. When canonical, any tags not found in the tags parameter will be removed from the object's metadata. | |
cloud_environment: ${12:AzureCloud} # not required. For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable. | |
cert_validation_mode: ${13|validate,ignore|} # not required. choices: validate;ignore. Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. | |
admin_username: ${14:undefined} # not required. Administrator username for the server. Once created it cannot be changed. | |
secret: ${15:null} # not required. Azure client secret. Use when authenticating with a Service Principal. | |
version: ${16:undefined} # not required. The version of the server. For example '12.0'. | |
location: ${17:undefined} # not required. Resource location. | |
auth_source: ${18|auto,cli,credential_file,env|} # not required. choices: auto;cli;credential_file;env. Controls the source of the credentials to use for authentication.,C(auto) will follow the default precedence of module parameters -> environment variables -> default profile in credential file C(~/.azure/credentials).,When set to C(cli), the credentials will be sources from the default Azure CLI profile.,Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. | |
subscription_id: ${19:null} # not required. Your Azure subscription Id. | |
admin_password: ${20:undefined} # not required. The administrator login password (required for server creation). | |
""" | |
'azure_rm_sqlserver_facts': | |
'prefix': "azure_rm_sqlserver_facts_snippet" | |
'description': "Get SQL Server facts." | |
'body': """ | |
azure_rm_sqlserver_facts: | |
resource_group: ${1:undefined} # required. The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. | |
profile: ${2:null} # not required. Security profile found in ~/.azure/credentials file. | |
server_name: ${3:undefined} # not required. The name of the server. | |
ad_user: ${4:null} # not required. Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | |
cloud_environment: ${5:AzureCloud} # not required. For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable. | |
cert_validation_mode: ${6|validate,ignore|} # not required. choices: validate;ignore. Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. | |
secret: ${7:null} # not required. Azure client secret. Use when authenticating with a Service Principal. | |
client_id: ${8:null} # not required. Azure client ID. Use when authenticating with a Service Principal. | |
api_profile: ${9|latest|} # not required. choices: latest. Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack. | |
auth_source: ${10|auto,cli,credential_file,env|} # not required. choices: auto;cli;credential_file;env. Controls the source of the credentials to use for authentication.,C(auto) will follow the default precedence of module parameters -> environment variables -> default profile in credential file C(~/.azure/credentials).,When set to C(cli), the credentials will be sources from the default Azure CLI profile.,Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. | |
subscription_id: ${11:null} # not required. Your Azure subscription Id. | |
password: ${12:null} # not required. Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | |
tenant: ${13:null} # not required. Azure tenant ID. Use when authenticating with a Service Principal. | |
""" | |
'azure_rm_storageaccount': | |
'prefix': "azure_rm_storageaccount_snippet" | |
'description': "Manage Azure storage accounts." | |
'body': """ | |
azure_rm_storageaccount: | |
resource_group: ${1:undefined} # required. Name of the resource group to use. | |
profile: ${2:null} # not required. Security profile found in ~/.azure/credentials file. | |
kind: ${3|Storage,BlobStorage|} # not required. choices: Storage;BlobStorage. The 'kind' of storage. | |
account_type: ${4|Premium_LRS,Standard_GRS,Standard_LRS,Standard_RAGRS,Standard_ZRS|} # not required. choices: Premium_LRS;Standard_GRS;Standard_LRS;Standard_RAGRS;Standard_ZRS. Type of storage account. Required when creating a storage account. NOTE: Standard_ZRS and Premium_LRS accounts cannot be changed to other account types, and other account types cannot be changed to Standard_ZRS or Premium_LRS. | |
custom_domain: ${5:null} # not required. User domain assigned to the storage account. Must be a dictionary with 'name' and 'use_sub_domain' keys where 'name' is the CNAME source. Only one custom domain is supported per storage account at this time. To clear the existing custom domain, use an empty string for the custom domain name property.,Can be added to an existing storage account. Will be ignored during storage account creation. | |
tags: ${6:null} # not required. Dictionary of string:string pairs to assign as metadata to the object. Metadata tags on the object will be updated with any provided values. To remove tags set append_tags option to false.\n | |
cloud_environment: ${7:AzureCloud} # not required. For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable. | |
append_tags: ${8:true} # not required. Use to control if tags field is canonical or just appends to existing tags. When canonical, any tags not found in the tags parameter will be removed from the object's metadata. | |
ad_user: ${9:null} # not required. Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | |
secret: ${10:null} # not required. Azure client secret. Use when authenticating with a Service Principal. | |
api_profile: ${11|latest|} # not required. choices: latest. Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack. | |
state: ${12|absent,present|} # not required. choices: absent;present. Assert the state of the storage account. Use 'present' to create or update a storage account and 'absent' to delete an account. | |
client_id: ${13:null} # not required. Azure client ID. Use when authenticating with a Service Principal. | |
location: ${14:resource_group location} # not required. Valid azure location. Defaults to location of the resource group. | |
access_tier: ${15|Hot,Cool|} # not required. choices: Hot;Cool. The access tier for this storage account. Required for a storage account of kind 'BlobStorage'. | |
cert_validation_mode: ${16|validate,ignore|} # not required. choices: validate;ignore. Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. | |
auth_source: ${17|auto,cli,credential_file,env|} # not required. choices: auto;cli;credential_file;env. Controls the source of the credentials to use for authentication.,C(auto) will follow the default precedence of module parameters -> environment variables -> default profile in credential file C(~/.azure/credentials).,When set to C(cli), the credentials will be sources from the default Azure CLI profile.,Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. | |
subscription_id: ${18:null} # not required. Your Azure subscription Id. | |
password: ${19:null} # not required. Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | |
tenant: ${20:null} # not required. Azure tenant ID. Use when authenticating with a Service Principal. | |
name: ${21:null} # not required. Name of the storage account to update or create. | |
""" | |
'azure_rm_storageaccount_facts': | |
'prefix': "azure_rm_storageaccount_facts_snippet" | |
'description': "Get storage account facts." | |
'body': """ | |
azure_rm_storageaccount_facts: | |
profile: ${1:null} # not required. Security profile found in ~/.azure/credentials file. | |
name: ${2:null} # not required. Only show results for a specific account. | |
resource_group: ${3:null} # not required. Limit results to a resource group. Required when filtering by name. | |
tags: ${4:null} # not required. Limit results by providing a list of tags. Format tags as 'key' or 'key:value'. | |
ad_user: ${5:null} # not required. Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | |
cloud_environment: ${6:AzureCloud} # not required. For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable. | |
cert_validation_mode: ${7|validate,ignore|} # not required. choices: validate;ignore. Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. | |
secret: ${8:null} # not required. Azure client secret. Use when authenticating with a Service Principal. | |
client_id: ${9:null} # not required. Azure client ID. Use when authenticating with a Service Principal. | |
api_profile: ${10|latest|} # not required. choices: latest. Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack. | |
auth_source: ${11|auto,cli,credential_file,env|} # not required. choices: auto;cli;credential_file;env. Controls the source of the credentials to use for authentication.,C(auto) will follow the default precedence of module parameters -> environment variables -> default profile in credential file C(~/.azure/credentials).,When set to C(cli), the credentials will be sources from the default Azure CLI profile.,Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. | |
subscription_id: ${12:null} # not required. Your Azure subscription Id. | |
password: ${13:null} # not required. Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | |
tenant: ${14:null} # not required. Azure tenant ID. Use when authenticating with a Service Principal. | |
""" | |
'azure_rm_storageblob': | |
'prefix': "azure_rm_storageblob_snippet" | |
'description': "Manage blob containers and blob objects." | |
'body': """ | |
azure_rm_storageblob: | |
resource_group: ${1:undefined} # required. Name of the resource group to use. | |
container: ${2:undefined} # required. Name of a blob container within the storage account. | |
storage_account_name: ${3:undefined} # required. Name of the storage account to use. | |
profile: ${4:null} # not required. Security profile found in ~/.azure/credentials file. | |
force: ${5:false} # not required. Overwrite existing blob or file when uploading or downloading. Force deletion of a container that contains blobs. | |
client_id: ${6:null} # not required. Azure client ID. Use when authenticating with a Service Principal. | |
tags: ${7:null} # not required. Dictionary of string:string pairs to assign as metadata to the object. Metadata tags on the object will be updated with any provided values. To remove tags set append_tags option to false.\n | |
dest: ${8:null} # not required. Destination file path. Use with state 'present' to download a blob. | |
cloud_environment: ${9:AzureCloud} # not required. For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable. | |
secret: ${10:null} # not required. Azure client secret. Use when authenticating with a Service Principal. | |
content_language: ${11:null} # not required. Set the blob content-language header. | |
content_type: ${12:null} # not required. Set the blob content-type header. For example, 'image/png'. | |
cert_validation_mode: ${13|validate,ignore|} # not required. choices: validate;ignore. Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. | |
public_access: ${14|container,blob|} # not required. choices: container;blob. Determine a container's level of public access. By default containers are private. Can only be set at time of container creation. | |
password: ${15:null} # not required. Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | |
tenant: ${16:null} # not required. Azure tenant ID. Use when authenticating with a Service Principal. | |
api_profile: ${17|latest|} # not required. choices: latest. Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack. | |
src: ${18:null} # not required. Source file path. Use with state 'present' to upload a blob. | |
append_tags: ${19:true} # not required. Use to control if tags field is canonical or just appends to existing tags. When canonical, any tags not found in the tags parameter will be removed from the object's metadata. | |
ad_user: ${20:null} # not required. Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | |
blob_type: ${21|block,page|} # not required. choices: block;page. Type of Blob Object. | |
state: ${22|absent,present|} # not required. choices: absent;present. Assert the state of a container or blob.,Use state 'absent' with a container value only to delete a container. Include a blob value to remove a specific blob. A container will not be deleted, if it contains blobs. Use the force option to override, deleting the container and all associated blobs.,Use state 'present' to create or update a container and upload or download a blob. If the container does not exist, it will be created. If it exists, it will be updated with configuration options. Provide a blob name and either src or dest to upload or download. Provide a src path to upload and a dest path to download. If a blob (uploading) or a file (downloading) already exists, it will not be overwritten unless the force parameter is true. | |
blob: ${23:null} # not required. Name of a blob object within the container. | |
auth_source: ${24|auto,cli,credential_file,env|} # not required. choices: auto;cli;credential_file;env. Controls the source of the credentials to use for authentication.,C(auto) will follow the default precedence of module parameters -> environment variables -> default profile in credential file C(~/.azure/credentials).,When set to C(cli), the credentials will be sources from the default Azure CLI profile.,Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. | |
content_md5: ${25:null} # not required. Set the blob md5 hash value. | |
subscription_id: ${26:null} # not required. Your Azure subscription Id. | |
content_disposition: ${27:null} # not required. Set the blob content-disposition header. | |
cache_control: ${28:null} # not required. Set the blob cache-control header. | |
content_encoding: ${29:null} # not required. Set the blob encoding header. | |
""" | |
'azure_rm_subnet': | |
'prefix': "azure_rm_subnet_snippet" | |
'description': "Manage Azure subnets." | |
'body': """ | |
azure_rm_subnet: | |
resource_group: ${1:undefined} # required. Name of resource group. | |
virtual_network_name: ${2:undefined} # required. Name of an existing virtual network with which the subnet is or will be associated. | |
name: ${3:undefined} # required. Name of the subnet. | |
address_prefix_cidr: ${4:undefined} # required. CIDR defining the IPv4 address space of the subnet. Must be valid within the context of the virtual network. | |
profile: ${5:null} # not required. Security profile found in ~/.azure/credentials file. | |
ad_user: ${6:null} # not required. Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | |
secret: ${7:null} # not required. Azure client secret. Use when authenticating with a Service Principal. | |
security_group_name: ${8:null} # not required. Name of an existing security group with which to associate the subnet. | |
client_id: ${9:null} # not required. Azure client ID. Use when authenticating with a Service Principal. | |
api_profile: ${10|latest|} # not required. choices: latest. Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack. | |
password: ${11:null} # not required. Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | |
tenant: ${12:null} # not required. Azure tenant ID. Use when authenticating with a Service Principal. | |
cloud_environment: ${13:AzureCloud} # not required. For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable. | |
state: ${14|absent,present|} # not required. choices: absent;present. Assert the state of the subnet. Use 'present' to create or update a subnet and 'absent' to delete a subnet. | |
cert_validation_mode: ${15|validate,ignore|} # not required. choices: validate;ignore. Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. | |
auth_source: ${16|auto,cli,credential_file,env|} # not required. choices: auto;cli;credential_file;env. Controls the source of the credentials to use for authentication.,C(auto) will follow the default precedence of module parameters -> environment variables -> default profile in credential file C(~/.azure/credentials).,When set to C(cli), the credentials will be sources from the default Azure CLI profile.,Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. | |
subscription_id: ${17:null} # not required. Your Azure subscription Id. | |
""" | |
'azure_rm_virtualmachine': | |
'prefix': "azure_rm_virtualmachine_snippet" | |
'description': "Manage Azure virtual machines." | |
'body': """ | |
azure_rm_virtualmachine: | |
resource_group: ${1:undefined} # required. Name of the resource group containing the virtual machine. | |
image: ${2:undefined} # required. Specifies the image used to build the VM.,If a string, the image is sourced from a custom image based on the name.,If a dict with the keys C(publisher), C(offer), C(sku), and C(version), the image is sourced from a Marketplace image. NOTE: set image.version to C(latest) to get the most recent version of a given image.,If a dict with the keys C(name) and C(resource_group), the image is sourced from a custom image based on the C(name) and C(resource_group) set. NOTE: the key C(resource_group) is optional and if omitted, all images in the subscription will be searched for by C(name).,Custom image support was added in Ansible 2.5 | |
name: ${3:undefined} # required. Name of the virtual machine. | |
virtual_network_resource_group: ${4:undefined} # not required. When creating a virtual machine, if a specific virtual network from another resource group should be used, use this parameter to specify the resource group to use. | |
storage_container_name: ${5:vhds} # not required. Name of the container to use within the storage account to store VHD blobs. If no name is specified a default container will created. | |
allocated: ${6:true} # not required. Toggle that controls if the machine is allocated/deallocated, only useful with state='present'. | |
ssh_password_enabled: ${7:true} # not required. When the os_type is Linux, setting ssh_password_enabled to false will disable SSH password authentication and require use of SSH keys. | |
availability_set: ${8:null} # not required. Name or ID of an existing availability set to add the VM to. The availability_set should be in the same resource group as VM. | |
append_tags: ${9:true} # not required. Use to control if tags field is canonical or just appends to existing tags. When canonical, any tags not found in the tags parameter will be removed from the object's metadata. | |
ad_user: ${10:null} # not required. Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | |
state: ${11|absent,present|} # not required. choices: absent;present. Assert the state of the virtual machine.,State 'present' will check that the machine exists with the requested configuration. If the configuration of the existing machine does not match, the machine will be updated. Use options started, allocated and restarted to change the machine's power state.,State 'absent' will remove the virtual machine. | |
secret: ${12:null} # not required. Azure client secret. Use when authenticating with a Service Principal. | |
subnet_name: ${13:undefined} # not required. When creating a virtual machine, if a network interface name is not provided, one will be created. The new network interface will be assigned to the first subnet found in the virtual network. Use this parameter to provide a specific subnet instead. | |
location: ${14:undefined} # not required. Valid Azure location. Defaults to location of the resource group. | |
admin_password: ${15:undefined} # not required. Password for the admin username. Not required if the os_type is Linux and SSH password authentication is disabled by setting ssh_password_enabled to false. | |
virtual_network_name: ${16:undefined} # not required. When creating a virtual machine, if a network interface name is not provided, one will be created. The new network interface will be assigned to the first virtual network found in the resource group. Use this parameter to provide a specific virtual network instead. | |
client_id: ${17:null} # not required. Azure client ID. Use when authenticating with a Service Principal. | |
storage_blob_name: ${18:undefined} # not required. Name fo the storage blob used to hold the VM's OS disk image. If no name is provided, defaults to the VM name + '.vhd'. If you provide a name, it must end with '.vhd" | |
password: ${19:null} # not required. Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | |
restarted: ${20:false} # not required. Use with state 'present' to restart a running VM. | |
api_profile: ${21|latest|} # not required. choices: latest. Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack. | |
os_type: ${22|Windows,Linux|} # not required. choices: Windows;Linux. Base type of operating system. | |
public_ip_allocation_method: ${23|Dynamic,Static|} # not required. choices: Dynamic;Static. If a public IP address is created when creating the VM (because a Network Interface was not provided), determines if the public IP address remains permanently associated with the Network Interface. If set to 'Dynamic' the public IP address may change any time the VM is rebooted or power cycled. | |
managed_disk_type: ${24|Standard_LRS,Premium_LRS|} # not required. choices: Standard_LRS;Premium_LRS. Managed OS disk type | |
ssh_public_keys: ${25:undefined} # not required. For os_type Linux provide a list of SSH keys. Each item in the list should be a dictionary where the dictionary contains two keys: path and key_data. Set the path to the default location of the authorized_keys files. On an Enterprise Linux host, for example, the path will be /home/<admin username>/.ssh/authorized_keys. Set key_data to the actual value of the public key. | |
remove_on_absent: ${26:all} # not required. When removing a VM using state 'absent', also remove associated resources,It can be 'all' or a list with any of the following: ['network_interfaces', 'virtual_storage', 'public_ips'],Any other input will be ignored | |
cloud_environment: ${27:AzureCloud} # not required. For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable. | |
short_hostname: ${28:undefined} # not required. Name assigned internally to the host. On a linux VM this is the name returned by the `hostname` command. When creating a virtual machine, short_hostname defaults to name. | |
started: ${29:true} # not required. Use with state 'present' to start the machine. Set to false to have the machine be 'stopped'. | |
cert_validation_mode: ${30|validate,ignore|} # not required. choices: validate;ignore. Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. | |
network_interface_names: ${31:undefined} # not required. List of existing network interface names to add to the VM. If a network interface name is not provided when the VM is created, a default network interface will be created. In order for the module to create a network interface, at least one Virtual Network with one Subnet must exist. | |
subscription_id: ${32:null} # not required. Your Azure subscription Id. | |
profile: ${33:null} # not required. Security profile found in ~/.azure/credentials file. | |
tags: ${34:null} # not required. Dictionary of string:string pairs to assign as metadata to the object. Metadata tags on the object will be updated with any provided values. To remove tags set append_tags option to false.\n | |
open_ports: ${35:undefined} # not required. If a network interface is created when creating the VM, a security group will be created as well. For Linux hosts a rule will be added to the security group allowing inbound TCP connections to the default SSH port 22, and for Windows hosts ports 3389 and 5986 will be opened. Override the default open ports by providing a list of ports. | |
plan: ${36:undefined} # not required. A dictionary describing a third-party billing plan for an instance | |
auth_source: ${37|auto,cli,credential_file,env|} # not required. choices: auto;cli;credential_file;env. Controls the source of the credentials to use for authentication.,C(auto) will follow the default precedence of module parameters -> environment variables -> default profile in credential file C(~/.azure/credentials).,When set to C(cli), the credentials will be sources from the default Azure CLI profile.,Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. | |
vm_size: ${38:undefined} # not required. A valid Azure VM size value. For example, 'Standard_D4'. The list of choices varies depending on the subscription and location. Check your subscription for available choices. Required when creating a VM. | |
tenant: ${39:null} # not required. Azure tenant ID. Use when authenticating with a Service Principal. | |
admin_username: ${40:undefined} # not required. Admin username used to access the host after it is created. Required when creating a VM. | |
custom_data: ${41:null} # not required. Data which is made available to the virtual machine and used by e.g., cloud-init. | |
storage_account_name: ${42:undefined} # not required. Name of an existing storage account that supports creation of VHD blobs. If not specified for a new VM, a new storage account named <vm name>01 will be created using storage type 'Standard_LRS'. | |
data_disks: ${43:null} # not required. Describes list of data disks. | |
os_disk_caching: ${44|ReadOnly,ReadWrite|} # not required. choices: ReadOnly;ReadWrite. Type of OS disk caching. | |
""" | |
'azure_rm_virtualmachine_extension': | |
'prefix': "azure_rm_virtualmachine_extension_snippet" | |
'description': "Managed Azure Virtual Machine extension" | |
'body': """ | |
azure_rm_virtualmachine_extension: | |
resource_group: ${1:undefined} # required. Name of a resource group where the vm extension exists or will be created. | |
name: ${2:undefined} # required. Name of the vm extension | |
ad_user: ${3:null} # not required. Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | |
cert_validation_mode: ${4|validate,ignore|} # not required. choices: validate;ignore. Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. | |
cloud_environment: ${5:AzureCloud} # not required. For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable. | |
state: ${6|absent,present|} # not required. choices: absent;present. Assert the state of the vm extension. Use 'present' to create or update a vm extension and 'absent' to delete a vm extension. | |
secret: ${7:null} # not required. Azure client secret. Use when authenticating with a Service Principal. | |
location: ${8:resource_group location} # not required. Valid azure location. Defaults to location of the resource group. | |
protected_settings: ${9:undefined} # not required. Json formatted protected settings for the extension. | |
subscription_id: ${10:null} # not required. Your Azure subscription Id. | |
type_handler_version: ${11:undefined} # not required. The type version of the extension handler. | |
profile: ${12:null} # not required. Security profile found in ~/.azure/credentials file. | |
auto_upgrade_minor_version: ${13:undefined} # not required. Whether the extension handler should be automatically upgraded across minor versions. | |
virtual_machine_extension_type: ${14:undefined} # not required. The type of the extension handler. | |
client_id: ${15:null} # not required. Azure client ID. Use when authenticating with a Service Principal. | |
auth_source: ${16|auto,cli,credential_file,env|} # not required. choices: auto;cli;credential_file;env. Controls the source of the credentials to use for authentication.,C(auto) will follow the default precedence of module parameters -> environment variables -> default profile in credential file C(~/.azure/credentials).,When set to C(cli), the credentials will be sources from the default Azure CLI profile.,Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. | |
password: ${17:null} # not required. Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | |
tenant: ${18:null} # not required. Azure tenant ID. Use when authenticating with a Service Principal. | |
virtual_machine_name: ${19:undefined} # not required. The name of the virtual machine where the extension should be create or updated. | |
publisher: ${20:undefined} # not required. The name of the extension handler publisher. | |
settings: ${21:undefined} # not required. Json formatted public settings for the extension. | |
api_profile: ${22|latest|} # not required. choices: latest. Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack. | |
""" | |
'azure_rm_virtualmachine_scaleset': | |
'prefix': "azure_rm_virtualmachine_scaleset_snippet" | |
'description': "Manage Azure virtual machine scale sets." | |
'body': """ | |
azure_rm_virtualmachine_scaleset: | |
resource_group: ${1:undefined} # required. Name of the resource group containing the virtual machine scale set. | |
image: ${2:undefined} # required. Specifies the image used to build the VM.,If a string, the image is sourced from a custom image based on the name.,If a dict with the keys C(publisher), C(offer), C(sku), and C(version), the image is sourced from a Marketplace image. NOTE: set image.version to C(latest) to get the most recent version of a given image.,If a dict with the keys C(name) and C(resource_group), the image is sourced from a custom image based on the C(name) and C(resource_group) set. NOTE: the key C(resource_group) is optional and if omitted, all images in the subscription will be searched for by C(name).,Custom image support was added in Ansible 2.5 | |
vm_size: ${3:undefined} # required. A valid Azure VM size value. For example, 'Standard_D4'. The list of choices varies depending on the subscription and location. Check your subscription for available choices. | |
capacity: ${4:undefined} # required. Capacity of VMSS. | |
name: ${5:undefined} # required. Name of the virtual machine. | |
load_balancer: ${6:undefined} # not required. Load balancer name. | |
profile: ${7:null} # not required. Security profile found in ~/.azure/credentials file. | |
admin_password: ${8:undefined} # not required. Password for the admin username. Not required if the os_type is Linux and SSH password authentication is disabled by setting ssh_password_enabled to false. | |
tags: ${9:null} # not required. Dictionary of string:string pairs to assign as metadata to the object. Metadata tags on the object will be updated with any provided values. To remove tags set append_tags option to false.\n | |
virtual_network_name: ${10:undefined} # not required. Virtual Network name. | |
cloud_environment: ${11:AzureCloud} # not required. For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable. | |
upgrade_policy: ${12|Manual,Automatic|} # not required. choices: Manual;Automatic. Upgrade policy. | |
managed_disk_type: ${13|Standard_LRS,Premium_LRS|} # not required. choices: Standard_LRS;Premium_LRS. Managed disk type. | |
ssh_public_keys: ${14:undefined} # not required. For os_type Linux provide a list of SSH keys. Each item in the list should be a dictionary where the dictionary contains two keys: path and key_data. Set the path to the default location of the authorized_keys files. On an Enterprise Linux host, for example, the path will be /home/<admin username>/.ssh/authorized_keys. Set key_data to the actual value of the public key. | |
client_id: ${15:null} # not required. Azure client ID. Use when authenticating with a Service Principal. | |
cert_validation_mode: ${16|validate,ignore|} # not required. choices: validate;ignore. Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. | |
tier: ${17|Basic,Standard|} # not required. choices: Basic;Standard. SKU Tier. | |
password: ${18:null} # not required. Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | |
ssh_password_enabled: ${19:true} # not required. When the os_type is Linux, setting ssh_password_enabled to false will disable SSH password authentication and require use of SSH keys. | |
subscription_id: ${20:null} # not required. Your Azure subscription Id. | |
tenant: ${21:null} # not required. Azure tenant ID. Use when authenticating with a Service Principal. | |
api_profile: ${22|latest|} # not required. choices: latest. Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack. | |
remove_on_absent: ${23:all} # not required. When removing a VM using state 'absent', also remove associated resources.,It can be 'all' or a list with any of the following: ['network_interfaces', 'virtual_storage', 'public_ips'].,Any other input will be ignored. | |
append_tags: ${24:true} # not required. Use to control if tags field is canonical or just appends to existing tags. When canonical, any tags not found in the tags parameter will be removed from the object's metadata. | |
ad_user: ${25:null} # not required. Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | |
secret: ${26:null} # not required. Azure client secret. Use when authenticating with a Service Principal. | |
admin_username: ${27:undefined} # not required. Admin username used to access the host after it is created. Required when creating a VM. | |
state: ${28|absent,present|} # not required. choices: absent;present. Assert the state of the virtual machine scale set.,State 'present' will check that the machine exists with the requested configuration. If the configuration of the existing machine does not match, the machine will be updated. state.,State 'absent' will remove the virtual machine scale set. | |
subnet_name: ${29:undefined} # not required. Subnet name. | |
location: ${30:undefined} # not required. Valid Azure location. Defaults to location of the resource group. | |
auth_source: ${31|auto,cli,credential_file,env|} # not required. choices: auto;cli;credential_file;env. Controls the source of the credentials to use for authentication.,C(auto) will follow the default precedence of module parameters -> environment variables -> default profile in credential file C(~/.azure/credentials).,When set to C(cli), the credentials will be sources from the default Azure CLI profile.,Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. | |
os_type: ${32|Windows,Linux|} # not required. choices: Windows;Linux. Base type of operating system. | |
data_disks: ${33:null} # not required. Describes list of data disks. | |
os_disk_caching: ${34|ReadOnly,ReadWrite|} # not required. choices: ReadOnly;ReadWrite. Type of OS disk caching. | |
""" | |
'azure_rm_virtualmachine_scaleset_facts': | |
'prefix': "azure_rm_virtualmachine_scaleset_facts_snippet" | |
'description': "Get Virtual Machine Scale Set facts" | |
'body': """ | |
azure_rm_virtualmachine_scaleset_facts: | |
profile: ${1:null} # not required. Security profile found in ~/.azure/credentials file. | |
name: ${2:null} # not required. Limit results to a specific virtual machine scale set | |
resource_group: ${3:null} # not required. The resource group to search for the desired virtual machine scale set | |
ad_user: ${4:null} # not required. Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | |
cloud_environment: ${5:AzureCloud} # not required. For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable. | |
cert_validation_mode: ${6|validate,ignore|} # not required. choices: validate;ignore. Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. | |
secret: ${7:null} # not required. Azure client secret. Use when authenticating with a Service Principal. | |
client_id: ${8:null} # not required. Azure client ID. Use when authenticating with a Service Principal. | |
api_profile: ${9|latest|} # not required. choices: latest. Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack. | |
auth_source: ${10|auto,cli,credential_file,env|} # not required. choices: auto;cli;credential_file;env. Controls the source of the credentials to use for authentication.,C(auto) will follow the default precedence of module parameters -> environment variables -> default profile in credential file C(~/.azure/credentials).,When set to C(cli), the credentials will be sources from the default Azure CLI profile.,Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. | |
subscription_id: ${11:null} # not required. Your Azure subscription Id. | |
password: ${12:null} # not required. Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | |
tenant: ${13:null} # not required. Azure tenant ID. Use when authenticating with a Service Principal. | |
""" | |
'azure_rm_virtualmachineimage_facts': | |
'prefix': "azure_rm_virtualmachineimage_facts_snippet" | |
'description': "Get virtual machine image facts." | |
'body': """ | |
azure_rm_virtualmachineimage_facts: | |
location: ${1:undefined} # required. Azure location value (ie. westus, eastus, eastus2, northcentralus, etc.). Supplying only a location value will yield a list of available publishers for the location. | |
profile: ${2:null} # not required. Security profile found in ~/.azure/credentials file. | |
offer: ${3:null} # not required. Name of an image offering. Combine with sku to see a list of available image versions. | |
ad_user: ${4:null} # not required. Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | |
client_id: ${5:null} # not required. Azure client ID. Use when authenticating with a Service Principal. | |
api_profile: ${6|latest|} # not required. choices: latest. Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack. | |
password: ${7:null} # not required. Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | |
tenant: ${8:null} # not required. Azure tenant ID. Use when authenticating with a Service Principal. | |
sku: ${9:null} # not required. Image offering SKU. Combine with offer to see a list of available versions. | |
publisher: ${10:null} # not required. Name of an image publisher. List image offerings associated with a particular publisher. | |
name: ${11:null} # not required. Only show results for a specific security group. | |
cloud_environment: ${12:AzureCloud} # not required. For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable. | |
cert_validation_mode: ${13|validate,ignore|} # not required. choices: validate;ignore. Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. | |
secret: ${14:null} # not required. Azure client secret. Use when authenticating with a Service Principal. | |
version: ${15:null} # not required. Specific version number of an image. | |
auth_source: ${16|auto,cli,credential_file,env|} # not required. choices: auto;cli;credential_file;env. Controls the source of the credentials to use for authentication.,C(auto) will follow the default precedence of module parameters -> environment variables -> default profile in credential file C(~/.azure/credentials).,When set to C(cli), the credentials will be sources from the default Azure CLI profile.,Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. | |
subscription_id: ${17:null} # not required. Your Azure subscription Id. | |
""" | |
'azure_rm_virtualnetwork': | |
'prefix': "azure_rm_virtualnetwork_snippet" | |
'description': "Manage Azure virtual networks." | |
'body': """ | |
azure_rm_virtualnetwork: | |
name: ${1:undefined} # required. name of the virtual network. | |
resource_group: ${2:undefined} # required. name of resource group. | |
profile: ${3:null} # not required. Security profile found in ~/.azure/credentials file. | |
dns_servers: ${4:null} # not required. Custom list of DNS servers. Maximum length of two. The first server in the list will be treated as the Primary server. This is an explicit list. Existing DNS servers will be replaced with the specified list. Use the purge_dns_servers option to remove all custom DNS servers and revert to default Azure servers. | |
tags: ${5:null} # not required. Dictionary of string:string pairs to assign as metadata to the object. Metadata tags on the object will be updated with any provided values. To remove tags set append_tags option to false.\n | |
cloud_environment: ${6:AzureCloud} # not required. For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable. | |
append_tags: ${7:true} # not required. Use to control if tags field is canonical or just appends to existing tags. When canonical, any tags not found in the tags parameter will be removed from the object's metadata. | |
ad_user: ${8:null} # not required. Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | |
secret: ${9:null} # not required. Azure client secret. Use when authenticating with a Service Principal. | |
api_profile: ${10|latest|} # not required. choices: latest. Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack. | |
cert_validation_mode: ${11|validate,ignore|} # not required. choices: validate;ignore. Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. | |
state: ${12|absent,present|} # not required. choices: absent;present. Assert the state of the virtual network. Use 'present' to create or update and 'absent' to delete. | |
auth_source: ${13|auto,cli,credential_file,env|} # not required. choices: auto;cli;credential_file;env. Controls the source of the credentials to use for authentication.,C(auto) will follow the default precedence of module parameters -> environment variables -> default profile in credential file C(~/.azure/credentials).,When set to C(cli), the credentials will be sources from the default Azure CLI profile.,Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. | |
address_prefixes_cidr: ${14:null} # not required. List of IPv4 address ranges where each is formatted using CIDR notation. Required when creating a new virtual network or using purge_address_prefixes. | |
client_id: ${15:null} # not required. Azure client ID. Use when authenticating with a Service Principal. | |
purge_address_prefixes: ${16:false} # not required. Use with state present to remove any existing address_prefixes. | |
purge_dns_servers: ${17:false} # not required. Use with state present to remove existing DNS servers, reverting to default Azure servers. Mutually exclusive with dns_servers. | |
subscription_id: ${18:null} # not required. Your Azure subscription Id. | |
password: ${19:null} # not required. Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | |
tenant: ${20:null} # not required. Azure tenant ID. Use when authenticating with a Service Principal. | |
location: ${21:resource_group location} # not required. Valid azure location. Defaults to location of the resource group. | |
""" | |
'azure_rm_virtualnetwork_facts': | |
'prefix': "azure_rm_virtualnetwork_facts_snippet" | |
'description': "Get virtual network facts." | |
'body': """ | |
azure_rm_virtualnetwork_facts: | |
profile: ${1:null} # not required. Security profile found in ~/.azure/credentials file. | |
name: ${2:null} # not required. Only show results for a specific security group. | |
resource_group: ${3:null} # not required. Limit results by resource group. Required when filtering by name. | |
tags: ${4:null} # not required. Limit results by providing a list of tags. Format tags as 'key' or 'key:value'. | |
ad_user: ${5:null} # not required. Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | |
cloud_environment: ${6:AzureCloud} # not required. For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable. | |
cert_validation_mode: ${7|validate,ignore|} # not required. choices: validate;ignore. Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. | |
secret: ${8:null} # not required. Azure client secret. Use when authenticating with a Service Principal. | |
client_id: ${9:null} # not required. Azure client ID. Use when authenticating with a Service Principal. | |
api_profile: ${10|latest|} # not required. choices: latest. Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack. | |
auth_source: ${11|auto,cli,credential_file,env|} # not required. choices: auto;cli;credential_file;env. Controls the source of the credentials to use for authentication.,C(auto) will follow the default precedence of module parameters -> environment variables -> default profile in credential file C(~/.azure/credentials).,When set to C(cli), the credentials will be sources from the default Azure CLI profile.,Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. | |
subscription_id: ${12:null} # not required. Your Azure subscription Id. | |
password: ${13:null} # not required. Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | |
tenant: ${14:null} # not required. Azure tenant ID. Use when authenticating with a Service Principal. | |
""" | |
'bcf_switch': | |
'prefix': "bcf_switch_snippet" | |
'description': "Create and remove a bcf switch." | |
'body': """ | |
bcf_switch: | |
name: ${1:undefined} # required. The name of the switch. | |
mac: ${2:undefined} # required. The MAC address of the switch. | |
controller: ${3:undefined} # required. The controller IP address. | |
fabric_role: ${4|spine,leaf|} # required. choices: spine;leaf. Fabric role of the switch. | |
access_token: ${5:undefined} # not required. Big Cloud Fabric access token. If this isn't set then the environment variable C(BIGSWITCH_ACCESS_TOKEN) is used. | |
state: ${6|present,absent|} # not required. choices: present;absent. Whether the switch should be present or absent. | |
leaf_group: ${7:undefined} # not required. The leaf group of the switch if the switch is a leaf. | |
validate_certs: ${8|true,false|} # not required. choices: true;false. If C(false), SSL certificates will not be validated. This should only be used on personally controlled devices using self-signed certificates. | |
""" | |
'beadm': | |
'prefix': "beadm_snippet" | |
'description': "Manage ZFS boot environments on FreeBSD/Solaris/illumos systems." | |
'body': """ | |
beadm: | |
name: ${1:undefined} # required. ZFS boot environment name. | |
state: ${2|present,absent,activated,mounted,unmounted|} # not required. choices: present;absent;activated;mounted;unmounted. Create or delete ZFS boot environment. | |
force: ${3|true,false|} # not required. choices: true;false. Specifies if the unmount should be forced. | |
mountpoint: ${4:false} # not required. Path where to mount the ZFS boot environment | |
snapshot: ${5:false} # not required. If specified, the new boot environment will be cloned from the given snapshot or inactive boot environment. | |
options: ${6:false} # not required. Create the datasets for new BE with specific ZFS properties. Multiple options can be specified. This option is available only on Solarish platforms. | |
description: ${7:false} # not required. Associate a description with a new boot environment. This option is available only on Solarish platforms. | |
""" | |
'bearychat': | |
'prefix': "bearychat_snippet" | |
'description': "Send BearyChat notifications" | |
'body': """ | |
bearychat: | |
url: ${1:undefined} # required. BearyChat WebHook URL. This authenticates you to the bearychat service. It looks like C(https://hook.bearychat.com/=ae2CF/incoming/e61bd5c57b164e04b11ac02e66f47f60). | |
text: ${2:undefined} # not required. Message to send. | |
markdown: ${3|yes|} # not required. choices: yes. If C(yes), text will be parsed as markdown. | |
attachments: ${4:undefined} # not required. Define a list of attachments. For more information, see https://github.com/bearyinnovative/bearychat-tutorial/blob/master/robots/incoming.md#attachments | |
channel: ${5:undefined} # not required. Channel to send the message to. If absent, the message goes to the default channel selected by the I(url). | |
""" | |
'bigip_asm_policy': | |
'prefix': "bigip_asm_policy_snippet" | |
'description': "Manage BIG-IP ASM policies" | |
'body': """ | |
bigip_asm_policy: | |
user: ${1:undefined} # required. The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable C(F5_USER) is set. | |
password: ${2:undefined} # required. The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable C(F5_PASSWORD) is set. | |
name: ${3:undefined} # required. The ASM policy to manage or create. | |
server: ${4:undefined} # required. The BIG-IP host. You can omit this option if the environment variable C(F5_SERVER) is set. | |
template: ${5|ActiveSync v1.0 v2.0 (http),ActiveSync v1.0 v2.0 (https),Comprehensive,Drupal,Fundamental,Joomla,LotusDomino 6.5 (http),LotusDomino 6.5 (https),OWA Exchange 2003 (http),OWA Exchange 2003 (https),OWA Exchange 2003 with ActiveSync (http),OWA Exchange 2003 with ActiveSync (https),OWA Exchange 2007 (http),OWA Exchange 2007 (https),OWA Exchange 2007 with ActiveSync (http),OWA Exchange 2007 with ActiveSync (https),OWA Exchange 2010 (http),OWA Exchange 2010 (https),Oracle 10g Portal (http),Oracle 10g Portal (https),Oracle Applications 11i (http),Oracle Applications 11i (https),PeopleSoft Portal 9 (http),PeopleSoft Portal 9 (https),Rapid Deployment Policy,SAP NetWeaver 7 (http),SAP NetWeaver 7 (https),SharePoint 2003 (http),SharePoint 2003 (https),SharePoint 2007 (http),SharePoint 2007 (https),SharePoint 2010 (http),SharePoint 2010 (https),Vulnerability Assessment Baseline,Wordpress|} # not required. choices: ActiveSync v1.0 v2.0 (http);ActiveSync v1.0 v2.0 (https);Comprehensive;Drupal;Fundamental;Joomla;LotusDomino 6.5 (http);LotusDomino 6.5 (https);OWA Exchange 2003 (http);OWA Exchange 2003 (https);OWA Exchange 2003 with ActiveSync (http);OWA Exchange 2003 with ActiveSync (https);OWA Exchange 2007 (http);OWA Exchange 2007 (https);OWA Exchange 2007 with ActiveSync (http);OWA Exchange 2007 with ActiveSync (https);OWA Exchange 2010 (http);OWA Exchange 2010 (https);Oracle 10g Portal (http);Oracle 10g Portal (https);Oracle Applications 11i (http);Oracle Applications 11i (https);PeopleSoft Portal 9 (http);PeopleSoft Portal 9 (https);Rapid Deployment Policy;SAP NetWeaver 7 (http);SAP NetWeaver 7 (https);SharePoint 2003 (http);SharePoint 2003 (https);SharePoint 2007 (http);SharePoint 2007 (https);SharePoint 2010 (http);SharePoint 2010 (https);Vulnerability Assessment Baseline;Wordpress. An ASM policy built-in template. If the template does not exist we will raise an error.,Once the policy has been created, this value cannot change.,The C(Comprehensive), C(Drupal), C(Fundamental), C(Joomla), C(Vulnerability Assessment Baseline), and C(Wordpress) templates are only available on BIG-IP versions >= 13. | |
file: ${6:undefined} # not required. Full path to a policy file to be imported into the BIG-IP ASM.,Policy files exported from newer versions of BIG-IP cannot be imported into older versions of BIG-IP. The opposite, however, is true; you can import older into newer. | |
active: ${7|true,false|} # not required. choices: true;false. If C(yes) will apply and activate existing inactive policy. If C(no), it will deactivate existing active policy. Generally should be C(yes) only in cases where you want to activate new or existing policy. | |
partition: ${8:Common} # not required. Device partition to manage resources on. | |
state: ${9|present,absent|} # not required. choices: present;absent. When C(state) is C(present), and C(file) or C(template) parameter is provided, new ASM policy is imported and created with the given C(name).,When C(state) is present and no C(file) or C(template) parameter is provided new blank ASM policy is created with the given C(name).,When C(state) is C(absent), ensures that the policy is removed, even if it is currently active. | |
server_port: ${10:443} # not required. The BIG-IP server port. You can omit this option if the environment variable C(F5_SERVER_PORT) is set. | |
provider: ${11:null} # not required. A dict object containing connection details. | |
validate_certs: ${12:true} # not required. If C(no), SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable C(F5_VALIDATE_CERTS) is set. | |
""" | |
'bigip_command': | |
'prefix': "bigip_command_snippet" | |
'description': "Run arbitrary command on F5 devices" | |
'body': """ | |
bigip_command: | |
user: ${1:undefined} # required. The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable C(F5_USER) is set. | |
transport: ${2|rest,cli|} # required. choices: rest;cli. Configures the transport connection to use when connecting to the remote device. The transport argument supports connectivity to the device over cli (ssh) or rest. | |
commands: ${3:undefined} # required. The commands to send to the remote BIG-IP device over the configured provider. The resulting output from the command is returned. If the I(wait_for) argument is provided, the module is not returned until the condition is satisfied or the number of retries as expired.,The I(commands) argument also accepts an alternative form that allows for complex values that specify the command to run and the output format to return. This can be done on a command by command basis. The complex argument supports the keywords C(command) and C(output) where C(command) is the command to run and C(output) is 'text' or 'one-line'. | |
password: ${4:undefined} # required. The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable C(F5_PASSWORD) is set. | |
server: ${5:undefined} # required. The BIG-IP host. You can omit this option if the environment variable C(F5_SERVER) is set. | |
wait_for: ${6:undefined} # not required. Specifies what to evaluate from the output of the command and what conditionals to apply. This argument will cause the task to wait for a particular conditional to be true before moving forward. If the conditional is not true by the configured retries, the task fails. See examples. | |
retries: ${7:10} # not required. Specifies the number of retries a command should by tried before it is considered failed. The command is run on the target device every retry and evaluated against the I(wait_for) conditionals. | |
interval: ${8:1} # not required. Configures the interval in seconds to wait between retries of the command. If the command does not pass the specified conditional, the interval indicates how to long to wait before trying the command again. | |
server_port: ${9:443} # not required. The BIG-IP server port. You can omit this option if the environment variable C(F5_SERVER_PORT) is set. | |
provider: ${10:null} # not required. A dict object containing connection details. | |
validate_certs: ${11:true} # not required. If C(no), SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable C(F5_VALIDATE_CERTS) is set. | |
match: ${12:all} # not required. The I(match) argument is used in conjunction with the I(wait_for) argument to specify the match policy. Valid values are C(all) or C(any). If the value is set to C(all) then all conditionals in the I(wait_for) must be satisfied. If the value is set to C(any) then only one of the values must be satisfied. | |
""" | |
'bigip_config': | |
'prefix': "bigip_config_snippet" | |
'description': "Manage BIG-IP configuration sections" | |
'body': """ | |
bigip_config: | |
password: ${1:undefined} # required. The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable C(F5_PASSWORD) is set. | |
server: ${2:undefined} # required. The BIG-IP host. You can omit this option if the environment variable C(F5_SERVER) is set. | |
user: ${3:undefined} # required. The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable C(F5_USER) is set. | |
reset: ${4:false} # not required. Loads the default configuration on the device. If this option is specified, the default configuration will be loaded before any commands or other provided configuration is run. | |
merge_content: ${5:undefined} # not required. Loads the specified configuration that you want to merge into the running configuration. This is equivalent to using the C(tmsh) command C(load sys config from-terminal merge). If you need to read configuration from a file or template, use Ansible's C(file) or C(template) lookup plugins respectively. | |
verify: ${6:false} # not required. Validates the specified configuration to see whether they are valid to replace the running configuration. The running configuration will not be changed. | |
server_port: ${7:443} # not required. The BIG-IP server port. You can omit this option if the environment variable C(F5_SERVER_PORT) is set. | |
provider: ${8:null} # not required. A dict object containing connection details. | |
save: ${9:false} # not required. The C(save) argument instructs the module to save the running-config to startup-config. This operation is performed after any changes are made to the current running config. If no changes are made, the configuration is still saved to the startup config. This option will always cause the module to return changed. | |
validate_certs: ${10:true} # not required. If C(no), SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable C(F5_VALIDATE_CERTS) is set. | |
""" | |
'bigip_configsync_action': | |
'prefix': "bigip_configsync_action_snippet" | |
'description': "Perform different actions related to config-sync" | |
'body': """ | |
bigip_configsync_action: | |
device_group: ${1:undefined} # required. The device group that you want to perform config-sync actions on. | |
server: ${2:undefined} # required. The BIG-IP host. You can omit this option if the environment variable C(F5_SERVER) is set. | |
user: ${3:undefined} # required. The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable C(F5_USER) is set. | |
password: ${4:undefined} # required. The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable C(F5_PASSWORD) is set. | |
sync_most_recent_to_device: ${5|true,false|} # not required. choices: true;false. Specifies that the system synchronizes configuration data from the device with the most recent configuration. In this case, the device will do a \"pull\" from the most recently updated device. This option is mutually exclusive with the C(sync_device_to_group) options. | |
sync_device_to_group: ${6|true,false|} # not required. choices: true;false. Specifies that the system synchronizes configuration data from this device to other members of the device group. In this case, the device will do a \"push\" to all the other devices in the group. This option is mutually exclusive with the C(sync_group_to_device) option. | |
server_port: ${7:443} # not required. The BIG-IP server port. You can omit this option if the environment variable C(F5_SERVER_PORT) is set. | |
provider: ${8:null} # not required. A dict object containing connection details. | |
overwrite_config: ${9|true,false|} # not required. choices: true;false. Indicates that the sync operation overwrites the configuration on the target. | |
validate_certs: ${10:true} # not required. If C(no), SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable C(F5_VALIDATE_CERTS) is set. | |
""" | |
'bigip_device_connectivity': | |
'prefix': "bigip_device_connectivity_snippet" | |
'description': "Manages device IP configuration settings for HA on a BIG-IP" | |
'body': """ | |
bigip_device_connectivity: | |
server: ${1:undefined} # required. The BIG-IP host. You can omit this option if the environment variable C(F5_SERVER) is set. | |
user: ${2:undefined} # required. The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable C(F5_USER) is set. | |
password: ${3:undefined} # required. The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable C(F5_PASSWORD) is set. | |
multicast_interface: ${4:undefined} # not required. Interface over which the system sends multicast messages associated with failover. When C(failover_multicast) is C(yes) and this option is not provided, a default of C(eth0) will be used. | |
validate_certs: ${5:true} # not required. If C(no), SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable C(F5_VALIDATE_CERTS) is set. | |
server_port: ${6:443} # not required. The BIG-IP server port. You can omit this option if the environment variable C(F5_SERVER_PORT) is set. | |
mirror_primary_address: ${7:undefined} # not required. Specifies the primary IP address for the system to use to mirror connections. | |
failover_multicast: ${8|true,false|} # not required. choices: true;false. When C(yes), ensures that the Failover Multicast configuration is enabled and if no further multicast configuration is provided, ensures that C(multicast_interface), C(multicast_address) and C(multicast_port) are the defaults specified in each option's description. When C(no), ensures that Failover Multicast configuration is disabled. | |
config_sync_ip: ${9:undefined} # not required. Local IP address that the system uses for ConfigSync operations. | |
provider: ${10:null} # not required. A dict object containing connection details. | |
mirror_secondary_address: ${11:undefined} # not required. Specifies the secondary IP address for the system to use to mirror connections. | |
multicast_address: ${12:undefined} # not required. IP address for the system to send multicast messages associated with failover. When C(failover_multicast) is C(yes) and this option is not provided, a default of C(224.0.0.245) will be used. | |
unicast_failover: ${13:undefined} # not required. Desired addresses to use for failover operations. Options C(address) and C(port) are supported with dictionary structure where C(address) is the local IP address that the system uses for failover operations. Port specifies the port that the system uses for failover operations. If C(port) is not specified, the default value C(1026) will be used. If you are specifying the (recommended) management IP address, use 'management-ip' in the address field. | |
multicast_port: ${14:undefined} # not required. Port for the system to send multicast messages associated with failover. When C(failover_multicast) is C(yes) and this option is not provided, a default of C(62960) will be used. This value must be between 0 and 65535. | |
""" | |
'bigip_device_dns': | |
'prefix': "bigip_device_dns_snippet" | |
'description': "Manage BIG-IP device DNS settings" | |
'body': """ | |
bigip_device_dns: | |
user: ${1:undefined} # required. The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable C(F5_USER) is set. | |
password: ${2:undefined} # required. The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable C(F5_PASSWORD) is set. | |
server: ${3:undefined} # required. The BIG-IP host. You can omit this option if the environment variable C(F5_SERVER) is set. | |
forwarders: ${4:undefined} # not required. A list of BIND servers that the system can use to perform DNS lookups,Deprecated in 2.4. Use the GUI or edit named.conf. | |
name_servers: ${5:undefined} # not required. A list of name servers that the system uses to validate DNS lookups | |
search: ${6:undefined} # not required. A list of domains that the system searches for local domain lookups, to resolve local host names. | |
cache: ${7|enabled,disabled|} # not required. choices: enabled;disabled. Specifies whether the system caches DNS lookups or performs the operation each time a lookup is needed. Please note that this applies only to Access Policy Manager features, such as ACLs, web application rewrites, and authentication. | |
state: ${8|absent,present|} # not required. choices: absent;present. The state of the variable on the system. When C(present), guarantees that an existing variable is set to C(value). | |
server_port: ${9:443} # not required. The BIG-IP server port. You can omit this option if the environment variable C(F5_SERVER_PORT) is set. | |
provider: ${10:null} # not required. A dict object containing connection details. | |
ip_version: ${11|4,6|} # not required. choices: 4;6. Specifies whether the DNS specifies IP addresses using IPv4 or IPv6. | |
validate_certs: ${12:true} # not required. If C(no), SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable C(F5_VALIDATE_CERTS) is set. | |
""" | |
'bigip_device_group': | |
'prefix': "bigip_device_group_snippet" | |
'description': "Manage device groups on a BIG-IP" | |
'body': """ | |
bigip_device_group: | |
name: ${1:undefined} # required. Specifies the name of the device group. | |
server: ${2:undefined} # required. The BIG-IP host. You can omit this option if the environment variable C(F5_SERVER) is set. | |
user: ${3:undefined} # required. The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable C(F5_USER) is set. | |
password: ${4:undefined} # required. The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable C(F5_PASSWORD) is set. | |
auto_sync: ${5:undefined} # not required. Indicates whether configuration synchronization occurs manually or automatically. When creating a new device group, this option will default to C(false). | |
validate_certs: ${6:true} # not required. If C(no), SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable C(F5_VALIDATE_CERTS) is set. | |
max_incremental_sync_size: ${7:undefined} # not required. Specifies the size of the changes cache for incremental sync. For example, using the default, if you make more than 1024 KB worth of incremental changes, the system performs a full synchronization operation. Using incremental synchronization operations can reduce the per-device sync/load time for configuration changes. This setting is relevant only when C(full_sync) is C(false). | |
server_port: ${8:443} # not required. The BIG-IP server port. You can omit this option if the environment variable C(F5_SERVER_PORT) is set. | |
save_on_auto_sync: ${9:undefined} # not required. When performing an auto-sync, specifies whether the configuration will be saved or not. If C(false), only the running configuration will be changed on the device(s) being synced to. When creating a new device group, this option will default to C(false). | |
state: ${10|present,absent|} # not required. choices: present;absent. When C(state) is C(present), ensures the device group exists.,When C(state) is C(absent), ensures that the device group is removed. | |
full_sync: ${11:undefined} # not required. Specifies whether the system synchronizes the entire configuration during synchronization operations. When C(false), the system performs incremental synchronization operations, based on the cache size specified in C(max_incremental_sync_size). Incremental configuration synchronization is a mechanism for synchronizing a device-group's configuration among its members, without requiring a full configuration load for each configuration change. In order for this to work, all devices in the device-group must initially agree on the configuration. Typically this requires at least one full configuration load to each device. When creating a new device group, this option will default to C(false). | |
provider: ${12:null} # not required. A dict object containing connection details. | |
type: ${13|sync-failover,sync-only|} # not required. choices: sync-failover;sync-only. Specifies that the type of group. A C(sync-failover) device group contains devices that synchronize their configuration data and fail over to one another when a device becomes unavailable. A C(sync-only) device group has no such failover. When creating a new device group, this option will default to C(sync-only). This setting cannot be changed once it has been set. | |
description: ${14:undefined} # not required. Description of the device group. | |
""" | |
'bigip_device_group_member': | |
'prefix': "bigip_device_group_member_snippet" | |
'description': "Manages members in a device group" | |
'body': """ | |
bigip_device_group_member: | |
name: ${1:undefined} # required. Specifies the name of the device that you want to add to the device group. Often this will be the hostname of the device. This member must be trusted by the device already. Trusting can be done with the C(bigip_device_trust) module and the C(peer_hostname) option to that module. | |
device_group: ${2:undefined} # required. The device group that you want to add the member to. | |
server: ${3:undefined} # required. The BIG-IP host. You can omit this option if the environment variable C(F5_SERVER) is set. | |
user: ${4:undefined} # required. The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable C(F5_USER) is set. | |
password: ${5:undefined} # required. The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable C(F5_PASSWORD) is set. | |
state: ${6|present,absent|} # not required. choices: present;absent. When C(present), ensures that the device group member.,When C(absent), ensures the device group member is removed. | |
server_port: ${7:443} # not required. The BIG-IP server port. You can omit this option if the environment variable C(F5_SERVER_PORT) is set. | |
provider: ${8:null} # not required. A dict object containing connection details. | |
validate_certs: ${9:true} # not required. If C(no), SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable C(F5_VALIDATE_CERTS) is set. | |
""" | |
'bigip_device_httpd': | |
'prefix': "bigip_device_httpd_snippet" | |
'description': "Manage HTTPD related settings on BIG-IP" | |
'body': """ | |
bigip_device_httpd: | |
server: ${1:undefined} # required. The BIG-IP host. You can omit this option if the environment variable C(F5_SERVER) is set. | |
password: ${2:undefined} # required. The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable C(F5_PASSWORD) is set. | |
user: ${3:undefined} # required. The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable C(F5_USER) is set. | |
auth_pam_validate_ip: ${4:undefined} # not required. Sets the authPamValidateIp setting. | |
hostname_lookup: ${5:undefined} # not required. Sets whether or not to display the hostname, if possible. | |
log_level: ${6|alert,crit,debug,emerg,error,info,notice,warn|} # not required. choices: alert;crit;debug;emerg;error;info;notice;warn. Sets the minimum httpd log level. | |
server_port: ${7:443} # not required. The BIG-IP server port. You can omit this option if the environment variable C(F5_SERVER_PORT) is set. | |
auth_name: ${8:undefined} # not required. Sets the BIG-IP authentication realm name. | |
validate_certs: ${9:true} # not required. If C(no), SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable C(F5_VALIDATE_CERTS) is set. | |
auth_pam_dashboard_timeout: ${10:undefined} # not required. Sets whether or not the BIG-IP dashboard will timeout. | |
redirect_http_to_https: ${11:undefined} # not required. Whether or not to redirect http requests to the GUI to https. | |
fast_cgi_timeout: ${12:undefined} # not required. Sets the timeout of FastCGI. | |
allow: ${13|all,IP address, such as 172.27.1.10,IP range, such as 172.27.*.* or 172.27.0.0/255.255.0.0|} # not required. choices: all;IP address, such as 172.27.1.10;IP range, such as 172.27.*.* or 172.27.0.0/255.255.0.0. Specifies, if you have enabled HTTPD access, the IP address or address range for other systems that can communicate with this system. | |
provider: ${14:null} # not required. A dict object containing connection details. | |
ssl_port: ${15:undefined} # not required. The HTTPS port to listen on. | |
auth_pam_idle_timeout: ${16:undefined} # not required. Sets the GUI timeout for automatic logout, in seconds. | |
max_clients: ${17:undefined} # not required. Sets the maximum number of clients that can connect to the GUI at once. | |
""" | |
'bigip_device_ntp': | |
'prefix': "bigip_device_ntp_snippet" | |
'description': "Manage NTP servers on a BIG-IP" | |
'body': """ | |
bigip_device_ntp: | |
server: ${1:undefined} # required. The BIG-IP host. You can omit this option if the environment variable C(F5_SERVER) is set. | |
user: ${2:undefined} # required. The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable C(F5_USER) is set. | |
password: ${3:undefined} # required. The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable C(F5_PASSWORD) is set. | |
ntp_servers: ${4:undefined} # not required. A list of NTP servers to set on the device. At least one of C(ntp_servers) or C(timezone) is required. | |
state: ${5|absent,present|} # not required. choices: absent;present. The state of the NTP servers on the system. When C(present), guarantees that the NTP servers are set on the system. When C(absent), removes the specified NTP servers from the device configuration. | |
server_port: ${6:443} # not required. The BIG-IP server port. You can omit this option if the environment variable C(F5_SERVER_PORT) is set. | |
provider: ${7:null} # not required. A dict object containing connection details. | |
timezone: ${8:UTC} # not required. The timezone to set for NTP lookups. At least one of C(ntp_servers) or C(timezone) is required. | |
validate_certs: ${9:true} # not required. If C(no), SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable C(F5_VALIDATE_CERTS) is set. | |
""" | |
'bigip_device_sshd': | |
'prefix': "bigip_device_sshd_snippet" | |
'description': "Manage the SSHD settings of a BIG-IP" | |
'body': """ | |
bigip_device_sshd: | |
user: ${1:undefined} # required. The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable C(F5_USER) is set. | |
password: ${2:undefined} # required. The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable C(F5_PASSWORD) is set. | |
server: ${3:undefined} # required. The BIG-IP host. You can omit this option if the environment variable C(F5_SERVER) is set. | |
server_port: ${4:443} # not required. The BIG-IP server port. You can omit this option if the environment variable C(F5_SERVER_PORT) is set. | |
banner_text: ${5:undefined} # not required. Specifies the text to include on the pre-login banner that displays when a user attempts to login to the system using SSH. | |
inactivity_timeout: ${6:undefined} # not required. Specifies the number of seconds before inactivity causes an SSH session to log out. | |
banner: ${7|enabled,disabled|} # not required. choices: enabled;disabled. Whether to enable the banner or not. | |
port: ${8:undefined} # not required. Port that you want the SSH daemon to run on. | |
log_level: ${9|debug,debug1,debug2,debug3,error,fatal,info,quiet,verbose|} # not required. choices: debug;debug1;debug2;debug3;error;fatal;info;quiet;verbose. Specifies the minimum SSHD message level to include in the system log. | |
allow: ${10|all,IP address, such as 172.27.1.10,IP range, such as 172.27.*.* or 172.27.0.0/255.255.0.0|} # not required. choices: all;IP address, such as 172.27.1.10;IP range, such as 172.27.*.* or 172.27.0.0/255.255.0.0. Specifies, if you have enabled SSH access, the IP address or address range for other systems that can use SSH to communicate with this system. | |
provider: ${11:null} # not required. A dict object containing connection details. | |
login: ${12|enabled,disabled|} # not required. choices: enabled;disabled. Specifies, when checked C(enabled), that the system accepts SSH communications. | |
validate_certs: ${13:true} # not required. If C(no), SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable C(F5_VALIDATE_CERTS) is set. | |
""" | |
'bigip_device_trust': | |
'prefix': "bigip_device_trust_snippet" | |
'description': "Manage the trust relationships between BIG-IPs" | |
'body': """ | |
bigip_device_trust: | |
user: ${1:undefined} # required. The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable C(F5_USER) is set. | |
peer_server: ${2:undefined} # required. The peer address to connect to and trust for synchronizing configuration. This is typically the management address of the remote device, but may also be a Self IP. | |
password: ${3:undefined} # required. The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable C(F5_PASSWORD) is set. | |
server: ${4:undefined} # required. The BIG-IP host. You can omit this option if the environment variable C(F5_SERVER) is set. | |
type: ${5|peer,subordinate|} # not required. choices: peer;subordinate. Specifies whether the device you are adding is a Peer or a Subordinate. The default is C(peer).,The difference between the two is a matter of mitigating risk of compromise.,A subordinate device cannot sign a certificate for another device.,In the case where the security of an authority device in a trust domain is compromised, the risk of compromise is minimized for any subordinate device.,Designating devices as subordinate devices is recommended for device groups with a large number of member devices, where the risk of compromise is high. | |
peer_hostname: ${6:undefined} # not required. The hostname that you want to associate with the device. This value will be used to easily distinguish this device in BIG-IP configuration. If not specified, the value of C(peer_server) will be used as a default. | |
peer_user: ${7:undefined} # not required. The API username of the remote peer device that you are trusting. Note that the CLI user cannot be used unless it too has an API account. If this value is not specified, then the value of C(user), or the environment variable C(F5_USER) will be used. | |
peer_password: ${8:undefined} # not required. The password of the API username of the remote peer device that you are trusting. If this value is not specified, then the value of C(password), or the environment variable C(F5_PASSWORD) will be used. | |
state: ${9|absent,present|} # not required. choices: absent;present. When C(present), ensures the specified devices are trusted.,When C(absent), removes the device trusts. | |
server_port: ${10:443} # not required. The BIG-IP server port. You can omit this option if the environment variable C(F5_SERVER_PORT) is set. | |
provider: ${11:null} # not required. A dict object containing connection details. | |
validate_certs: ${12:true} # not required. If C(no), SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable C(F5_VALIDATE_CERTS) is set. | |
""" | |
'bigip_facts': | |
'prefix': "bigip_facts_snippet" | |
'description': "Collect facts from F5 BIG-IP devices" | |
'body': """ | |
bigip_facts: | |
password: ${1:undefined} # required. The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable C(F5_PASSWORD) is set. | |
server: ${2:undefined} # required. The BIG-IP host. You can omit this option if the environment variable C(F5_SERVER) is set. | |
user: ${3:undefined} # required. The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable C(F5_USER) is set. | |
include: ${4|address_class,certificate,client_ssl_profile,device,device_group,interface,key,node,pool,provision,rule,self_ip,software,system_info,traffic_group,trunk,virtual_address,virtual_server,vlan|} # required. choices: address_class;certificate;client_ssl_profile;device;device_group;interface;key;node;pool;provision;rule;self_ip;software;system_info;traffic_group;trunk;virtual_address;virtual_server;vlan. Fact category or list of categories to collect | |
filter: ${5||} # not required. choices: . Shell-style glob matching string used to filter fact keys. Not applicable for software, provision, and system_info fact categories. | |
session: ${6||} # not required. choices: . BIG-IP session support; may be useful to avoid concurrency issues in certain circumstances. | |
server_port: ${7:443} # not required. The BIG-IP server port. You can omit this option if the environment variable C(F5_SERVER_PORT) is set. | |
provider: ${8:null} # not required. A dict object containing connection details. | |
validate_certs: ${9:true} # not required. If C(no), SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable C(F5_VALIDATE_CERTS) is set. | |
""" | |
'bigip_gtm_datacenter': | |
'prefix': "bigip_gtm_datacenter_snippet" | |
'description': "Manage Datacenter configuration in BIG-IP" | |
'body': """ | |
bigip_gtm_datacenter: | |
user: ${1:undefined} # required. The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable C(F5_USER) is set. | |
password: ${2:undefined} # required. The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable C(F5_PASSWORD) is set. | |
name: ${3:undefined} # required. The name of the data center. | |
server: ${4:undefined} # required. The BIG-IP host. You can omit this option if the environment variable C(F5_SERVER) is set. | |
description: ${5:undefined} # not required. The description of the data center. | |
partition: ${6:Common} # not required. Device partition to manage resources on. | |
state: ${7|present,absent,enabled,disabled|} # not required. choices: present;absent;enabled;disabled. The virtual address state. If C(absent), an attempt to delete the virtual address will be made. This will only succeed if this virtual address is not in use by a virtual server. C(present) creates the virtual address and enables it. If C(enabled), enable the virtual address if it exists. If C(disabled), create the virtual address if needed, and set state to C(disabled). | |
contact: ${8:undefined} # not required. The name of the contact for the data center. | |
location: ${9:undefined} # not required. The location of the data center. | |
server_port: ${10:443} # not required. The BIG-IP server port. You can omit this option if the environment variable C(F5_SERVER_PORT) is set. | |
provider: ${11:null} # not required. A dict object containing connection details. | |
validate_certs: ${12:true} # not required. If C(no), SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable C(F5_VALIDATE_CERTS) is set. | |
""" | |
'bigip_gtm_facts': | |
'prefix': "bigip_gtm_facts_snippet" | |
'description': "Collect facts from F5 BIG-IP GTM devices" | |
'body': """ | |
bigip_gtm_facts: | |
include: ${1|pool,wide_ip,server|} # required. choices: pool;wide_ip;server. Fact category to collect. | |
server: ${2:undefined} # required. The BIG-IP host. You can omit this option if the environment variable C(F5_SERVER) is set. | |
user: ${3:undefined} # required. The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable C(F5_USER) is set. | |
password: ${4:undefined} # required. The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable C(F5_PASSWORD) is set. | |
filter: ${5:undefined} # not required. Perform regex filter of response. Filtering is done on the name of the resource. Valid filters are anything that can be provided to Python's C(re) module. | |
server_port: ${6:443} # not required. The BIG-IP server port. You can omit this option if the environment variable C(F5_SERVER_PORT) is set. | |
provider: ${7:null} # not required. A dict object containing connection details. | |
validate_certs: ${8:true} # not required. If C(no), SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable C(F5_VALIDATE_CERTS) is set. | |
""" | |
'bigip_gtm_pool': | |
'prefix': "bigip_gtm_pool_snippet" | |
'description': "Manages F5 BIG-IP GTM pools" | |
'body': """ | |
bigip_gtm_pool: | |
name: ${1:undefined} # required. Name of the GTM pool. | |
server: ${2:undefined} # required. The BIG-IP host. You can omit this option if the environment variable C(F5_SERVER) is set. | |
user: ${3:undefined} # required. The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable C(F5_USER) is set. | |
password: ${4:undefined} # required. The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable C(F5_PASSWORD) is set. | |
alternate_lb_method: ${5|round-robin,return-to-dns,none,ratio,topology,static-persistence,global-availability,virtual-server-capacity,packet-rate,drop-packet,fallback-ip,virtual-server-score|} # not required. choices: round-robin;return-to-dns;none;ratio;topology;static-persistence;global-availability;virtual-server-capacity;packet-rate;drop-packet;fallback-ip;virtual-server-score. The load balancing mode that the system tries if the C(preferred_lb_method) is unsuccessful in picking a pool. | |
validate_certs: ${6:true} # not required. If C(no), SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable C(F5_VALIDATE_CERTS) is set. | |
partition: ${7:Common} # not required. Device partition to manage resources on. | |
fallback_ip: ${8:undefined} # not required. Specifies the IPv4, or IPv6 address of the server to which the system directs requests when it cannot use one of its pools to do so. Note that the system uses the fallback IP only if you select the C(fallback_ip) load balancing method. | |
state: ${9|present,absent,enabled,disabled|} # not required. choices: present;absent;enabled;disabled. Pool member state. When C(present), ensures that the pool is created and enabled. When C(absent), ensures that the pool is removed from the system. When C(enabled) or C(disabled), ensures that the pool is enabled or disabled (respectively) on the remote device. | |
fallback_lb_method: ${10|round-robin,return-to-dns,ratio,topology,static-persistence,global-availability,virtual-server-capacity,least-connections,lowest-round-trip-time,fewest-hops,packet-rate,cpu,completion-rate,quality-of-service,kilobytes-per-second,drop-packet,fallback-ip,virtual-server-score|} # not required. choices: round-robin;return-to-dns;ratio;topology;static-persistence;global-availability;virtual-server-capacity;least-connections;lowest-round-trip-time;fewest-hops;packet-rate;cpu;completion-rate;quality-of-service;kilobytes-per-second;drop-packet;fallback-ip;virtual-server-score. The load balancing mode that the system tries if both the C(preferred_lb_method) and C(alternate_lb_method)s are unsuccessful in picking a pool. | |
server_port: ${11:443} # not required. The BIG-IP server port. You can omit this option if the environment variable C(F5_SERVER_PORT) is set. | |
preferred_lb_method: ${12|round-robin,return-to-dns,ratio,topology,static-persistence,global-availability,virtual-server-capacity,least-connections,lowest-round-trip-time,fewest-hops,packet-rate,cpu,completion-rate,quality-of-service,kilobytes-per-second,drop-packet,fallback-ip,virtual-server-score|} # not required. choices: round-robin;return-to-dns;ratio;topology;static-persistence;global-availability;virtual-server-capacity;least-connections;lowest-round-trip-time;fewest-hops;packet-rate;cpu;completion-rate;quality-of-service;kilobytes-per-second;drop-packet;fallback-ip;virtual-server-score. The load balancing mode that the system tries first. | |
type: ${13|a,aaaa,cname,mx,naptr,srv|} # not required. choices: a;aaaa;cname;mx;naptr;srv. The type of GTM pool that you want to create. On BIG-IP releases prior to version 12, this parameter is not required. On later versions of BIG-IP, this is a required parameter. | |
provider: ${14:null} # not required. A dict object containing connection details. | |
""" | |
'bigip_gtm_server': | |
'prefix': "bigip_gtm_server_snippet" | |
'description': "Manages F5 BIG-IP GTM servers" | |
'body': """ | |
bigip_gtm_server: | |
name: ${1:undefined} # required. The name of the server. | |
server: ${2:undefined} # required. The BIG-IP host. You can omit this option if the environment variable C(F5_SERVER) is set. | |
password: ${3:undefined} # required. The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable C(F5_PASSWORD) is set. | |
user: ${4:undefined} # required. The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable C(F5_USER) is set. | |
link_discovery: ${5|enabled,disabled,enabled-no-delete|} # not required. choices: enabled;disabled;enabled-no-delete. Specifies whether the system auto-discovers the links for this server. When creating a new GTM server, if this parameter is not specified, the default value C(disabled) is used.,If you set this parameter to C(enabled) or C(enabled-no-delete), you must also ensure that the C(virtual_server_discovery) parameter is also set to C(enabled) or C(enabled-no-delete). | |
datacenter: ${6:undefined} # not required. Data center the server belongs to. When creating a new GTM server, this value is required. | |
partition: ${7:Common} # not required. Device partition to manage resources on. | |
server_type: ${8|alteon-ace-director,cisco-css,cisco-server-load-balancer,generic-host,radware-wsd,windows-nt-4.0,bigip,cisco-local-director-v2,extreme,generic-load-balancer,sun-solaris,cacheflow,cisco-local-director-v3,foundry-server-iron,netapp,windows-2000-server|} # not required. choices: alteon-ace-director;cisco-css;cisco-server-load-balancer;generic-host;radware-wsd;windows-nt-4.0;bigip;cisco-local-director-v2;extreme;generic-load-balancer;sun-solaris;cacheflow;cisco-local-director-v3;foundry-server-iron;netapp;windows-2000-server. Specifies the server type. The server type determines the metrics that the system can collect from the server. When creating a new GTM server, the default value C(bigip) is used. | |
state: ${9|present,absent,enabled,disabled|} # not required. choices: present;absent;enabled;disabled. The server state. If C(absent), an attempt to delete the server will be made. This will only succeed if this server is not in use by a virtual server. C(present) creates the server and enables it. If C(enabled), enable the server if it exists. If C(disabled), create the server if needed, and set state to C(disabled). | |
devices: ${10:undefined} # not required. Lists the self IP addresses and translations for each device. When creating a new GTM server, this value is required. This list is a complex list that specifies a number of keys. There are several supported keys.,The C(name) key specifies a name for the device. The device name must be unique per server. This key is required.,The C(address) key contains an IP address, or list of IP addresses, for the destination server. This key is required.,The C(translation) key contains an IP address to translate the C(address) value above to. This key is optional.,Specifying duplicate C(name) fields is a supported means of providing device addresses. In this scenario, the addresses will be assigned to the C(name)'s list of addresses. | |
server_port: ${11:443} # not required. The BIG-IP server port. You can omit this option if the environment variable C(F5_SERVER_PORT) is set. | |
provider: ${12:null} # not required. A dict object containing connection details. | |
virtual_server_discovery: ${13|enabled,disabled,enabled-no-delete|} # not required. choices: enabled;disabled;enabled-no-delete. Specifies whether the system auto-discovers the virtual servers for this server. When creating a new GTM server, if this parameter is not specified, the default value C(disabled) is used. | |
validate_certs: ${14:true} # not required. If C(no), SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable C(F5_VALIDATE_CERTS) is set. | |
""" | |
'bigip_gtm_virtual_server': | |
'prefix': "bigip_gtm_virtual_server_snippet" | |
'description': "Manages F5 BIG-IP GTM virtual servers" | |
'body': """ | |
bigip_gtm_virtual_server: | |
virtual_server_name: ${1:undefined} # required. Virtual server name. | |
server: ${2:undefined} # required. The BIG-IP host. You can omit this option if the environment variable C(F5_SERVER) is set. | |
user: ${3:undefined} # required. The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable C(F5_USER) is set. | |
password: ${4:undefined} # required. The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable C(F5_PASSWORD) is set. | |
virtual_server_server: ${5:undefined} # required. Virtual server server. | |
validate_certs: ${6:true} # not required. If C(no), SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable C(F5_VALIDATE_CERTS) is set. | |
state: ${7|present,absent,enabled,disabled|} # not required. choices: present;absent;enabled;disabled. Virtual server state. | |
host: ${8:undefined} # not required. Virtual server host. | |
server_port: ${9:443} # not required. The BIG-IP server port. You can omit this option if the environment variable C(F5_SERVER_PORT) is set. | |
provider: ${10:null} # not required. A dict object containing connection details. | |
port: ${11:undefined} # not required. Virtual server port. | |
""" | |
'bigip_gtm_wide_ip': | |
'prefix': "bigip_gtm_wide_ip_snippet" | |
'description': "Manages F5 BIG-IP GTM wide ip" | |
'body': """ | |
bigip_gtm_wide_ip: | |
user: ${1:undefined} # required. The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable C(F5_USER) is set. | |
password: ${2:undefined} # required. The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable C(F5_PASSWORD) is set. | |
name: ${3:undefined} # required. Wide IP name. This name must be formatted as a fully qualified domain name (FQDN). You can also use the alias C(wide_ip) but this is deprecated and will be removed in a future Ansible version. | |
pool_lb_method: ${4|round-robin,ratio,topology,global-availability|} # required. choices: round-robin;ratio;topology;global-availability. Specifies the load balancing method used to select a pool in this wide IP. This setting is relevant only when multiple pools are configured for a wide IP. | |
server: ${5:undefined} # required. The BIG-IP host. You can omit this option if the environment variable C(F5_SERVER) is set. | |
type: ${6|a,aaaa,cname,mx,naptr,srv|} # not required. choices: a;aaaa;cname;mx;naptr;srv. Specifies the type of wide IP. GTM wide IPs need to be keyed by query type in addition to name, since pool members need different attributes depending on the response RDATA they are meant to supply. This value is required if you are using BIG-IP versions >= 12.0.0. | |
partition: ${7:Common} # not required. Device partition to manage resources on. | |
state: ${8|present,absent,disabled,enabled|} # not required. choices: present;absent;disabled;enabled. When C(present) or C(enabled), ensures that the Wide IP exists and is enabled.,When C(absent), ensures that the Wide IP has been removed.,When C(disabled), ensures that the Wide IP exists and is disabled. | |
server_port: ${9:443} # not required. The BIG-IP server port. You can omit this option if the environment variable C(F5_SERVER_PORT) is set. | |
provider: ${10:null} # not required. A dict object containing connection details. | |
pools: ${11:undefined} # not required. The pools that you want associated with the Wide IP.,If C(ratio) is not provided when creating a new Wide IP, it will default to 1. | |
validate_certs: ${12:true} # not required. If C(no), SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable C(F5_VALIDATE_CERTS) is set. | |
""" | |
'bigip_hostname': | |
'prefix': "bigip_hostname_snippet" | |
'description': "Manage the hostname of a BIG-IP" | |
'body': """ | |
bigip_hostname: | |
hostname: ${1:undefined} # required. Hostname of the BIG-IP host. | |
server: ${2:undefined} # required. The BIG-IP host. You can omit this option if the environment variable C(F5_SERVER) is set. | |
user: ${3:undefined} # required. The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable C(F5_USER) is set. | |
password: ${4:undefined} # required. The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable C(F5_PASSWORD) is set. | |
server_port: ${5:443} # not required. The BIG-IP server port. You can omit this option if the environment variable C(F5_SERVER_PORT) is set. | |
provider: ${6:null} # not required. A dict object containing connection details. | |
validate_certs: ${7:true} # not required. If C(no), SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable C(F5_VALIDATE_CERTS) is set. | |
""" | |
'bigip_iapp_service': | |
'prefix': "bigip_iapp_service_snippet" | |
'description': "Manages TCL iApp services on a BIG-IP" | |
'body': """ | |
bigip_iapp_service: | |
name: ${1:undefined} # required. The name of the iApp service that you want to deploy. | |
server: ${2:undefined} # required. The BIG-IP host. You can omit this option if the environment variable C(F5_SERVER) is set. | |
user: ${3:undefined} # required. The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable C(F5_USER) is set. | |
password: ${4:undefined} # required. The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable C(F5_PASSWORD) is set. | |
force: ${5:false} # not required. Forces the updating of an iApp service even if the parameters to the service have not changed. This option is of particular importance if the iApp template that underlies the service has been updated in-place. This option is equivalent to re-configuring the iApp if that template has changed. | |
parameters: ${6:undefined} # not required. A hash of all the required template variables for the iApp template. If your parameters are stored in a file (the more common scenario) it is recommended you use either the `file` or `template` lookups to supply the expected parameters.,These parameters typically consist of the C(lists), C(tables), and C(variables) fields. | |
strict_updates: ${7:true} # not required. Indicates whether the application service is tied to the template, so when the template is updated, the application service changes to reflect the updates.,When C(yes), disallows any updates to the resources that the iApp service has created, if they are not updated directly through the iApp.,When C(no), allows updates outside of the iApp.,If this option is specified in the Ansible task, it will take precedence over any similar setting in the iApp Server payload that you provide in the C(parameters) field. | |
partition: ${8:Common} # not required. Device partition to manage resources on. | |
server_port: ${9:443} # not required. The BIG-IP server port. You can omit this option if the environment variable C(F5_SERVER_PORT) is set. | |
state: ${10|present,absent|} # not required. choices: present;absent. When C(present), ensures that the iApp service is created and running. When C(absent), ensures that the iApp service has been removed. | |
template: ${11:undefined} # not required. The iApp template from which to instantiate a new service. This template must exist on your BIG-IP before you can successfully create a service. This parameter is required if the C(state) parameter is C(present). | |
provider: ${12:null} # not required. A dict object containing connection details. | |
traffic_group: ${13:undefined} # not required. The traffic group for the iApp service. When creating a new service, if this value is not specified, the default of C(/Common/traffic-group-1) will be used.,If this option is specified in the Ansible task, it will take precedence over any similar setting in the iApp Server payload that you provide in the C(parameters) field. | |
validate_certs: ${14:true} # not required. If C(no), SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable C(F5_VALIDATE_CERTS) is set. | |
""" | |
'bigip_iapp_template': | |
'prefix': "bigip_iapp_template_snippet" | |
'description': "Manages TCL iApp templates on a BIG-IP" | |
'body': """ | |
bigip_iapp_template: | |
server: ${1:undefined} # required. The BIG-IP host. You can omit this option if the environment variable C(F5_SERVER) is set. | |
user: ${2:undefined} # required. The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable C(F5_USER) is set. | |
password: ${3:undefined} # required. The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable C(F5_PASSWORD) is set. | |
force: ${4:undefined} # not required. Specifies whether or not to force the uploading of an iApp. When C(yes), will force update the iApp even if there are iApp services using it. This will not update the running service though. Use C(bigip_iapp_service) to do that. When C(no), will update the iApp only if there are no iApp services using the template. | |
name: ${5:undefined} # not required. The name of the iApp template that you want to delete. This option is only available when specifying a C(state) of C(absent) and is provided as a way to delete templates that you may no longer have the source of. | |
partition: ${6:Common} # not required. Device partition to manage resources on. | |
content: ${7:undefined} # not required. Sets the contents of an iApp template directly to the specified value. This is for simple values, but can be used with lookup plugins for anything complex or with formatting. C(content) must be provided when creating new templates. | |
state: ${8|present,absent|} # not required. choices: present;absent. Whether the iApp template should exist or not. | |
server_port: ${9:443} # not required. The BIG-IP server port. You can omit this option if the environment variable C(F5_SERVER_PORT) is set. | |
provider: ${10:null} # not required. A dict object containing connection details. | |
validate_certs: ${11:true} # not required. If C(no), SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable C(F5_VALIDATE_CERTS) is set. | |
""" | |
'bigip_iapplx_package': | |
'prefix': "bigip_iapplx_package_snippet" | |
'description': "Manages Javascript iApp packages on a BIG-IP" | |
'body': """ | |
bigip_iapplx_package: | |
server: ${1:undefined} # required. The BIG-IP host. You can omit this option if the environment variable C(F5_SERVER) is set. | |
user: ${2:undefined} # required. The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable C(F5_USER) is set. | |
password: ${3:undefined} # required. The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable C(F5_PASSWORD) is set. | |
package: ${4:undefined} # not required. The iAppLX package that you want to upload or remove. When C(state) is C(present), and you intend to use this module in a C(role), it is recommended that you use the C({{ role_path }}) variable. An example is provided in the C(EXAMPLES) section.,When C(state) is C(absent), it is not necessary for the package to exist on the Ansible controller. If the full path to the package is provided, the fileame will specifically be cherry picked from it to properly remove the package. | |
state: ${5|present,absent|} # not required. choices: present;absent. Whether the iAppLX package should exist or not. | |
server_port: ${6:443} # not required. The BIG-IP server port. You can omit this option if the environment variable C(F5_SERVER_PORT) is set. | |
provider: ${7:null} # not required. A dict object containing connection details. | |
validate_certs: ${8:true} # not required. If C(no), SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable C(F5_VALIDATE_CERTS) is set. | |
""" | |
'bigip_irule': | |
'prefix': "bigip_irule_snippet" | |
'description': "Manage iRules across different modules on a BIG-IP" | |
'body': """ | |
bigip_irule: | |
module: ${1|ltm,gtm|} # required. choices: ltm;gtm. The BIG-IP module to add the iRule to. | |
user: ${2:undefined} # required. The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable C(F5_USER) is set. | |
password: ${3:undefined} # required. The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable C(F5_PASSWORD) is set. | |
src: ${4:undefined} # required. The iRule file to interpret and upload to the BIG-IP. Either one of C(src) or C(content) must be provided. | |
name: ${5:undefined} # required. The name of the iRule. | |
server: ${6:undefined} # required. The BIG-IP host. You can omit this option if the environment variable C(F5_SERVER) is set. | |
partition: ${7:Common} # not required. Device partition to manage resources on. | |
content: ${8:undefined} # not required. When used instead of 'src', sets the contents of an iRule directly to the specified value. This is for simple values, but can be used with lookup plugins for anything complex or with formatting. Either one of C(src) or C(content) must be provided. | |
state: ${9|present,absent|} # not required. choices: present;absent. Whether the iRule should exist or not. | |
server_port: ${10:443} # not required. The BIG-IP server port. You can omit this option if the environment variable C(F5_SERVER_PORT) is set. | |
provider: ${11:null} # not required. A dict object containing connection details. | |
validate_certs: ${12:true} # not required. If C(no), SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable C(F5_VALIDATE_CERTS) is set. | |
""" | |
'bigip_monitor_http': | |
'prefix': "bigip_monitor_http_snippet" | |
'description': "Manages F5 BIG-IP LTM http monitors" | |
'body': """ | |
bigip_monitor_http: | |
name: ${1:undefined} # required. Monitor name. | |
server: ${2:undefined} # required. The BIG-IP host. You can omit this option if the environment variable C(F5_SERVER) is set. | |
user: ${3:undefined} # required. The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable C(F5_USER) is set. | |
password: ${4:undefined} # required. The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable C(F5_PASSWORD) is set. | |
interval: ${5:undefined} # not required. The interval specifying how frequently the monitor instance of this template will run. If this parameter is not provided when creating a new monitor, then the default value will be 5. This value B(must) be less than the C(timeout) value. | |
parent: ${6:/Common/http} # not required. The parent template of this monitor template. Once this value has been set, it cannot be changed. By default, this value is the C(http) parent on the C(Common) partition. | |
receive: ${7:undefined} # not required. The receive string for the monitor call. | |
ip: ${8:undefined} # not required. IP address part of the IP/port definition. If this parameter is not provided when creating a new monitor, then the default value will be '*'. | |
partition: ${9:Common} # not required. Device partition to manage resources on. | |
send: ${10:undefined} # not required. The send string for the monitor call. When creating a new monitor, if this value is not provided, the default C(GET /\\r\\n) will be used. | |
port: ${11:undefined} # not required. Port address part of the IP/port definition. If this parameter is not provided when creating a new monitor, then the default value will be '*'. Note that if specifying an IP address, a value between 1 and 65535 must be specified. | |
server_port: ${12:443} # not required. The BIG-IP server port. You can omit this option if the environment variable C(F5_SERVER_PORT) is set. | |
state: ${13|present,absent|} # not required. choices: present;absent. When C(present), ensures that the monitor exists.,When C(absent), ensures the monitor is removed. | |
time_until_up: ${14:undefined} # not required. Specifies the amount of time in seconds after the first successful response before a node will be marked up. A value of 0 will cause a node to be marked up immediately after a valid response is received from the node. If this parameter is not provided when creating a new monitor, then the default value will be 0. | |
timeout: ${15:undefined} # not required. The number of seconds in which the node or service must respond to the monitor request. If the target responds within the set time period, it is considered up. If the target does not respond within the set time period, it is considered down. You can change this number to any number you want, however, it should be 3 times the interval number of seconds plus 1 second. If this parameter is not provided when creating a new monitor, then the default value will be 16. | |
provider: ${16:null} # not required. A dict object containing connection details. | |
target_password: ${17:undefined} # not required. Specifies the password, if the monitored target requires authentication. | |
validate_certs: ${18:true} # not required. If C(no), SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable C(F5_VALIDATE_CERTS) is set. | |
target_username: ${19:undefined} # not required. Specifies the user name, if the monitored target requires authentication. | |
receive_disable: ${20:undefined} # not required. This setting works like C(receive), except that the system marks the node or pool member disabled when its response matches the C(receive_disable) string but not C(receive). To use this setting, you must specify both C(receive_disable) and C(receive). | |
""" | |
'bigip_monitor_https': | |
'prefix': "bigip_monitor_https_snippet" | |
'description': "Manages F5 BIG-IP LTM https monitors" | |
'body': """ | |
bigip_monitor_https: | |
name: ${1:undefined} # required. Monitor name. | |
server: ${2:undefined} # required. The BIG-IP host. You can omit this option if the environment variable C(F5_SERVER) is set. | |
user: ${3:undefined} # required. The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable C(F5_USER) is set. | |
password: ${4:undefined} # required. The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable C(F5_PASSWORD) is set. | |
interval: ${5:undefined} # not required. The interval specifying how frequently the monitor instance of this template will run. If this parameter is not provided when creating a new monitor, then the default value will be 5. This value B(must) be less than the C(timeout) value. | |
parent: ${6:/Common/https} # not required. The parent template of this monitor template. Once this value has been set, it cannot be changed. By default, this value is the C(https) parent on the C(Common) partition. | |
receive: ${7:undefined} # not required. The receive string for the monitor call. | |
ip: ${8:undefined} # not required. IP address part of the IP/port definition. If this parameter is not provided when creating a new monitor, then the default value will be '*'. | |
partition: ${9:Common} # not required. Device partition to manage resources on. | |
send: ${10:undefined} # not required. The send string for the monitor call. When creating a new monitor, if this value is not provided, the default C(GET /\\\\r\\\\n) will be used. | |
port: ${11:undefined} # not required. Port address part of the IP/port definition. If this parameter is not provided when creating a new monitor, then the default value will be '*'. Note that if specifying an IP address, a value between 1 and 65535 must be specified | |
server_port: ${12:443} # not required. The BIG-IP server port. You can omit this option if the environment variable C(F5_SERVER_PORT) is set. | |
state: ${13|present,absent|} # not required. choices: present;absent. When C(present), ensures that the monitor exists.,When C(absent), ensures the monitor is removed. | |
time_until_up: ${14:undefined} # not required. Specifies the amount of time in seconds after the first successful response before a node will be marked up. A value of 0 will cause a node to be marked up immediately after a valid response is received from the node. If this parameter is not provided when creating a new monitor, then the default value will be 0. | |
timeout: ${15:undefined} # not required. The number of seconds in which the node or service must respond to the monitor request. If the target responds within the set time period, it is considered up. If the target does not respond within the set time period, it is considered down. You can change this number to any number you want, however, it should be 3 times the interval number of seconds plus 1 second. If this parameter is not provided when creating a new monitor, then the default value will be 16. | |
provider: ${16:null} # not required. A dict object containing connection details. | |
target_password: ${17:undefined} # not required. Specifies the password, if the monitored target requires authentication. | |
validate_certs: ${18:true} # not required. If C(no), SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable C(F5_VALIDATE_CERTS) is set. | |
target_username: ${19:undefined} # not required. Specifies the user name, if the monitored target requires authentication. | |
receive_disable: ${20:undefined} # not required. This setting works like C(receive), except that the system marks the node or pool member disabled when its response matches the C(receive_disable) string but not C(receive). To use this setting, you must specify both C(receive_disable) and C(receive). | |
""" | |
'bigip_monitor_snmp_dca': | |
'prefix': "bigip_monitor_snmp_dca_snippet" | |
'description': "Manages BIG-IP SNMP data collecting agent (DCA) monitors" | |
'body': """ | |
bigip_monitor_snmp_dca: | |
user: ${1:undefined} # required. The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable C(F5_USER) is set. | |
password: ${2:undefined} # required. The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable C(F5_PASSWORD) is set. | |
name: ${3:undefined} # required. Monitor name. | |
server: ${4:undefined} # required. The BIG-IP host. You can omit this option if the environment variable C(F5_SERVER) is set. | |
interval: ${5:undefined} # not required. Specifies, in seconds, the frequency at which the system issues the monitor check when either the resource is down or the status of the resource is unknown. When creating a new monitor, the default is C(10). | |
disk_threshold: ${6:undefined} # not required. Specifies the maximum acceptable disk usage on the target server. When creating a new monitor, the default is C(90) percent. | |
parent: ${7:/Common/snmp_dca} # not required. The parent template of this monitor template. Once this value has been set, it cannot be changed. By default, this value is the C(snmp_dca) parent on the C(Common) partition. | |
community: ${8:undefined} # not required. Specifies the community name that the system must use to authenticate with the host server through SNMP. When creating a new monitor, the default value is C(public). Note that this value is case sensitive. | |
server_port: ${9:443} # not required. The BIG-IP server port. You can omit this option if the environment variable C(F5_SERVER_PORT) is set. | |
cpu_threshold: ${10:undefined} # not required. Specifies the maximum acceptable CPU usage on the target server. When creating a new monitor, the default is C(80) percent. | |
description: ${11:undefined} # not required. Specifies descriptive text that identifies the monitor. | |
cpu_coefficient: ${12:undefined} # not required. Specifies the coefficient that the system uses to calculate the weight of the CPU threshold in the dynamic ratio load balancing algorithm. When creating a new monitor, the default is C(1.5). | |
time_until_up: ${13:undefined} # not required. Specifies the number of seconds to wait after a resource first responds correctly to the monitor before setting the resource to 'up'. During the interval, all responses from the resource must be correct. When the interval expires, the resource is marked 'up'. A value of 0, means that the resource is marked up immediately upon receipt of the first correct response. When creating a new monitor, the default is C(0). | |
partition: ${14:Common} # not required. Device partition to manage resources on. | |
memory_threshold: ${15:undefined} # not required. Specifies the maximum acceptable memory usage on the target server. When creating a new monitor, the default is C(70) percent. | |
disk_coefficient: ${16:undefined} # not required. Specifies the coefficient that the system uses to calculate the weight of the disk threshold in the dynamic ratio load balancing algorithm. When creating a new monitor, the default is C(2.0). | |
state: ${17|present,absent|} # not required. choices: present;absent. When C(present), ensures that the monitor exists.,When C(absent), ensures the monitor is removed. | |
version: ${18|v1,v2c|} # not required. choices: v1;v2c. Specifies the version of SNMP that the host server uses. When creating a new monitor, the default is C(v1). When C(v1), specifies that the host server uses SNMP version 1. When C(v2c), specifies that the host server uses SNMP version 2c. | |
agent_type: ${19|UCD,WIN2000,GENERIC|} # not required. choices: UCD;WIN2000;GENERIC. Specifies the SNMP agent running on the monitored server. When creating a new monitor, the default is C(UCD) (UC-Davis). | |
memory_coefficient: ${20:undefined} # not required. Specifies the coefficient that the system uses to calculate the weight of the memory threshold in the dynamic ratio load balancing algorithm. When creating a new monitor, the default is C(1.0). | |
timeout: ${21:undefined} # not required. Specifies the number of seconds the target has in which to respond to the monitor request. When creating a new monitor, the default is C(30) seconds. If the target responds within the set time period, it is considered 'up'. If the target does not respond within the set time period, it is considered 'down'. When this value is set to 0 (zero), the system uses the interval from the parent monitor. Note that C(timeout) and C(time_until_up) combine to control when a resource is set to up. | |
provider: ${22:null} # not required. A dict object containing connection details. | |
validate_certs: ${23:true} # not required. If C(no), SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable C(F5_VALIDATE_CERTS) is set. | |
""" | |
'bigip_monitor_tcp': | |
'prefix': "bigip_monitor_tcp_snippet" | |
'description': "Manages F5 BIG-IP LTM tcp monitors" | |
'body': """ | |
bigip_monitor_tcp: | |
name: ${1:undefined} # required. Monitor name. | |
server: ${2:undefined} # required. The BIG-IP host. You can omit this option if the environment variable C(F5_SERVER) is set. | |
user: ${3:undefined} # required. The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable C(F5_USER) is set. | |
password: ${4:undefined} # required. The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable C(F5_PASSWORD) is set. | |
interval: ${5:undefined} # not required. The interval specifying how frequently the monitor instance of this template will run. If this parameter is not provided when creating a new monitor, then the default value will be 5. This value B(must) be less than the C(timeout) value. | |
parent: ${6:/Common/tcp} # not required. The parent template of this monitor template. Once this value has been set, it cannot be changed. By default, this value is the C(tcp) parent on the C(Common) partition. | |
receive: ${7:undefined} # not required. The receive string for the monitor call. | |
ip: ${8:undefined} # not required. IP address part of the IP/port definition. If this parameter is not provided when creating a new monitor, then the default value will be '*'.,If this value is an IP address, and the C(type) is C(tcp) (the default), then a C(port) number must be specified. | |
partition: ${9:Common} # not required. Device partition to manage resources on. | |
send: ${10:undefined} # not required. The send string for the monitor call. | |
server_port: ${11:443} # not required. The BIG-IP server port. You can omit this option if the environment variable C(F5_SERVER_PORT) is set. | |
state: ${12|present,absent|} # not required. choices: present;absent. When C(present), ensures that the monitor exists.,When C(absent), ensures the monitor is removed. | |
time_until_up: ${13:undefined} # not required. Specifies the amount of time in seconds after the first successful response before a node will be marked up. A value of 0 will cause a node to be marked up immediately after a valid response is received from the node. If this parameter is not provided when creating a new monitor, then the default value will be 0. | |
timeout: ${14:undefined} # not required. The number of seconds in which the node or service must respond to the monitor request. If the target responds within the set time period, it is considered up. If the target does not respond within the set time period, it is considered down. You can change this number to any number you want, however, it should be 3 times the interval number of seconds plus 1 second. If this parameter is not provided when creating a new monitor, then the default value will be 16. | |
provider: ${15:null} # not required. A dict object containing connection details. | |
validate_certs: ${16:true} # not required. If C(no), SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable C(F5_VALIDATE_CERTS) is set. | |
port: ${17:undefined} # not required. Port address part of the IP/port definition. If this parameter is not provided when creating a new monitor, then the default value will be '*'. Note that if specifying an IP address, a value between 1 and 65535 must be specified,This argument is not supported for TCP Echo types. | |
""" | |
'bigip_monitor_tcp_echo': | |
'prefix': "bigip_monitor_tcp_echo_snippet" | |
'description': "Manages F5 BIG-IP LTM tcp echo monitors" | |
'body': """ | |
bigip_monitor_tcp_echo: | |
name: ${1:undefined} # required. Monitor name. | |
server: ${2:undefined} # required. The BIG-IP host. You can omit this option if the environment variable C(F5_SERVER) is set. | |
user: ${3:undefined} # required. The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable C(F5_USER) is set. | |
password: ${4:undefined} # required. The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable C(F5_PASSWORD) is set. | |
interval: ${5:undefined} # not required. The interval specifying how frequently the monitor instance of this template will run. If this parameter is not provided when creating a new monitor, then the default value will be 5. This value B(must) be less than the C(timeout) value. | |
parent: ${6:/Common/tcp_echo} # not required. The parent template of this monitor template. Once this value has been set, it cannot be changed. By default, this value is the C(tcp_echo) parent on the C(Common) partition. | |
ip: ${7:undefined} # not required. IP address part of the IP/port definition. If this parameter is not provided when creating a new monitor, then the default value will be '*'.,If this value is an IP address, and the C(type) is C(tcp) (the default), then a C(port) number must be specified. | |
partition: ${8:Common} # not required. Device partition to manage resources on. | |
server_port: ${9:443} # not required. The BIG-IP server port. You can omit this option if the environment variable C(F5_SERVER_PORT) is set. | |
state: ${10|present,absent|} # not required. choices: present;absent. When C(present), ensures that the monitor exists.,When C(absent), ensures the monitor is removed. | |
time_until_up: ${11:undefined} # not required. Specifies the amount of time in seconds after the first successful response before a node will be marked up. A value of 0 will cause a node to be marked up immediately after a valid response is received from the node. If this parameter is not provided when creating a new monitor, then the default value will be 0. | |
timeout: ${12:undefined} # not required. The number of seconds in which the node or service must respond to the monitor request. If the target responds within the set time period, it is considered up. If the target does not respond within the set time period, it is considered down. You can change this number to any number you want, however, it should be 3 times the interval number of seconds plus 1 second. If this parameter is not provided when creating a new monitor, then the default value will be 16. | |
provider: ${13:null} # not required. A dict object containing connection details. | |
validate_certs: ${14:true} # not required. If C(no), SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable C(F5_VALIDATE_CERTS) is set. | |
""" | |
'bigip_monitor_tcp_half_open': | |
'prefix': "bigip_monitor_tcp_half_open_snippet" | |
'description': "Manages F5 BIG-IP LTM tcp half-open monitors" | |
'body': """ | |
bigip_monitor_tcp_half_open: | |
name: ${1:undefined} # required. Monitor name. | |
server: ${2:undefined} # required. The BIG-IP host. You can omit this option if the environment variable C(F5_SERVER) is set. | |
user: ${3:undefined} # required. The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable C(F5_USER) is set. | |
password: ${4:undefined} # required. The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable C(F5_PASSWORD) is set. | |
interval: ${5:undefined} # not required. The interval specifying how frequently the monitor instance of this template will run. If this parameter is not provided when creating a new monitor, then the default value will be 5. This value B(must) be less than the C(timeout) value. | |
parent: ${6:/Common/tcp_half_open} # not required. The parent template of this monitor template. Once this value has been set, it cannot be changed. By default, this value is the C(tcp_half_open) parent on the C(Common) partition. | |
ip: ${7:undefined} # not required. IP address part of the IP/port definition. If this parameter is not provided when creating a new monitor, then the default value will be '*'.,If this value is an IP address, and the C(type) is C(tcp) (the default), then a C(port) number must be specified. | |
partition: ${8:Common} # not required. Device partition to manage resources on. | |
server_port: ${9:443} # not required. The BIG-IP server port. You can omit this option if the environment variable C(F5_SERVER_PORT) is set. | |
state: ${10|present,absent|} # not required. choices: present;absent. When C(present), ensures that the monitor exists.,When C(absent), ensures the monitor is removed. | |
time_until_up: ${11:undefined} # not required. Specifies the amount of time in seconds after the first successful response before a node will be marked up. A value of 0 will cause a node to be marked up immediately after a valid response is received from the node. If this parameter is not provided when creating a new monitor, then the default value will be 0. | |
timeout: ${12:undefined} # not required. The number of seconds in which the node or service must respond to the monitor request. If the target responds within the set time period, it is considered up. If the target does not respond within the set time period, it is considered down. You can change this number to any number you want, however, it should be 3 times the interval number of seconds plus 1 second. If this parameter is not provided when creating a new monitor, then the default value will be 16. | |
provider: ${13:null} # not required. A dict object containing connection details. | |
validate_certs: ${14:true} # not required. If C(no), SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable C(F5_VALIDATE_CERTS) is set. | |
port: ${15:undefined} # not required. Port address part of the IP/port definition. If this parameter is not provided when creating a new monitor, then the default value will be '*'. Note that if specifying an IP address, a value between 1 and 65535 must be specified | |
""" | |
'bigip_monitor_udp': | |
'prefix': "bigip_monitor_udp_snippet" | |
'description': "Manages F5 BIG-IP LTM udp monitors" | |
'body': """ | |
bigip_monitor_udp: | |
name: ${1:undefined} # required. Monitor name. | |
server: ${2:undefined} # required. The BIG-IP host. You can omit this option if the environment variable C(F5_SERVER) is set. | |
user: ${3:undefined} # required. The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable C(F5_USER) is set. | |
password: ${4:undefined} # required. The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable C(F5_PASSWORD) is set. | |
interval: ${5:undefined} # not required. The interval specifying how frequently the monitor instance of this template will run. If this parameter is not provided when creating a new monitor, then the default value will be 5. This value B(must) be less than the C(timeout) value. | |
parent: ${6:/Common/udp} # not required. The parent template of this monitor template. Once this value has been set, it cannot be changed. By default, this value is the C(udp) parent on the C(Common) partition. | |
receive: ${7:undefined} # not required. The receive string for the monitor call. | |
ip: ${8:undefined} # not required. IP address part of the IP/port definition. If this parameter is not provided when creating a new monitor, then the default value will be '*'. | |
partition: ${9:Common} # not required. Device partition to manage resources on. | |
send: ${10:undefined} # not required. The send string for the monitor call. When creating a new monitor, if this value is not provided, the default C(default send string) will be used. | |
server_port: ${11:443} # not required. The BIG-IP server port. You can omit this option if the environment variable C(F5_SERVER_PORT) is set. | |
state: ${12|present,absent|} # not required. choices: present;absent. When C(present), ensures that the monitor exists.,When C(absent), ensures the monitor is removed. | |
time_until_up: ${13:undefined} # not required. Specifies the amount of time in seconds after the first successful response before a node will be marked up. A value of 0 will cause a node to be marked up immediately after a valid response is received from the node. If this parameter is not provided when creating a new monitor, then the default value will be 0. | |
timeout: ${14:undefined} # not required. The number of seconds in which the node or service must respond to the monitor request. If the target responds within the set time period, it is considered up. If the target does not respond within the set time period, it is considered down. You can change this number to any number you want, however, it should be 3 times the interval number of seconds plus 1 second. If this parameter is not provided when creating a new monitor, then the default value will be 16. | |
provider: ${15:null} # not required. A dict object containing connection details. | |
validate_certs: ${16:true} # not required. If C(no), SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable C(F5_VALIDATE_CERTS) is set. | |
port: ${17:undefined} # not required. Port address part of the IP/port definition. If this parameter is not provided when creating a new monitor, then the default value will be '*'. Note that if specifying an IP address, a value between 1 and 65535 must be specified. | |
receive_disable: ${18:undefined} # not required. This setting works like C(receive), except that the system marks the node or pool member disabled when its response matches the C(receive_disable) string but not C(receive). To use this setting, you must specify both C(receive_disable) and C(receive). | |
""" | |
'bigip_node': | |
'prefix': "bigip_node_snippet" | |
'description': "Manages F5 BIG-IP LTM nodes" | |
'body': """ | |
bigip_node: | |
name: ${1:undefined} # required. Specifies the name of the node. | |
server: ${2:undefined} # required. The BIG-IP host. You can omit this option if the environment variable C(F5_SERVER) is set. | |
user: ${3:undefined} # required. The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable C(F5_USER) is set. | |
password: ${4:undefined} # required. The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable C(F5_PASSWORD) is set. | |
provider: ${5:null} # not required. A dict object containing connection details. | |
quorum: ${6:undefined} # not required. Monitor quorum value when C(monitor_type) is C(m_of_n). | |
partition: ${7:Common} # not required. Device partition to manage resources on. | |
fqdn: ${8:undefined} # not required. FQDN name of the node. This can be any name that is a valid RFC 1123 DNS name. Therefore, the only characters that can be used are \"A\" to \"Z\", \"a\" to \"z\", \"0\" to \"9\", the hyphen (\"-\") and the period (\".\").,FQDN names must include at lease one period; delineating the host from the domain. ex. C(host.domain).,FQDN names must end with a letter or a number.,When creating a new node, one of either C(address) or C(fqdn) must be provided. This parameter cannot be updated after it is set. | |
monitors: ${9:undefined} # not required. Specifies the health monitors that the system currently uses to monitor this node. | |
state: ${10|present,absent,enabled,disabled,offline|} # not required. choices: present;absent;enabled;disabled;offline. Specifies the current state of the node. C(enabled) (All traffic allowed), specifies that system sends traffic to this node regardless of the node's state. C(disabled) (Only persistent or active connections allowed), Specifies that the node can handle only persistent or active connections. C(offline) (Only active connections allowed), Specifies that the node can handle only active connections. In all cases except C(absent), the node will be created if it does not yet exist.,Be particularly careful about changing the status of a node whose FQDN cannot be resolved. These situations disable your ability to change their C(state) to C(disabled) or C(offline). They will remain in an *Unavailable - Enabled* state. | |
server_port: ${11:443} # not required. The BIG-IP server port. You can omit this option if the environment variable C(F5_SERVER_PORT) is set. | |
address: ${12:undefined} # not required. IP address of the node. This can be either IPv4 or IPv6. When creating a new node, one of either C(address) or C(fqdn) must be provided. This parameter cannot be updated after it is set. | |
validate_certs: ${13:true} # not required. If C(no), SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable C(F5_VALIDATE_CERTS) is set. | |
monitor_type: ${14|and_list,m_of_n,single|} # not required. choices: and_list;m_of_n;single. Monitor rule type when C(monitors) is specified. When creating a new pool, if this value is not specified, the default of 'and_list' will be used.,Both C(single) and C(and_list) are functionally identical since BIG-IP considers all monitors as \"a list\". BIG=IP either has a list of many, or it has a list of one. Where they differ is in the extra guards that C(single) provides; namely that it only allows a single monitor. | |
description: ${15:undefined} # not required. Specifies descriptive text that identifies the node. | |
""" | |
'bigip_partition': | |
'prefix': "bigip_partition_snippet" | |
'description': "Manage BIG-IP partitions" | |
'body': """ | |
bigip_partition: | |
server: ${1:undefined} # required. The BIG-IP host. You can omit this option if the environment variable C(F5_SERVER) is set. | |
user: ${2:undefined} # required. The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable C(F5_USER) is set. | |
password: ${3:undefined} # required. The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable C(F5_PASSWORD) is set. | |
name: ${4:undefined} # required. Name of the partition | |
description: ${5:undefined} # not required. The description to attach to the Partition. | |
state: ${6|present,absent|} # not required. choices: present;absent. Whether the partition should exist or not. | |
route_domain: ${7:undefined} # not required. The default Route Domain to assign to the Partition. If no route domain is specified, then the default route domain for the system (typically zero) will be used only when creating a new partition. | |
server_port: ${8:443} # not required. The BIG-IP server port. You can omit this option if the environment variable C(F5_SERVER_PORT) is set. | |
provider: ${9:null} # not required. A dict object containing connection details. | |
validate_certs: ${10:true} # not required. If C(no), SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable C(F5_VALIDATE_CERTS) is set. | |
""" | |
'bigip_policy': | |
'prefix': "bigip_policy_snippet" | |
'description': "Manage general policy configuration on a BIG-IP" | |
'body': """ | |
bigip_policy: | |
user: ${1:undefined} # required. The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable C(F5_USER) is set. | |
password: ${2:undefined} # required. The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable C(F5_PASSWORD) is set. | |
name: ${3:undefined} # required. The name of the policy to create. | |
server: ${4:undefined} # required. The BIG-IP host. You can omit this option if the environment variable C(F5_SERVER) is set. | |
description: ${5:undefined} # not required. The description to attach to the policy.,This parameter is only supported on versions of BIG-IP >= 12.1.0. On earlier versions it will simply be ignored. | |
rules: ${6:undefined} # not required. Specifies a list of rules that you want associated with this policy. The order of this list is the order they will be evaluated by BIG-IP. If the specified rules do not exist (for example when creating a new policy) then they will be created.,The C(conditions) for a default rule are C(all).,The C(actions) for a default rule are C(ignore).,The C(bigip_policy_rule) module can be used to create and edit existing and new rules. | |
partition: ${7:Common} # not required. Device partition to manage resources on. | |
strategy: ${8|first,all,best|} # not required. choices: first;all;best. Specifies the method to determine which actions get executed in the case where there are multiple rules that match. When creating new policies, the default is C(first).,This module does not allow you to specify the C(best) strategy to use. It will choose the system default (C(/Common/best-match)) for you instead. | |
state: ${9|present,absent,draft|} # not required. choices: present;absent;draft. When C(state) is C(present), ensures that the policy exists and is published. When C(state) is C(absent), ensures that the policy is removed, even if it is currently drafted.,When C(state) is C(draft), ensures that the policy exists and is drafted. When modifying rules, it is required that policies first be in a draft.,Drafting is only supported on versions of BIG-IP >= 12.1.0. On versions prior to that, specifying a C(state) of C(draft) will raise an error. | |
server_port: ${10:443} # not required. The BIG-IP server port. You can omit this option if the environment variable C(F5_SERVER_PORT) is set. | |
provider: ${11:null} # not required. A dict object containing connection details. | |
validate_certs: ${12:true} # not required. If C(no), SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable C(F5_VALIDATE_CERTS) is set. | |
""" | |
'bigip_policy_rule': | |
'prefix': "bigip_policy_rule_snippet" | |
'description': "Manage LTM policy rules on a BIG-IP" | |
'body': """ | |
bigip_policy_rule: | |
user: ${1:undefined} # required. The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable C(F5_USER) is set. | |
password: ${2:undefined} # required. The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable C(F5_PASSWORD) is set. | |
name: ${3:undefined} # required. The name of the rule. | |
server: ${4:undefined} # required. The BIG-IP host. You can omit this option if the environment variable C(F5_SERVER) is set. | |
policy: ${5:undefined} # required. The name of the policy that you want to associate this rule with. | |
description: ${6:undefined} # not required. Description of the policy rule. | |
actions: ${7:undefined} # not required. The actions that you want the policy rule to perform.,The available attributes vary by the action, however, each action requires that a C(type) be specified.,These conditions can be specified in any order. Despite them being a list, the BIG-IP does not treat their order as anything special.,Available C(type) values are C(forward). | |
validate_certs: ${8:true} # not required. If C(no), SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable C(F5_VALIDATE_CERTS) is set. | |
partition: ${9:Common} # not required. Device partition to manage resources on. | |
state: ${10|present,absent|} # not required. choices: present;absent. When C(present), ensures that the key is uploaded to the device. When C(absent), ensures that the key is removed from the device. If the key is currently in use, the module will not be able to remove the key. | |
server_port: ${11:443} # not required. The BIG-IP server port. You can omit this option if the environment variable C(F5_SERVER_PORT) is set. | |
provider: ${12:null} # not required. A dict object containing connection details. | |
conditions: ${13:undefined} # not required. A list of attributes that describe the condition.,See suboptions for details on how to construct each list entry.,The ordering of this list is important, the module will ensure the order is kept when modifying the task.,The suboption options listed below are not required for all condition types, read the description for more details.,These conditions can be specified in any order. Despite them being a list, the BIG-IP does not treat their order as anything special. | |
""" | |
'bigip_pool': | |
'prefix': "bigip_pool_snippet" | |
'description': "Manages F5 BIG-IP LTM pools" | |
'body': """ | |
bigip_pool: | |
password: ${1:undefined} # required. The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable C(F5_PASSWORD) is set. | |
server: ${2:undefined} # required. The BIG-IP host. You can omit this option if the environment variable C(F5_SERVER) is set. | |
user: ${3:undefined} # required. The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable C(F5_USER) is set. | |
name: ${4:undefined} # required. Pool name | |
monitors: ${5:undefined} # not required. Monitor template name list. If the partition is not provided as part of the monitor name, then the C(partition) option will be used instead. | |
lb_method: ${6|dynamic-ratio-member,dynamic-ratio-node,fastest-app-response,fastest-node,least-connections-member,least-connections-node,least-sessions,observed-member,observed-node,predictive-member,predictive-node,ratio-least-connections-member,ratio-least-connections-node,ratio-member,ratio-node,ratio-session,round-robin,weighted-least-connections-member,weighted-least-connections-nod|} # not required. choices: dynamic-ratio-member;dynamic-ratio-node;fastest-app-response;fastest-node;least-connections-member;least-connections-node;least-sessions;observed-member;observed-node;predictive-member;predictive-node;ratio-least-connections-member;ratio-least-connections-node;ratio-member;ratio-node;ratio-session;round-robin;weighted-least-connections-member;weighted-least-connections-nod. Load balancing method. When creating a new pool, if this value is not specified, the default of C(round-robin) will be used. | |
quorum: ${7:undefined} # not required. Monitor quorum value when C(monitor_type) is C(m_of_n).,Quorum must be a value of 1 or greater when C(monitor_type) is C(m_of_n). | |
description: ${8:undefined} # not required. Specifies descriptive text that identifies the pool. | |
partition: ${9:Common} # not required. Device partition to manage resources on. | |
slow_ramp_time: ${10:undefined} # not required. Sets the ramp-up time (in seconds) to gradually ramp up the load on newly added or freshly detected up pool members. | |
service_down_action: ${11|none,reset,drop,reselect|} # not required. choices: none;reset;drop;reselect. Sets the action to take when node goes down in pool. | |
reselect_tries: ${12:undefined} # not required. Sets the number of times the system tries to contact a pool member after a passive failure. | |
state: ${13|absent,present|} # not required. choices: absent;present. When C(present), guarantees that the pool exists with the provided attributes.,When C(absent), removes the pool from the system. | |
server_port: ${14:443} # not required. The BIG-IP server port. You can omit this option if the environment variable C(F5_SERVER_PORT) is set. | |
provider: ${15:null} # not required. A dict object containing connection details. | |
metadata: ${16:undefined} # not required. Arbitrary key/value pairs that you can attach to a pool. This is useful in situations where you might want to annotate a pool to me managed by Ansible.,Key names will be stored as strings; this includes names that are numbers.,Values for all of the keys will be stored as strings; this includes values that are numbers.,Data will be persisted, not ephemeral. | |
validate_certs: ${17:true} # not required. If C(no), SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable C(F5_VALIDATE_CERTS) is set. | |
monitor_type: ${18|and_list,m_of_n,single|} # not required. choices: and_list;m_of_n;single. Monitor rule type when C(monitors) is specified.,When creating a new pool, if this value is not specified, the default of 'and_list' will be used.,When C(single) ensures that all specified monitors are checked, but additionally includes checks to make sure you only specified a single monitor.,When C(and_list) ensures that B(all) monitors are checked.,When C(m_of_n) ensures that C(quorum) of C(monitors) are checked. C(m_of_n) B(requires) that a C(quorum) of 1 or greater be set either in the playbook, or already existing on the device.,Both C(single) and C(and_list) are functionally identical since BIG-IP considers all monitors as \"a list\". | |
""" | |
'bigip_pool_member': | |
'prefix': "bigip_pool_member_snippet" | |
'description': "Manages F5 BIG-IP LTM pool members" | |
'body': """ | |
bigip_pool_member: | |
state: ${1|present,absent|} # required. choices: present;absent. Pool member state. | |
server: ${2:undefined} # required. The BIG-IP host. You can omit this option if the environment variable C(F5_SERVER) is set. | |
host: ${3:undefined} # required. Pool member IP. | |
user: ${4:undefined} # required. The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable C(F5_USER) is set. | |
password: ${5:undefined} # required. The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable C(F5_PASSWORD) is set. | |
port: ${6:undefined} # required. Pool member port. | |
pool: ${7:undefined} # required. Pool name. This pool must exist. | |
session_state: ${8|enabled,disabled|} # not required. choices: enabled;disabled. Set new session availability status for pool member. | |
ratio: ${9:undefined} # not required. Pool member ratio weight. Valid values range from 1 through 100. New pool members -- unless overridden with this value -- default to 1. | |
description: ${10:undefined} # not required. Pool member description. | |
monitor_state: ${11|enabled,disabled|} # not required. choices: enabled;disabled. Set monitor availability status for pool member. | |
partition: ${12:Common} # not required. Partition | |
connection_limit: ${13:undefined} # not required. Pool member connection limit. Setting this to 0 disables the limit. | |
preserve_node: ${14|true,false|} # not required. choices: true;false. When state is absent and the pool member is no longer referenced in other pools, the default behavior removes the unused node o bject. Setting this to 'yes' disables this behavior. | |
server_port: ${15:443} # not required. The BIG-IP server port. You can omit this option if the environment variable C(F5_SERVER_PORT) is set. | |
provider: ${16:null} # not required. A dict object containing connection details. | |
rate_limit: ${17:undefined} # not required. Pool member rate limit (connections-per-second). Setting this to 0 disables the limit. | |
priority_group: ${18:undefined} # not required. Specifies a number representing the priority group for the pool member.,When adding a new member, the default is 0, meaning that the member has no priority.,To specify a priority, you must activate priority group usage when you create a new pool or when adding or removing pool members. When activated, the system load balances traffic according to the priority group number assigned to the pool member.,The higher the number, the higher the priority, so a member with a priority of 3 has higher priority than a member with a priority of 1. | |
validate_certs: ${19:true} # not required. If C(no), SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable C(F5_VALIDATE_CERTS) is set. | |
""" | |
'bigip_profile_client_ssl': | |
'prefix': "bigip_profile_client_ssl_snippet" | |
'description': "Manages client SSL profiles on a BIG-IP" | |
'body': """ | |
bigip_profile_client_ssl: | |
user: ${1:undefined} # required. The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable C(F5_USER) is set. | |
password: ${2:undefined} # required. The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable C(F5_PASSWORD) is set. | |
name: ${3:undefined} # required. Specifies the name of the profile. | |
server: ${4:undefined} # required. The BIG-IP host. You can omit this option if the environment variable C(F5_SERVER) is set. | |
parent: ${5:/Common/clientssl} # not required. The parent template of this monitor template. Once this value has been set, it cannot be changed. By default, this value is the C(clientssl) parent on the C(Common) partition. | |
cert_key_chain: ${6:undefined} # not required. One or more certificates and keys to associate with the SSL profile. This option is always a list. The keys in the list dictate the details of the client/key/chain combination. Note that BIG-IPs can only have one of each type of each certificate/key type. This means that you can only have one RSA, one DSA, and one ECDSA per profile. If you attempt to assign two RSA, DSA, or ECDSA certificate/key combo, the device will reject this.,This list is a complex list that specifies a number of keys. There are several supported keys. | |
ciphers: ${7:undefined} # not required. Specifies the list of ciphers that the system supports. When creating a new profile, the default cipher list is C(DEFAULT). | |
partition: ${8:Common} # not required. Device partition to manage resources on. | |
state: ${9|present,absent|} # not required. choices: present;absent. When C(present), ensures that the profile exists.,When C(absent), ensures the profile is removed. | |
server_port: ${10:443} # not required. The BIG-IP server port. You can omit this option if the environment variable C(F5_SERVER_PORT) is set. | |
provider: ${11:null} # not required. A dict object containing connection details. | |
validate_certs: ${12:true} # not required. If C(no), SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable C(F5_VALIDATE_CERTS) is set. | |
""" | |
'bigip_provision': | |
'prefix': "bigip_provision_snippet" | |
'description': "Manage BIG-IP module provisioning" | |
'body': """ | |
bigip_provision: | |
name: ${1|am,afm,apm,asm,avr,fps,gtm,ilx,lc,ltm,pem,sam,swg,vcmp|} # required. choices: am;afm;apm;asm;avr;fps;gtm;ilx;lc;ltm;pem;sam;swg;vcmp. The module to provision in BIG-IP. | |
server: ${2:undefined} # required. The BIG-IP host. You can omit this option if the environment variable C(F5_SERVER) is set. | |
user: ${3:undefined} # required. The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable C(F5_USER) is set. | |
password: ${4:undefined} # required. The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable C(F5_PASSWORD) is set. | |
level: ${5|dedicated,nominal,minimum|} # not required. choices: dedicated;nominal;minimum. Sets the provisioning level for the requested modules. Changing the level for one module may require modifying the level of another module. For example, changing one module to C(dedicated) requires setting all others to C(none). Setting the level of a module to C(none) means that the module is not activated. | |
state: ${6|present,absent|} # not required. choices: present;absent. The state of the provisioned module on the system. When C(present), guarantees that the specified module is provisioned at the requested level provided that there are sufficient resources on the device (such as physical RAM) to support the provisioned module. When C(absent), de-provision the module. | |
server_port: ${7:443} # not required. The BIG-IP server port. You can omit this option if the environment variable C(F5_SERVER_PORT) is set. | |
provider: ${8:null} # not required. A dict object containing connection details. | |
validate_certs: ${9:true} # not required. If C(no), SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable C(F5_VALIDATE_CERTS) is set. | |
""" | |
'bigip_qkview': | |
'prefix': "bigip_qkview_snippet" | |
'description': "Manage qkviews on the device" | |
'body': """ | |
bigip_qkview: | |
dest: ${1:undefined} # required. Destination on your local filesystem when you want to save the qkview. | |
server: ${2:undefined} # required. The BIG-IP host. You can omit this option if the environment variable C(F5_SERVER) is set. | |
user: ${3:undefined} # required. The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable C(F5_USER) is set. | |
password: ${4:undefined} # required. The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable C(F5_PASSWORD) is set. | |
max_file_size: ${5:0} # not required. Max file size, in bytes, of the qkview to create. By default, no max file size is specified. | |
force: ${6:true} # not required. If C(no), the file will only be transferred if the destination does not exist. | |
server_port: ${7:443} # not required. The BIG-IP server port. You can omit this option if the environment variable C(F5_SERVER_PORT) is set. | |
asm_request_log: ${8:false} # not required. When C(True), includes the ASM request log data. When C(False), excludes the ASM request log data. | |
filename: ${9:localhost.localdomain.qkview} # not required. Name of the qkview to create on the remote BIG-IP. | |
exclude_core: ${10:false} # not required. Exclude core files from the qkview. | |
complete_information: ${11:true} # not required. Include complete information in the qkview. | |
provider: ${12:null} # not required. A dict object containing connection details. | |
exclude: ${13|all,audit,secure,bash_history|} # not required. choices: all;audit;secure;bash_history. Exclude various file from the qkview. | |
validate_certs: ${14:true} # not required. If C(no), SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable C(F5_VALIDATE_CERTS) is set. | |
""" | |
'bigip_remote_syslog': | |
'prefix': "bigip_remote_syslog_snippet" | |
'description': "Manipulate remote syslog settings on a BIG-IP" | |
'body': """ | |
bigip_remote_syslog: | |
server: ${1:undefined} # required. The BIG-IP host. You can omit this option if the environment variable C(F5_SERVER) is set. | |
user: ${2:undefined} # required. The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable C(F5_USER) is set. | |
password: ${3:undefined} # required. The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable C(F5_PASSWORD) is set. | |
remote_host: ${4:undefined} # required. Specifies the IP address, or hostname, for the remote system to which the system sends log messages. | |
remote_port: ${5:undefined} # not required. Specifies the port that the system uses to send messages to the remote logging server. When creating a remote syslog, if this parameter is not specified, the default value C(514) is used. | |
validate_certs: ${6:true} # not required. If C(no), SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable C(F5_VALIDATE_CERTS) is set. | |
local_ip: ${7:undefined} # not required. Specifies the local IP address of the system that is logging. To provide no local IP, specify the value C(none). When creating a remote syslog, if this parameter is not specified, the default value C(none) is used. | |
state: ${8|absent,present|} # not required. choices: absent;present. When C(present), guarantees that the remote syslog exists with the provided attributes.,When C(absent), removes the remote syslog from the system. | |
server_port: ${9:443} # not required. The BIG-IP server port. You can omit this option if the environment variable C(F5_SERVER_PORT) is set. | |
provider: ${10:null} # not required. A dict object containing connection details. | |
""" | |
'bigip_routedomain': | |
'prefix': "bigip_routedomain_snippet" | |
'description': "Manage route domains on a BIG-IP" | |
'body': """ | |
bigip_routedomain: | |
password: ${1:undefined} # required. The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable C(F5_PASSWORD) is set. | |
user: ${2:undefined} # required. The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable C(F5_USER) is set. | |
server: ${3:undefined} # required. The BIG-IP host. You can omit this option if the environment variable C(F5_SERVER) is set. | |
flow_eviction_policy: ${4:undefined} # not required. The eviction policy to use with this route domain. Apply an eviction policy to provide customized responses to flow overflows and slow flows on the route domain. | |
service_policy: ${5:undefined} # not required. Service policy to associate with the route domain. | |
description: ${6:undefined} # not required. Specifies descriptive text that identifies the route domain. | |
parent: ${7:undefined} # not required. Specifies the route domain the system searches when it cannot find a route in the configured domain. | |
partition: ${8:Common} # not required. Partition to create the route domain on. Partitions cannot be updated once they are created. | |
connection_limit: ${9:undefined} # not required. The maximum number of concurrent connections allowed for the route domain. Setting this to C(0) turns off connection limits. | |
provider: ${10:null} # not required. A dict object containing connection details. | |
strict: ${11|enabled,disabled|} # not required. choices: enabled;disabled. Specifies whether the system enforces cross-routing restrictions or not. | |
state: ${12|present,absent|} # not required. choices: present;absent. Whether the route domain should exist or not. | |
routing_protocol: ${13|BFD,BGP,IS-IS,OSPFv2,OSPFv3,PIM,RIP,RIPng|} # not required. choices: BFD;BGP;IS-IS;OSPFv2;OSPFv3;PIM;RIP;RIPng. Dynamic routing protocols for the system to use in the route domain. | |
server_port: ${14:443} # not required. The BIG-IP server port. You can omit this option if the environment variable C(F5_SERVER_PORT) is set. | |
bwc_policy: ${15:undefined} # not required. The bandwidth controller for the route domain. | |
vlans: ${16:undefined} # not required. VLANs for the system to use in the route domain | |
validate_certs: ${17:true} # not required. If C(no), SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable C(F5_VALIDATE_CERTS) is set. | |
id: ${18:undefined} # not required. The unique identifying integer representing the route domain.,This field is required when creating a new route domain.,In version 2.5, this value is no longer used to reference a route domain when making modifications to it (for instance during update and delete operations). Instead, the C(name) parameter is used. In version 2.6, the C(name) value will become a required parameter. | |
name: ${19:undefined} # not required. The name of the route domain.,When creating a new route domain, if this value is not specified, then the value of C(id) will be used for it. | |
""" | |
'bigip_security_address_list': | |
'prefix': "bigip_security_address_list_snippet" | |
'description': "Manage address lists on BIG-IP AFM" | |
'body': """ | |
bigip_security_address_list: | |
name: ${1:undefined} # required. Specifies the name of the address list. | |
server: ${2:undefined} # required. The BIG-IP host. You can omit this option if the environment variable C(F5_SERVER) is set. | |
user: ${3:undefined} # required. The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable C(F5_USER) is set. | |
password: ${4:undefined} # required. The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable C(F5_PASSWORD) is set. | |
geo_locations: ${5:undefined} # not required. List of geolocations specified by their C(country) and C(region). | |
addresses: ${6:undefined} # not required. Individual addresses that you want to add to the list. These addresses differ from ranges, and lists of lists such as what can be used in C(address_ranges) and C(address_lists) respectively. | |
address_ranges: ${7:undefined} # not required. A list of address ranges where the range starts with a port number, is followed by a dash (-) and then a second number.,If the first address is greater than the second number, the numbers will be reversed so-as to be properly formatted. ie, C(2.2.2.2-1.1.1). would become C(1.1.1.1-2.2.2.2). | |
address_lists: ${8:undefined} # not required. Simple list of existing address lists to add to this list. Address lists can be specified in either their fully qualified name (/Common/foo) or their short name (foo). If a short name is used, the C(partition) argument will automatically be prepended to the short name. | |
fqdns: ${9:undefined} # not required. A list of fully qualified domain names (FQDNs).,An FQDN has at least one decimal point in it, separating the host from the domain.,To add FQDNs to a list requires that a global FQDN resolver be configured. At the moment, this must either be done via C(bigip_command), or, in the GUI of BIG-IP. If using C(bigip_command), this can be done with C(tmsh modify security firewall global-fqdn-policy FOO) where C(FOO) is a DNS resolver configured at C(tmsh create net dns-resolver FOO). | |
partition: ${10:Common} # not required. Device partition to manage resources on. | |
state: ${11|present,absent|} # not required. choices: present;absent. When C(present), ensures that the address list and entries exists.,When C(absent), ensures the address list is removed. | |
server_port: ${12:443} # not required. The BIG-IP server port. You can omit this option if the environment variable C(F5_SERVER_PORT) is set. | |
provider: ${13:null} # not required. A dict object containing connection details. | |
validate_certs: ${14:true} # not required. If C(no), SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable C(F5_VALIDATE_CERTS) is set. | |
description: ${15:undefined} # not required. Description of the address list | |
""" | |
'bigip_security_port_list': | |
'prefix': "bigip_security_port_list_snippet" | |
'description': "Manage port lists on BIG-IP AFM" | |
'body': """ | |
bigip_security_port_list: | |
user: ${1:undefined} # required. The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable C(F5_USER) is set. | |
password: ${2:undefined} # required. The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable C(F5_PASSWORD) is set. | |
name: ${3:undefined} # required. Specifies the name of the port list. | |
server: ${4:undefined} # required. The BIG-IP host. You can omit this option if the environment variable C(F5_SERVER) is set. | |
description: ${5:undefined} # not required. Description of the port list | |
port_ranges: ${6:undefined} # not required. A list of port ranges where the range starts with a port number, is followed by a dash (-) and then a second number.,If the first number is greater than the second number, the numbers will be reversed so-as to be properly formatted. ie, 90-78 would become 78-90. | |
partition: ${7:Common} # not required. Device partition to manage resources on. | |
port_lists: ${8:undefined} # not required. Simple list of existing port lists to add to this list. Port lists can be specified in either their fully qualified name (/Common/foo) or their short name (foo). If a short name is used, the C(partition) argument will automatically be prepended to the short name. | |
state: ${9|present,absent|} # not required. choices: present;absent. When C(present), ensures that the address list and entries exists.,When C(absent), ensures the address list is removed. | |
server_port: ${10:443} # not required. The BIG-IP server port. You can omit this option if the environment variable C(F5_SERVER_PORT) is set. | |
provider: ${11:null} # not required. A dict object containing connection details. | |
validate_certs: ${12:true} # not required. If C(no), SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable C(F5_VALIDATE_CERTS) is set. | |
ports: ${13:undefined} # not required. Simple list of port values to add to the list | |
""" | |
'bigip_selfip': | |
'prefix': "bigip_selfip_snippet" | |
'description': "Manage Self-IPs on a BIG-IP system" | |
'body': """ | |
bigip_selfip: | |
name: ${1:Value of C(address)} # required. The self IP to create. | |
server: ${2:undefined} # required. The BIG-IP host. You can omit this option if the environment variable C(F5_SERVER) is set. | |
user: ${3:undefined} # required. The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable C(F5_USER) is set. | |
password: ${4:undefined} # required. The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable C(F5_PASSWORD) is set. | |
vlan: ${5:undefined} # not required. The VLAN that the new self IPs will be on. When creating a new Self IP, this value is required. | |
partition: ${6:Common} # not required. Device partition to manage resources on. You can set different partitions for Self IPs, but the address used may not match any other address used by a Self IP. In that sense, Self IPs are not isolated by partitions as other resources on a BIG-IP are. | |
netmask: ${7:undefined} # not required. The netmask for the self IP. When creating a new Self IP, this value is required. | |
allow_service: ${8:undefined} # not required. Configure port lockdown for the Self IP. By default, the Self IP has a \"default deny\" policy. This can be changed to allow TCP and UDP ports as well as specific protocols. This list should contain C(protocol):C(port) values. | |
state: ${9|absent,present|} # not required. choices: absent;present. When C(present), guarantees that the Self-IP exists with the provided attributes.,When C(absent), removes the Self-IP from the system. | |
route_domain: ${10:undefined} # not required. The route domain id of the system. When creating a new Self IP, if this value is not specified, a default value of C(0) will be used.,This value cannot be changed after it is set. | |
server_port: ${11:443} # not required. The BIG-IP server port. You can omit this option if the environment variable C(F5_SERVER_PORT) is set. | |
address: ${12:undefined} # not required. The IP addresses for the new self IP. This value is ignored upon update as addresses themselves cannot be changed after they are created.,This value is required when creating new self IPs. | |
traffic_group: ${13:undefined} # not required. The traffic group for the Self IP addresses in an active-active, redundant load balancer configuration. When creating a new Self IP, if this value is not specified, the default of C(/Common/traffic-group-local-only) will be used. | |
validate_certs: ${14:true} # not required. If C(no), SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable C(F5_VALIDATE_CERTS) is set. | |
provider: ${15:null} # not required. A dict object containing connection details. | |
""" | |
'bigip_snat_pool': | |
'prefix': "bigip_snat_pool_snippet" | |
'description': "Manage SNAT pools on a BIG-IP" | |
'body': """ | |
bigip_snat_pool: | |
name: ${1:undefined} # required. The name of the SNAT pool. | |
server: ${2:undefined} # required. The BIG-IP host. You can omit this option if the environment variable C(F5_SERVER) is set. | |
user: ${3:undefined} # required. The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable C(F5_USER) is set. | |
password: ${4:undefined} # required. The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable C(F5_PASSWORD) is set. | |
partition: ${5:Common} # not required. Device partition to manage resources on. | |
members: ${6:undefined} # not required. List of members to put in the SNAT pool. When a C(state) of present is provided, this parameter is required. Otherwise, it is optional. | |
state: ${7|present,absent|} # not required. choices: present;absent. Whether the SNAT pool should exist or not. | |
server_port: ${8:443} # not required. The BIG-IP server port. You can omit this option if the environment variable C(F5_SERVER_PORT) is set. | |
provider: ${9:null} # not required. A dict object containing connection details. | |
validate_certs: ${10:true} # not required. If C(no), SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable C(F5_VALIDATE_CERTS) is set. | |
""" | |
'bigip_snmp': | |
'prefix': "bigip_snmp_snippet" | |
'description': "Manipulate general SNMP settings on a BIG-IP" | |
'body': """ | |
bigip_snmp: | |
server: ${1:undefined} # required. The BIG-IP host. You can omit this option if the environment variable C(F5_SERVER) is set. | |
user: ${2:undefined} # required. The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable C(F5_USER) is set. | |
password: ${3:undefined} # required. The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable C(F5_PASSWORD) is set. | |
agent_status_traps: ${4|enabled,disabled|} # not required. choices: enabled;disabled. When C(enabled), ensures that the system sends a trap whenever the SNMP agent starts running or stops running. This is usually enabled by default on a BIG-IP. | |
agent_authentication_traps: ${5|enabled,disabled|} # not required. choices: enabled;disabled. When C(enabled), ensures that the system sends authentication warning traps to the trap destinations. This is usually disabled by default on a BIG-IP. | |
device_warning_traps: ${6|enabled,disabled|} # not required. choices: enabled;disabled. When C(enabled), ensures that the system sends device warning traps to the trap destinations. This is usually enabled by default on a BIG-IP. | |
contact: ${7:undefined} # not required. Specifies the name of the person who administers the SNMP service for this system. | |
server_port: ${8:443} # not required. The BIG-IP server port. You can omit this option if the environment variable C(F5_SERVER_PORT) is set. | |
provider: ${9:null} # not required. A dict object containing connection details. | |
validate_certs: ${10:true} # not required. If C(no), SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable C(F5_VALIDATE_CERTS) is set. | |
location: ${11:undefined} # not required. Specifies the description of this system's physical location. | |
""" | |
'bigip_snmp_trap': | |
'prefix': "bigip_snmp_trap_snippet" | |
'description': "Manipulate SNMP trap information on a BIG-IP" | |
'body': """ | |
bigip_snmp_trap: | |
server: ${1:undefined} # required. The BIG-IP host. You can omit this option if the environment variable C(F5_SERVER) is set. | |
user: ${2:undefined} # required. The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable C(F5_USER) is set. | |
password: ${3:undefined} # required. The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable C(F5_PASSWORD) is set. | |
name: ${4:undefined} # required. Name of the SNMP configuration endpoint. | |
snmp_version: ${5|1,2c|} # not required. choices: 1;2c. Specifies to which Simple Network Management Protocol (SNMP) version the trap destination applies. | |
destination: ${6:undefined} # not required. Specifies the address for the trap destination. This can be either an IP address or a hostname. | |
network: ${7|other,management,default|} # not required. choices: other;management;default. Specifies the name of the trap network. This option is not supported in versions of BIG-IP < 12.1.0. If used on versions < 12.1.0, it will simply be ignored. | |
partition: ${8:Common} # not required. Device partition to manage resources on. | |
community: ${9:undefined} # not required. Specifies the community name for the trap destination. | |
state: ${10|present,absent|} # not required. choices: present;absent. When C(present), ensures that the cloud connector exists. When C(absent), ensures that the cloud connector does not exist. | |
server_port: ${11:443} # not required. The BIG-IP server port. You can omit this option if the environment variable C(F5_SERVER_PORT) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment