You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

google.cloud.gcp_compute_resource_policy module – Creates a GCP ResourcePolicy

Note

This module is part of the google.cloud collection (version 1.3.0).

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.

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
access_token string	An OAuth2 access token if credential type is accesstoken.
auth_kind string / required	The type of credential used. Choices: `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
description string	An optional description of this resource. Provide this property when you create the resource.
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	Resource policy for instances used for placement configuration.
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.
instance_schedule_policy dictionary	Resource policy for scheduling instance operations.
expiration_time string	The expiration time of the schedule. The timestamp is an RFC3339 string.
start_time string	The start time of the schedule. The timestamp is an RFC3339 string.
time_zone string / required	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.
vm_start_schedule dictionary	Specifies the schedule for starting instances.
schedule string / required	Specifies the frequency for the operation, using the unix-cron format.
vm_stop_schedule dictionary	Specifies the schedule for stopping instances.
schedule string / required	Specifies the frequency for the operation, using the unix-cron format.
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	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: `"KEEP_AUTO_SNAPSHOTS"`
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. Choices: `false` `true`
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 Choices: `"present"` ← (default) `"absent"`

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
description string	An optional description of this resource. Provide this property when you create the resource. Returned: success
groupPlacementPolicy complex	Resource policy for instances used for placement configuration. Returned: success
availabilityDomainCount 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 . Returned: success
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. Returned: success
vmCount integer	Number of vms in this placement group. Returned: success
instanceSchedulePolicy complex	Resource policy for scheduling instance operations. Returned: success
expirationTime string	The expiration time of the schedule. The timestamp is an RFC3339 string. Returned: success
startTime string	The start time of the schedule. The timestamp is an RFC3339 string. Returned: success
timeZone 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. Returned: success
vmStartSchedule complex	Specifies the schedule for starting instances. Returned: success
schedule string	Specifies the frequency for the operation, using the unix-cron format. Returned: success
vmStopSchedule complex	Specifies the schedule for stopping instances. Returned: success
schedule string	Specifies the frequency for the operation, using the unix-cron format. Returned: success
name string	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 string	Region where resource policy resides. Returned: success
snapshotSchedulePolicy complex	Policy for creating snapshots of persistent disks. Returned: success
retentionPolicy complex	Retention policy applied to snapshots created by this resource policy. Returned: success
maxRetentionDays integer	Maximum age of the snapshot that is allowed to be kept. Returned: success
onSourceDiskDelete string	Specifies the behavior to apply to scheduled snapshots when the source disk is deleted. Returned: success
schedule complex	Contains one of an `hourlySchedule`, `dailySchedule`, or `weeklySchedule`. Returned: success
dailySchedule complex	The policy will execute every nth day at the specified time. Returned: success
daysInCycle integer	The number of days between snapshots. Returned: success
startTime string	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
hourlySchedule complex	The policy will execute every nth hour starting at the specified time. Returned: success
hoursInCycle integer	The number of hours between snapshots. Returned: success
startTime string	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
weeklySchedule complex	Allows specifying a snapshot time for each day of the week. Returned: success
dayOfWeeks complex	May contain up to seven (one for each day of the week) snapshot times. Returned: success
day string	The day of the week to create the snapshot. e.g. MONDAY . Returned: success
startTime string	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
snapshotProperties complex	Properties with which the snapshots are created, such as labels. Returned: success
guestFlush boolean	Whether to perform a ‘guest aware’ snapshot. Returned: success
labels dictionary	A set of key-value pairs. Returned: success
storageLocations list / elements=string	Cloud Storage bucket location to store the auto snapshot (regional or multi-regional) . Returned: success

Authors

Google Inc. (@googlecloudplatform)

google.cloud.gcp_compute_resource_policy module – Creates a GCP ResourcePolicy

Synopsis

Requirements

Parameters

Examples

Return Values