ansible / ansible.builtin / v2.9.27 / module / netact_cm_command Manage network configuration data in Nokia Core and Radio networks | "added in version" 2.5 of ansible.builtin" Authors: Harri Tuominen (@hatuomin) preview | supported by communityansible.builtin.netact_cm_command (v2.9.27) — module
pip
Install with pip install ansible==2.9.27
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
# Pass in a message - name: Upload netact_cm_command: operation: "Upload" opsname: 'Uploading_test' dn: "PLMN-PLMN/MRBTS-746" extra_opts: '-btsContentInUse true'
- name: Provision netact_cm_command: operation: "Provision" opsname: 'Provision_test' dn: "PLMN-PLMN/MRBTS-746" planName: 'mySiteTemplate' type: 'actual' createBackupPlan: true backupPlanName: 'myBackupPlanName'
- name: Export and fetching data from target netact_cm_command: operation: "Export" opsname: 'Export_test' planName: 'mySiteTemplate' type: 'actual' fileName: 'exportTest.xml'
- fetch: src: /var/opt/nokia/oss/global/racops/export/exportTest.xml dest: fetched
- name: Import netact_cm_command: operation: "Import" opsname: 'Import_test' fileFormat: 'CSV' type: 'plan' fileName: 'myCSVFile' planName: 'myPlanName' extra_ops: 'enablePolicyPlans true'
# fail the module - name: Test failure of the module netact_cm_command: name: fail me
DN: description: Sets the exact scope of the operation in form of a list of managed object Distinguished Names (DN) in the network. A single DN or a list of DNs can be given (comma separated list without spaces). Alternatively, if DN or a list of DNs is not given, working set (WS) or Maintenance Region (MR) must be provided as parameter to set the scope of operation. required: false MR: description: Sets the scope of the operation to network elements assigned to a Maintenance Region (MR) Value can be set as MR IDs including the Maintenance Region Collection (MRC) information (for example MRC-FIN1/MR-Hel). Multiple MRs can be given (comma-separated list without spaces) The value of this parameter is searched through MR IDs under given MRC. If there is no match, then it is searched from all MR names. Alternatively, if MR ID or a list or MR IDs is not given, Distinguished Name (DN) or Working Set (WS) must be provided as parameter to set the scope of operation. required: false WS: description: Sets the scope of the operation to use one or more pre-defined working sets (WS) in NetAct. A working set contains network elements selected by user according to defined criteria. A single WS name, or multiple WSs can be provided (comma-separated list without spaces). Alternatively, if a WS name or a list of WSs is not given, Distinguished Name (DN) or Maintenance Region(MR) must be provided as parameter to set the scope of operation. required: false opsName: description: - user specified operation name required: false verbose: description: NetAct Configurator will print more info required: false fileName: description: - Specifies a file name. Valid for Import and Export operations. required: false planName: description: - Specifies a plan name. required: false inputFile: description: 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. required: false operation: aliases: - op choices: - upload - provision - import - export - Provision_Mass_Modification description: 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. required: true extra_opts: description: 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. required: false fileFormat: choices: - RAML2 - CSV - XLSX description: Indicates file format. required: false typeOption: aliases: - type choices: - plan - actual - reference - template - siteTemplate description: Specifies the type of the export operation. required: false backupPlanName: description: - Specifies a backup plan name required: false createBackupPlan: description: - Specifies if backup plan generation is enabled. required: false type: bool
changed: description: data changed returned: true if data is changed type: bool message: description: The output message that the netact_cm_command module generates returned: Command output message type: str original_message: description: The original name param that was passed in returned: Command line sample: /opt/oss/bin/racclimx.sh -op Upload -opsName Uploading_testi -DN PLMN-PLMN/MRBTS-746 type: str