Class: Ansible::Ruby::Modules::Bigip_device_group

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

Overview

Managing device groups allows you to create HA pairs and clusters of BIG-IP devices. Usage of this module should be done in conjunction with the C(bigip_configsync_actions) to sync configuration across the pair or cluster if auto-sync is disabled.

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

#auto_sync ⇒ Symbol?

Returns Indicates whether configuration synchronization occurs manually or automatically.,When creating a new device group, this option will default to C(no).

Returns:

  • (Symbol, nil) —

    Indicates whether configuration synchronization occurs manually or automatically.,When creating a new device group, this option will default to C(no).



23
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_device_group.rb', line 23

attribute :auto_sync

#description ⇒ Object?

Returns Description of the device group.

Returns:

  • (Object, nil) —

    Description of the device group.



20
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_device_group.rb', line 20

attribute :description

#full_sync ⇒ Symbol?

Returns Specifies whether the system synchronizes the entire configuration during synchronization operations.,When C(no), the system performs incremental synchronization operations, based on the cache size specified in C(max_incremental_sync_size).,Incremental configuration synchronization is a mechanism for synchronizing a device-group’s configuration among its members, without requiring a full configuration load for each configuration change.,In order for this to work, all devices in the device-group must initially agree on the configuration. Typically this requires at least one full configuration load to each device.,When creating a new device group, this option will default to C(no).

Returns:

  • (Symbol, nil) —

    Specifies whether the system synchronizes the entire configuration during synchronization operations.,When C(no), the system performs incremental synchronization operations, based on the cache size specified in C(max_incremental_sync_size).,Incremental configuration synchronization is a mechanism for synchronizing a device-group’s configuration among its members, without requiring a full configuration load for each configuration change.,In order for this to work, all devices in the device-group must initially agree on the configuration. Typically this requires at least one full configuration load to each device.,When creating a new device group, this option will default to C(no).



31
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_device_group.rb', line 31

attribute :full_sync

#max_incremental_sync_size ⇒ Object?

Returns Specifies the size of the changes cache for incremental sync.,For example, using the default, if you make more than 1024 KB worth of incremental changes, the system performs a full synchronization operation.,Using incremental synchronization operations can reduce the per-device sync/load time for configuration changes.,This setting is relevant only when C(full_sync) is C(no).

Returns:

  • (Object, nil) —

    Specifies the size of the changes cache for incremental sync.,For example, using the default, if you make more than 1024 KB worth of incremental changes, the system performs a full synchronization operation.,Using incremental synchronization operations can reduce the per-device sync/load time for configuration changes.,This setting is relevant only when C(full_sync) is C(no).



35
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_device_group.rb', line 35

attribute :max_incremental_sync_size

#name ⇒ String

Returns Specifies the name of the device group.

Returns:

  • (String) —

    Specifies the name of the device group.



12
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_device_group.rb', line 12

attribute :name

#network_failover ⇒ Symbol?

Returns Indicates whether failover occurs over the network or is hard-wired.,This parameter is only valid for C(type)‘s that are C(sync-failover).

Returns:

  • (Symbol, nil) —

    Indicates whether failover occurs over the network or is hard-wired.,This parameter is only valid for C(type)‘s that are C(sync-failover).



42
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_device_group.rb', line 42

attribute :network_failover

#save_on_auto_sync ⇒ Symbol?

Returns When performing an auto-sync, specifies whether the configuration will be saved or not.,When C(no), only the running configuration will be changed on the device(s) being synced to.,When creating a new device group, this option will default to C(no).

Returns:

  • (Symbol, nil) —

    When performing an auto-sync, specifies whether the configuration will be saved or not.,When C(no), only the running configuration will be changed on the device(s) being synced to.,When creating a new device group, this option will default to C(no).



27
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_device_group.rb', line 27

attribute :save_on_auto_sync

#state ⇒ :present, ...

Returns When C(state) is C(present), ensures the device group exists.,When C(state) is C(absent), ensures that the device group is removed.

Returns:

  • (:present, :absent, nil) —

    When C(state) is C(present), ensures the device group exists.,When C(state) is C(absent), ensures that the device group is removed.



38
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_device_group.rb', line 38

attribute :state

#type ⇒ :"sync-failover", ...

Returns Specifies that the type of group.,A C(sync-failover) device group contains devices that synchronize their configuration data and fail over to one another when a device becomes unavailable.,A C(sync-only) device group has no such failover. When creating a new device group, this option will default to C(sync-only).,This setting cannot be changed once it has been set.

Returns:

  • (:"sync-failover", :"sync-only", nil) —

    Specifies that the type of group.,A C(sync-failover) device group contains devices that synchronize their configuration data and fail over to one another when a device becomes unavailable.,A C(sync-only) device group has no such failover. When creating a new device group, this option will default to C(sync-only).,This setting cannot be changed once it has been set.



16
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_device_group.rb', line 16

attribute :type