mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-22 12:50:22 -07:00
Clean up module documentation (#36909)
* Clean up module documentation This PR includes: - Removal of `default: None` (and variations) - Removal of `required: false` - Fixing booleans and `type: bool` where required * Fix remaining (new) validation issues
This commit is contained in:
parent
58eb2e849d
commit
cdd21e2170
624 changed files with 1458 additions and 9114 deletions
|
@ -31,71 +31,56 @@ options:
|
|||
object:
|
||||
description:
|
||||
- Keyname of the object inside the bucket. Can be also be used to create "virtual directories" (see examples).
|
||||
required: false
|
||||
default: null
|
||||
src:
|
||||
description:
|
||||
- The source file path when performing a PUT operation.
|
||||
required: false
|
||||
default: null
|
||||
dest:
|
||||
description:
|
||||
- The destination file path when downloading an object/key with a GET operation.
|
||||
required: false
|
||||
force:
|
||||
description:
|
||||
- Forces an overwrite either locally on the filesystem or remotely with the object/key. Used with PUT and GET operations.
|
||||
required: false
|
||||
default: true
|
||||
type: bool
|
||||
default: 'yes'
|
||||
aliases: [ 'overwrite' ]
|
||||
permission:
|
||||
description:
|
||||
- This option let's the user set the canned permissions on the object/bucket that are created. The permissions that can be set are 'private',
|
||||
'public-read', 'authenticated-read'.
|
||||
required: false
|
||||
default: private
|
||||
headers:
|
||||
version_added: "2.0"
|
||||
description:
|
||||
- Headers to attach to object.
|
||||
required: false
|
||||
default: '{}'
|
||||
default: {}
|
||||
expiration:
|
||||
description:
|
||||
- Time limit (in seconds) for the URL generated and returned by GCA when performing a mode=put or mode=get_url operation. This url is only
|
||||
available when public-read is the acl for the object.
|
||||
required: false
|
||||
default: null
|
||||
mode:
|
||||
description:
|
||||
- Switches the module behaviour between upload, download, get_url (return download url) , get_str (download object as string), create (bucket) and
|
||||
delete (bucket).
|
||||
required: true
|
||||
default: null
|
||||
choices: [ 'get', 'put', 'get_url', 'get_str', 'delete', 'create' ]
|
||||
gs_secret_key:
|
||||
description:
|
||||
- GS secret key. If not set then the value of the GS_SECRET_ACCESS_KEY environment variable is used.
|
||||
required: true
|
||||
default: null
|
||||
gs_access_key:
|
||||
description:
|
||||
- GS access key. If not set then the value of the GS_ACCESS_KEY_ID environment variable is used.
|
||||
required: true
|
||||
default: null
|
||||
region:
|
||||
version_added: "2.4"
|
||||
description:
|
||||
- The gs region to use. If not defined then the value 'US' will be used. See U(https://cloud.google.com/storage/docs/bucket-locations)
|
||||
required: false
|
||||
default: 'US'
|
||||
versioning:
|
||||
version_added: "2.4"
|
||||
description:
|
||||
- Whether versioning is enabled or disabled (note that once versioning is enabled, it can only be suspended)
|
||||
required: false
|
||||
default: null
|
||||
choices: [ 'yes', 'no' ]
|
||||
type: bool
|
||||
|
||||
requirements:
|
||||
- "python >= 2.6"
|
||||
|
|
|
@ -32,7 +32,6 @@ options:
|
|||
state:
|
||||
description:
|
||||
- Whether the given resource record should or should not be present.
|
||||
required: false
|
||||
choices: ["present", "absent"]
|
||||
default: "present"
|
||||
record:
|
||||
|
@ -47,7 +46,6 @@ options:
|
|||
option, or the module will fail.
|
||||
- If both I(zone) and I(zone_id) are specified, I(zone_id) will be
|
||||
used.
|
||||
required: false
|
||||
zone_id:
|
||||
description:
|
||||
- The Google Cloud ID of the zone (e.g., example-com).
|
||||
|
@ -59,7 +57,6 @@ options:
|
|||
number of zones.
|
||||
- If both I(zone) and I(zone_id) are specified, I(zone_id) will be
|
||||
used.
|
||||
required: false
|
||||
type:
|
||||
description:
|
||||
- The type of resource record to add.
|
||||
|
@ -85,7 +82,6 @@ options:
|
|||
description:
|
||||
- The amount of time in seconds that a resource record will remain
|
||||
cached by a caching resolver.
|
||||
required: false
|
||||
default: 300
|
||||
overwrite:
|
||||
description:
|
||||
|
@ -102,34 +98,25 @@ options:
|
|||
If I(state) is C(absent) and I(overwrite) is C(False), this
|
||||
module will fail if the provided record_data do not match exactly
|
||||
with the existing resource record's record_data.
|
||||
required: false
|
||||
choices: [True, False]
|
||||
default: False
|
||||
type: bool
|
||||
default: 'no'
|
||||
service_account_email:
|
||||
description:
|
||||
- The e-mail address for a service account with access to Google
|
||||
Cloud DNS.
|
||||
required: false
|
||||
default: null
|
||||
pem_file:
|
||||
description:
|
||||
- The path to the PEM file associated with the service account
|
||||
email.
|
||||
- This option is deprecated and may be removed in a future release.
|
||||
Use I(credentials_file) instead.
|
||||
required: false
|
||||
default: null
|
||||
credentials_file:
|
||||
description:
|
||||
- The path to the JSON file associated with the service account
|
||||
email.
|
||||
required: false
|
||||
default: null
|
||||
project_id:
|
||||
description:
|
||||
- The Google Cloud Platform project ID to use.
|
||||
required: false
|
||||
default: null
|
||||
notes:
|
||||
- See also M(gcdns_zone).
|
||||
- This modules's underlying library does not support in-place updates for
|
||||
|
|
|
@ -31,7 +31,6 @@ options:
|
|||
state:
|
||||
description:
|
||||
- Whether the given zone should or should not be present.
|
||||
required: false
|
||||
choices: ["present", "absent"]
|
||||
default: "present"
|
||||
zone:
|
||||
|
@ -45,33 +44,24 @@ options:
|
|||
description:
|
||||
description:
|
||||
- An arbitrary text string to use for the zone description.
|
||||
required: false
|
||||
default: ""
|
||||
service_account_email:
|
||||
description:
|
||||
- The e-mail address for a service account with access to Google
|
||||
Cloud DNS.
|
||||
required: false
|
||||
default: null
|
||||
pem_file:
|
||||
description:
|
||||
- The path to the PEM file associated with the service account
|
||||
email.
|
||||
- This option is deprecated and may be removed in a future release.
|
||||
Use I(credentials_file) instead.
|
||||
required: false
|
||||
default: null
|
||||
credentials_file:
|
||||
description:
|
||||
- The path to the JSON file associated with the service account
|
||||
email.
|
||||
required: false
|
||||
default: null
|
||||
project_id:
|
||||
description:
|
||||
- The Google Cloud Platform project ID to use.
|
||||
required: false
|
||||
default: null
|
||||
notes:
|
||||
- See also M(gcdns_record).
|
||||
- Zones that are newly created must still be set up with a domain registrar
|
||||
|
|
|
@ -25,52 +25,38 @@ options:
|
|||
description:
|
||||
- image string to use for the instance (default will follow latest
|
||||
stable debian image)
|
||||
required: false
|
||||
default: "debian-8"
|
||||
image_family:
|
||||
description:
|
||||
- image family from which to select the image. The most recent
|
||||
non-deprecated image in the family will be used.
|
||||
required: false
|
||||
default: null
|
||||
version_added: "2.4"
|
||||
external_projects:
|
||||
description:
|
||||
- A list of other projects (accessible with the provisioning credentials)
|
||||
to be searched for the image.
|
||||
required: false
|
||||
default: null
|
||||
version_added: "2.4"
|
||||
instance_names:
|
||||
description:
|
||||
- a comma-separated list of instance names to create or destroy
|
||||
required: false
|
||||
default: null
|
||||
machine_type:
|
||||
description:
|
||||
- machine type to use for the instance, use 'n1-standard-1' by default
|
||||
required: false
|
||||
default: "n1-standard-1"
|
||||
metadata:
|
||||
description:
|
||||
- a hash/dictionary of custom data for the instance;
|
||||
'{"key":"value", ...}'
|
||||
required: false
|
||||
default: null
|
||||
service_account_email:
|
||||
version_added: "1.5.1"
|
||||
description:
|
||||
- service account email
|
||||
required: false
|
||||
default: null
|
||||
service_account_permissions:
|
||||
version_added: "2.0"
|
||||
description:
|
||||
- service account permissions (see
|
||||
U(https://cloud.google.com/sdk/gcloud/reference/compute/instances/create),
|
||||
--scopes section for detailed information)
|
||||
required: false
|
||||
default: null
|
||||
choices: [
|
||||
"bigquery", "cloud-platform", "compute-ro", "compute-rw",
|
||||
"useraccounts-ro", "useraccounts-rw", "datastore", "logging-write",
|
||||
|
@ -82,69 +68,53 @@ options:
|
|||
description:
|
||||
- path to the pem file associated with the service account email
|
||||
This option is deprecated. Use 'credentials_file'.
|
||||
required: false
|
||||
default: null
|
||||
credentials_file:
|
||||
version_added: "2.1.0"
|
||||
description:
|
||||
- path to the JSON file associated with the service account email
|
||||
default: null
|
||||
required: false
|
||||
project_id:
|
||||
version_added: "1.5.1"
|
||||
description:
|
||||
- your GCE project ID
|
||||
required: false
|
||||
default: null
|
||||
name:
|
||||
description:
|
||||
- either a name of a single instance or when used with 'num_instances',
|
||||
the base name of a cluster of nodes
|
||||
required: false
|
||||
aliases: ['base_name']
|
||||
num_instances:
|
||||
description:
|
||||
- can be used with 'name', specifies
|
||||
the number of nodes to provision using 'name'
|
||||
as a base name
|
||||
required: false
|
||||
version_added: "2.3"
|
||||
network:
|
||||
description:
|
||||
- name of the network, 'default' will be used if not specified
|
||||
required: false
|
||||
default: "default"
|
||||
subnetwork:
|
||||
description:
|
||||
- name of the subnetwork in which the instance should be created
|
||||
required: false
|
||||
default: null
|
||||
version_added: "2.2"
|
||||
persistent_boot_disk:
|
||||
description:
|
||||
- if set, create the instance with a persistent boot disk
|
||||
required: false
|
||||
default: "false"
|
||||
type: bool
|
||||
default: 'no'
|
||||
disks:
|
||||
description:
|
||||
- a list of persistent disks to attach to the instance; a string value
|
||||
gives the name of the disk; alternatively, a dictionary value can
|
||||
define 'name' and 'mode' ('READ_ONLY' or 'READ_WRITE'). The first entry
|
||||
will be the boot disk (which must be READ_WRITE).
|
||||
required: false
|
||||
default: null
|
||||
version_added: "1.7"
|
||||
state:
|
||||
description:
|
||||
- desired state of the resource
|
||||
required: false
|
||||
default: "present"
|
||||
choices: ["active", "present", "absent", "deleted", "started", "stopped", "terminated"]
|
||||
tags:
|
||||
description:
|
||||
- a comma-separated list of tags to associate with the instance
|
||||
required: false
|
||||
default: null
|
||||
zone:
|
||||
description:
|
||||
- the GCE zone to use. The list of available zones is at U(https://cloud.google.com/compute/docs/regions-zones/regions-zones#available).
|
||||
|
@ -153,33 +123,31 @@ options:
|
|||
ip_forward:
|
||||
version_added: "1.9"
|
||||
description:
|
||||
- set to true if the instance can forward ip packets (useful for
|
||||
- set to C(yes) if the instance can forward ip packets (useful for
|
||||
gateways)
|
||||
required: false
|
||||
default: "false"
|
||||
type: bool
|
||||
default: 'no'
|
||||
external_ip:
|
||||
version_added: "1.9"
|
||||
description:
|
||||
- type of external ip, ephemeral by default; alternatively, a fixed gce ip or ip name can be given. Specify 'none' if no external ip is desired.
|
||||
required: false
|
||||
default: "ephemeral"
|
||||
disk_auto_delete:
|
||||
version_added: "1.9"
|
||||
description:
|
||||
- if set boot disk will be removed after instance destruction
|
||||
required: false
|
||||
default: "true"
|
||||
type: bool
|
||||
default: 'yes'
|
||||
preemptible:
|
||||
version_added: "2.1"
|
||||
description:
|
||||
- if set to true, instances will be preemptible and time-limited.
|
||||
- if set to C(yes), instances will be preemptible and time-limited.
|
||||
(requires libcloud >= 0.20.0)
|
||||
required: false
|
||||
default: "false"
|
||||
type: bool
|
||||
default: 'no'
|
||||
disk_size:
|
||||
description:
|
||||
- The size of the boot disk created for this instance (in GB)
|
||||
required: false
|
||||
default: 10
|
||||
version_added: "2.3"
|
||||
|
||||
|
|
|
@ -27,55 +27,39 @@ options:
|
|||
description:
|
||||
- the name of the image to create or delete
|
||||
required: true
|
||||
default: null
|
||||
description:
|
||||
description:
|
||||
- an optional description
|
||||
required: false
|
||||
default: null
|
||||
family:
|
||||
description:
|
||||
- an optional family name
|
||||
required: false
|
||||
default: null
|
||||
version_added: "2.2"
|
||||
source:
|
||||
description:
|
||||
- the source disk or the Google Cloud Storage URI to create the image from
|
||||
required: false
|
||||
default: null
|
||||
state:
|
||||
description:
|
||||
- desired state of the image
|
||||
required: false
|
||||
default: "present"
|
||||
choices: ["present", "absent"]
|
||||
zone:
|
||||
description:
|
||||
- the zone of the disk specified by source
|
||||
required: false
|
||||
default: "us-central1-a"
|
||||
timeout:
|
||||
description:
|
||||
- timeout for the operation
|
||||
required: false
|
||||
default: 180
|
||||
version_added: "2.0"
|
||||
service_account_email:
|
||||
description:
|
||||
- service account email
|
||||
required: false
|
||||
default: null
|
||||
pem_file:
|
||||
description:
|
||||
- path to the pem file associated with the service account email
|
||||
required: false
|
||||
default: null
|
||||
project_id:
|
||||
description:
|
||||
- your GCE project ID
|
||||
required: false
|
||||
default: null
|
||||
requirements:
|
||||
- "python >= 2.6"
|
||||
- "apache-libcloud"
|
||||
|
|
|
@ -28,8 +28,6 @@ options:
|
|||
name:
|
||||
description:
|
||||
- The name of the GCE instance template.
|
||||
required: true
|
||||
default: null
|
||||
size:
|
||||
description:
|
||||
- The desired machine type for the instance template.
|
||||
|
@ -38,18 +36,15 @@ options:
|
|||
description:
|
||||
- A source disk to attach to the instance.
|
||||
Cannot specify both I(image) and I(source).
|
||||
default: null
|
||||
image:
|
||||
description:
|
||||
- The image to use to create the instance.
|
||||
Cannot specify both both I(image) and I(source).
|
||||
default: null
|
||||
image_family:
|
||||
description:
|
||||
- The image family to use to create the instance.
|
||||
If I(image) has been used I(image_family) is ignored.
|
||||
Cannot specify both I(image) and I(source).
|
||||
default: null
|
||||
disk_type:
|
||||
description:
|
||||
- Specify a C(pd-standard) disk or C(pd-ssd)
|
||||
|
@ -67,12 +62,12 @@ options:
|
|||
subnetwork:
|
||||
description:
|
||||
- The Subnetwork resource name for this instance.
|
||||
default: null
|
||||
can_ip_forward:
|
||||
description:
|
||||
- Set to True to allow instance to
|
||||
- Set to C(yes) to allow instance to
|
||||
send/receive non-matching src/dst packets.
|
||||
default: false
|
||||
type: bool
|
||||
default: 'no'
|
||||
external_ip:
|
||||
description:
|
||||
- The external IP address to use.
|
||||
|
@ -84,13 +79,11 @@ options:
|
|||
service_account_email:
|
||||
description:
|
||||
- service account email
|
||||
default: null
|
||||
service_account_permissions:
|
||||
description:
|
||||
- service account permissions (see
|
||||
U(https://cloud.google.com/sdk/gcloud/reference/compute/instances/create),
|
||||
--scopes section for detailed information)
|
||||
default: null
|
||||
choices: [
|
||||
"bigquery", "cloud-platform", "compute-ro", "compute-rw",
|
||||
"useraccounts-ro", "useraccounts-rw", "datastore", "logging-write",
|
||||
|
@ -102,61 +95,49 @@ options:
|
|||
- Defines whether the instance should be
|
||||
automatically restarted when it is
|
||||
terminated by Compute Engine.
|
||||
default: null
|
||||
preemptible:
|
||||
description:
|
||||
- Defines whether the instance is preemptible.
|
||||
default: null
|
||||
tags:
|
||||
description:
|
||||
- a comma-separated list of tags to associate with the instance
|
||||
default: null
|
||||
metadata:
|
||||
description:
|
||||
- a hash/dictionary of custom data for the instance;
|
||||
'{"key":"value", ...}'
|
||||
default: null
|
||||
description:
|
||||
description:
|
||||
- description of instance template
|
||||
default: null
|
||||
disks:
|
||||
description:
|
||||
- a list of persistent disks to attach to the instance; a string value
|
||||
gives the name of the disk; alternatively, a dictionary value can
|
||||
define 'name' and 'mode' ('READ_ONLY' or 'READ_WRITE'). The first entry
|
||||
will be the boot disk (which must be READ_WRITE).
|
||||
default: null
|
||||
nic_gce_struct:
|
||||
description:
|
||||
- Support passing in the GCE-specific
|
||||
formatted networkInterfaces[] structure.
|
||||
default: null
|
||||
disks_gce_struct:
|
||||
description:
|
||||
- Support passing in the GCE-specific
|
||||
formatted formatted disks[] structure. Case sensitive.
|
||||
see U(https://cloud.google.com/compute/docs/reference/latest/instanceTemplates#resource) for detailed information
|
||||
default: null
|
||||
version_added: "2.4"
|
||||
project_id:
|
||||
description:
|
||||
- your GCE project ID
|
||||
default: null
|
||||
pem_file:
|
||||
description:
|
||||
- path to the pem file associated with the service account email
|
||||
This option is deprecated. Use 'credentials_file'.
|
||||
default: null
|
||||
credentials_file:
|
||||
description:
|
||||
- path to the JSON file associated with the service account email
|
||||
default: null
|
||||
subnetwork_region:
|
||||
version_added: "2.4"
|
||||
description:
|
||||
- Region that subnetwork resides in. (Required for subnetwork to successfully complete)
|
||||
default: null
|
||||
requirements:
|
||||
- "python >= 2.6"
|
||||
- "apache-libcloud >= 0.13.3, >= 0.17.0 if using JSON credentials,
|
||||
|
|
|
@ -31,108 +31,76 @@ options:
|
|||
httphealthcheck_name:
|
||||
description:
|
||||
- the name identifier for the HTTP health check
|
||||
required: false
|
||||
default: null
|
||||
httphealthcheck_port:
|
||||
description:
|
||||
- the TCP port to use for HTTP health checking
|
||||
required: false
|
||||
default: 80
|
||||
httphealthcheck_path:
|
||||
description:
|
||||
- the url path to use for HTTP health checking
|
||||
required: false
|
||||
default: "/"
|
||||
httphealthcheck_interval:
|
||||
description:
|
||||
- the duration in seconds between each health check request
|
||||
required: false
|
||||
default: 5
|
||||
httphealthcheck_timeout:
|
||||
description:
|
||||
- the timeout in seconds before a request is considered a failed check
|
||||
required: false
|
||||
default: 5
|
||||
httphealthcheck_unhealthy_count:
|
||||
description:
|
||||
- number of consecutive failed checks before marking a node unhealthy
|
||||
required: false
|
||||
default: 2
|
||||
httphealthcheck_healthy_count:
|
||||
description:
|
||||
- number of consecutive successful checks before marking a node healthy
|
||||
required: false
|
||||
default: 2
|
||||
httphealthcheck_host:
|
||||
description:
|
||||
- host header to pass through on HTTP check requests
|
||||
required: false
|
||||
default: null
|
||||
name:
|
||||
description:
|
||||
- name of the load-balancer resource
|
||||
required: false
|
||||
default: null
|
||||
protocol:
|
||||
description:
|
||||
- the protocol used for the load-balancer packet forwarding, tcp or udp
|
||||
required: false
|
||||
default: "tcp"
|
||||
choices: ['tcp', 'udp']
|
||||
region:
|
||||
description:
|
||||
- the GCE region where the load-balancer is defined
|
||||
required: false
|
||||
external_ip:
|
||||
description:
|
||||
- the external static IPv4 (or auto-assigned) address for the LB
|
||||
required: false
|
||||
default: null
|
||||
port_range:
|
||||
description:
|
||||
- the port (range) to forward, e.g. 80 or 8000-8888 defaults to all ports
|
||||
required: false
|
||||
default: null
|
||||
members:
|
||||
description:
|
||||
- a list of zone/nodename pairs, e.g ['us-central1-a/www-a', ...]
|
||||
required: false
|
||||
aliases: ['nodes']
|
||||
state:
|
||||
description:
|
||||
- desired state of the LB
|
||||
default: "present"
|
||||
choices: ["active", "present", "absent", "deleted"]
|
||||
aliases: []
|
||||
required: false
|
||||
service_account_email:
|
||||
version_added: "1.6"
|
||||
description:
|
||||
- service account email
|
||||
required: false
|
||||
default: null
|
||||
aliases: []
|
||||
pem_file:
|
||||
version_added: "1.6"
|
||||
description:
|
||||
- path to the pem file associated with the service account email
|
||||
This option is deprecated. Use 'credentials_file'.
|
||||
required: false
|
||||
default: null
|
||||
aliases: []
|
||||
credentials_file:
|
||||
version_added: "2.1.0"
|
||||
description:
|
||||
- path to the JSON file associated with the service account email
|
||||
default: null
|
||||
required: false
|
||||
project_id:
|
||||
version_added: "1.6"
|
||||
description:
|
||||
- your GCE project ID
|
||||
required: false
|
||||
default: null
|
||||
aliases: []
|
||||
|
||||
requirements:
|
||||
- "python >= 2.6"
|
||||
|
|
|
@ -40,31 +40,22 @@ options:
|
|||
- Instance Template to be used in creating the VMs. See
|
||||
U(https://cloud.google.com/compute/docs/instance-templates) to learn more
|
||||
about Instance Templates. Required for creating MIGs.
|
||||
required: false
|
||||
size:
|
||||
description:
|
||||
- Size of Managed Instance Group. If MIG already exists, it will be
|
||||
resized to the number provided here. Required for creating MIGs.
|
||||
required: false
|
||||
service_account_email:
|
||||
description:
|
||||
- service account email
|
||||
required: false
|
||||
default: null
|
||||
credentials_file:
|
||||
description:
|
||||
- Path to the JSON file associated with the service account email
|
||||
default: null
|
||||
required: false
|
||||
project_id:
|
||||
description:
|
||||
- GCE project ID
|
||||
required: false
|
||||
default: null
|
||||
state:
|
||||
description:
|
||||
- desired state of the resource
|
||||
required: false
|
||||
default: "present"
|
||||
choices: ["absent", "present"]
|
||||
zone:
|
||||
|
@ -77,15 +68,11 @@ options:
|
|||
and policy.max_instances (int) are required fields if autoscaling is used. See
|
||||
U(https://cloud.google.com/compute/docs/reference/beta/autoscalers) for more information
|
||||
on Autoscaling.
|
||||
required: false
|
||||
default: null
|
||||
named_ports:
|
||||
version_added: "2.3"
|
||||
description:
|
||||
- Define named ports that backend services can forward data to. Format is a a list of
|
||||
name:port dictionaries.
|
||||
required: false
|
||||
default: null
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
|
|
|
@ -30,82 +30,54 @@ options:
|
|||
description:
|
||||
- the protocol:ports to allow ('tcp:80' or 'tcp:80,443' or 'tcp:80-800;udp:1-25')
|
||||
this parameter is mandatory when creating or updating a firewall rule
|
||||
required: false
|
||||
default: null
|
||||
aliases: []
|
||||
ipv4_range:
|
||||
description:
|
||||
- the IPv4 address range in CIDR notation for the network
|
||||
this parameter is not mandatory when you specified existing network in name parameter, but when you create new network, this parameter is mandatory
|
||||
required: false
|
||||
aliases: ['cidr']
|
||||
fwname:
|
||||
description:
|
||||
- name of the firewall rule
|
||||
required: false
|
||||
default: null
|
||||
aliases: ['fwrule']
|
||||
name:
|
||||
description:
|
||||
- name of the network
|
||||
required: false
|
||||
default: null
|
||||
aliases: []
|
||||
src_range:
|
||||
description:
|
||||
- the source IPv4 address range in CIDR notation
|
||||
required: false
|
||||
default: []
|
||||
aliases: ['src_cidr']
|
||||
src_tags:
|
||||
description:
|
||||
- the source instance tags for creating a firewall rule
|
||||
required: false
|
||||
default: []
|
||||
aliases: []
|
||||
target_tags:
|
||||
version_added: "1.9"
|
||||
description:
|
||||
- the target instance tags for creating a firewall rule
|
||||
required: false
|
||||
default: []
|
||||
aliases: []
|
||||
state:
|
||||
description:
|
||||
- desired state of the network or firewall
|
||||
required: false
|
||||
default: "present"
|
||||
choices: ["active", "present", "absent", "deleted"]
|
||||
aliases: []
|
||||
service_account_email:
|
||||
version_added: "1.6"
|
||||
description:
|
||||
- service account email
|
||||
required: false
|
||||
default: null
|
||||
aliases: []
|
||||
pem_file:
|
||||
version_added: "1.6"
|
||||
description:
|
||||
- path to the pem file associated with the service account email
|
||||
This option is deprecated. Use 'credentials_file'.
|
||||
required: false
|
||||
default: null
|
||||
aliases: []
|
||||
credentials_file:
|
||||
version_added: "2.1.0"
|
||||
description:
|
||||
- path to the JSON file associated with the service account email
|
||||
required: false
|
||||
default: null
|
||||
aliases: []
|
||||
project_id:
|
||||
version_added: "1.6"
|
||||
description:
|
||||
- your GCE project ID
|
||||
required: false
|
||||
default: null
|
||||
aliases: []
|
||||
mode:
|
||||
version_added: "2.2"
|
||||
description:
|
||||
|
@ -114,31 +86,20 @@ options:
|
|||
"auto" automatically generates subnetworks in different regions
|
||||
"custom" uses networks to group subnets of user specified IP address ranges
|
||||
https://cloud.google.com/compute/docs/networking#network_types
|
||||
required: false
|
||||
default: "legacy"
|
||||
choices: ["legacy", "auto", "custom"]
|
||||
aliases: []
|
||||
subnet_name:
|
||||
version_added: "2.2"
|
||||
description:
|
||||
- name of subnet to create
|
||||
required: false
|
||||
default: null
|
||||
aliases: []
|
||||
subnet_region:
|
||||
version_added: "2.2"
|
||||
description:
|
||||
- region of subnet to create
|
||||
required: false
|
||||
default: null
|
||||
aliases: []
|
||||
subnet_desc:
|
||||
version_added: "2.2"
|
||||
description:
|
||||
- description of subnet to create
|
||||
required: false
|
||||
default: null
|
||||
aliases: []
|
||||
|
||||
requirements:
|
||||
- "python >= 2.6"
|
||||
|
|
|
@ -26,105 +26,70 @@ options:
|
|||
detach_only:
|
||||
description:
|
||||
- do not destroy the disk, merely detach it from an instance
|
||||
required: false
|
||||
default: "no"
|
||||
choices: ["yes", "no"]
|
||||
aliases: []
|
||||
type: bool
|
||||
default: 'no'
|
||||
instance_name:
|
||||
description:
|
||||
- instance name if you wish to attach or detach the disk
|
||||
required: false
|
||||
default: null
|
||||
aliases: []
|
||||
mode:
|
||||
description:
|
||||
- GCE mount mode of disk, READ_ONLY (default) or READ_WRITE
|
||||
required: false
|
||||
default: "READ_ONLY"
|
||||
choices: ["READ_WRITE", "READ_ONLY"]
|
||||
aliases: []
|
||||
name:
|
||||
description:
|
||||
- name of the disk
|
||||
required: true
|
||||
default: null
|
||||
aliases: []
|
||||
size_gb:
|
||||
description:
|
||||
- whole integer size of disk (in GB) to create, default is 10 GB
|
||||
required: false
|
||||
default: 10
|
||||
aliases: []
|
||||
image:
|
||||
description:
|
||||
- the source image to use for the disk
|
||||
required: false
|
||||
default: null
|
||||
aliases: []
|
||||
version_added: "1.7"
|
||||
snapshot:
|
||||
description:
|
||||
- the source snapshot to use for the disk
|
||||
required: false
|
||||
default: null
|
||||
aliases: []
|
||||
version_added: "1.7"
|
||||
state:
|
||||
description:
|
||||
- desired state of the persistent disk
|
||||
required: false
|
||||
default: "present"
|
||||
choices: ["active", "present", "absent", "deleted"]
|
||||
aliases: []
|
||||
zone:
|
||||
description:
|
||||
- zone in which to create the disk
|
||||
required: false
|
||||
default: "us-central1-b"
|
||||
aliases: []
|
||||
service_account_email:
|
||||
version_added: "1.6"
|
||||
description:
|
||||
- service account email
|
||||
required: false
|
||||
default: null
|
||||
aliases: []
|
||||
pem_file:
|
||||
version_added: "1.6"
|
||||
description:
|
||||
- path to the pem file associated with the service account email
|
||||
This option is deprecated. Use 'credentials_file'.
|
||||
required: false
|
||||
default: null
|
||||
aliases: []
|
||||
credentials_file:
|
||||
version_added: "2.1.0"
|
||||
description:
|
||||
- path to the JSON file associated with the service account email
|
||||
required: false
|
||||
default: null
|
||||
aliases: []
|
||||
project_id:
|
||||
version_added: "1.6"
|
||||
description:
|
||||
- your GCE project ID
|
||||
required: false
|
||||
default: null
|
||||
aliases: []
|
||||
disk_type:
|
||||
version_added: "1.9"
|
||||
description:
|
||||
- type of disk provisioned
|
||||
required: false
|
||||
default: "pd-standard"
|
||||
choices: ["pd-standard", "pd-ssd"]
|
||||
aliases: []
|
||||
delete_on_termination:
|
||||
version_added: "2.3"
|
||||
description:
|
||||
- If yes, deletes the volume when instance is terminated
|
||||
default: no
|
||||
choices: ["yes", "no"]
|
||||
- If C(yes), deletes the volume when instance is terminated
|
||||
type: bool
|
||||
default: 'no'
|
||||
|
||||
requirements:
|
||||
- "python >= 2.6"
|
||||
|
|
|
@ -46,13 +46,10 @@ options:
|
|||
enable_cdn:
|
||||
description:
|
||||
- If true, enable Cloud CDN for this Backend Service.
|
||||
required: false
|
||||
port_name:
|
||||
description:
|
||||
- Name of the port on the managed instance group (MIG) that backend
|
||||
services can forward data to. Required for external load balancing.
|
||||
required: false
|
||||
default: null
|
||||
protocol:
|
||||
description:
|
||||
- The protocol this Backend Service uses to communicate with backends.
|
||||
|
@ -66,22 +63,15 @@ options:
|
|||
service_account_email:
|
||||
description:
|
||||
- Service account email
|
||||
required: false
|
||||
default: null
|
||||
credentials_file:
|
||||
description:
|
||||
- Path to the JSON file associated with the service account email.
|
||||
default: null
|
||||
required: false
|
||||
project_id:
|
||||
description:
|
||||
- GCE project ID.
|
||||
required: false
|
||||
default: null
|
||||
state:
|
||||
description:
|
||||
- Desired state of the resource
|
||||
required: false
|
||||
default: "present"
|
||||
choices: ["absent", "present"]
|
||||
'''
|
||||
|
|
|
@ -43,7 +43,6 @@ options:
|
|||
check_interval:
|
||||
description:
|
||||
- How often (in seconds) to send a health check.
|
||||
required: false
|
||||
default: 5
|
||||
healthcheck_name:
|
||||
description:
|
||||
|
@ -65,7 +64,6 @@ options:
|
|||
description:
|
||||
- The TCP port number for the health check request. The default value is
|
||||
443 for HTTPS and 80 for HTTP.
|
||||
required: false
|
||||
request_path:
|
||||
description:
|
||||
- The request path of the HTTPS health check request.
|
||||
|
@ -80,33 +78,26 @@ options:
|
|||
- How long (in seconds) to wait for a response before claiming
|
||||
failure. It is invalid for timeout
|
||||
to have a greater value than check_interval.
|
||||
required: false
|
||||
default: 5
|
||||
unhealthy_threshold:
|
||||
description:
|
||||
- A so-far healthy instance will be marked unhealthy after this
|
||||
many consecutive failures.
|
||||
required: false
|
||||
default: 2
|
||||
healthy_threshold:
|
||||
description:
|
||||
- A so-far unhealthy instance will be marked healthy after this
|
||||
many consecutive successes.
|
||||
required: false
|
||||
default: 2
|
||||
service_account_email:
|
||||
description:
|
||||
- service account email
|
||||
required: false
|
||||
default: null
|
||||
service_account_permissions:
|
||||
version_added: "2.0"
|
||||
description:
|
||||
- service account permissions (see
|
||||
U(https://cloud.google.com/sdk/gcloud/reference/compute/instances/create),
|
||||
--scopes section for detailed information)
|
||||
required: false
|
||||
default: null
|
||||
choices: [
|
||||
"bigquery", "cloud-platform", "compute-ro", "compute-rw",
|
||||
"useraccounts-ro", "useraccounts-rw", "datastore", "logging-write",
|
||||
|
@ -116,13 +107,9 @@ options:
|
|||
credentials_file:
|
||||
description:
|
||||
- Path to the JSON file associated with the service account email
|
||||
default: null
|
||||
required: false
|
||||
project_id:
|
||||
description:
|
||||
- Your GCP project ID
|
||||
required: false
|
||||
default: null
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue