Class: Ansible::Ruby::Modules::Netact_cm_command

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

Overview

netact_cm_command can be used to run various configuration management operations. This module requires that the target hosts have Nokia NetAct network management system installed. Module will access the Configurator command line interface in NetAct to upload network configuration to NetAct, run configuration export, plan import and configuration provision operations To set the scope of the operation, define Distinguished Name (DN) or Working Set (WS) or Maintenance Region (MR) as input

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

#backupPlanName ⇒ String?

Returns Specifies a backup plan name.

Returns:

  • (String, nil) —

    Specifies a backup plan name



51
 
# File 'lib/ansible/ruby/modules/generated/network/netact/netact_cm_command.rb', line 51

attribute :backupPlanName

#createBackupPlan ⇒ Symbol?

Returns Specifies if backup plan generation is enabled.

Returns:

  • (Symbol, nil) —

    Specifies if backup plan generation is enabled.



47
 
# File 'lib/ansible/ruby/modules/generated/network/netact/netact_cm_command.rb', line 47

attribute :createBackupPlan

#extra_opts ⇒ String?

Returns Extra options to be set for operations. Check Configuration Management > Configuration Management Operating Procedures > Command Line Operations in Nokia NetAct user documentation for further information for extra options.

Returns:

  • (String, nil) —

    Extra options to be set for operations. Check Configuration Management > Configuration Management Operating Procedures > Command Line Operations in Nokia NetAct user documentation for further information for extra options.



58
 
# File 'lib/ansible/ruby/modules/generated/network/netact/netact_cm_command.rb', line 58

attribute :extra_opts

#fileFormat ⇒ :RAML2, ...

Returns Indicates file format.

Returns:

  • (:RAML2, :CSV, :XLSX, nil) —

    Indicates file format.



36
 
# File 'lib/ansible/ruby/modules/generated/network/netact/netact_cm_command.rb', line 36

attribute :fileFormat

#fileName ⇒ String?

Returns Specifies a file name. Valid for Import and Export operations.

Returns:

  • (String, nil) —

    Specifies a file name. Valid for Import and Export operations.



40
 
# File 'lib/ansible/ruby/modules/generated/network/netact/netact_cm_command.rb', line 40

attribute :fileName

#inputFile ⇒ Object?

Returns Specifies full path to plan file location for the import operation. This parameter (inputFile) or the fileName parameter must be filled. If both are present then the inputFile is used.

Returns:

  • (Object, nil) —

    Specifies full path to plan file location for the import operation. This parameter (inputFile) or the fileName parameter must be filled. If both are present then the inputFile is used.



44
 
# File 'lib/ansible/ruby/modules/generated/network/netact/netact_cm_command.rb', line 44

attribute :inputFile

#operation ⇒ :upload, ...

Returns Supported operations allow user to upload actual configuration from the network, to import and provision prepared plans, or export reference or actual configuration for planning purposes. Provision_Mass_Modification enables provisioning the same parameters to multiple network elements. This operation supports modifications only to one object class at a time. With this option NetAct Configurator creates and provisions a plan to the network with the given scope and options.

Returns:

  • (:upload, :provision, :import, :export, :Provision_Mass_Modification) —

    Supported operations allow user to upload actual configuration from the network, to import and provision prepared plans, or export reference or actual configuration for planning purposes. Provision_Mass_Modification enables provisioning the same parameters to multiple network elements. This operation supports modifications only to one object class at a time. With this option NetAct Configurator creates and provisions a plan to the network with the given scope and options.



12
 
# File 'lib/ansible/ruby/modules/generated/network/netact/netact_cm_command.rb', line 12

attribute :operation

#opsName ⇒ Object?

Returns user specified operation name.

Returns:

  • (Object, nil) —

    user specified operation name



16
 
# File 'lib/ansible/ruby/modules/generated/network/netact/netact_cm_command.rb', line 16

attribute :opsName

#planName ⇒ String?

Returns Specifies a plan name.

Returns:

  • (String, nil) —

    Specifies a plan name.



28
 
# File 'lib/ansible/ruby/modules/generated/network/netact/netact_cm_command.rb', line 28

attribute :planName

#typeOption ⇒ :plan, ...

Returns Specifies the type of the export operation.

Returns:

  • (:plan, :actual, :reference, :template, :siteTemplate, nil) —

    Specifies the type of the export operation.



32
 
# File 'lib/ansible/ruby/modules/generated/network/netact/netact_cm_command.rb', line 32

attribute :typeOption

#verbose ⇒ Object?

Returns NetAct Configurator will print more info.

Returns:

  • (Object, nil) —

    NetAct Configurator will print more info



55
 
# File 'lib/ansible/ruby/modules/generated/network/netact/netact_cm_command.rb', line 55

attribute :verbose