diff options
author | Zim Kalinowski <zikalino@microsoft.com> | 2019-02-21 23:07:10 +0800 |
---|---|---|
committer | Alicia Cozine <879121+acozine@users.noreply.github.com> | 2019-02-21 09:07:10 -0600 |
commit | 053081a8a00aed9cdb3c1b551eb25b870ce5a626 (patch) | |
tree | dbb1a1021be93bc7f1c9a53dd4606692ea48ff3e /lib/ansible/modules/cloud | |
parent | a7221336409aaf04cab6d4a2c1ef6885b9d77f86 (diff) | |
download | ansible-053081a8a00aed9cdb3c1b551eb25b870ce5a626.tar.gz |
use the same C() everywhere for absent / present options (#52610)
* use the same C() everywhere for absent / present options
* Update lib/ansible/modules/cloud/azure/azure_rm_cdnendpoint.py
* Update lib/ansible/modules/cloud/azure/azure_rm_resourcegroup.py
* Update lib/ansible/modules/cloud/azure/azure_rm_cdnendpoint.py
* Update lib/ansible/modules/cloud/azure/azure_rm_cdnendpoint.py
Co-Authored-By: zikalino <zikalino@microsoft.com>
Diffstat (limited to 'lib/ansible/modules/cloud')
42 files changed, 70 insertions, 70 deletions
diff --git a/lib/ansible/modules/cloud/azure/azure_rm_acs.py b/lib/ansible/modules/cloud/azure/azure_rm_acs.py index 70478ce7ec..e11ec18ac9 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_acs.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_acs.py @@ -31,7 +31,7 @@ options: required: true state: description: - - Assert the state of the ACS. Use 'present' to create or update an ACS and 'absent' to delete it. + - Assert the state of the ACS. Use C(present) to create or update an ACS and C(absent) to delete it. default: present choices: - absent diff --git a/lib/ansible/modules/cloud/azure/azure_rm_appgateway.py b/lib/ansible/modules/cloud/azure/azure_rm_appgateway.py index 1d82556449..44e55e0237 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_appgateway.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_appgateway.py @@ -357,8 +357,8 @@ options: - Redirect configuration resource of the application gateway state: description: - - Assert the state of the Public IP. Use 'present' to create or update a and - 'absent' to delete. + - Assert the state of the Public IP. Use C(present) to create or update a and + C(absent) to delete. default: present choices: - absent diff --git a/lib/ansible/modules/cloud/azure/azure_rm_applicationsecuritygroup.py b/lib/ansible/modules/cloud/azure/azure_rm_applicationsecuritygroup.py index bcb2a3dc09..a516d5e967 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_applicationsecuritygroup.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_applicationsecuritygroup.py @@ -36,7 +36,7 @@ options: state: description: - Assert the state of the Application Security Group. - - Use 'present' to create or update an Application Security Group and 'absent' to delete it. + - Use C(present) to create or update an Application Security Group and C(absent) to delete it. default: present choices: - absent diff --git a/lib/ansible/modules/cloud/azure/azure_rm_appserviceplan.py b/lib/ansible/modules/cloud/azure/azure_rm_appserviceplan.py index 768233e92c..21e9b790c1 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_appserviceplan.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_appserviceplan.py @@ -55,7 +55,7 @@ options: state: description: - Assert the state of the app service plan. - - Use 'present' to create or update an app service plan and 'absent' to delete it. + - Use C(present) to create or update an app service plan and C(absent) to delete it. default: present choices: - absent diff --git a/lib/ansible/modules/cloud/azure/azure_rm_autoscale.py b/lib/ansible/modules/cloud/azure/azure_rm_autoscale.py index fa30062937..dd07353b25 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_autoscale.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_autoscale.py @@ -179,7 +179,7 @@ options: description: A value indicating whether to send email to subscription co-administrators. state: default: present - description: Assert the state of the virtual network. Use 'present' to create or update and 'absent' to delete. + description: Assert the state of the virtual network. Use C(present) to create or update and C(absent) to delete. choices: - present - absent diff --git a/lib/ansible/modules/cloud/azure/azure_rm_availabilityset.py b/lib/ansible/modules/cloud/azure/azure_rm_availabilityset.py index 0fe22eb569..3fbfb4c6e6 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_availabilityset.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_availabilityset.py @@ -35,8 +35,8 @@ options: required: true state: description: - - Assert the state of the availability set. Use 'present' to create or update a availability set and - 'absent' to delete a availability set. + - Assert the state of the availability set. Use C(present) to create or update a availability set and + C(absent) to delete a availability set. default: present choices: - absent diff --git a/lib/ansible/modules/cloud/azure/azure_rm_cdnendpoint.py b/lib/ansible/modules/cloud/azure/azure_rm_cdnendpoint.py index aaa3311e13..e51612036e 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_cdnendpoint.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_cdnendpoint.py @@ -33,16 +33,16 @@ options: - Valid azure location. Defaults to location of the resource group. started: description: - - Use with I(state) 'present' to start the endpoint. Set to false to stop the endpoint. Set to true to start the endpoint. + - Use with I(state) C(present) to start the endpoint. Set to C(false) to stop the endpoint. Set to C(true) to start the endpoint. type: bool purge: description: - - Use with I(state) 'present' to purge the endpoint. Set to true to have the endpoint be purged. + - Use with I(state) C(present) to purge the endpoint. Set to C(true) to have the endpoint be purged. type: bool default: false purge_content_paths: description: - - Use with I(state) 'present' and I(purge) 'true' to specify content paths to be purged. + - Use with I(state) C(present) and I(purge) C(true) to specify content paths to be purged. type: list default: ['/'] profile_name: diff --git a/lib/ansible/modules/cloud/azure/azure_rm_containerinstance.py b/lib/ansible/modules/cloud/azure/azure_rm_containerinstance.py index 14ff3552a5..f958230a0b 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_containerinstance.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_containerinstance.py @@ -39,7 +39,7 @@ options: default: linux state: description: - - Assert the state of the container instance. Use 'present' to create or update an container instance and 'absent' to delete it. + - Assert the state of the container instance. Use C(present) to create or update an container instance and C(absent) to delete it. default: present choices: - absent diff --git a/lib/ansible/modules/cloud/azure/azure_rm_containerregistry.py b/lib/ansible/modules/cloud/azure/azure_rm_containerregistry.py index 13fbf15c77..30719e4aad 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_containerregistry.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_containerregistry.py @@ -30,7 +30,7 @@ options: required: true state: description: - - Assert the state of the container registry. Use 'present' to create or update an container registry and 'absent' to delete it. + - Assert the state of the container registry. Use C(present) to create or update an container registry and C(absent) to delete it. default: present choices: - absent diff --git a/lib/ansible/modules/cloud/azure/azure_rm_cosmosdbaccount.py b/lib/ansible/modules/cloud/azure/azure_rm_cosmosdbaccount.py index 3acf2db8fb..f0c7c6e34a 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_cosmosdbaccount.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_cosmosdbaccount.py @@ -129,7 +129,7 @@ options: state: description: - Assert the state of the Database Account. - - Use 'present' to create or update an Database Account and 'absent' to delete it. + - Use C(present) to create or update an Database Account and C(absent) to delete it. default: present choices: - absent diff --git a/lib/ansible/modules/cloud/azure/azure_rm_devtestlabvirtualnetwork.py b/lib/ansible/modules/cloud/azure/azure_rm_devtestlabvirtualnetwork.py index 88f6222a96..1003ad8ed1 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_devtestlabvirtualnetwork.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_devtestlabvirtualnetwork.py @@ -43,7 +43,7 @@ options: state: description: - Assert the state of the Virtual Network. - - Use 'present' to create or update an Virtual Network and 'absent' to delete it. + - Use C(present) to create or update an Virtual Network and C(absent) to delete it. default: present choices: - absent diff --git a/lib/ansible/modules/cloud/azure/azure_rm_dnszone.py b/lib/ansible/modules/cloud/azure/azure_rm_dnszone.py index e3d505b1ff..4f401e29b1 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_dnszone.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_dnszone.py @@ -47,8 +47,8 @@ options: required: true state: description: - - Assert the state of the zone. Use 'present' to create or update and - 'absent' to delete. + - Assert the state of the zone. Use C(present) to create or update and + C(absent) to delete. default: present choices: - absent diff --git a/lib/ansible/modules/cloud/azure/azure_rm_functionapp.py b/lib/ansible/modules/cloud/azure/azure_rm_functionapp.py index d23086615f..e1734414a2 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_functionapp.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_functionapp.py @@ -46,8 +46,8 @@ options: - Dictionary containing application settings state: description: - - Assert the state of the Function App. Use 'present' to create or update a Function App and - 'absent' to delete. + - Assert the state of the Function App. Use C(present) to create or update a Function App and + C(absent) to delete. default: present choices: - absent diff --git a/lib/ansible/modules/cloud/azure/azure_rm_keyvault.py b/lib/ansible/modules/cloud/azure/azure_rm_keyvault.py index efd5ec61c8..a0e597b8c1 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_keyvault.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_keyvault.py @@ -143,7 +143,7 @@ options: type: bool state: description: - - Assert the state of the KeyVault. Use 'present' to create or update an KeyVault and 'absent' to delete it. + - Assert the state of the KeyVault. Use C(present) to create or update an KeyVault and C(absent) to delete it. default: present choices: - absent diff --git a/lib/ansible/modules/cloud/azure/azure_rm_keyvaultkey.py b/lib/ansible/modules/cloud/azure/azure_rm_keyvaultkey.py index d762e10ce2..21e78fd484 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_keyvaultkey.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_keyvaultkey.py @@ -39,8 +39,8 @@ options: - PEM password. state: description: - - Assert the state of the key. Use 'present' to create a key and - 'absent' to delete a key. + - Assert the state of the key. Use C(present) to create a key and + C(absent) to delete a key. default: present choices: - absent diff --git a/lib/ansible/modules/cloud/azure/azure_rm_keyvaultsecret.py b/lib/ansible/modules/cloud/azure/azure_rm_keyvaultsecret.py index 2830fee824..0e43896e7f 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_keyvaultsecret.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_keyvaultsecret.py @@ -33,8 +33,8 @@ options: - Secret to be secured by keyvault. state: description: - - Assert the state of the subnet. Use 'present' to create or update a secret and - 'absent' to delete a secret . + - Assert the state of the subnet. Use C(present) to create or update a secret and + C(absent) to delete a secret . default: present choices: - absent diff --git a/lib/ansible/modules/cloud/azure/azure_rm_managed_disk.py b/lib/ansible/modules/cloud/azure/azure_rm_managed_disk.py index d522875d46..f4131efedb 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_managed_disk.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_managed_disk.py @@ -35,7 +35,7 @@ options: required: true state: description: - - Assert the state of the managed disk. Use C(present) to create or update a managed disk and 'absent' to delete a managed disk. + - Assert the state of the managed disk. Use C(present) to create or update a managed disk and C(absent) to delete a managed disk. default: present choices: - absent diff --git a/lib/ansible/modules/cloud/azure/azure_rm_mysqldatabase.py b/lib/ansible/modules/cloud/azure/azure_rm_mysqldatabase.py index 7491d64bf0..bf2a654f4a 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_mysqldatabase.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_mysqldatabase.py @@ -54,7 +54,7 @@ options: default: 'no' state: description: - - Assert the state of the MySQL Database. Use 'present' to create or update a database and 'absent' to delete it. + - Assert the state of the MySQL Database. Use C(present) to create or update a database and C(absent) to delete it. default: present choices: - absent diff --git a/lib/ansible/modules/cloud/azure/azure_rm_mysqlfirewallrule.py b/lib/ansible/modules/cloud/azure/azure_rm_mysqlfirewallrule.py index 677b223f16..8c48e5783f 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_mysqlfirewallrule.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_mysqlfirewallrule.py @@ -42,7 +42,7 @@ options: - The end IP address of the MySQL firewall rule. Must be IPv4 format. state: description: - - Assert the state of the MySQL firewall rule. Use 'present' to create or update a rule and 'absent' to ensure it is not present. + - Assert the state of the MySQL firewall rule. Use C(present) to create or update a rule and C(absent) to ensure it is not present. default: present choices: - absent diff --git a/lib/ansible/modules/cloud/azure/azure_rm_mysqlserver.py b/lib/ansible/modules/cloud/azure/azure_rm_mysqlserver.py index 3eb5ed63a2..559f9dc879 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_mysqlserver.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_mysqlserver.py @@ -74,7 +74,7 @@ options: default: Default state: description: - - Assert the state of the MySQL Server. Use 'present' to create or update a server and 'absent' to delete it. + - Assert the state of the MySQL Server. Use C(present) to create or update a server and C(absent) to delete it. default: present choices: - absent diff --git a/lib/ansible/modules/cloud/azure/azure_rm_networkinterface.py b/lib/ansible/modules/cloud/azure/azure_rm_networkinterface.py index 6ed75795a4..d79710071b 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_networkinterface.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_networkinterface.py @@ -40,8 +40,8 @@ options: required: true state: description: - - Assert the state of the network interface. Use 'present' to create or update an interface and - 'absent' to delete an interface. + - Assert the state of the network interface. Use C(present) to create or update an interface and + C(absent) to delete an interface. default: present choices: - absent diff --git a/lib/ansible/modules/cloud/azure/azure_rm_postgresqldatabase.py b/lib/ansible/modules/cloud/azure/azure_rm_postgresqldatabase.py index 6bcb996b4b..ca0636dc72 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_postgresqldatabase.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_postgresqldatabase.py @@ -54,7 +54,7 @@ options: default: 'no' state: description: - - Assert the state of the PostgreSQL database. Use 'present' to create or update a database and 'absent' to delete it. + - Assert the state of the PostgreSQL database. Use C(present) to create or update a database and C(absent) to delete it. default: present choices: - absent diff --git a/lib/ansible/modules/cloud/azure/azure_rm_postgresqlfirewallrule.py b/lib/ansible/modules/cloud/azure/azure_rm_postgresqlfirewallrule.py index de76f68abb..b7a13d0808 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_postgresqlfirewallrule.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_postgresqlfirewallrule.py @@ -42,7 +42,7 @@ options: - The end IP address of the PostgreSQL firewall rule. Must be IPv4 format. state: description: - - Assert the state of the PostgreSQL firewall rule. Use 'present' to create or update a PostgreSQL firewall rule and 'absent' to delete it. + - Assert the state of the PostgreSQL firewall rule. Use C(present) to create or update a PostgreSQL firewall rule and C(absent) to delete it. default: present choices: - absent diff --git a/lib/ansible/modules/cloud/azure/azure_rm_postgresqlserver.py b/lib/ansible/modules/cloud/azure/azure_rm_postgresqlserver.py index e91e9930be..54a049da91 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_postgresqlserver.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_postgresqlserver.py @@ -74,7 +74,7 @@ options: default: Default state: description: - - Assert the state of the PostgreSQL server. Use 'present' to create or update a server and 'absent' to delete it. + - Assert the state of the PostgreSQL server. Use C(present) to create or update a server and C(absent) to delete it. default: present choices: - present diff --git a/lib/ansible/modules/cloud/azure/azure_rm_publicipaddress.py b/lib/ansible/modules/cloud/azure/azure_rm_publicipaddress.py index 8369fa1ea8..2b50fc5369 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_publicipaddress.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_publicipaddress.py @@ -53,8 +53,8 @@ options: required: true state: description: - - Assert the state of the Public IP. Use 'present' to create or update a and - 'absent' to delete. + - Assert the state of the Public IP. Use C(present) to create or update a and + C(absent) to delete. default: present choices: - absent diff --git a/lib/ansible/modules/cloud/azure/azure_rm_rediscache.py b/lib/ansible/modules/cloud/azure/azure_rm_rediscache.py index be848a51db..0eb536d10e 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_rediscache.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_rediscache.py @@ -113,7 +113,7 @@ options: state: description: - Assert the state of the redis cache. - - Use 'present' to create or update a redis cache and 'absent' to delete it. + - Use C(present) to create or update a redis cache and C(absent) to delete it. default: present choices: - absent diff --git a/lib/ansible/modules/cloud/azure/azure_rm_resourcegroup.py b/lib/ansible/modules/cloud/azure/azure_rm_resourcegroup.py index 3bcdbd9237..e8f6188293 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_resourcegroup.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_resourcegroup.py @@ -24,7 +24,7 @@ description: options: force_delete_nonempty: description: - - Remove a resource group and all associated resources. Use with state 'absent' to delete a resource + - Remove a resource group and all associated resources. Use with state C(absent) to delete a resource. group that contains resources. type: bool aliases: @@ -40,8 +40,8 @@ options: required: true state: description: - - 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 + - Assert the state of the resource group. Use C(present) to create or update and + C(absent) to delete. When C(absent) a resource group containing resources will not be removed unless the force option is used. default: present choices: diff --git a/lib/ansible/modules/cloud/azure/azure_rm_route.py b/lib/ansible/modules/cloud/azure/azure_rm_route.py index 7f4692dd23..754766c13b 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_route.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_route.py @@ -31,8 +31,8 @@ options: required: true state: description: - - Assert the state of the route. Use 'present' to create or update and - 'absent' to delete. + - Assert the state of the route. Use C(present) to create or update and + C(absent) to delete. default: present choices: - absent diff --git a/lib/ansible/modules/cloud/azure/azure_rm_routetable.py b/lib/ansible/modules/cloud/azure/azure_rm_routetable.py index f94aec0ee3..40fa0dd355 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_routetable.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_routetable.py @@ -31,8 +31,8 @@ options: required: true state: description: - - Assert the state of the route table. Use 'present' to create or update and - 'absent' to delete. + - Assert the state of the route table. Use C(present) to create or update and + C(absent) to delete. default: present choices: - absent diff --git a/lib/ansible/modules/cloud/azure/azure_rm_securitygroup.py b/lib/ansible/modules/cloud/azure/azure_rm_securitygroup.py index c377c57d15..89fd1e77ad 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_securitygroup.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_securitygroup.py @@ -115,8 +115,8 @@ options: default: Inbound state: description: - - 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. + - Assert the state of the security group. Set to C(present) to create or update a security group. Set to + C(absent) to remove a security group. default: present choices: - absent diff --git a/lib/ansible/modules/cloud/azure/azure_rm_sqldatabase.py b/lib/ansible/modules/cloud/azure/azure_rm_sqldatabase.py index a51818747c..d568d68277 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_sqldatabase.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_sqldatabase.py @@ -127,7 +127,7 @@ options: type: bool state: description: - - Assert the state of the SQL Database. Use 'present' to create or update an SQL Database and 'absent' to delete it. + - Assert the state of the SQL Database. Use C(present) to create or update an SQL Database and C(absent) to delete it. default: present choices: - absent diff --git a/lib/ansible/modules/cloud/azure/azure_rm_sqlfirewallrule.py b/lib/ansible/modules/cloud/azure/azure_rm_sqlfirewallrule.py index d999ccf942..008a84981a 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_sqlfirewallrule.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_sqlfirewallrule.py @@ -43,7 +43,7 @@ options: nt all Azure-internal IP addresses." state: description: - - Assert the state of the SQL Database. Use 'present' to create or update an SQL Database and 'absent' to delete it. + - Assert the state of the SQL Database. Use C(present) to create or update an SQL Database and C(absent) to delete it. default: present choices: - absent diff --git a/lib/ansible/modules/cloud/azure/azure_rm_sqlserver.py b/lib/ansible/modules/cloud/azure/azure_rm_sqlserver.py index 35026f84b3..5e127ebad3 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_sqlserver.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_sqlserver.py @@ -48,8 +48,8 @@ options: ce. Possible values include: 'SystemAssigned'" state: description: - - Assert the state of the SQL server. Use 'present' to create or update a server and - 'absent' to delete a server. + - Assert the state of the SQL server. Use C(present) to create or update a server and + C(absent) to delete a server. default: present choices: - absent diff --git a/lib/ansible/modules/cloud/azure/azure_rm_storageaccount.py b/lib/ansible/modules/cloud/azure/azure_rm_storageaccount.py index 4e79bb9728..31d3555812 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_storageaccount.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_storageaccount.py @@ -33,8 +33,8 @@ options: - Name of the storage account to update or create. state: description: - - Assert the state of the storage account. Use 'present' to create or update a storage account and - 'absent' to delete an account. + - Assert the state of the storage account. Use C(present) to create or update a storage account and + C(absent) to delete an account. default: present choices: - absent diff --git a/lib/ansible/modules/cloud/azure/azure_rm_storageblob.py b/lib/ansible/modules/cloud/azure/azure_rm_storageblob.py index 5e940ca1ac..1bf9e7de46 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_storageblob.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_storageblob.py @@ -69,7 +69,7 @@ options: - Set the blob md5 hash value. dest: description: - - Destination file path. Use with state 'present' to download a blob. + - Destination file path. Use with state C(present) to download a blob. aliases: - destination force: @@ -86,16 +86,16 @@ options: - resource_group_name src: description: - - Source file path. Use with state 'present' to upload a blob. + - Source file path. Use with state C(present) to upload a blob. aliases: - source state: description: - 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 + - Use state C(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 + - Use state C(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 diff --git a/lib/ansible/modules/cloud/azure/azure_rm_subnet.py b/lib/ansible/modules/cloud/azure/azure_rm_subnet.py index 75d23f1278..c1d50c6ba3 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_subnet.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_subnet.py @@ -49,8 +49,8 @@ options: - security_group_name state: description: - - Assert the state of the subnet. Use 'present' to create or update a subnet and - 'absent' to delete a subnet. + - Assert the state of the subnet. Use C(present) to create or update a subnet and + C(absent) to delete a subnet. default: present choices: - absent diff --git a/lib/ansible/modules/cloud/azure/azure_rm_virtualmachine.py b/lib/ansible/modules/cloud/azure/azure_rm_virtualmachine.py index fda2188af2..a5a504394f 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_virtualmachine.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_virtualmachine.py @@ -50,17 +50,17 @@ options: state: description: - Assert the state of the virtual machine. - - State 'present' will check that the machine exists with the requested configuration. If the configuration + - State C(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. + - State C(absent) will remove the virtual machine. default: present choices: - absent - present started: description: - - Use with state 'present' to start the machine. Set to false to have the machine be 'stopped'. + - Use with state C(present) to start the machine. Set to false to have the machine be 'stopped'. default: true type: bool allocated: @@ -70,13 +70,13 @@ options: type: bool generalized: description: - - Use with state 'present' to generalize the machine. Set to true to generalize the machine. + - Use with state C(present) to generalize the machine. Set to true to generalize the machine. - Please note that this operation is irreversible. type: bool version_added: "2.8" restarted: description: - - Use with state 'present' to restart a running VM. + - Use with state C(present) to restart a running VM. type: bool location: description: diff --git a/lib/ansible/modules/cloud/azure/azure_rm_virtualmachine_extension.py b/lib/ansible/modules/cloud/azure/azure_rm_virtualmachine_extension.py index ae72409ca4..aa3e358c11 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_virtualmachine_extension.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_virtualmachine_extension.py @@ -35,8 +35,8 @@ options: required: true state: description: - - Assert the state of the vm extension. Use 'present' to create or update a vm extension and - 'absent' to delete a vm extension. + - Assert the state of the vm extension. Use C(present) to create or update a vm extension and + C(absent) to delete a vm extension. default: present choices: - absent diff --git a/lib/ansible/modules/cloud/azure/azure_rm_virtualmachine_scaleset.py b/lib/ansible/modules/cloud/azure/azure_rm_virtualmachine_scaleset.py index 9624d945c8..5f02155da2 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_virtualmachine_scaleset.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_virtualmachine_scaleset.py @@ -36,10 +36,10 @@ options: state: description: - Assert the state of the virtual machine scale set. - - State 'present' will check that the machine exists with the requested configuration. If the configuration + - State C(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. + - State C(absent) will remove the virtual machine scale set. default: present choices: - absent diff --git a/lib/ansible/modules/cloud/azure/azure_rm_virtualnetwork.py b/lib/ansible/modules/cloud/azure/azure_rm_virtualnetwork.py index 61c3732d02..ae4ecf2343 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_virtualnetwork.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_virtualnetwork.py @@ -61,8 +61,8 @@ options: default: 'no' state: description: - - Assert the state of the virtual network. Use 'present' to create or update and - 'absent' to delete. + - Assert the state of the virtual network. Use C(present) to create or update and + C(absent) to delete. default: present choices: - absent diff --git a/lib/ansible/modules/cloud/azure/azure_rm_webapp.py b/lib/ansible/modules/cloud/azure/azure_rm_webapp.py index 3228814b41..1328842628 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_webapp.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_webapp.py @@ -171,7 +171,7 @@ options: state: description: - Assert the state of the Web App. - - Use 'present' to create or update a Web App and 'absent' to delete it. + - Use C(present) to create or update a Web App and C(absent) to delete it. default: present choices: - absent diff --git a/lib/ansible/modules/cloud/azure/azure_rm_webappslot.py b/lib/ansible/modules/cloud/azure/azure_rm_webappslot.py index 1ddf15b82e..d39ba68eed 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_webappslot.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_webappslot.py @@ -153,7 +153,7 @@ options: state: description: - Assert the state of the Web App deployment slot. - - Use 'present' to create or update a slot and 'absent' to delete it. + - Use C(present) to create or update a slot and C(absent) to delete it. default: present choices: - absent |