Quickstart

After installing the collection outlined in the installation guide, you can access the collection and the ansible-doc covered in the following topics:

ansible user

Modules included in this collection require administrator rights to run. It is recommended to create an ansible user with the proper level of privilege on the VIOS like this:

$ oem_setup_env
# mkuser roles=PAdmin,CacheAdm,FSAdmin,pkgadm \
       default_roles=PAdmin,CacheAdm,FSAdmin,pkgadm ansible

To connect to the VIOS using this ansible user, specify user: ansible in the playbook or ansible_user=ansible in the inventory.

ibm.power_vios

After the collection is installed, you can access the collection content for a playbook by referencing the namespace ibm and the collection’s fully qualified name power_vios. For example:

- hosts: all

tasks:
- name: Query and install latest updates
  ibm.power_vios.suma:
      oslevel: 'latest'

In Ansible 2.9, the collections keyword was added to reduce the need to refer to the collection repeatedly. For example, you can use the collections keyword in your playbook:

- hosts: all
  collections:
  - ibm.power_vios

tasks:
- name: Query and install latest updates
  suma:
      oslevel: 'latest'

ansible-doc

Modules included in this collection provide additional documentation that is similar to a UNIX-like operating system man page (manual page). This documentation can be accessed from the command line by using the ansible-doc command.

Here’s how to use the ansible-doc command after you install the IBM Power Systems VIOS collection: ansible-doc ibm.power_vios.suma

> SUMA    (/Users/user/.ansible/collections/ansible_collections/ibm/power_vios/plugins/modules/suma.py)

    Creates a task to automate the download and installation of
    technology level (TL) and service packs (SP) from a fix server
    using the Service Update Management Assistant (SUMA).

* This module is maintained by The Ansible Community
OPTIONS (= is mandatory):

For more information on using the ansible-doc command, refer to the Ansible guide.