novalink_registration – Register or unregister a NovaLink host in IBM PowerVC.
Synopsis
Register or unregister a NovaLink managed host in IBM PowerVC.
Parameters
- name (optional, str, None)
Display name of the NovaLink host.
- access_ip (optional, str, None)
Management IP address of the NovaLink host.
- user (optional, str, None)
User ID of the NovaLink host.
- password (optional, str, None)
Password for the NovaLink host user.
- force (optional, bool, False)
Forcefully adds the NovaLink.
- uninstall (optional, bool, False)
Removes the PowerVC software from the host.
- stand_by (optional, bool, False)
Enables standby mode.
- standby_tag (optional, str, unplanned_maintenance)
Tag of the standby Host.
- host_id (optional, str, None)
HYPERVISOR_ID/MTMS of the NovaLink host.
- state (True, str, None)
Desired state of the NovaLink host.
Examples
- name: Register a NovaLink host
hosts: localhost
gather_facts: no
tasks:
- name: Register the NovaLink host
ibm.powervc.novalink_registration:
cloud: "CLOUD"
name: "HOST_DISPLAY_NAME"
access_ip: "IP_ADDRESS"
user: "USER_ID"
password: "PASSWORD"
force: True
state: present
register: output
- debug:
var: output.result
- name: Register a NovaLink host in standby mode
hosts: localhost
gather_facts: no
tasks:
- name: Register the NovaLink host
ibm.powervc.novalink_registration:
cloud: "CLOUD"
name: "HOST_DISPLAY_NAME"
access_ip: "IP_ADDRESS"
user: "USER_ID"
password: "PASSWORD"
stand_by: True
standby_tag: "planned_maintenance"
state: present
register: output
- debug:
var: output.result
- name: Register a NovaLink host using private key
hosts: localhost
gather_facts: no
tasks:
- name: Register the NovaLink host
ibm.powervc.novalink_registration:
cloud: "CLOUD"
name: "HOST_DISPLAY_NAME"
host_type: "HOST_TYPE"
access_ip: "IP_ADDRESS"
user: "USER_ID"
private_key: |
-----BEGIN RSA PRIVATE KEY-----
-------------------------------
-----END RSA PRIVATE KEY-----
state: present
register: output
- debug:
var: output.result
- name: Unregister a NovaLink host
hosts: localhost
gather_facts: no
tasks:
- name: Unregister the NovaLink host
ibm.powervc.novalink_registration:
cloud: "CLOUD"
host_id: "HYPERVISOR_ID/MTMS"
state: absent
register: output
- debug:
var: output.result
- name: Removes the PowerVC software from the NovaLink host
hosts: localhost
gather_facts: no
tasks:
- name: Removes the PowerVC software from host
ibm.powervc.novalink_registration:
cloud: "CLOUD"
host_id: "HYPERVISOR_ID/MTMS"
uninstall: True
state: absent
register: output
- debug:
var: output.result
Status
This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by PowerVC.