zhmc_cpc - Manages a CPC.

Synopsis

• Gathers facts about the CPC including its child resources.
• Updates the properties of a CPC.

Requirements (on host that executes module)

• Network access to HMC
• zhmcclient >=0.20.0
• ansible >=2.2.0.0

Options

parameter	required	default	choices	comments
faked_session	no	Real HMC will be used.		A zhmcclient_mock.FakedSession object that has a mocked HMC set up. If provided, it will be used instead of connecting to a real HMC. This is used for testing purposes only.
hmc_auth	yes			The authentication credentials for the HMC.
	Dictionary object hmc_auth parameter required default choices comments userid yes The userid (username) for authenticating with the HMC. password yes The password for authenticating with the HMC.
hmc_host	yes			The hostname or IP address of the HMC.
log_file	no			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.
name	yes			The name of the target CPC.
properties	no	No property changes.		Only for state=set: New values for the properties of the CPC. Properties omitted in this dictionary will remain unchanged. This parameter will be ignored for state=facts. The parameter is a dictionary. The key of each dictionary item is the property name as specified in the data model for CPC resources, with underscores instead of hyphens. The value of each dictionary item is the property value (in YAML syntax). Integer properties may also be provided as decimal strings. The possible properties in this dictionary are the properties defined as writeable in the data model for CPC resources.
state	yes		set facts	The desired state for the attachment: * set: Ensures that the CPC has the specified properties. * facts: Does not change anything on the CPC and returns the CPC properties including its child resources.

Examples

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

- name: Gather facts about the CPC
  zhmc_cpc:
    hmc_host: "{{ my_hmc_host }}"
    hmc_auth: "{{ my_hmc_auth }}"
    name: "{{ my_cpc_name }}"
    state: facts
  register: cpc1

- name: Ensure the CPC has the desired property values
  zhmc_cpc:
    hmc_host: "{{ my_hmc_host }}"
    hmc_auth: "{{ my_hmc_auth }}"
    name: "{{ my_cpc_name }}"
    state: set
    properties:
      acceptable_status:
       - active
      description: "This is CPC {{ my_cpc_name }}"

Return Values

Common return values are documented here Return Values, the following are the fields unique to this module:

name	description	returned	type	sample
cpc	For state=set|facts, a dictionary with the properties of the CPC. The properties contain these additional artificial properties for listing its child resources: - 'partitions': The defined partitions of the CPC, as a dict of key: partition name, value: dict of a subset of the partition properties (name, status, object_uri). - 'adapters': The adapters of the CPC, as a dict of key: adapter name, value: dict of a subset of the adapter properties (name, status, object_uri).	success	dict	{ "name": "CPCA", "description": "CPC A", "status": "active", "acceptable_status": [ "active" ], ... "partitions": [ { "name": "part-1", ... }, ... ], "adapters": [ { "name": "adapter-1", ... }, ... ], }

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support.

For help in developing on modules, should you be so inclined, please read the contribution guidelines in the module’s source repository, Testing Ansible and Developing Modules.

Shipment

This module is a third-party module and is not shipped with Ansible. See the module’s source repository for details.