Class: Ansible::Ruby::Modules::Cs_snapshot_policy

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_snapshot_policy.rb

Overview

Create, update and delete volume snapshot policies.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#account ⇒ Object?

Returns Account the volume is related to.

Returns:

  • (Object, nil) —

    Account the volume is related to.



54
 
# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_snapshot_policy.rb', line 54

attribute :account

#device_id ⇒ Integer?

Returns ID of the device on a VM the volume is attached to.,This will only be considered if VM has multiple DATADISK volumes.

Returns:

  • (Integer, nil) —

    ID of the device on a VM the volume is attached to.,This will only be considered if VM has multiple DATADISK volumes.



24
 
# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_snapshot_policy.rb', line 24

attribute :device_id

#domain ⇒ Object?

Returns Domain the volume is related to.

Returns:

  • (Object, nil) —

    Domain the volume is related to.



51
 
# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_snapshot_policy.rb', line 51

attribute :domain

#interval_type ⇒ :hourly, ...

Returns Interval of the snapshot.

Returns:

  • (:hourly, :daily, :weekly, :monthly, nil) —

    Interval of the snapshot.



31
 
# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_snapshot_policy.rb', line 31

attribute :interval_type

#max_snaps ⇒ Integer?

Returns Max number of snapshots.

Returns:

  • (Integer, nil) —

    Max number of snapshots.



35
 
# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_snapshot_policy.rb', line 35

attribute :max_snaps

#project ⇒ Object?

Returns Name of the project the volume is related to.

Returns:

  • (Object, nil) —

    Name of the project the volume is related to.



57
 
# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_snapshot_policy.rb', line 57

attribute :project

#schedule ⇒ String?

Returns Time the snapshot is scheduled. Required if C(state=present).,Format for C(interval_type=HOURLY): C(MM),Format for C(interval_type=DAILY): C(MM:HH),Format for C(interval_type=WEEKLY): C(MM:HH:DD (1-7)),Format for C(interval_type=MONTHLY): C(MM:HH:DD (1-28)).

Returns:

  • (String, nil) —

    Time the snapshot is scheduled. Required if C(state=present).,Format for C(interval_type=HOURLY): C(MM),Format for C(interval_type=DAILY): C(MM:HH),Format for C(interval_type=WEEKLY): C(MM:HH:DD (1-7)),Format for C(interval_type=MONTHLY): C(MM:HH:DD (1-28))



39
 
# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_snapshot_policy.rb', line 39

attribute :schedule

#state ⇒ :present, ...

Returns State of the snapshot policy.

Returns:

  • (:present, :absent, nil) —

    State of the snapshot policy.



47
 
# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_snapshot_policy.rb', line 47

attribute :state

#time_zone ⇒ String?

Returns Specifies a timezone for this command.

Returns:

  • (String, nil) —

    Specifies a timezone for this command.



43
 
# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_snapshot_policy.rb', line 43

attribute :time_zone

#vm ⇒ String?

Returns Name of the instance to select the volume from.,Use C(volume_type) if VM has a DATADISK and ROOT volume.,In case of C(volume_type=DATADISK), additionally use C(device_id) if VM has more than one DATADISK volume.,Either C(volume) or C(vm) is required.

Returns:

  • (String, nil) —

    Name of the instance to select the volume from.,Use C(volume_type) if VM has a DATADISK and ROOT volume.,In case of C(volume_type=DATADISK), additionally use C(device_id) if VM has more than one DATADISK volume.,Either C(volume) or C(vm) is required.



20
 
# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_snapshot_policy.rb', line 20

attribute :vm

#volume ⇒ String?

Returns Name of the volume.,Either C(volume) or C(vm) is required.

Returns:

  • (String, nil) —

    Name of the volume.,Either C(volume) or C(vm) is required.



12
 
# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_snapshot_policy.rb', line 12

attribute :volume

#volume_type ⇒ :DATADISK, ...

Returns Type of the volume.

Returns:

  • (:DATADISK, :ROOT, nil) —

    Type of the volume.



16
 
# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_snapshot_policy.rb', line 16

attribute :volume_type

#vpc ⇒ Object?

Returns Name of the vpc the instance is deployed in.

Returns:

  • (Object, nil) —

    Name of the vpc the instance is deployed in.



28
 
# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_snapshot_policy.rb', line 28

attribute :vpc