zhmc_hba – Create HBAs in partitions

Synopsis 

Create, update, or delete an HBA (virtual Host Bus Adapter) in a partition of a CPC (Z system).
Note that the Ansible module zhmc_partition can be used to gather facts about existing HBAs of a partition.

Requirements 

The targeted Z system must be a z13 generation and must be in the Dynamic Partition Manager (DPM) operational mode. The z14 and later generations in DPM mode manage HBAs automatically via the “dpm-storage-management” firmware feature.
The HMC userid must have these task permissions: ‘Partition Details’.
The HMC userid must have object-access permissions to these objects: Partitions of the target HBAs, CPCs of these partitions, storage adapters backing the target HBAs.

Dictionary with input properties for the HBA, for state=present. Key is the property name with underscores instead of hyphens, and value is the property value in YAML syntax. Integer properties may also be provided as decimal strings. Will be ignored for state=absent.

The possible input properties in this dictionary are the properties defined as writeable in the data model for HBA resources (where the property names contain underscores instead of hyphens), with the following exceptions:

name: Cannot be specified because the name has already been specified in the name module parameter.
adapter_port_uri: Cannot be specified because this information is specified using the artificial properties adapter_name and adapter_port.
adapter_name: The name of the adapter that has the port backing the target HBA. Cannot be changed after the HBA exists.
adapter_port: The port index of the adapter port backing the target HBA. Cannot be changed after the HBA exists.

Properties omitted in this dictionary will remain unchanged when the HBA already exists, and will get the default value defined in the data model for HBAs when the HBA is being created.

required: False

type: dict

log_file

File path of a log file to which the logic flow of this module as well as interactions with the HMC are logged. If null, logging will be propagated to the Python root logger.

required: False

type: str

Examples 

---
# Note: The following examples assume that some variables named 'my_*' are set.

- name: Ensure HBA exists in the partition
  zhmc_partition:
    hmc_host: "{{ my_hmc_host }}"
    hmc_auth: "{{ my_hmc_auth }}"
    cpc_name: "{{ my_cpc_name }}"
    partition_name: "{{ my_partition_name }}"
    name: "{{ my_hba_name }}"
    state: present
    properties:
      adapter_name: FCP-1
      adapter_port: 0
      description: "The port to our V7K #1"
      device_number: "123F"
  register: hba1

- name: Ensure HBA does not exist in the partition
  zhmc_partition:
    hmc_host: "{{ my_hmc_host }}"
    hmc_auth: "{{ my_hmc_auth }}"
    cpc_name: "{{ my_cpc_name }}"
    partition_name: "{{ my_partition_name }}"
    name: "{{ my_hba_name }}"
    state: absent

Return Values 

changed

Indicates if any change has been made by the module. For state=facts, always will be false.

returned: always

type: bool

msg

An error message that describes the failure.

returned: failure

type: str

hba

For state=absent, an empty dictionary.

For state=present, the resource properties of the HBA after any changes.

returned: success

type: dict

name: HBA name

type: str
{property}: Additional properties of the HBA, as described in the data model of the ‘HBA’ element object of the ‘Partition’ object in the HMC API book. The property names have hyphens (-) as described in that book.

zhmc_hba – Create HBAs in partitions

Synopsis

Requirements

Parameters

Examples

Return Values

Synopsis 

Requirements 

Parameters 

Examples 

Return Values 