google.cloud.gcp_compute_resource_policy module – Creates a GCP ResourcePolicy
Note
This module is part of the google.cloud collection (version 1.4.1).
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.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: google.cloud.gcp_compute_resource_policy.
Note
The google.cloud collection will be removed from Ansible 12 due to violations of the Ansible inclusion requirements. The collection has unresolved sanity test failures. See the discussion thread for more information.
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 |
Comments |
|---|---|
An OAuth2 access token if credential type is accesstoken. |
|
The type of credential used. Choices:
|
|
An optional description of this resource. Provide this property when you create the resource. |
|
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. |
|
Resource policy for instances used for placement configuration. |
|
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 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” |
|
Number of vms in this placement group. |
|
Resource policy for scheduling instance operations. |
|
The expiration time of the schedule. The timestamp is an RFC3339 string. |
|
The start time of the schedule. The timestamp is an RFC3339 string. |
|
Specifies the time zone to be used in interpreting the schedule. The value of this field must be a time zone name from the tz database: http://en.wikipedia.org/wiki/Tz_database. |
|
Specifies the schedule for starting instances. |
|
Specifies the frequency for the operation, using the unix-cron format. |
|
Specifies the schedule for stopping instances. |
|
Specifies the frequency for the operation, using the unix-cron format. |
|
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. |
|
The Google Cloud Platform project to use. |
|
Region where resource policy resides. |
|
Array of scopes to be used |
|
The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it. |
|
An optional service account email address if machineaccount is selected and the user does not wish to use the default email. |
|
The path of a Service Account JSON file if serviceaccount is selected as type. |
|
Policy for creating snapshots of persistent disks. |
|
Retention policy applied to snapshots created by this resource policy. |
|
Maximum age of the snapshot that is allowed to be kept. |
|
Specifies the behavior to apply to scheduled snapshots when the source disk is deleted. Some valid choices include: “KEEP_AUTO_SNAPSHOTS”, “APPLY_RETENTION_POLICY” Default: |
|
Contains one of an `hourlySchedule`, `dailySchedule`, or `weeklySchedule`. |
|
The policy will execute every nth day at the specified time. |
|
The number of days between snapshots. |
|
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. |
|
The policy will execute every nth hour starting at the specified time. |
|
The number of hours between snapshots. |
|
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 . |
|
Allows specifying a snapshot time for each day of the week. |
|
May contain up to seven (one for each day of the week) snapshot times. |
|
The day of the week to create the snapshot. e.g. MONDAY . Some valid choices include: “MONDAY”, “TUESDAY”, “WEDNESDAY”, “THURSDAY”, “FRIDAY”, “SATURDAY”, “SUNDAY” |
|
Time within the window to start the operations. It must be in format “HH:MM”, where HH : [00-23] and MM : [00-00] GMT. |
|
Properties with which the snapshots are created, such as labels. |
|
Whether to perform a ‘guest aware’ snapshot. Choices:
|
|
A set of key-value pairs. |
|
Cloud Storage bucket location to store the auto snapshot (regional or multi-regional) . |
|
Whether the given object should exist in GCP Choices:
|
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 |
Description |
|---|---|
An optional description of this resource. Provide this property when you create the resource. Returned: success |
|
Resource policy for instances used for placement configuration. Returned: 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 . Returned: 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. Returned: success |
|
Number of vms in this placement group. Returned: success |
|
Resource policy for scheduling instance operations. Returned: success |
|
The expiration time of the schedule. The timestamp is an RFC3339 string. Returned: success |
|
The start time of the schedule. The timestamp is an RFC3339 string. Returned: success |
|
Specifies the time zone to be used in interpreting the schedule. The value of this field must be a time zone name from the tz database: http://en.wikipedia.org/wiki/Tz_database. Returned: success |
|
Specifies the schedule for starting instances. Returned: success |
|
Specifies the frequency for the operation, using the unix-cron format. Returned: success |
|
Specifies the schedule for stopping instances. Returned: success |
|
Specifies the frequency for the operation, using the unix-cron format. Returned: 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. Returned: success |
|
Region where resource policy resides. Returned: success |
|
Policy for creating snapshots of persistent disks. Returned: success |
|
Retention policy applied to snapshots created by this resource policy. Returned: success |
|
Maximum age of the snapshot that is allowed to be kept. Returned: success |
|
Specifies the behavior to apply to scheduled snapshots when the source disk is deleted. Returned: success |
|
Contains one of an `hourlySchedule`, `dailySchedule`, or `weeklySchedule`. Returned: success |
|
The policy will execute every nth day at the specified time. Returned: success |
|
The number of days between snapshots. Returned: 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. Returned: success |
|
The policy will execute every nth hour starting at the specified time. Returned: success |
|
The number of hours between snapshots. Returned: 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 . Returned: success |
|
Allows specifying a snapshot time for each day of the week. Returned: success |
|
May contain up to seven (one for each day of the week) snapshot times. Returned: success |
|
The day of the week to create the snapshot. e.g. MONDAY . Returned: 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. Returned: success |
|
Properties with which the snapshots are created, such as labels. Returned: success |
|
Whether to perform a ‘guest aware’ snapshot. Returned: success |
|
A set of key-value pairs. Returned: success |
|
Cloud Storage bucket location to store the auto snapshot (regional or multi-regional) . Returned: success |