Class: Ansible::Ruby::Modules::Nxos_gir

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

Overview

Trigger a graceful removal or insertion (GIR) of the switch.

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

#state ⇒ :present, :absent

Returns Specify desired state of the resource.

Returns:

  • (:present, :absent) —

    Specify desired state of the resource.



32
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_gir.rb', line 32

attribute :state

#system_mode_maintenance ⇒ Symbol?

Returns When C(system_mode_maintenance=true) it puts all enabled protocols in maintenance mode (using the isolate command). When C(system_mode_maintenance=false) it puts all enabled protocols in normal mode (using the no isolate command).

Returns:

  • (Symbol, nil) —

    When C(system_mode_maintenance=true) it puts all enabled protocols in maintenance mode (using the isolate command). When C(system_mode_maintenance=false) it puts all enabled protocols in normal mode (using the no isolate command).



12
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_gir.rb', line 12

attribute :system_mode_maintenance

#system_mode_maintenance_dont_generate_profile ⇒ Symbol?

Returns When C(system_mode_maintenance_dont_generate_profile=true) it prevents the dynamic searching of enabled protocols and executes commands configured in a maintenance-mode profile. Use this option if you want the system to use a maintenance-mode profile that you have created. When C(system_mode_maintenance_dont_generate_profile=false) it prevents the dynamic searching of enabled protocols and executes commands configured in a normal-mode profile. Use this option if you want the system to use a normal-mode profile that you have created.

Returns:

  • (Symbol, nil) —

    When C(system_mode_maintenance_dont_generate_profile=true) it prevents the dynamic searching of enabled protocols and executes commands configured in a maintenance-mode profile. Use this option if you want the system to use a maintenance-mode profile that you have created. When C(system_mode_maintenance_dont_generate_profile=false) it prevents the dynamic searching of enabled protocols and executes commands configured in a normal-mode profile. Use this option if you want the system to use a normal-mode profile that you have created.



16
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_gir.rb', line 16

attribute :system_mode_maintenance_dont_generate_profile

#system_mode_maintenance_on_reload_reset_reason ⇒ :hw_error, ...

Returns Boots the switch into maintenance mode automatically in the event of a specified system crash. Note that not all reset reasons are applicable for all platforms. Also if reset reason is set to match_any, it is not idempotent as it turns on all reset reasons. If reset reason is match_any and state is absent, it turns off all the reset reasons.

Returns:

  • (:hw_error, :svc_failure, :kern_failure, :wdog_timeout, :fatal_error, :lc_failure, :match_any, :manual_reload, :any_other, :maintenance, nil) —

    Boots the switch into maintenance mode automatically in the event of a specified system crash. Note that not all reset reasons are applicable for all platforms. Also if reset reason is set to match_any, it is not idempotent as it turns on all reset reasons. If reset reason is match_any and state is absent, it turns off all the reset reasons.



28
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_gir.rb', line 28

attribute :system_mode_maintenance_on_reload_reset_reason

#system_mode_maintenance_shutdown ⇒ Symbol?

Returns Shuts down all protocols, vPC domains, and interfaces except the management interface (using the shutdown command). This option is disruptive while C(system_mode_maintenance) (which uses the isolate command) is not.

Returns:

  • (Symbol, nil) —

    Shuts down all protocols, vPC domains, and interfaces except the management interface (using the shutdown command). This option is disruptive while C(system_mode_maintenance) (which uses the isolate command) is not.



24
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_gir.rb', line 24

attribute :system_mode_maintenance_shutdown

#system_mode_maintenance_timeout ⇒ Integer?

Returns Keeps the switch in maintenance mode for a specified number of minutes. Range is 5-65535.

Returns:

  • (Integer, nil) —

    Keeps the switch in maintenance mode for a specified number of minutes. Range is 5-65535.



20
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_gir.rb', line 20

attribute :system_mode_maintenance_timeout