Class: Ansible::Ruby::Modules::Aci_config_snapshot

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/network/aci/aci_config_snapshot.rb

Overview

Manage Config Snapshots on Cisco ACI fabrics. Creating new Snapshots is done using the configExportP class. Removing Snapshots is done using the configSnapshot class.

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

#description ⇒ String?

Returns The description for the Config Export Policy.

Returns:

  • (String, nil) —

    The description for the Config Export Policy.



14
 
# File 'lib/ansible/ruby/modules/generated/network/aci/aci_config_snapshot.rb', line 14

attribute :description

#export_policy ⇒ String?

Returns The name of the Export Policy to use for Config Snapshots.

Returns:

  • (String, nil) —

    The name of the Export Policy to use for Config Snapshots.



18
 
# File 'lib/ansible/ruby/modules/generated/network/aci/aci_config_snapshot.rb', line 18

attribute :export_policy

#format ⇒ :json, ...

Returns Sets the config backup to be formatted in JSON or XML.,The APIC defaults to C(json) when unset.

Returns:

  • (:json, :xml, nil) —

    Sets the config backup to be formatted in JSON or XML.,The APIC defaults to C(json) when unset.



22
 
# File 'lib/ansible/ruby/modules/generated/network/aci/aci_config_snapshot.rb', line 22

attribute :format

#include_secure ⇒ Symbol?

Returns Determines if secure information should be included in the backup.,The APIC defaults to C(yes) when unset.

Returns:

  • (Symbol, nil) —

    Determines if secure information should be included in the backup.,The APIC defaults to C(yes) when unset.



26
 
# File 'lib/ansible/ruby/modules/generated/network/aci/aci_config_snapshot.rb', line 26

attribute :include_secure

#max_count ⇒ Integer?

Returns Determines how many snapshots can exist for the Export Policy before the APIC starts to rollover.,Accepted values range between C(1) and C(10).,The APIC defaults to C(3) when unset.

Returns:

  • (Integer, nil) —

    Determines how many snapshots can exist for the Export Policy before the APIC starts to rollover.,Accepted values range between C(1) and C(10).,The APIC defaults to C(3) when unset.



30
 
# File 'lib/ansible/ruby/modules/generated/network/aci/aci_config_snapshot.rb', line 30

attribute :max_count

#snapshot ⇒ String?

Returns The name of the snapshot to delete.

Returns:

  • (String, nil) —

    The name of the snapshot to delete.



34
 
# File 'lib/ansible/ruby/modules/generated/network/aci/aci_config_snapshot.rb', line 34

attribute :snapshot

#state ⇒ :absent, ...

Returns Use C(present) or C(absent) for adding or removing.,Use C(query) for listing an object or multiple objects.

Returns:

  • (:absent, :present, :query, nil) —

    Use C(present) or C(absent) for adding or removing.,Use C(query) for listing an object or multiple objects.



38
 
# File 'lib/ansible/ruby/modules/generated/network/aci/aci_config_snapshot.rb', line 38

attribute :state