google.cloud.gcp_compute_resource_policy – Creates a GCP ResourcePolicy
Note
This plugin is part of the google.cloud collection (version 1.0.2).
You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install google.cloud.
To use it in a playbook, specify: google.cloud.gcp_compute_resource_policy.
Synopsis
- A policy that can be attached to a resource to specify or schedule actions on that resource.
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Parameters
| Parameter | Choices/Defaults | Comments | ||||
|---|---|---|---|---|---|---|
| auth_kind
string / required
|
|
The type of credential used.
|
||||
| env_type
string
|
Specifies which Ansible environment you're running this module within.
This should not be set unless you know what you're doing.
This only alters the User Agent string for any API requests.
|
|||||
| group_placement_policy
dictionary
|
Policy for creating snapshots of persistent disks.
|
|||||
| availability_domain_count
integer
|
The number of availability domains instances will be spread across. If two instances are in different availability domain, they will not be put in the same low latency network .
|
|||||
| collocation
string
|
Collocation specifies whether to place VMs inside the same availability domain on the same low-latency network.
Specify `COLLOCATED` to enable collocation. Can only be specified with `vm_count`. If compute instances are created with a COLLOCATED policy, then exactly `vm_count` instances must be created at the same time with the resource policy attached.
Some valid choices include: "COLLOCATED"
|
|||||
| vm_count
integer
|
Number of vms in this placement group.
|
|||||
| name
string / required
|
The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])`? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
|
|||||
| project
string
|
The Google Cloud Platform project to use.
|
|||||
| region
string / required
|
Region where resource policy resides.
|
|||||
| scopes
list / elements=string
|
Array of scopes to be used
|
|||||
| service_account_contents
jsonarg
|
The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it.
|
|||||
| service_account_email
string
|
An optional service account email address if machineaccount is selected and the user does not wish to use the default email.
|
|||||
| service_account_file
path
|
The path of a Service Account JSON file if serviceaccount is selected as type.
|
|||||
| snapshot_schedule_policy
dictionary
|
Policy for creating snapshots of persistent disks.
|
|||||
| retention_policy
dictionary
|
Retention policy applied to snapshots created by this resource policy.
|
|||||
| max_retention_days
integer / required
|
Maximum age of the snapshot that is allowed to be kept.
|
|||||
| on_source_disk_delete
string
|
Default:
"KEEP_AUTO_SNAPSHOTS"
|
Specifies the behavior to apply to scheduled snapshots when the source disk is deleted.
Some valid choices include: "KEEP_AUTO_SNAPSHOTS", "APPLY_RETENTION_POLICY"
|
||||
| schedule
dictionary / required
|
Contains one of an `hourlySchedule`, `dailySchedule`, or `weeklySchedule`.
|
|||||
| daily_schedule
dictionary
|
The policy will execute every nth day at the specified time.
|
|||||
| days_in_cycle
integer / required
|
The number of days between snapshots.
|
|||||
| start_time
string / required
|
This must be in UTC format that resolves to one of 00:00, 04:00, 08:00, 12:00, 16:00, or 20:00. For example, both 13:00-5 and 08:00 are valid.
|
|||||
| hourly_schedule
dictionary
|
The policy will execute every nth hour starting at the specified time.
|
|||||
| hours_in_cycle
integer / required
|
The number of hours between snapshots.
|
|||||
| start_time
string / required
|
Time within the window to start the operations.
It must be in an hourly format "HH:MM", where HH : [00-23] and MM : [00] GMT.
eg: 21:00 .
|
|||||
| weekly_schedule
dictionary
|
Allows specifying a snapshot time for each day of the week.
|
|||||
| day_of_weeks
list / elements=dictionary / required
|
May contain up to seven (one for each day of the week) snapshot times.
|
|||||
| day
string / required
|
The day of the week to create the snapshot. e.g. MONDAY .
Some valid choices include: "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"
|
|||||
| start_time
string / required
|
Time within the window to start the operations.
It must be in format "HH:MM", where HH : [00-23] and MM : [00-00] GMT.
|
|||||
| snapshot_properties
dictionary
|
Properties with which the snapshots are created, such as labels.
|
|||||
| guest_flush
boolean
|
|
Whether to perform a 'guest aware' snapshot.
|
||||
| labels
dictionary
|
A set of key-value pairs.
|
|||||
| storage_locations
list / elements=string
|
Cloud Storage bucket location to store the auto snapshot (regional or multi-regional) .
|
|||||
| state
string
|
|
Whether the given object should exist in GCP
|
||||
Examples
- name: create a resource policy
google.cloud.gcp_compute_resource_policy:
name: test_object
region: us-central1
snapshot_schedule_policy:
schedule:
daily_schedule:
days_in_cycle: 1
start_time: '04:00'
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
state: present
Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description | ||||
|---|---|---|---|---|---|---|
| groupPlacementPolicy
complex
|
success |
Policy for creating snapshots of persistent disks.
|
||||
| availabilityDomainCount
integer
|
success |
The number of availability domains instances will be spread across. If two instances are in different availability domain, they will not be put in the same low latency network .
|
||||
| collocation
string
|
success |
Collocation specifies whether to place VMs inside the same availability domain on the same low-latency network.
Specify `COLLOCATED` to enable collocation. Can only be specified with `vm_count`. If compute instances are created with a COLLOCATED policy, then exactly `vm_count` instances must be created at the same time with the resource policy attached.
|
||||
| vmCount
integer
|
success |
Number of vms in this placement group.
|
||||
| name
string
|
success |
The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])`? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
|
||||
| region
string
|
success |
Region where resource policy resides.
|
||||
| snapshotSchedulePolicy
complex
|
success |
Policy for creating snapshots of persistent disks.
|
||||
| retentionPolicy
complex
|
success |
Retention policy applied to snapshots created by this resource policy.
|
||||
| maxRetentionDays
integer
|
success |
Maximum age of the snapshot that is allowed to be kept.
|
||||
| onSourceDiskDelete
string
|
success |
Specifies the behavior to apply to scheduled snapshots when the source disk is deleted.
|
||||
| schedule
complex
|
success |
Contains one of an `hourlySchedule`, `dailySchedule`, or `weeklySchedule`.
|
||||
| dailySchedule
complex
|
success |
The policy will execute every nth day at the specified time.
|
||||
| daysInCycle
integer
|
success |
The number of days between snapshots.
|
||||
| startTime
string
|
success |
This must be in UTC format that resolves to one of 00:00, 04:00, 08:00, 12:00, 16:00, or 20:00. For example, both 13:00-5 and 08:00 are valid.
|
||||
| hourlySchedule
complex
|
success |
The policy will execute every nth hour starting at the specified time.
|
||||
| hoursInCycle
integer
|
success |
The number of hours between snapshots.
|
||||
| startTime
string
|
success |
Time within the window to start the operations.
It must be in an hourly format "HH:MM", where HH : [00-23] and MM : [00] GMT.
eg: 21:00 .
|
||||
| weeklySchedule
complex
|
success |
Allows specifying a snapshot time for each day of the week.
|
||||
| dayOfWeeks
complex
|
success |
May contain up to seven (one for each day of the week) snapshot times.
|
||||
| day
string
|
success |
The day of the week to create the snapshot. e.g. MONDAY .
|
||||
| startTime
string
|
success |
Time within the window to start the operations.
It must be in format "HH:MM", where HH : [00-23] and MM : [00-00] GMT.
|
||||
| snapshotProperties
complex
|
success |
Properties with which the snapshots are created, such as labels.
|
||||
| guestFlush
boolean
|
success |
Whether to perform a 'guest aware' snapshot.
|
||||
| labels
dictionary
|
success |
A set of key-value pairs.
|
||||
| storageLocations
list / elements=string
|
success |
Cloud Storage bucket location to store the auto snapshot (regional or multi-regional) .
|
||||
Authors
- Google Inc. (@googlecloudplatform)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/google/cloud/gcp_compute_resource_policy_module.html