From 7cf6462496633c6173a6b3f3ae52b45dfe64057e Mon Sep 17 00:00:00 2001 From: Andreas Maier Date: Sat, 21 Nov 2020 13:27:57 +0100 Subject: [PATCH] Updated the docs using the modified module.rst.j2 template Signed-off-by: Andreas Maier --- docs/modules/zhmc_adapter.html | 177 +++++--- docs/modules/zhmc_cpc.html | 225 +++++++--- docs/modules/zhmc_crypto_attachment.html | 242 +++++++--- docs/modules/zhmc_hba.html | 148 +++--- docs/modules/zhmc_nic.html | 147 +++--- docs/modules/zhmc_partition.html | 235 ++++++---- docs/modules/zhmc_storage_group.html | 283 ++++++++---- .../zhmc_storage_group_attachment.html | 153 ++++--- docs/modules/zhmc_storage_volume.html | 171 ++++--- docs/modules/zhmc_user.html | 159 ++++--- docs/modules/zhmc_virtual_function.html | 147 +++--- docs/searchindex.js | 2 +- docs_source/modules/zhmc_adapter.rst | 321 +++++++------ docs_source/modules/zhmc_cpc.rst | 286 ++++++++---- .../modules/zhmc_crypto_attachment.rst | 385 ++++++++++------ docs_source/modules/zhmc_hba.rst | 214 +++++---- docs_source/modules/zhmc_nic.rst | 213 +++++---- docs_source/modules/zhmc_partition.rst | 420 +++++++++++------- docs_source/modules/zhmc_storage_group.rst | 389 ++++++++++------ .../modules/zhmc_storage_group_attachment.rst | 202 +++++---- docs_source/modules/zhmc_storage_volume.rst | 241 ++++++---- docs_source/modules/zhmc_user.rst | 244 ++++++---- docs_source/modules/zhmc_virtual_function.rst | 209 +++++---- 23 files changed, 3316 insertions(+), 1897 deletions(-) diff --git a/docs/modules/zhmc_adapter.html b/docs/modules/zhmc_adapter.html index e9e8ce9a2..4bf062e3e 100644 --- a/docs/modules/zhmc_adapter.html +++ b/docs/modules/zhmc_adapter.html @@ -87,14 +87,9 @@
  • All modules
    • zhmc_adapter – Update adapters and create Hipersocket adapters
    • zhmc_cpc – Update CPCs
      • @@ -153,6 +148,8 @@ + +
        @@ -167,6 +164,11 @@
      • + + + Edit on GitHub + +
        • @@ -183,59 +185,84 @@

        Synopsis

        -

        Gather facts about an adapter of a CPC (Z system), including its ports.

        -

        Update the properties of an adapter and its ports.

        -

        Create or delete a Hipersocket adapter.

        -
        -
        -

        Requirements

        -

        The below requirements are needed on the host that executes this module.

          -

        • Access to the WS API of the HMC of the targeted Z system (see HMC API). The targeted Z system must be in the Dynamic Partition Manager (DPM) operational mode.

          • +

        • Gather facts about an adapter of a CPC (Z system), including its ports.

          • +

        • Update the properties of an adapter and its ports.

          • +

        • Create or delete a Hipersocket adapter.

        -

        Parameters

        -
        -
        -
        hmc_host (True, str, None)

        The hostname or IP address of the HMC.

        +

        Parameters

        +
        +
        hmc_host

        The hostname or IP address of the HMC.

        +
        +
        required: True
        +
        type: str
        +
        -
        hmc_auth (True, dict, None)

        The authentication credentials for the HMC, as a dictionary of userid, password.

        -
        -
        userid (True, str, None)

        The userid (username) for authenticating with the HMC.

        +
        hmc_auth

        The authentication credentials for the HMC, as a dictionary of userid, password.

        +
        +
        required: True
        +
        type: dict
        +
        +
        +
        userid

        The userid (username) for authenticating with the HMC.

        +
        +
        required: True
        +
        type: str
        +
        -
        password (True, str, None)

        The password for authenticating with the HMC.

        +
        password

        The password for authenticating with the HMC.

        +
        +
        required: True
        +
        type: str
        +
        -
        name (True, str, None)

        The name of the target adapter. In case of renaming an adapter, this is the new name of the adapter.

        +
        name

        The name of the target adapter. In case of renaming an adapter, this is the new name of the adapter.

        +
        +
        required: True
        +
        type: str
        +
        -
        cpc_name (True, str, None)

        The name of the target CPC.

        +
        cpc_name

        The name of the target CPC.

        +
        +
        required: True
        +
        type: str
        +
        -
        match (False, dict, None)

        Only for state=set: Match properties for identifying the target adapter in the set of adapters in the CPC, if an adapter with the name specified in the name module parameter does not exist in that set. This parameter will be ignored otherwise.

        +
        match

        Only for state=set: Match properties for identifying the target adapter in the set of adapters in the CPC, if an adapter with the name specified in the name module parameter does not exist in that set. This parameter will be ignored otherwise.

        Use of this parameter allows renaming an adapter: The name module parameter specifies the new name of the target adapter, and the match module parameter identifies the adapter to be renamed. This can be combined with other property updates by using the properties module parameter.

        The parameter is a dictionary. The key of each dictionary item is the property name as specified in the data model for adapter resources, with underscores instead of hyphens. The value of each dictionary item is the match value for the property (in YAML syntax). Integer properties may also be provided as decimal strings.

        The specified match properties follow the rules of filtering for the zhmcclient library as described in https://python-zhmcclient.readthedocs.io/en/stable/concepts.html#filtering

        The possible match properties are all properties in the data model for adapter resources, including name.

        +
        +
        required: False
        +
        type: dict
        +
        -
        state (True, str, None)

        The desired state for the attachment:

        +
        state

        The desired state for the attachment:

        • set: Ensures that an existing adapter has the specified properties.

        • present: Ensures that a Hipersockets adapter exists and has the specified properties.

        • absent: Ensures that a Hipersockets adapter does not exist.

        • facts: Does not change anything on the adapter and returns the adapter properties including its ports.

        +
        +
        required: True
        +
        type: str
        +
        choices: set, present, absent, facts
        +
        -
        properties (False, dict, None)

        Only for state=set|present: New values for the properties of the adapter. Properties omitted in this dictionary will remain unchanged. This parameter will be ignored for other states.

        +
        properties

        Only for state=set|present: New values for the properties of the adapter. Properties omitted in this dictionary will remain unchanged. This parameter will be ignored for other states.

        The parameter is a dictionary. The key of each dictionary item is the property name as specified in the data model for adapter 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 adapter resources, with the following exceptions:

        +
        +
        required: False
        +
        type: dict
        +
        -
        log_file (False, str, None)

        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.

        +
        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
        +
        -
        faked_session (False, raw, None)

        A zhmcclient_mock.FakedSession object that has a mocked HMC set up. If not null, this session will be used instead of connecting to the HMC specified in hmc_host. This is used for testing purposes only.

        +
        faked_session

        A zhmcclient_mock.FakedSession object that has a mocked HMC set up. If not null, this session will be used instead of connecting to the HMC specified in hmc_host. This is used for testing purposes only.

        +
        +
        required: False
        +
        type: raw
        +
        -
        -

        Examples

        +

        Examples

        ---
 # Note: The following examples assume that some variables named 'my_*' are set.
 
@@ -314,24 +352,56 @@ 
        Examples
-
        Return Values
        
-
        
-
        cpc (success, dict, )
        For state=absent, an empty dictionary.
        
+
        Return Values
        
+
        
+
        
+
        cpc
        
+
        For state=absent, an empty dictionary.
        
 
        For state=set|present|facts, a dictionary with the properties of the adapter, including additional artificial properties as described below.
        
+
        
+
        returned: success
        
+
        type: dict
        
+
        
+
        
 
        
-
        name (, str, )
        Adapter name
        
+
        name
        Adapter name
        
+
        
+
        type: str
        
+
        
 
        
-
        {property} (, any, )
        Additional properties of the adapter, as described in the HMC API (using hyphens (-) in the property names).
        
+
        {property}
        Additional properties of the adapter, as described in the HMC API (using hyphens (-) in the property names).
        
+
        
+
        type:
        
+
        
 
        
-
        ports (, dict, )
        Artificial property for the ports of the adapter, with a subset of its properties.
        
+
        ports
        
+
        Artificial property for the ports of the adapter, with a subset of its properties.
        
+
        
+
        type: dict
        
+
        
+
        
 
        
-
        {name} (, dict, )
        Port name
        
-
        
-
        name (, str, )
        Port name
        
+
        {name}
        
+
        Port name
        
+
        
+
        type: dict
        
+
        
+
        
+
        
+
        name
        Port name
        
+
        
+
        type: str
        
+
        
 
        
-
        status (, str, )
        Status of the port
        
+
        status
        Status of the port
        
+
        
+
        type: str
        
+
        
 
        
-
        element_uri (, str, )
        Canonical URI of the port
        
+
        element_uri
        Canonical URI of the port
        
+
        
+
        type: str
        
+
        
 
        
 
        
 
        
@@ -340,20 +410,7 @@ 
        Return Values
 
        
 
        
-
        
-
        
-
        Status
        
-
          
-
        • This module is guaranteed to have backward compatible interface changes going forward. [stableinterface]
          • 
-
        • This module is maintained by community.
          • 
-
        
-
        
-
        Authors
        
-
          
-
        • Andreas Maier (@andy-maier)
          • 
-
        • Andreas Scheuring (@scheuran)
          • 
-
        
-
        
+
        diff --git a/docs/modules/zhmc_cpc.html b/docs/modules/zhmc_cpc.html index 3692224dc..68f178017 100644 --- a/docs/modules/zhmc_cpc.html +++ b/docs/modules/zhmc_cpc.html @@ -88,14 +88,9 @@
      • zhmc_adapter – Update adapters and create Hipersocket adapters
      • zhmc_cpc – Update CPCs
      • zhmc_crypto_attachment – Attach crypto resources to partitions
        • @@ -153,6 +148,8 @@ + +
          @@ -167,6 +164,11 @@
        • + + + Edit on GitHub + +
          • @@ -183,60 +185,88 @@

          Synopsis

          -

          Gather facts about a CPC (Z system), including its adapters and partitions.

          -

          Update the properties of a CPC.

          -
          -
          -

          Requirements

          -

          The below requirements are needed on the host that executes this module.

            -

          • Access to the WS API of the HMC of the targeted Z system (see HMC API). The targeted Z system must be in the Dynamic Partition Manager (DPM) operational mode

            • +

          • Gather facts about a CPC (Z system), including its adapters and partitions.

            • +

          • Update the properties of a CPC.

          -

          Parameters

          -
          -
          -
          hmc_host (True, str, None)

          The hostname or IP address of the HMC.

          +

          Parameters

          +
          +
          hmc_host

          The hostname or IP address of the HMC.

          +
          +
          required: True
          +
          type: str
          +
          -
          hmc_auth (True, dict, None)

          The authentication credentials for the HMC, as a dictionary of userid, password.

          -
          -
          userid (True, str, None)

          The userid (username) for authenticating with the HMC.

          +
          hmc_auth

          The authentication credentials for the HMC, as a dictionary of userid, password.

          +
          +
          required: True
          +
          type: dict
          +
          +
          +
          userid

          The userid (username) for authenticating with the HMC.

          +
          +
          required: True
          +
          type: str
          +
          -
          password (True, str, None)

          The password for authenticating with the HMC.

          +
          password

          The password for authenticating with the HMC.

          +
          +
          required: True
          +
          type: str
          +
          -
          name (True, str, None)

          The name of the target CPC.

          +
          name

          The name of the target CPC.

          +
          +
          required: True
          +
          type: str
          +
          -
          state (True, str, None)

          The desired state for the attachment:

          +
          state

          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.

          +
          +
          required: True
          +
          type: str
          +
          choices: set, facts
          +
          -
          properties (False, dict, None)

          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.

          +
          properties

          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.

          +
          +
          required: False
          +
          type: dict
          +
          -
          log_file (False, str, None)

          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.

          +
          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
          +
          -
          faked_session (False, raw, None)

          A zhmcclient_mock.FakedSession object that has a mocked HMC set up. If not null, this session will be used instead of connecting to the HMC specified in hmc_host. This is used for testing purposes only.

          +
          faked_session

          A zhmcclient_mock.FakedSession object that has a mocked HMC set up. If not null, this session will be used instead of connecting to the HMC specified in hmc_host. This is used for testing purposes only.

          +
          +
          required: False
          +
          type: raw
          +
          -
          -

          Examples

          +

          Examples

          ---
 # Note: The following examples assume that some variables named 'my_*' are set.
 
@@ -262,51 +292,121 @@ 
          Examples
-
          Return Values
          
-
          
-
          cpc (success, dict, )
          A dictionary with the properties of the CPC, including additional artificial properties as described below.
          
+
          Return Values
          
+
          
+
          
+
          cpc
          
+
          A dictionary with the properties of the CPC, including additional artificial properties as described below.
          
+
          
+
          returned: success
          
+
          type: dict
          
+
          
+
          
 
          
-
          name (, str, )
          CPC name
          
+
          name
          CPC name
          
+
          
+
          type: str
          
+
          
 
          
-
          {property} (, any, )
          Additional properties of the CPC, as described in the HMC API (using hyphens (-) in the property names).
          
+
          {property}
          Additional properties of the CPC, as described in the HMC API (using hyphens (-) in the property names).
          
+
          
+
          type:
          
+
          
 
          
-
          partitions (, dict, )
          Artificial property for the defined partitions of the CPC, with a subset of its properties.
          
+
          partitions
          
+
          Artificial property for the defined partitions of the CPC, with a subset of its properties.
          
+
          
+
          type: dict
          
+
          
+
          
+
          
+
          {name}
          
+
          Partition name
          
+
          
+
          type: dict
          
+
          
+
          
 
          
-
          {name} (, dict, )
          Partition name
          
-
          
-
          name (, str, )
          Partition name
          
+
          name
          Partition name
          
+
          
+
          type: str
          
+
          
 
          
-
          status (, str, )
          Status of the partition
          
+
          status
          Status of the partition
          
+
          
+
          type: str
          
+
          
 
          
-
          object_uri (, str, )
          Canonical URI of the partition
          
+
          object_uri
          Canonical URI of the partition
          
+
          
+
          type: str
          
+
          
 
          
 
          
 
          
 
          
 
          
-
          adapters (, dict, )
          Artificial property for the adapters of the CPC, with a subset of its properties.
          
+
          adapters
          
+
          Artificial property for the adapters of the CPC, with a subset of its properties.
          
+
          
+
          type: dict
          
+
          
+
          
+
          
+
          {name}
          
+
          Adapter name
          
+
          
+
          type: dict
          
+
          
+
          
 
          
-
          {name} (, dict, )
          Adapter name
          
-
          
-
          name (, str, )
          Adapter name
          
+
          name
          Adapter name
          
+
          
+
          type: str
          
+
          
 
          
-
          status (, str, )
          Status of the adapter
          
+
          status
          Status of the adapter
          
+
          
+
          type: str
          
+
          
 
          
-
          object_uri (, str, )
          Canonical URI of the adapter
          
+
          object_uri
          Canonical URI of the adapter
          
+
          
+
          type: str
          
+
          
 
          
 
          
 
          
 
          
 
          
-
          storage-groups (, dict, )
          Artificial property for the storage groups associated with the CPC, with a subset of its properties.
          
+
          storage-groups
          
+
          Artificial property for the storage groups associated with the CPC, with a subset of its properties.
          
+
          
+
          type: dict
          
+
          
+
          
+
          
+
          {name}
          
+
          Storage group name
          
+
          
+
          type: dict
          
+
          
+
          
 
          
-
          {name} (, dict, )
          Storage group name
          
-
          
-
          name (, str, )
          Storage group name
          
+
          name
          Storage group name
          
+
          
+
          type: str
          
+
          
 
          
-
          fulfillment-status (, str, )
          Fulfillment status of the storage group
          
+
          fulfillment-status
          Fulfillment status of the storage group
          
+
          
+
          type: str
          
+
          
 
          
-
          object_uri (, str, )
          Canonical URI of the storage group
          
+
          object_uri
          Canonical URI of the storage group
          
+
          
+
          type: str
          
+
          
 
          
 
          
 
          
@@ -315,20 +415,7 @@ 
          Return Values
 
          
 
          
-
          
-
          
-
          Status
          
-
            
-
          • This module is guaranteed to have backward compatible interface changes going forward. [stableinterface]
            • 
-
          • This module is maintained by community.
            • 
-
          
-
          
-
          Authors
          
-
            
-
          • Andreas Maier (@andy-maier)
            • 
-
          • Andreas Scheuring (@scheuran)
            • 
-
          
-
          
+
          diff --git a/docs/modules/zhmc_crypto_attachment.html b/docs/modules/zhmc_crypto_attachment.html index 737c7d103..fd5eef66d 100644 --- a/docs/modules/zhmc_crypto_attachment.html +++ b/docs/modules/zhmc_crypto_attachment.html @@ -89,14 +89,9 @@
        • zhmc_cpc – Update CPCs
        • zhmc_crypto_attachment – Attach crypto resources to partitions
        • zhmc_hba – Create HBAs in partitions
          • @@ -153,6 +148,8 @@ + +
            @@ -167,6 +164,11 @@
          • + + + Edit on GitHub + +
            • @@ -183,70 +185,124 @@

            Synopsis

            -

            Gather facts about the attachment of crypto adapters and crypto domains to a partition of a CPC (Z system).

            -

            Attach a range of crypto domains and a number of crypto adapters to a partition.

            -

            Detach all crypto domains and all crypto adapters from a partition.

            -
            -
            -

            Requirements

            -

            The below requirements are needed on the host that executes this module.

              -

            • Access to the WS API of the HMC of the targeted Z system (see HMC API). The targeted Z system must be in the Dynamic Partition Manager (DPM) operational mode.

              • +

            • Gather facts about the attachment of crypto adapters and crypto domains to a partition of a CPC (Z system).

              • +

            • Attach a range of crypto domains and a number of crypto adapters to a partition.

              • +

            • Detach all crypto domains and all crypto adapters from a partition.

            -

            Parameters

            -
            -
            -
            hmc_host (True, str, None)

            The hostname or IP address of the HMC.

            +

            Parameters

            +
            +
            hmc_host

            The hostname or IP address of the HMC.

            +
            +
            required: True
            +
            type: str
            +
            -
            hmc_auth (True, dict, None)

            The authentication credentials for the HMC, as a dictionary of userid, password.

            -
            -
            userid (True, str, None)

            The userid (username) for authenticating with the HMC.

            +
            hmc_auth

            The authentication credentials for the HMC, as a dictionary of userid, password.

            +
            +
            required: True
            +
            type: dict
            +
            +
            +
            userid

            The userid (username) for authenticating with the HMC.

            +
            +
            required: True
            +
            type: str
            +
            -
            password (True, str, None)

            The password for authenticating with the HMC.

            +
            password

            The password for authenticating with the HMC.

            +
            +
            required: True
            +
            type: str
            +
            -
            cpc_name (True, str, None)

            The name of the CPC that has the partition and the crypto adapters.

            +
            cpc_name

            The name of the CPC that has the partition and the crypto adapters.

            +
            +
            required: True
            +
            type: str
            +
            -
            partition_name (True, str, None)

            The name of the partition to which the crypto domains and crypto adapters are attached.

            +
            partition_name

            The name of the partition to which the crypto domains and crypto adapters are attached.

            +
            +
            required: True
            +
            type: str
            +
            -
            state (True, str, None)

            The desired state for the attachment:

            +
            state

            The desired state for the attachment:

            • attached: Ensures that the specified number of crypto adapters of the specified crypto type, and the specified range of domain index numbers in the specified access mode are attached to the partition.

            • detached: Ensures that no crypto adapter and no crypto domains are attached to the partition.

            • facts: Does not change anything on the attachment and returns the crypto configuration of the partition.

            +
            +
            required: True
            +
            type: str
            +
            choices: attached, detached, facts
            +
            -
            adapter_count (False, int, -1)

            Only for state=attach: The number of crypto adapters the partition needs to have attached. The special value -1 means all adapters of the desired crypto type in the CPC. The adapter_names and adapter_count parameters are mutually exclusive; if neither is specified the default for adapter_count applies.

            +
            adapter_count

            Only for state=attach: The number of crypto adapters the partition needs to have attached. The special value -1 means all adapters of the desired crypto type in the CPC. The adapter_names and adapter_count parameters are mutually exclusive; if neither is specified the default for adapter_count applies.

            +
            +
            required: False
            +
            type: int
            +
            default: -1
            +
            -
            adapter_names (False, list, [])

            Only for state=attach: The names of the crypto adapters the partition needs to have attached. The adapter_names and adapter_count parameters are mutually exclusive; if neither is specified the default for adapter_count applies.

            +
            adapter_names

            Only for state=attach: The names of the crypto adapters the partition needs to have attached. The adapter_names and adapter_count parameters are mutually exclusive; if neither is specified the default for adapter_count applies.

            +
            +
            required: False
            +
            type: list
            +
            -
            domain_range (False, list, [0, -1])

            Only for state=attach: The domain range the partition needs to have attached, as a tuple of integers (min, max) that specify the inclusive range of domain index numbers. Other domains attached to the partition remain unchanged. The special value -1 for the max item means the maximum supported domain index number.

            +
            domain_range

            Only for state=attach: The domain range the partition needs to have attached, as a tuple of integers (min, max) that specify the inclusive range of domain index numbers. Other domains attached to the partition remain unchanged. The special value -1 for the max item means the maximum supported domain index number.

            +
            +
            required: False
            +
            type: list
            +
            default: [0, -1]
            +
            -
            access_mode (False, str, usage)

            Only for state=attach: The access mode in which the crypto domains specified in domain_range need to be attached.

            +
            access_mode

            Only for state=attach: The access mode in which the crypto domains specified in domain_range need to be attached.

            +
            +
            required: False
            +
            type: str
            +
            default: usage
            +
            choices: usage, control
            +
            -
            crypto_type (False, str, ep11)

            Only for state=attach: The crypto type of the crypto adapters that will be considered for attaching.

            +
            crypto_type

            Only for state=attach: The crypto type of the crypto adapters that will be considered for attaching.

            +
            +
            required: False
            +
            type: str
            +
            default: ep11
            +
            choices: ep11, cca, acc
            +
            -
            log_file (False, str, None)

            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.

            +
            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
            +
            -
            faked_session (False, raw, None)

            A zhmcclient_mock.FakedSession object that has a mocked HMC set up. If not null, this session will be used instead of connecting to the HMC specified in hmc_host. This is used for testing purposes only.

            +
            faked_session

            A zhmcclient_mock.FakedSession object that has a mocked HMC set up. If not null, this session will be used instead of connecting to the HMC specified in hmc_host. This is used for testing purposes only.

            +
            +
            required: False
            +
            type: raw
            +
            -
            -

            Examples

            +

            Examples

            ---
 # Note: The following examples assume that some variables named 'my_*' are set.
 
@@ -310,65 +366,111 @@ 
            Examples
-
            Return Values
            
+
            Return Values
            
+
            
+
            
+
            crypto_configuration
            
+
            For state=detached|attached|facts, the crypto configuration of the partition after the changes performed by the module.
            
+
            
+
            returned: success
            
+
            type: dict
            
+
            
+
            
 
            
-
            crypto_configuration (success, dict, )
            For state=detached|attached|facts, the crypto configuration of the partition after the changes performed by the module.
            
+
            {name}
            
+
            Partition name
            
+
            
+
            type: dict
            
+
            
+
            
 
            
-
            {name} (, dict, )
            Partition name
            
+
            adapters
            
+
            Attached adapters
            
+
            
+
            type: dict
            
+
            
+
            
 
            
-
            adapters (, dict, )
            Attached adapters
            
+
            {name}
            
+
            Adapter name
            
+
            
+
            type: dict
            
+
            
+
            
 
            
-
            {name} (, dict, )
            Adapter name
            
-
            
-
            name (, str, )
            Adapter name
            
+
            name
            Adapter name
            
+
            
+
            type: str
            
+
            
 
            
-
            {property} (, any, )
            Additional properties of the adapter, as described in the HMC API (using hyphens (-) in the property names).
            
+
            {property}
            Additional properties of the adapter, as described in the HMC API (using hyphens (-) in the property names).
            
+
            
+
            type:
            
+
            
 
            
 
            
 
            
 
            
 
            
-
            domain_config (, dict, )
            Attached crypto domains
            
+
            domain_config
            
+
            Attached crypto domains
            
+
            
+
            type: dict
            
+
            
+
            
 
            
-
            {index} (, dict, )
            Crypto domain index
            
-
            
-
            {access_mode} (, str, )
            Access mode (‘control’ or ‘usage’).
            
+
            {index}
            
+
            Crypto domain index
            
+
            
+
            type: dict
            
+
            
+
            
+
            
+
            {access_mode}
            Access mode (‘control’ or ‘usage’).
            
+
            
+
            type: str
            
+
            
 
            
 
            
 
            
 
            
 
            
-
            usage_domains (, list, )
            Domain index numbers of the crypto domains attached in usage mode
            
+
            usage_domains
            Domain index numbers of the crypto domains attached in usage mode
            
+
            
+
            type: list
            
+
            
 
            
-
            control_domains (, list, )
            Domain index numbers of the crypto domains attached in control mode
            
+
            control_domains
            Domain index numbers of the crypto domains attached in control mode
            
+
            
+
            type: list
            
+
            
 
            
 
            
 
            
 
            
 
            
-
            changes (success, dict, )
            For state=detached|attached|facts, a dictionary with the changes performed.
            
-
            
-
            added-adapters (, list, )
            Names of the adapters that were added to the partition
            
+
            changes
            
+
            For state=detached|attached|facts, a dictionary with the changes performed.
            
+
            
+
            returned: success
            
+
            type: dict
            
+
            
+
            
+
            
+
            added-adapters
            Names of the adapters that were added to the partition
            
+
            
+
            type: list
            
+
            
 
            
-
            added-domains (, list, )
            Domain index numbers of the crypto domains that were added to the partition
            
+
            added-domains
            Domain index numbers of the crypto domains that were added to the partition
            
+
            
+
            type: list
            
+
            
 
            
 
            
 
            
 
            
-
            
-
            
-
            Status
            
-
              
-
            • This module is guaranteed to have backward compatible interface changes going forward. [stableinterface]
              • 
-
            • This module is maintained by community.
              • 
-
            
-
            
-
            Authors
            
-
              
-
            • Andreas Maier (@andy-maier)
              • 
-
            • Andreas Scheuring (@scheuran)
              • 
-
            
-
            
+
            diff --git a/docs/modules/zhmc_hba.html b/docs/modules/zhmc_hba.html index 5e5d9ab8a..0d1c3c49e 100644 --- a/docs/modules/zhmc_hba.html +++ b/docs/modules/zhmc_hba.html @@ -90,14 +90,9 @@
          • zhmc_crypto_attachment – Attach crypto resources to partitions
          • zhmc_hba – Create HBAs in partitions
          • zhmc_nic – Create NICs in partitions
            • @@ -153,6 +148,8 @@ + +
              @@ -167,6 +164,11 @@
            • + + + Edit on GitHub + +
              • @@ -183,51 +185,75 @@

              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 below requirements are needed on the host that executes this module.

                -

              • Access to the WS API of the HMC of the targeted Z system (see HMC API). The targeted Z system must be in the Dynamic Partition Manager (DPM) operational mode.

                • -

              • The targeted Z system must be a z13 generation. The z14 and later generations manage HBAs automatically via the “dpm-storage-management” firmware feature.

                • +

              • 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.

              -

              Parameters

              -
              -
              -
              hmc_host (True, str, None)

              The hostname or IP address of the HMC.

              +

              Parameters

              +
              +
              hmc_host

              The hostname or IP address of the HMC.

              +
              +
              required: True
              +
              type: str
              +
              -
              hmc_auth (True, dict, None)

              The authentication credentials for the HMC, as a dictionary of userid, password.

              -
              -
              userid (True, str, None)

              The userid (username) for authenticating with the HMC.

              +
              hmc_auth

              The authentication credentials for the HMC, as a dictionary of userid, password.

              +
              +
              required: True
              +
              type: dict
              +
              +
              +
              userid

              The userid (username) for authenticating with the HMC.

              +
              +
              required: True
              +
              type: str
              +
              -
              password (True, str, None)

              The password for authenticating with the HMC.

              +
              password

              The password for authenticating with the HMC.

              +
              +
              required: True
              +
              type: str
              +
              -
              cpc_name (True, str, None)

              The name of the CPC with the partition containing the HBA.

              +
              cpc_name

              The name of the CPC with the partition containing the HBA.

              +
              +
              required: True
              +
              type: str
              +
              -
              partition_name (True, str, None)

              The name of the partition containing the HBA.

              +
              partition_name

              The name of the partition containing the HBA.

              +
              +
              required: True
              +
              type: str
              +
              -
              name (True, str, None)

              The name of the target HBA that is managed. If the HBA needs to be created, this value becomes its name.

              +
              name

              The name of the target HBA that is managed. If the HBA needs to be created, this value becomes its name.

              +
              +
              required: True
              +
              type: str
              +
              -
              state (True, str, None)

              The desired state for the target HBA:

              +
              state

              The desired state for the target HBA:

              absent: Ensures that the HBA does not exist in the specified partition.

              present: Ensures that the HBA exists in the specified partition and has the specified properties.

              +
              +
              required: True
              +
              type: str
              +
              choices: absent, present
              +
              -
              properties (False, dict, None)

              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.

              +
              properties

              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:

              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 (False, str, None)

              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.

              +
              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
              +
              -
              faked_session (False, raw, None)

              A zhmcclient_mock.FakedSession object that has a mocked HMC set up. If not null, this session will be used instead of connecting to the HMC specified in hmc_host. This is used for testing purposes only.

              +
              faked_session

              A zhmcclient_mock.FakedSession object that has a mocked HMC set up. If not null, this session will be used instead of connecting to the HMC specified in hmc_host. This is used for testing purposes only.

              +
              +
              required: False
              +
              type: raw
              +
              -
              -

              Examples

              +

              Examples

              ---
 # Note: The following examples assume that some variables named 'my_*' are set.
 
@@ -276,33 +313,32 @@ 
              Examples
-
              Return Values
              
-
              
-
              hba (success, dict, )
              For state=absent, an empty dictionary.
              
+
              Return Values
              
+
              
+
              
+
              hba
              
+
              For state=absent, an empty dictionary.
              
 
              For state=present, a dictionary with the resource properties of the HBA after changes, if any.
              
-
              
-
              name (, str, )
              HBA name
              
+
              
+
              returned: success
              
+
              type: dict
              
+
              
+
              
+
              
+
              name
              HBA name
              
+
              
+
              type: str
              
+
              
 
              
-
              {property} (, any, )
              Additional properties of the HBA, as described in the HMC API (using hyphens (-) in the property names).
              
+
              {property}
              Additional properties of the HBA, as described in the HMC API (using hyphens (-) in the property names).
              
+
              
+
              type:
              
+
              
 
              
 
              
 
              
 
              
-
              
-
              
-
              Status
              
-
                
-
              • This module is guaranteed to have backward compatible interface changes going forward. [stableinterface]
                • 
-
              • This module is maintained by community.
                • 
-
              
-
              
-
              Authors
              
-
                
-
              • Andreas Maier (@andy-maier)
                • 
-
              • Andreas Scheuring (@scheuran)
                • 
-
              • Juergen Leopold (@leopoldjuergen)
                • 
-
              
-
              
+
              diff --git a/docs/modules/zhmc_nic.html b/docs/modules/zhmc_nic.html index 800bcedc2..6b7b36064 100644 --- a/docs/modules/zhmc_nic.html +++ b/docs/modules/zhmc_nic.html @@ -91,14 +91,9 @@
            • zhmc_hba – Create HBAs in partitions
            • zhmc_nic – Create NICs in partitions
            • zhmc_partition – Create partitions
              • @@ -153,6 +148,8 @@ + +
                @@ -167,6 +164,11 @@
              • + + + Edit on GitHub + +
                • @@ -183,50 +185,75 @@

                Synopsis

                -

                Create, update, or delete a NIC (virtual Network Interface Card) in a partition of a CPC (Z system).

                -

                Note that the Ansible module zhmc_partition can be used to gather facts about existing NICs of a partition.

                -
                -
                -

                Requirements

                -

                The below requirements are needed on the host that executes this module.

                  -

                • Access to the WS API of the HMC of the targeted Z system (see HMC API). The targeted Z system must be in the Dynamic Partition Manager (DPM) operational mode.

                  • +

                • Create, update, or delete a NIC (virtual Network Interface Card) in a partition of a CPC (Z system).

                  • +

                • Note that the Ansible module zhmc_partition can be used to gather facts about existing NICs of a partition.

                -

                Parameters

                -
                -
                -
                hmc_host (True, str, None)

                The hostname or IP address of the HMC.

                +

                Parameters

                +
                +
                hmc_host

                The hostname or IP address of the HMC.

                +
                +
                required: True
                +
                type: str
                +
                -
                hmc_auth (True, dict, None)

                The authentication credentials for the HMC, as a dictionary of userid, password.

                -
                -
                userid (True, str, None)

                The userid (username) for authenticating with the HMC.

                +
                hmc_auth

                The authentication credentials for the HMC, as a dictionary of userid, password.

                +
                +
                required: True
                +
                type: dict
                +
                +
                +
                userid

                The userid (username) for authenticating with the HMC.

                +
                +
                required: True
                +
                type: str
                +
                -
                password (True, str, None)

                The password for authenticating with the HMC.

                +
                password

                The password for authenticating with the HMC.

                +
                +
                required: True
                +
                type: str
                +
                -
                cpc_name (True, str, None)

                The name of the CPC with the partition containing the NIC.

                +
                cpc_name

                The name of the CPC with the partition containing the NIC.

                +
                +
                required: True
                +
                type: str
                +
                -
                partition_name (True, str, None)

                The name of the partition containing the NIC.

                +
                partition_name

                The name of the partition containing the NIC.

                +
                +
                required: True
                +
                type: str
                +
                -
                name (True, str, None)

                The name of the target NIC that is managed. If the NIC needs to be created, this value becomes its name.

                +
                name

                The name of the target NIC that is managed. If the NIC needs to be created, this value becomes its name.

                +
                +
                required: True
                +
                type: str
                +
                -
                state (True, str, None)

                The desired state for the target NIC:

                +
                state

                The desired state for the target NIC:

                absent: Ensures that the NIC does not exist in the specified partition.

                present: Ensures that the NIC exists in the specified partition and has the specified properties.

                +
                +
                required: True
                +
                type: str
                +
                choices: absent, present
                +
                -
                properties (False, dict, None)

                Dictionary with input properties for the NIC, 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.

                +
                properties

                Dictionary with input properties for the NIC, 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 NIC resources (where the property names contain underscores instead of hyphens), with the following exceptions:

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

                +
                +
                required: False
                +
                type: dict
                +
                -
                log_file (False, str, None)

                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.

                +
                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
                +
                -
                faked_session (False, raw, None)

                A zhmcclient_mock.FakedSession object that has a mocked HMC set up. If not null, this session will be used instead of connecting to the HMC specified in hmc_host. This is used for testing purposes only.

                +
                faked_session

                A zhmcclient_mock.FakedSession object that has a mocked HMC set up. If not null, this session will be used instead of connecting to the HMC specified in hmc_host. This is used for testing purposes only.

                +
                +
                required: False
                +
                type: raw
                +
                -
                -

                Examples

                +

                Examples

                ---
 # Note: The following examples assume that some variables named 'my_*' are set.
 
@@ -275,33 +313,32 @@ 
                Examples
-
                Return Values
                
-
                
-
                nic (success, dict, )
                For state=absent, an empty dictionary.
                
+
                Return Values
                
+
                
+
                
+
                nic
                
+
                For state=absent, an empty dictionary.
                
 
                For state=present, a dictionary with the resource properties of the NIC after changes, if any.
                
-
                
-
                name (, str, )
                NIC name
                
+
                
+
                returned: success
                
+
                type: dict
                
+
                
+
                
+
                
+
                name
                NIC name
                
+
                
+
                type: str
                
+
                
 
                
-
                {property} (, any, )
                Additional properties of the NIC, as described in the HMC API (using hyphens (-) in the property names).
                
+
                {property}
                Additional properties of the NIC, as described in the HMC API (using hyphens (-) in the property names).
                
+
                
+
                type:
                
+
                
 
                
 
                
 
                
 
                
-
                
-
                
-
                Status
                
-
                  
-
                • This module is guaranteed to have backward compatible interface changes going forward. [stableinterface]
                  • 
-
                • This module is maintained by community.
                  • 
-
                
-
                
-
                Authors
                
-
                  
-
                • Andreas Maier (@andy-maier)
                  • 
-
                • Andreas Scheuring (@scheuran)
                  • 
-
                • Juergen Leopold (@leopoldjuergen)
                  • 
-
                
-
                
+
                diff --git a/docs/modules/zhmc_partition.html b/docs/modules/zhmc_partition.html index 0886a6d47..3eac915df 100644 --- a/docs/modules/zhmc_partition.html +++ b/docs/modules/zhmc_partition.html @@ -92,15 +92,10 @@
              • zhmc_nic – Create NICs in partitions
              • zhmc_partition – Create partitions
              • zhmc_storage_group – Create storage groups
                • @@ -154,6 +149,8 @@ + +
                  @@ -168,6 +165,11 @@
                • + + + Edit on GitHub + +
                  • @@ -184,52 +186,73 @@

                  Synopsis

                  -

                  Gather facts about a partition of a CPC (Z system), including its HBAs, NICs, and virtual functions.

                  -

                  Create, update, or delete a partition. The HBAs, NICs, and virtual functions of the partition are managed by separate Ansible modules.

                  -

                  Start or stop a partition.

                  -
                  -
                  -

                  Requirements

                  -

                  The below requirements are needed on the host that executes this module.

                    -

                  • Access to the WS API of the HMC of the targeted Z system (see HMC API). The targeted Z system must be in the Dynamic Partition Manager (DPM) operational mode.

                    • +

                  • Gather facts about a partition of a CPC (Z system), including its HBAs, NICs, and virtual functions.

                    • +

                  • Create, update, or delete a partition. The HBAs, NICs, and virtual functions of the partition are managed by separate Ansible modules.

                    • +

                  • Start or stop a partition.

                  -

                  Parameters

                  -
                  -
                  -
                  hmc_host (True, str, None)

                  The hostname or IP address of the HMC.

                  +

                  Parameters

                  +
                  +
                  hmc_host

                  The hostname or IP address of the HMC.

                  +
                  +
                  required: True
                  +
                  type: str
                  +
                  -
                  hmc_auth (True, dict, None)

                  The authentication credentials for the HMC, as a dictionary of userid, password.

                  -
                  -
                  userid (True, str, None)

                  The userid (username) for authenticating with the HMC.

                  +
                  hmc_auth

                  The authentication credentials for the HMC, as a dictionary of userid, password.

                  +
                  +
                  required: True
                  +
                  type: dict
                  +
                  +
                  +
                  userid

                  The userid (username) for authenticating with the HMC.

                  +
                  +
                  required: True
                  +
                  type: str
                  +
                  -
                  password (True, str, None)

                  The password for authenticating with the HMC.

                  +
                  password

                  The password for authenticating with the HMC.

                  +
                  +
                  required: True
                  +
                  type: str
                  +
                  -
                  cpc_name (True, str, None)

                  The name of the CPC with the target partition.

                  +
                  cpc_name

                  The name of the CPC with the target partition.

                  +
                  +
                  required: True
                  +
                  type: str
                  +
                  -
                  name (True, str, None)

                  The name of the target partition.

                  +
                  name

                  The name of the target partition.

                  +
                  +
                  required: True
                  +
                  type: str
                  +
                  -
                  state (True, str, None)

                  The desired state for the target partition:

                  +
                  state

                  The desired state for the target partition:

                  absent: Ensures that the partition does not exist in the specified CPC.

                  stopped: Ensures that the partition exists in the specified CPC, has the specified properties, and is in the ‘stopped’ status.

                  active: Ensures that the partition exists in the specified CPC, has the specified properties, and is in the ‘active’ or ‘degraded’ status.

                  facts: Does not change anything on the partition and returns the partition properties and the properties of its child resources (HBAs, NICs, and virtual functions).

                  +
                  +
                  required: True
                  +
                  type: str
                  +
                  choices: absent, stopped, active, facts
                  +
                  -
                  properties (False, dict, None)

                  Dictionary with input properties for the partition, for state=stopped and state=active. 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.

                  +
                  properties

                  Dictionary with input properties for the partition, for state=stopped and state=active. 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 Partition resources (where the property names contain underscores instead of hyphens), with the following exceptions:

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

                  +
                  +
                  required: False
                  +
                  type: dict
                  +
                  -
                  expand_storage_groups (False, bool, False)

                  Boolean that controls whether the returned partition contains an additional artificial property ‘storage-groups’ that is the list of storage groups attached to the partition, with properties as described for the zhmc_storage_group module with expand=true.

                  -
                  -
                  expand_crypto_adapters (False, bool, False)

                  Boolean that controls whether the returned partition contains an additional artificial property ‘crypto-adapters’ in its ‘crypto-configuration’ property that is the list of crypto adapters attached to the partition, with properties as described for the zhmc_adapter module.

                  -
                  -
                  log_file (False, str, None)

                  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.

                  -
                  -
                  faked_session (False, raw, None)

                  A zhmcclient_mock.FakedSession object that has a mocked HMC set up. If not null, this session will be used instead of connecting to the HMC specified in hmc_host. This is used for testing purposes only.

                  +
                  expand_storage_groups

                  Boolean that controls whether the returned partition contains an additional artificial property ‘storage-groups’ that is the list of storage groups attached to the partition, with properties as described for the zhmc_storage_group module with expand=true.

                  +
                  +
                  required: False
                  +
                  type: bool
                  +
                  -
                  -
                  +
                  expand_crypto_adapters

                  Boolean that controls whether the returned partition contains an additional artificial property ‘crypto-adapters’ in its ‘crypto-configuration’ property that is the list of crypto adapters attached to the partition, with properties as described for the zhmc_adapter module.

                  +
                  +
                  required: False
                  +
                  type: bool
                  -
                  -

                  See Also

                  -
                  -

                  See also

                  -
                  -
                  zhmc_hba – Create HBAs in partitions

                  The official documentation on the zhmc_hba module.

                  -
                  zhmc_nic – Create NICs in partitions

                  The official documentation on the zhmc_nic module.

                  +
                  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
                  +
                  -
                  zhmc_virtual_function – Create virtual functions in partitions

                  The official documentation on the zhmc_virtual_function module.

                  +
                  faked_session

                  A zhmcclient_mock.FakedSession object that has a mocked HMC set up. If not null, this session will be used instead of connecting to the HMC specified in hmc_host. This is used for testing purposes only.

                  +
                  +
                  required: False
                  +
                  type: raw
                  +
                  -
                  -

                  Examples

                  +

                  Examples

                  ---
 # Note: The following examples assume that some variables named 'my_*' are set.
 
@@ -349,59 +377,102 @@ 
                  Examples
+
                  See Also
                  
+
                  
+
                  See also
                  
+
+
                  
+
                  -

                  Return Values

                  -
                  -
                  partition (success, dict, )

                  For state=absent, an empty dictionary.

                  +

                  Return Values

                  +
                  +
                  +
                  partition
                  +

                  For state=absent, an empty dictionary.

                  For state=stopped and state=active, a dictionary with the resource properties of the partition after changes, if any.

                  For state=facts, a dictionary with the resource properties of the partition, including its child resources as described below.

                  +
                  +
                  returned: success
                  +
                  type: dict
                  +
                  +
                  -
                  name (, str, )

                  Partition name

                  +
                  name

                  Partition name

                  +
                  +
                  type: str
                  +
                  -
                  {property} (, any, )

                  Additional properties of the partition, as described in the HMC API (using hyphens (-) in the property names).

                  +
                  {property}

                  Additional properties of the partition, as described in the HMC API (using hyphens (-) in the property names).

                  +
                  +
                  type:
                  +
                  -
                  hbas (, list, )

                  HBAs of the partition (for state=facts).

                  -
                  -
                  name (, str, )

                  HBA name

                  +
                  hbas
                  +

                  HBAs of the partition (for state=facts).

                  +
                  +
                  type: list
                  +
                  +
                  +
                  +
                  name

                  HBA name

                  +
                  +
                  type: str
                  +
                  -
                  {property} (, any, )

                  Additional properties of the HBA, as described in the HMC API (using hyphens (-) in the property names).

                  +
                  {property}

                  Additional properties of the HBA, as described in the HMC API (using hyphens (-) in the property names).

                  +
                  +
                  type:
                  +
                  -
                  nics (, list, )

                  NICs of the partition (for state=facts).

                  -
                  -
                  name (, str, )

                  NIC name

                  +
                  nics
                  +

                  NICs of the partition (for state=facts).

                  +
                  +
                  type: list
                  +
                  +
                  +
                  +
                  name

                  NIC name

                  +
                  +
                  type: str
                  +
                  -
                  {property} (, any, )

                  Additional properties of the NIC, as described in the HMC API (using hyphens (-) in the property names).

                  +
                  {property}

                  Additional properties of the NIC, as described in the HMC API (using hyphens (-) in the property names).

                  +
                  +
                  type:
                  +
                  -
                  virtual-functions (, list, )

                  Virtual functions of the partition (for state=facts).

                  -
                  -
                  name (, str, )

                  VF name

                  +
                  virtual-functions
                  +

                  Virtual functions of the partition (for state=facts).

                  +
                  +
                  type: list
                  +
                  +
                  +
                  +
                  name

                  VF name

                  +
                  +
                  type: str
                  +
                  -
                  {property} (, any, )

                  Additional properties of the VF, as described in the HMC API (using hyphens (-) in the property names).

                  +
                  {property}

                  Additional properties of the VF, as described in the HMC API (using hyphens (-) in the property names).

                  +
                  +
                  type:
                  +
                  -
                  -
                  -

                  Status

                  -
                    -

                  • This module is guaranteed to have backward compatible interface changes going forward. [stableinterface]

                    • -

                  • This module is maintained by community.

                    • -
                  -
                  -

                  Authors

                  -
                    -

                  • Andreas Maier (@andy-maier)

                    • -

                  • Andreas Scheuring (@scheuran)

                    • -

                  • Juergen Leopold (@leopoldjuergen)

                    • -
                  -
                  +
                  diff --git a/docs/modules/zhmc_storage_group.html b/docs/modules/zhmc_storage_group.html index e66b4e666..08f9ef652 100644 --- a/docs/modules/zhmc_storage_group.html +++ b/docs/modules/zhmc_storage_group.html @@ -93,15 +93,10 @@
                • zhmc_partition – Create partitions
                • zhmc_storage_group – Create storage groups
                • zhmc_storage_group_attachment – Attach storage groups to partitions
                  • @@ -154,6 +149,8 @@ + +
                    @@ -168,6 +165,11 @@
                  • + + + Edit on GitHub + +
                    • @@ -184,81 +186,106 @@

                    Synopsis

                    -

                    Gather facts about a storage group associated with a CPC (Z system), including its storage volumes and virtual storage resources.

                    -

                    Create, delete, or update a storage group associated with a CPC.

                    -
                    -
                    -

                    Requirements

                    -

                    The below requirements are needed on the host that executes this module.

                      -

                    • Access to the WS API of the HMC of the targeted Z system (see HMC API). The targeted Z system must be in the Dynamic Partition Manager (DPM) operational mode.

                      • -

                    • The Z system must be of generation z14 or later, to have the “dpm-storage-management” firmware feature.

                      • +

                    • Gather facts about a storage group associated with a CPC (Z system), including its storage volumes and virtual storage resources.

                      • +

                    • Create, delete, or update a storage group associated with a CPC.

                    -

                    Parameters

                    -
                    -
                    -
                    hmc_host (True, str, None)

                    The hostname or IP address of the HMC.

                    +

                    Parameters

                    +
                    +
                    hmc_host

                    The hostname or IP address of the HMC.

                    +
                    +
                    required: True
                    +
                    type: str
                    +
                    -
                    hmc_auth (True, dict, None)

                    The authentication credentials for the HMC, as a dictionary of userid, password.

                    -
                    -
                    userid (True, str, None)

                    The userid (username) for authenticating with the HMC.

                    +
                    hmc_auth

                    The authentication credentials for the HMC, as a dictionary of userid, password.

                    +
                    +
                    required: True
                    +
                    type: dict
                    +
                    +
                    +
                    userid

                    The userid (username) for authenticating with the HMC.

                    +
                    +
                    required: True
                    +
                    type: str
                    +
                    -
                    password (True, str, None)

                    The password for authenticating with the HMC.

                    +
                    password

                    The password for authenticating with the HMC.

                    +
                    +
                    required: True
                    +
                    type: str
                    +
                    -
                    cpc_name (True, str, None)

                    The name of the CPC associated with the target storage group.

                    +
                    cpc_name

                    The name of the CPC associated with the target storage group.

                    +
                    +
                    required: True
                    +
                    type: str
                    +
                    -
                    name (True, str, None)

                    The name of the target storage group.

                    +
                    name

                    The name of the target storage group.

                    +
                    +
                    required: True
                    +
                    type: str
                    +
                    -
                    state (True, str, None)

                    The desired state for the target storage group:

                    +
                    state

                    The desired state for the target storage group:

                    • absent: Ensures that the storage group does not exist. If the storage group is currently attached to any partitions, the module will fail.

                    • present: Ensures that the storage group exists and is associated with the specified CPC, and has the specified properties. The attachment state of the storage group to a partition is not changed.

                    • facts: Does not change anything on the storage group and returns the storage group properties.

                    +
                    +
                    required: True
                    +
                    type: str
                    +
                    choices: absent, present, facts
                    +
                    -
                    properties (False, dict, None)

                    Dictionary with desired properties for the storage group. Used for state=present; ignored for state=absent|facts. Dictionary key is the property name with underscores instead of hyphens, and dictionary value is the property value in YAML syntax. Integer properties may also be provided as decimal strings.

                    +
                    properties

                    Dictionary with desired properties for the storage group. Used for state=present; ignored for state=absent|facts. Dictionary key is the property name with underscores instead of hyphens, and dictionary value is the property value in YAML syntax. Integer properties may also be provided as decimal strings.

                    The possible input properties in this dictionary are the properties defined as writeable in the data model for Storage Group 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.

                    • type: Cannot be changed once the storage group exists.

                    Properties omitted in this dictionary will remain unchanged when the storage group already exists, and will get the default value defined in the data model for storage groups in the HMC API when the storage group is being created.

                    +
                    +
                    required: False
                    +
                    type: dict
                    +
                    -
                    expand (False, bool, False)

                    Boolean that controls whether the returned storage group contains additional artificial properties that expand certain URI or name properties to the full set of resource properties (see description of return values of this module).

                    +
                    expand

                    Boolean that controls whether the returned storage group contains additional artificial properties that expand certain URI or name properties to the full set of resource properties (see description of return values of this module).

                    +
                    +
                    required: False
                    +
                    type: bool
                    +
                    -
                    log_file (False, str, None)

                    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.

                    +
                    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
                    +
                    -
                    faked_session (False, raw, None)

                    A zhmcclient_mock.FakedSession object that has a mocked HMC set up. If not null, this session will be used instead of connecting to the HMC specified in hmc_host. This is used for testing purposes only.

                    +
                    faked_session

                    A zhmcclient_mock.FakedSession object that has a mocked HMC set up. If not null, this session will be used instead of connecting to the HMC specified in hmc_host. This is used for testing purposes only.

                    +
                    +
                    required: False
                    +
                    type: raw
                    +
                    -
                    -
                    -
                    -

                    Notes

                    -
                    -

                    Note

                    -
                      -

                    • This module manages only the knowledge of the Z system about its storage, but does not perform any actions against the storage subsystems or SAN switches attached to the Z system.

                      • -

                    • Attachment of storage groups to and from partitions is managed by the Ansible module zhmc_storage_group_attachment.

                      • -
                    -
                    -

                    Examples

                    +

                    Examples

                    ---
 # Note: The following examples assume that some variables named 'my_*' are set.
 
@@ -298,82 +325,160 @@ 
                    Examples
+
                    Notes
                    
+
                    
+
                    Note
                    
+
                    This module manages only the knowledge of the Z system about its storage, but does not perform any actions against the storage subsystems or SAN switches attached to the Z system.
                    
+
                    Attachment of storage groups to and from partitions is managed by the Ansible module zhmc_storage_group_attachment.
                    
+
                    
+
                    -

                    Return Values

                    -
                    -
                    storage_group (success, dict, )

                    For state=absent, an empty dictionary.

                    +

                    Return Values

                    +
                    +
                    +
                    storage_group
                    +

                    For state=absent, an empty dictionary.

                    For state=present|facts, a dictionary with the resource properties of the target storage group, plus additional artificial properties as described below.

                    +
                    +
                    returned: success
                    +
                    type: dict
                    +
                    +
                    -
                    name (, str, )

                    Storage group name

                    +
                    name

                    Storage group name

                    +
                    +
                    type: str
                    +
                    -
                    {property} (, any, )

                    Additional properties of the storage group, as described in the HMC API (using hyphens (-) in the property names).

                    +
                    {property}

                    Additional properties of the storage group, as described in the HMC API (using hyphens (-) in the property names).

                    +
                    +
                    type:
                    +
                    -
                    attached-partition-names (, list, )

                    Names of the partitions to which the storage group is attached.

                    +
                    attached-partition-names

                    Names of the partitions to which the storage group is attached.

                    +
                    +
                    type: list
                    +
                    -
                    cpc-name (, str, )

                    Name of the CPC that is associated to this storage group.

                    +
                    cpc-name

                    Name of the CPC that is associated to this storage group.

                    +
                    +
                    type: str
                    +
                    -
                    candidate-adapter-ports (success+expand, list, )

                    Only if expand was requested: List of candidate storage adapter ports of the storage group.

                    +
                    candidate-adapter-ports
                    +

                    Only if expand was requested: List of candidate storage adapter ports of the storage group.

                    +
                    +
                    returned: success+expand
                    +
                    type: list
                    +
                    +
                    -
                    name (, str, )

                    Storage port name

                    +
                    name

                    Storage port name

                    +
                    +
                    type: str
                    +
                    -
                    index (, int, )

                    Storage port index

                    +
                    index

                    Storage port index

                    +
                    +
                    type: int
                    +
                    -
                    {property} (, any, )

                    Additional properties of the storage port, as described in the HMC API (using hyphens (-) in the property names).

                    +
                    {property}

                    Additional properties of the storage port, as described in the HMC API (using hyphens (-) in the property names).

                    +
                    +
                    type:
                    +
                    -
                    parent-adapter (, dict, )

                    Storage adapter of the port.

                    -
                    -
                    name (, str, )

                    Storage adapter name

                    +
                    parent-adapter
                    +

                    Storage adapter of the port.

                    +
                    +
                    type: dict
                    +
                    +
                    +
                    +
                    name

                    Storage adapter name

                    +
                    +
                    type: str
                    +
                    -
                    {property} (, any, )

                    Additional properties of the storage adapter, as described in the HMC API (using hyphens (-) in the property names).

                    +
                    {property}

                    Additional properties of the storage adapter, as described in the HMC API (using hyphens (-) in the property names).

                    +
                    +
                    type:
                    +
                    -
                    storage-volumes (success+expand, list, )

                    Only if expand was requested: List of storage volumes of the storage group.

                    -
                    -
                    name (, str, )

                    Storage volume name

                    +
                    storage-volumes
                    +

                    Only if expand was requested: List of storage volumes of the storage group.

                    +
                    +
                    returned: success+expand
                    +
                    type: list
                    +
                    +
                    +
                    +
                    name

                    Storage volume name

                    +
                    +
                    type: str
                    +
                    -
                    {property} (, any, )

                    Additional properties of the storage volume, as described in the HMC API (using hyphens (-) in the property names).

                    +
                    {property}

                    Additional properties of the storage volume, as described in the HMC API (using hyphens (-) in the property names).

                    +
                    +
                    type:
                    +
                    -
                    virtual-storage-resources (success+expand, list, )

                    Only if expand was requested: List of virtual storage resources of the storage group.

                    -
                    -
                    {property} (, any, )

                    Properties of the virtual storage resource, as described in the HMC API (using hyphens (-) in the property names).

                    +
                    virtual-storage-resources
                    +

                    Only if expand was requested: List of virtual storage resources of the storage group.

                    +
                    +
                    returned: success+expand
                    +
                    type: list
                    +
                    +
                    +
                    +
                    {property}

                    Properties of the virtual storage resource, as described in the HMC API (using hyphens (-) in the property names).

                    +
                    +
                    type:
                    +
                    -
                    attached-partitions (success+expand, list, )

                    Only if expand was requested: List of partitions to which the storage group is attached.

                    -
                    -
                    {property} (, any, )

                    Properties of the partition, as described in the HMC API (using hyphens (-) in the property names).

                    +
                    attached-partitions
                    +

                    Only if expand was requested: List of partitions to which the storage group is attached.

                    +
                    +
                    returned: success+expand
                    +
                    type: list
                    +
                    +
                    +
                    +
                    {property}

                    Properties of the partition, as described in the HMC API (using hyphens (-) in the property names).

                    +
                    +
                    type:
                    +
                    -
                    cpc (success+expand, list, )

                    Only if expand was requested: The CPC that is associated to this storage group.

                    -
                    -
                    {property} (, any, )

                    Properties of the CPC, as described in the HMC API (using hyphens (-) in the property names).

                    +
                    cpc
                    +

                    Only if expand was requested: The CPC that is associated to this storage group.

                    +
                    +
                    returned: success+expand
                    +
                    type: list
                    +
                    +
                    +
                    +
                    {property}

                    Properties of the CPC, as described in the HMC API (using hyphens (-) in the property names).

                    +
                    +
                    type:
                    +
                    -
                    -
                    -

                    Status

                    -
                      -

                    • This module is guaranteed to have backward compatible interface changes going forward. [stableinterface]

                      • -

                    • This module is maintained by community.

                      • -
                    -
                    -

                    Authors

                    -
                      -

                    • Andreas Maier (@andy-maier)

                      • -

                    • Andreas Scheuring (@scheuran)

                      • -

                    • Juergen Leopold (@leopoldjuergen)

                      • -
                    -
                    +
                    diff --git a/docs/modules/zhmc_storage_group_attachment.html b/docs/modules/zhmc_storage_group_attachment.html index 935dcefd2..238ca73a9 100644 --- a/docs/modules/zhmc_storage_group_attachment.html +++ b/docs/modules/zhmc_storage_group_attachment.html @@ -94,15 +94,10 @@
                  • zhmc_storage_group – Create storage groups
                  • zhmc_storage_group_attachment – Attach storage groups to partitions
                  • zhmc_storage_volume – Create storage volumes
                    • @@ -154,6 +149,8 @@ + +
                      @@ -168,6 +165,11 @@
                    • + + + Edit on GitHub + +
                      • @@ -184,72 +186,94 @@

                      Synopsis

                      -

                      Gather facts about the attachment of a storage group to a partition of a CPC (Z system).

                      -

                      Attach and detach a storage group to and from a partition.

                      -
                      -
                      -

                      Requirements

                      -

                      The below requirements are needed on the host that executes this module.

                        -

                      • Access to the WS API of the HMC of the targeted Z system (see HMC API). The targeted Z system must be in the Dynamic Partition Manager (DPM) operational mode.

                        • -

                      • The Z system must be of generation z14 or later, to have the “dpm-storage-management” firmware feature.

                        • +

                      • Gather facts about the attachment of a storage group to a partition of a CPC (Z system).

                        • +

                      • Attach and detach a storage group to and from a partition.

                      -

                      Parameters

                      -
                      -
                      -
                      hmc_host (True, str, None)

                      The hostname or IP address of the HMC.

                      +

                      Parameters

                      +
                      +
                      hmc_host

                      The hostname or IP address of the HMC.

                      +
                      +
                      required: True
                      +
                      type: str
                      +
                      -
                      hmc_auth (True, dict, None)

                      The authentication credentials for the HMC, as a dictionary of userid, password.

                      -
                      -
                      userid (True, str, None)

                      The userid (username) for authenticating with the HMC.

                      +
                      hmc_auth

                      The authentication credentials for the HMC, as a dictionary of userid, password.

                      +
                      +
                      required: True
                      +
                      type: dict
                      +
                      +
                      +
                      userid

                      The userid (username) for authenticating with the HMC.

                      +
                      +
                      required: True
                      +
                      type: str
                      +
                      -
                      password (True, str, None)

                      The password for authenticating with the HMC.

                      +
                      password

                      The password for authenticating with the HMC.

                      +
                      +
                      required: True
                      +
                      type: str
                      +
                      -
                      cpc_name (True, str, None)

                      The name of the CPC that has the partition and is associated with the storage group.

                      +
                      cpc_name

                      The name of the CPC that has the partition and is associated with the storage group.

                      +
                      +
                      required: True
                      +
                      type: str
                      +
                      -
                      storage_group_name (True, str, None)

                      The name of the storage group for the attachment.

                      +
                      storage_group_name

                      The name of the storage group for the attachment.

                      +
                      +
                      required: True
                      +
                      type: str
                      +
                      -
                      partition_name (True, str, None)

                      The name of the partition for the attachment.

                      +
                      partition_name

                      The name of the partition for the attachment.

                      +
                      +
                      required: True
                      +
                      type: str
                      +
                      -
                      state (True, str, None)

                      The desired state for the attachment:

                      +
                      state

                      The desired state for the attachment:

                      • detached: Ensures that the storage group is not attached to the partition. If the storage group is currently attached to the partition and the partition is currently active, the module will fail.

                      • attached: Ensures that the storage group is attached to the partition.

                      • facts: Does not change anything on the attachment and returns the attachment status.

                      +
                      +
                      required: True
                      +
                      type: str
                      +
                      choices: detached, attached, facts
                      +
                      -
                      log_file (False, str, None)

                      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.

                      +
                      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
                      +
                      -
                      faked_session (False, raw, None)

                      A zhmcclient_mock.FakedSession object that has a mocked HMC set up. If not null, this session will be used instead of connecting to the HMC specified in hmc_host. This is used for testing purposes only.

                      +
                      faked_session

                      A zhmcclient_mock.FakedSession object that has a mocked HMC set up. If not null, this session will be used instead of connecting to the HMC specified in hmc_host. This is used for testing purposes only.

                      +
                      +
                      required: False
                      +
                      type: raw
                      +
                      -
                      -
                      -
                      -

                      Notes

                      -
                      -

                      Note

                      -
                        -

                      • This module manages only the knowledge of the Z system about its storage, but does not perform any actions against the storage subsystems or SAN switches attached to the Z system.

                        • -
                      -
                      -

                      Examples

                      +

                      Examples

                      ---
 # Note: The following examples assume that some variables named 'my_*' are set.
 
@@ -283,31 +307,34 @@ 
                      Examples
+
                      Notes
                      
+
                      
+
                      Note
                      
+
                      This module manages only the knowledge of the Z system about its storage, but does not perform any actions against the storage subsystems or SAN switches attached to the Z system.
                      
+
                      
+
                      -

                      Return Values

                      +

                      Return Values

                      +
                      +
                      +
                      storage_group_attachment
                      +

                      Attachment state of the storage group. If no check mode was requested, the attachment state after any changes is returned. If check mode was requested, the actual attachment state is returned.

                      +
                      +
                      returned: success
                      +
                      type: dict
                      +
                      +
                      -
                      storage_group_attachment (success, dict, )

                      Attachment state of the storage group. If no check mode was requested, the attachment state after any changes is returned. If check mode was requested, the actual attachment state is returned.

                      -
                      -
                      attached (, bool, )

                      Attachment state of the storage group: Indicates whether the storage group is attached to the partition.

                      +
                      attached

                      Attachment state of the storage group: Indicates whether the storage group is attached to the partition.

                      +
                      +
                      type: bool
                      +
                      -
                      -
                      -

                      Status

                      -
                        -

                      • This module is guaranteed to have backward compatible interface changes going forward. [stableinterface]

                        • -

                      • This module is maintained by community.

                        • -
                      -
                      -

                      Authors

                      -
                        -

                      • Andreas Maier (@andy-maier)

                        • -

                      • Andreas Scheuring (@scheuran)

                        • -

                      • Juergen Leopold (@leopoldjuergen)

                        • -
                      -
                      +
                      diff --git a/docs/modules/zhmc_storage_volume.html b/docs/modules/zhmc_storage_volume.html index 69c60a07d..6129dcd40 100644 --- a/docs/modules/zhmc_storage_volume.html +++ b/docs/modules/zhmc_storage_volume.html @@ -95,15 +95,10 @@
                    • zhmc_storage_group_attachment – Attach storage groups to partitions
                    • zhmc_storage_volume – Create storage volumes
                    • zhmc_user – Create HMC users
                      • @@ -154,6 +149,8 @@ + +
                        @@ -168,6 +165,11 @@
                      • + + + Edit on GitHub + +
                        • @@ -184,79 +186,105 @@

                        Synopsis

                        -

                        Gather facts about a storage volume in a storage group associated with a CPC (Z system).

                        -

                        Create, delete, or update a storage volume in a storage group associated with a CPC.

                        -
                        -
                        -

                        Requirements

                        -

                        The below requirements are needed on the host that executes this module.

                          -

                        • Access to the WS API of the HMC of the targeted Z system (see HMC API). The targeted Z system must be in the Dynamic Partition Manager (DPM) operational mode.

                          • -

                        • The Z system must be of generation z14 or later, to have the “dpm-storage-management” firmware feature.

                          • +

                        • Gather facts about a storage volume in a storage group associated with a CPC (Z system).

                          • +

                        • Create, delete, or update a storage volume in a storage group associated with a CPC.

                        -

                        Parameters

                        -
                        -
                        -
                        hmc_host (True, str, None)

                        The hostname or IP address of the HMC.

                        +

                        Parameters

                        +
                        +
                        hmc_host

                        The hostname or IP address of the HMC.

                        +
                        +
                        required: True
                        +
                        type: str
                        +
                        -
                        hmc_auth (True, dict, None)

                        The authentication credentials for the HMC, as a dictionary of userid, password.

                        -
                        -
                        userid (True, str, None)

                        The userid (username) for authenticating with the HMC.

                        +
                        hmc_auth

                        The authentication credentials for the HMC, as a dictionary of userid, password.

                        +
                        +
                        required: True
                        +
                        type: dict
                        +
                        +
                        +
                        userid

                        The userid (username) for authenticating with the HMC.

                        +
                        +
                        required: True
                        +
                        type: str
                        +
                        -
                        password (True, str, None)

                        The password for authenticating with the HMC.

                        +
                        password

                        The password for authenticating with the HMC.

                        +
                        +
                        required: True
                        +
                        type: str
                        +
                        -
                        cpc_name (True, str, None)

                        The name of the CPC associated with the storage group containing the target storage volume.

                        +
                        cpc_name

                        The name of the CPC associated with the storage group containing the target storage volume.

                        +
                        +
                        required: True
                        +
                        type: str
                        +
                        -
                        storage_group_name (True, str, None)

                        The name of the storage group containing the target storage volume.

                        +
                        storage_group_name

                        The name of the storage group containing the target storage volume.

                        +
                        +
                        required: True
                        +
                        type: str
                        +
                        -
                        name (True, str, None)

                        The name of the target storage volume.

                        +
                        name

                        The name of the target storage volume.

                        +
                        +
                        required: True
                        +
                        type: str
                        +
                        -
                        state (True, str, None)

                        The desired state for the target storage volume:

                        +
                        state

                        The desired state for the target storage volume:

                        • absent: Ensures that the storage volume does not exist in the specified storage group.

                        • present: Ensures that the storage volume exists in the specified storage group, and has the specified properties.

                        • facts: Does not change anything on the storage volume and returns the storage volume properties.

                        +
                        +
                        required: True
                        +
                        type: str
                        +
                        choices: absent, present, facts
                        +
                        -
                        properties (False, dict, None)

                        Dictionary with desired properties for the storage volume. Used for state=present; ignored for state=absent|facts. Dictionary key is the property name with underscores instead of hyphens, and dictionary value is the property value in YAML syntax. Integer properties may also be provided as decimal strings.

                        +
                        properties

                        Dictionary with desired properties for the storage volume. Used for state=present; ignored for state=absent|facts. Dictionary key is the property name with underscores instead of hyphens, and dictionary value is the property value in YAML syntax. Integer properties may also be provided as decimal strings.

                        The possible input properties in this dictionary are the properties defined as writeable in the data model for Storage Volume 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.

                        Properties omitted in this dictionary will remain unchanged when the storage volume already exists, and will get the default value defined in the data model for storage volumes in the HMC API when the storage volume is being created.

                        +
                        +
                        required: False
                        +
                        type: dict
                        +
                        -
                        log_file (False, str, None)

                        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.

                        +
                        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
                        +
                        -
                        faked_session (False, raw, None)

                        A zhmcclient_mock.FakedSession object that has a mocked HMC set up. If not null, this session will be used instead of connecting to the HMC specified in hmc_host. This is used for testing purposes only.

                        +
                        faked_session

                        A zhmcclient_mock.FakedSession object that has a mocked HMC set up. If not null, this session will be used instead of connecting to the HMC specified in hmc_host. This is used for testing purposes only.

                        +
                        +
                        required: False
                        +
                        type: raw
                        +
                        -
                        -
                        -
                        -

                        Notes

                        -
                        -

                        Note

                        -
                          -

                        • This module manages only the knowledge of the Z system about its storage, but does not perform any actions against the storage subsystems or SAN switches attached to the Z system.

                          • -
                        -
                        -

                        Examples

                        +

                        Examples

                        ---
 # Note: The following examples assume that some variables named 'my_*' are set.
 
@@ -294,36 +322,45 @@ 
                        Examples
+
                        Notes
                        
+
                        
+
                        Note
                        
+
                        This module manages only the knowledge of the Z system about its storage, but does not perform any actions against the storage subsystems or SAN switches attached to the Z system.
                        
+
                        
+
                        -

                        Return Values

                        -
                        -
                        storage_volume (success, dict, )

                        For state=absent, an empty dictionary.

                        +

                        Return Values

                        +
                        +
                        +
                        storage_volume
                        +

                        For state=absent, an empty dictionary.

                        For state=present|facts, a dictionary with the resource properties of the storage volume, indicating the state after changes from this module (if any) have been applied.

                        -
                        -
                        name (, str, )

                        Storage volume name

                        +
                        +
                        returned: success
                        +
                        type: dict
                        +
                        +
                        +
                        +
                        name

                        Storage volume name

                        +
                        +
                        type: str
                        +
                        -
                        {property} (, any, )

                        Additional properties of the storage volume, as described in the HMC API (using hyphens (-) in the property names).

                        +
                        {property}

                        Additional properties of the storage volume, as described in the HMC API (using hyphens (-) in the property names).

                        +
                        +
                        type:
                        +
                        -
                        type (, str, )

                        Type of the storage volume (‘fc’ or ‘fcp’), as defined in its storage group.

                        +
                        type

                        Type of the storage volume (‘fc’ or ‘fcp’), as defined in its storage group.

                        +
                        +
                        type: str
                        +
                        -
                        -
                        -

                        Status

                        -
                          -

                        • This module is guaranteed to have backward compatible interface changes going forward. [stableinterface]

                          • -

                        • This module is maintained by community.

                          • -
                        -
                        -

                        Authors

                        -
                          -

                        • Andreas Maier (@andy-maier)

                          • -

                        • Andreas Scheuring (@scheuran)

                          • -

                        • Juergen Leopold (@leopoldjuergen)

                          • -
                        -
                        +
                        diff --git a/docs/modules/zhmc_user.html b/docs/modules/zhmc_user.html index 07f066ef0..0e32cc17b 100644 --- a/docs/modules/zhmc_user.html +++ b/docs/modules/zhmc_user.html @@ -96,14 +96,9 @@
                      • zhmc_storage_volume – Create storage volumes
                      • zhmc_user – Create HMC users
                      • zhmc_virtual_function – Create virtual functions in partitions
                        • @@ -153,6 +148,8 @@ + +
                          @@ -167,6 +164,11 @@
                        • + + + Edit on GitHub + +
                          • @@ -183,49 +185,66 @@

                          Synopsis

                          -

                          Gather facts about a user on an HMC of a Z system.

                          -

                          Create, delete, or update a user on an HMC.

                          -
                          -
                          -

                          Requirements

                          -

                          The below requirements are needed on the host that executes this module.

                            -

                          • Access to the WS API of the HMC of the targeted Z system (see HMC API). The targeted Z system can be in any operational mode (classic, DPM)

                            • +

                          • Gather facts about a user on an HMC of a Z system.

                            • +

                          • Create, delete, or update a user on an HMC.

                          -

                          Parameters

                          -
                          -
                          -
                          hmc_host (True, str, None)

                          The hostname or IP address of the HMC.

                          +

                          Parameters

                          +
                          +
                          hmc_host

                          The hostname or IP address of the HMC.

                          +
                          +
                          required: True
                          +
                          type: str
                          +
                          -
                          hmc_auth (True, dict, None)

                          The authentication credentials for the HMC, as a dictionary of userid, password.

                          -
                          -
                          userid (True, str, None)

                          The userid (username) for authenticating with the HMC.

                          +
                          hmc_auth

                          The authentication credentials for the HMC, as a dictionary of userid, password.

                          +
                          +
                          required: True
                          +
                          type: dict
                          +
                          +
                          +
                          userid

                          The userid (username) for authenticating with the HMC.

                          +
                          +
                          required: True
                          +
                          type: str
                          +
                          -
                          password (True, str, None)

                          The password for authenticating with the HMC.

                          +
                          password

                          The password for authenticating with the HMC.

                          +
                          +
                          required: True
                          +
                          type: str
                          +
                          -
                          name (True, str, None)

                          The userid of the target user (i.e. the ‘name’ property of the User object).

                          +
                          name

                          The userid of the target user (i.e. the ‘name’ property of the User object).

                          +
                          +
                          required: True
                          +
                          type: str
                          +
                          -
                          state (True, str, None)

                          The desired state for the target user:

                          +
                          state

                          The desired state for the target user:

                          • absent: Ensures that the user does not exist.

                          • present: Ensures that the user exists and has the specified properties.

                          • facts: Does not change anything on the user and returns the user properties.

                          +
                          +
                          required: True
                          +
                          type: str
                          +
                          choices: absent, present, facts
                          +
                          -
                          properties (False, dict, None)

                          Dictionary with desired properties for the user. Used for state=present; ignored for state=absent|facts. Dictionary key is the property name with underscores instead of hyphens, and dictionary value is the property value in YAML syntax. Integer properties may also be provided as decimal strings.

                          +
                          properties

                          Dictionary with desired properties for the user. Used for state=present; ignored for state=absent|facts. Dictionary key is the property name with underscores instead of hyphens, and dictionary value is the property value in YAML syntax. Integer properties may also be provided as decimal strings.

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

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

                          +
                          +
                          required: False
                          +
                          type: dict
                          +
                          -
                          expand (False, bool, False)

                          Boolean that controls whether the returned user contains additional artificial properties that expand certain URI or name properties to the full set of resource properties (see description of return values of this module).

                          +
                          expand

                          Boolean that controls whether the returned user contains additional artificial properties that expand certain URI or name properties to the full set of resource properties (see description of return values of this module).

                          +
                          +
                          required: False
                          +
                          type: bool
                          +
                          -
                          log_file (False, str, None)

                          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.

                          +
                          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
                          +
                          -
                          faked_session (False, raw, None)

                          A zhmcclient_mock.FakedSession object that has a mocked HMC set up. If not null, this session will be used instead of connecting to the HMC specified in hmc_host. This is used for testing purposes only.

                          +
                          faked_session

                          A zhmcclient_mock.FakedSession object that has a mocked HMC set up. If not null, this session will be used instead of connecting to the HMC specified in hmc_host. This is used for testing purposes only.

                          +
                          +
                          required: False
                          +
                          type: raw
                          +
                          -
                          -

                          Examples

                          +

                          Examples

                          ---
 # Note: The following examples assume that some variables named 'my_*' are set.
 
@@ -282,39 +316,52 @@ 
                          Examples
-
                          Return Values
                          
-
                          
-
                          user (success, dict, )
                          For state=absent, an empty dictionary.
                          
+
                          Return Values
                          
+
                          
+
                          
+
                          user
                          
+
                          For state=absent, an empty dictionary.
                          
 
                          For state=present|facts, a dictionary with the resource properties of the target user, plus additional artificial properties as described in the following list items.
                          
-
                          
-
                          name (, str, )
                          User name
                          
+
                          
+
                          returned: success
                          
+
                          type: dict
                          
+
                          
+
                          
+
                          
+
                          name
                          User name
                          
+
                          
+
                          type: str
                          
+
                          
 
                          
-
                          {property} (, any, )
                          Additional properties of the user, as described in the HMC API (using hyphens (-) in the property names).
                          
+
                          {property}
                          Additional properties of the user, as described in the HMC API (using hyphens (-) in the property names).
                          
+
                          
+
                          type:
                          
+
                          
 
                          
-
                          user-pattern-name (, str, )
                          Name of the user pattern referenced by property user-pattern-uri.
                          
+
                          user-pattern-name
                          Name of the user pattern referenced by property user-pattern-uri.
                          
+
                          
+
                          type: str
                          
+
                          
 
                          
-
                          password-rule-name (, str, )
                          Name of the password rule referenced by property password-rule-uri.
                          
+
                          password-rule-name
                          Name of the password rule referenced by property password-rule-uri.
                          
+
                          
+
                          type: str
                          
+
                          
 
                          
-
                          ldap-server-definition-name (, str, )
                          Name of the LDAP server definition referenced by property ldap-server-definition-uri.
                          
+
                          ldap-server-definition-name
                          Name of the LDAP server definition referenced by property ldap-server-definition-uri.
                          
+
                          
+
                          type: str
                          
+
                          
 
                          
-
                          default-group-name (, str, )
                          Name of the group referenced by property default-group-uri.
                          
+
                          default-group-name
                          Name of the group referenced by property default-group-uri.
                          
+
                          
+
                          type: str
                          
+
                          
 
                          
 
                          
 
                          
 
                          
-
                          
-
                          
-
                          Status
                          
-
                            
-
                          • This module is guaranteed to have backward compatible interface changes going forward. [stableinterface]
                            • 
-
                          • This module is maintained by community.
                            • 
-
                          
-
                          
-
                          Authors
                          
-
                            
-
                          • Andreas Maier (@andy-maier)
                            • 
-
                          
-
                          
+
                          diff --git a/docs/modules/zhmc_virtual_function.html b/docs/modules/zhmc_virtual_function.html index 01fbba0f5..0954aff67 100644 --- a/docs/modules/zhmc_virtual_function.html +++ b/docs/modules/zhmc_virtual_function.html @@ -97,14 +97,9 @@
                        • zhmc_user – Create HMC users
                        • zhmc_virtual_function – Create virtual functions in partitions
                        @@ -153,6 +148,8 @@ + +
                          @@ -167,6 +164,11 @@
                        • + + + Edit on GitHub + +
                          • @@ -183,50 +185,75 @@

                          Synopsis

                          -

                          Create, update, or delete a virtual function in a partition of a CPC (Z system).

                          -

                          Note that the Ansible module zhmc_partition can be used to gather facts about existing virtual functions of a partition.

                          -
                          -
                          -

                          Requirements

                          -

                          The below requirements are needed on the host that executes this module.

                            -

                          • Access to the WS API of the HMC of the targeted Z system (see HMC API). The targeted Z system must be in the Dynamic Partition Manager (DPM) operational mode.

                            • +

                          • Create, update, or delete a virtual function in a partition of a CPC (Z system).

                            • +

                          • Note that the Ansible module zhmc_partition can be used to gather facts about existing virtual functions of a partition.

                          -

                          Parameters

                          -
                          -
                          -
                          hmc_host (True, str, None)

                          The hostname or IP address of the HMC.

                          +

                          Parameters

                          +
                          +
                          hmc_host

                          The hostname or IP address of the HMC.

                          +
                          +
                          required: True
                          +
                          type: str
                          +
                          -
                          hmc_auth (True, dict, None)

                          The authentication credentials for the HMC, as a dictionary of userid, password.

                          -
                          -
                          userid (True, str, None)

                          The userid (username) for authenticating with the HMC.

                          +
                          hmc_auth

                          The authentication credentials for the HMC, as a dictionary of userid, password.

                          +
                          +
                          required: True
                          +
                          type: dict
                          +
                          +
                          +
                          userid

                          The userid (username) for authenticating with the HMC.

                          +
                          +
                          required: True
                          +
                          type: str
                          +
                          -
                          password (True, str, None)

                          The password for authenticating with the HMC.

                          +
                          password

                          The password for authenticating with the HMC.

                          +
                          +
                          required: True
                          +
                          type: str
                          +
                          -
                          cpc_name (True, str, None)

                          The name of the CPC with the partition containing the virtual function.

                          +
                          cpc_name

                          The name of the CPC with the partition containing the virtual function.

                          +
                          +
                          required: True
                          +
                          type: str
                          +
                          -
                          partition_name (True, str, None)

                          The name of the partition containing the virtual function.

                          +
                          partition_name

                          The name of the partition containing the virtual function.

                          +
                          +
                          required: True
                          +
                          type: str
                          +
                          -
                          name (True, str, None)

                          The name of the target virtual function that is managed. If the virtual function needs to be created, this value becomes its name.

                          +
                          name

                          The name of the target virtual function that is managed. If the virtual function needs to be created, this value becomes its name.

                          +
                          +
                          required: True
                          +
                          type: str
                          +
                          -
                          state (True, str, None)

                          The desired state for the target virtual function:

                          +
                          state

                          The desired state for the target virtual function:

                          absent: Ensures that the virtual function does not exist in the specified partition.

                          present: Ensures that the virtual function exists in the specified partition and has the specified properties.

                          +
                          +
                          required: True
                          +
                          type: str
                          +
                          choices: absent, present
                          +
                          -
                          properties (False, dict, None)

                          Dictionary with input properties for the virtual function, 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.

                          +
                          properties

                          Dictionary with input properties for the virtual function, 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 Virtual Function resources (where the property names contain underscores instead of hyphens), with the following exceptions:

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

                          +
                          +
                          required: False
                          +
                          type: dict
                          +
                          -
                          log_file (False, str, None)

                          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.

                          +
                          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
                          +
                          -
                          faked_session (False, raw, None)

                          A zhmcclient_mock.FakedSession object that has a mocked HMC set up. If not null, this session will be used instead of connecting to the HMC specified in hmc_host. This is used for testing purposes only.

                          +
                          faked_session

                          A zhmcclient_mock.FakedSession object that has a mocked HMC set up. If not null, this session will be used instead of connecting to the HMC specified in hmc_host. This is used for testing purposes only.

                          +
                          +
                          required: False
                          +
                          type: raw
                          +
                          -
                          -

                          Examples

                          +

                          Examples

                          ---
 # Note: The following examples assume that some variables named 'my_*' are set.
 
@@ -273,33 +311,32 @@ 
                          Examples
-
                          Return Values
                          
-
                          
-
                          virtual_function (success, dict, )
                          For state=absent, an empty dictionary.
                          
+
                          Return Values
                          
+
                          
+
                          
+
                          virtual_function
                          
+
                          For state=absent, an empty dictionary.
                          
 
                          For state=present, a dictionary with the resource properties of the virtual function (after changes, if any).
                          
-
                          
-
                          name (, str, )
                          Virtual function name
                          
+
                          
+
                          returned: success
                          
+
                          type: dict
                          
+
                          
+
                          
+
                          
+
                          name
                          Virtual function name
                          
+
                          
+
                          type: str
                          
+
                          
 
                          
-
                          {property} (, any, )
                          Additional properties of the virtual function, as described in the HMC API (using hyphens (-) in the property names).
                          
+
                          {property}
                          Additional properties of the virtual function, as described in the HMC API (using hyphens (-) in the property names).
                          
+
                          
+
                          type:
                          
+
                          
 
                          
 
                          
 
                          
 
                          
-
                          
-
                          
-
                          Status
                          
-
                            
-
                          • This module is guaranteed to have backward compatible interface changes going forward. [stableinterface]
                            • 
-
                          • This module is maintained by community.
                            • 
-
                          
-
                          
-
                          Authors
                          
-
                            
-
                          • Andreas Maier (@andy-maier)
                            • 
-
                          • Andreas Scheuring (@scheuran)
                            • 
-
                          • Juergen Leopold (@leopoldjuergen)
                            • 
-
                          
-
                          
+
                          diff --git a/docs/searchindex.js b/docs/searchindex.js index d6e83a608..24b02a4bf 100644 --- a/docs/searchindex.js +++ b/docs/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["CONTRIBUTING","all_modules","appendix","changes","development","index","intro","modules/zhmc_adapter","modules/zhmc_cpc","modules/zhmc_crypto_attachment","modules/zhmc_hba","modules/zhmc_nic","modules/zhmc_partition","modules/zhmc_storage_group","modules/zhmc_storage_group_attachment","modules/zhmc_storage_volume","modules/zhmc_user","modules/zhmc_virtual_function"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,sphinx:56},filenames:["CONTRIBUTING.rst","all_modules.rst","appendix.rst","changes.rst","development.rst","index.rst","intro.rst","modules/zhmc_adapter.rst","modules/zhmc_cpc.rst","modules/zhmc_crypto_attachment.rst","modules/zhmc_hba.rst","modules/zhmc_nic.rst","modules/zhmc_partition.rst","modules/zhmc_storage_group.rst","modules/zhmc_storage_group_attachment.rst","modules/zhmc_storage_volume.rst","modules/zhmc_user.rst","modules/zhmc_virtual_function.rst"],objects:{},objnames:{},objtypes:{},terms:{"00000000001":12,"0128":11,"023f":11,"033f":17,"1024":12,"112":3,"123":17,"123f":10,"127":6,"12c":7,"141":3,"18074":3,"187":3,"2013":3,"2017":3,"2018":3,"2019":3,"2616":2,"2617":2,"2626":2,"2627":2,"2634":2,"2636":2,"2637":2,"2638":2,"755":6,"boolean":[3,12,13,16],"case":[3,6,7],"default":[0,3,4,6,9,10,11,12,13,15,16,17],"final":4,"float":3,"function":[1,3,4,5,6,12],"import":[0,4,6],"int":[9,13],"new":[0,3,5,6,7,8],"null":[6,7,8,9,10,11,12,13,14,15,16,17],"public":6,"return":3,"short":[0,4],"switch":[4,13,14,15],"true":[7,8,9,10,11,12,13,14,15,16,17],"try":4,"var":6,Added:3,Bus:10,For:[0,4,6,7,9,10,11,12,13,15,16,17],Into:0,That:4,The:[0,2,3,4,6,7,8,9,10,11,12,13,14,15,16,17],Then:[4,6],There:4,These:[4,6],Use:[0,7],Used:[11,13,15,16],Using:6,VFs:3,Will:[10,11,12,17],With:0,a13b:11,abc:17,abcdefabcdef:12,abil:[6,7],abl:6,about:[3,4,6,7,8,9,10,11,12,13,14,15,16,17],absent:[3,7,10,11,12,13,15,16,17],acc:7,acceler:[6,17],acceptable_statu:[3,8],access:[7,8,9,10,11,12,13,14,15,16,17],access_mod:[9,12],accordingli:[3,6],action:[3,6,13,14,15],activ:[4,6,8,12,14],actual:14,adapt:[1,3,5,6,8,9,10,11,12,13,17],adapter1:[7,12],adapter2:12,adapter_count:9,adapter_id:7,adapter_nam:[9,10,11,17],adapter_port:[10,11],adapter_port_uri:10,adapter_uri:17,add:[0,3,4],added:[9,12],adding:3,addit:[3,4,7,8,9,10,11,12,13,15,16,17],address:[0,7,8,9,10,11,12,13,14,15,16,17],adjust:[3,6],advantag:6,affect:0,after:[0,4,6,9,10,11,12,14,15,17],again:4,against:[3,4,13,14,15],all:[3,4,5,6,7,9,11,12],allow:[3,6,7],along:3,alpha:[3,4],alreadi:[3,4,6,7,10,11,12,13,15,16,17],also:[3,4,6,7,8,10,11,13,15,16,17],altern:3,alwai:6,amend:0,anco_dir:6,andi:[7,8,9,10,11,12,13,14,15,16,17],andrea:[7,8,9,10,11,12,13,14,15,16,17],ani:[3,4,6,7,8,9,10,11,12,13,14,15,16,17],ansibl:[2,3,4,6,10,11,12,13,17],ansible_collect:6,ansible_python_interpret:6,anyth:[7,8,9,12,13,14,15,16],apach:6,api:[0,2,3,6,7,8,9,10,11,12,13,14,15,16,17],appear:4,append:0,appendix:5,appli:[0,3,6,9,15],appveyor:3,arriv:4,artifici:[3,7,8,10,11,12,13,16,17],ask:4,assign:12,associ:[8,13,14,15],assum:[4,7,8,9,10,11,12,13,14,15,16,17],attach:[1,3,5,7,8,12,13,15],attent:4,attributeerror:3,authent:[6,7,8,9,10,11,12,13,14,15,16,17],author:4,autom:0,automat:[4,6,10,12],avail:[4,12],awai:6,back:[3,10,11,17],backward:[6,7,8,9,10,11,12,13,14,15,16,17],bad:0,base:4,bash:6,becaus:[3,4,6,7,10,11,12,13,15,16,17],becom:[10,11,17],been:[4,6,7,10,11,12,13,15,16,17],befor:[0,4,6],being:[3,10,11,12,13,15,16,17],below:[0,3,7,8,9,10,11,12,13,14,15,16,17],besid:4,beta:3,between:[6,7],bibliographi:5,bin:6,blank:0,book:2,bool:[12,13,14,16],boot:[6,12],boot_devic:12,boot_logical_unit_numb:12,boot_network_devic:12,boot_network_nic_nam:12,boot_storage_devic:12,boot_storage_device_hba_nam:12,boot_storage_hba_nam:12,boot_world_wide_port_nam:12,bootabl:12,both:2,branch:[3,4],bring:3,browser:4,bug:[3,4],build:5,built:[4,6],call:6,can:[0,4,6,7,10,11,12,16,17],candid:13,cannot:[3,4,7,10,11,12,13,15,16,17],canon:[7,8],card:11,care:6,cat:6,caus:[3,4],cca:7,certain:[3,13,16],certif:0,certifi:0,chang:[0,4,5,6,7,8,9,10,11,12,13,14,15,16,17],charact:3,check:[0,3,4,6,14],checkout:4,child:[3,8,12],chmod:6,circumvent:3,classic:16,clean:4,cleanup:[3,4],clobber:4,clone:4,close:4,cna:3,code:4,collect:[3,4,6],colon:0,com:4,combin:7,command:[4,6],comment:0,commit:[4,5],common:3,commun:[2,7,8,9,10,11,12,13,14,15,16,17],compat:[0,3,5,7,8,9,10,11,12,13,14,15,16,17],complet:4,compli:0,compon:0,compris:0,concept:7,config:0,configur:[0,3,6,7,9,12],confirm:4,conflict:3,connect:[7,8,9,10,11,12,13,14,15,16,17],consid:[0,4,9],consist:3,consol:[2,6],construct:12,contain:[0,3,6,10,11,12,13,15,16,17],contribut:5,control:[6,9,12,13,16],control_domain:9,convers:3,cooki:0,copi:6,correct:4,correctli:[3,6],could:3,count:3,cover:[2,4],coverag:4,cpc1:8,cpc:[1,3,5,6,7,9,10,11,12,13,14,15,17],cpc_name:[7,9,10,11,12,13,14,15,17],creat:[0,1,3,4,5,6],create_partit:6,creation:[0,3],credenti:[6,7,8,9,10,11,12,13,14,15,16,17],cryp00:9,cryp01:9,crypto1:9,crypto:[1,3,5,7,12],crypto_adapter_nam:12,crypto_adapter_uri:12,crypto_configur:[9,12],crypto_domain_configur:12,crypto_numb:3,crypto_typ:[7,9],cryptographi:3,current:[4,6,13,14],cve:3,data:[3,7,8,10,11,12,13,15,16,17],date:4,dco:0,decim:[3,7,8,10,11,12,13,15,16,17],defin:[6,7,8,10,11,12,13,15,16,17],definit:[3,16],degrad:12,delet:[3,4,6,7,10,11,12,13,15,16,17],delete_partit:6,deliv:0,demonstr:0,depend:[3,6],deprec:[3,4,5],describ:[2,3,4,6,7,8,9,10,11,12,13,15,16,17],descript:[0,4,7,8,10,11,12,13,15,16,17],desir:[6,7,8,9,10,11,12,13,14,15,16,17],detach:[9,14],detail:[0,3,4,6,12],dev1:[4,6],dev:[3,6],dev_guid:[],devd:6,develop:[0,2,3,5,6],devic:12,device_numb:[10,11,17],dict:[7,8,9,10,11,12,13,14,15,16,17],dictionari:[3,7,8,9,10,11,12,13,14,15,16,17],did:3,difficulti:3,directli:16,directori:[3,4,6],disabl:3,discuss:0,displai:4,distribut:[3,6],doc:[3,4],docs_sourc:4,document:[2,3,5,6,12],doe:[3,4,6,7,8,9,10,11,12,13,14,15,16,17],domain:[3,9],domain_config:9,domain_index:12,domain_rang:9,done:[0,3,6,12],doubl:[4,6],dpm:[3,7,8,9,10,11,12,13,14,15,16,17],drop:3,due:3,dure:[0,3],dynam:[7,8,9,10,11,12,13,14,15,17],each:[0,4,7,8],eas:6,easi:4,easili:3,edit:[0,4],editor:0,effect:3,either:4,element:3,element_uri:7,email:0,emperor:6,empti:[3,4,7,10,11,12,13,15,16,17],enabl:3,encount:6,end2end:[3,4],end:[0,6],enhanc:[3,4],enrich:3,ensur:[6,7,8,9,10,11,12,13,14,15,16,17],env_python:6,environ:5,eot:6,ep11:[7,9],error:[3,6],etc:[4,6],even:[0,6],everyth:0,examin:3,exampl:[0,3,4,5],except:[3,7,10,11,12,13,15,16,17],exclus:9,execut:[6,7,8,9,10,11,12,13,14,15,16,17],exist:[3,4,6,7,10,11,12,13,15,16,17],expand:[12,13,16],expand_crypto_adapt:[3,12],expand_storage_group:[3,12],expect:6,explain:0,explicitli:3,exploit:0,express:[3,7],extend:3,extens:4,fact:[3,6,7,8,9,10,11,12,13,14,15,16,17],fail:[4,6,13,14],faked_sess:[7,8,9,10,11,12,13,14,15,16,17],fakedsess:[7,8,9,10,11,12,13,14,15,16,17],fals:[7,8,9,10,11,12,13,14,15,16,17],famili:11,fcp:[7,10,12,13,15],featur:[0,10,13,14,15],few:3,ficon:[3,7],field:12,file:[0,3,4,6,7,8,9,10,11,12,13,14,15,16,17],fill:0,filter:7,find:6,firmwar:[10,13,14,15],first:0,fix:[3,4],flake8:[3,4],flexibl:3,flow:[7,8,9,10,11,12,13,14,15,16,17],folder:6,follow:[0,2,3,4,6,7,8,9,10,11,12,13,14,15,16,17],format:[3,5,12],forward:[7,8,9,10,11,12,13,14,15,16,17],found:6,four:4,from:[3,4,6,9,12,13,14,15],fulfil:8,full:[3,4,13,16],fulli:6,function_numb:3,function_rang:3,further:0,ga1:2,ga2:2,galaxi:[3,4,6],gather:[3,6,7,8,9,10,11,12,13,14,15,16,17],gener:[3,4,6,10,13,14,15],get:[0,4,10,11,12,13,15,16,17],get_cpc_io:3,get_fact:3,git:[0,4],gitcop:0,github:[3,4],goal:6,going:[7,8,9,10,11,12,13,14,15,16,17],good:0,got:6,gov:3,group:[1,3,5,8,12,15,16],guarante:[7,8,9,10,11,12,13,14,15,16,17],guid:2,had:3,handl:3,happen:6,hardwar:[2,6],has:[3,4,6,7,8,9,10,11,12,13,14,15,16,17],have:[0,4,6,7,8,9,10,11,12,13,14,15,16,17],hba1:[10,12],hba:[1,3,5,6,12],help:[0,4],higher:6,hipersocket:[1,3,5,11],hmc:[1,2,3,5,6,7,8,9,10,11,12,13,14,15,17],hmc_auth:[7,8,9,10,11,12,13,14,15,16,17],hmc_host:[7,8,9,10,11,12,13,14,15,16,17],home:6,host:[3,6,7,8,9,10,11,12,13,14,15,16,17],hostnam:[7,8,9,10,11,12,13,14,15,16,17],how:[0,3],howev:4,html:[4,7],http:[3,4,7],hyphen:[3,7,8,9,10,11,12,13,15,16,17],ibm:[2,3,4,6],idempot:[3,6],identifi:[0,7],ifl_processor:12,ignor:[7,8,10,11,12,13,15,16,17],iii:6,imag:12,implement:[0,3,6],improv:3,includ:[0,3,4,6,7,8,12,13],inclus:9,incompat:[3,4,6],incorrect:3,increas:3,independ:4,index:[2,3,4,5,9,10,11,13],indic:[4,14,15],indirectli:16,inform:[3,10,11,12,17],initi:[3,6],initial_memori:12,input:[3,10,11,12,13,15,16,17],insert:4,instal:[3,4,5],instead:[0,3,7,8,9,10,11,12,13,14,15,16,17],instruct:6,integ:[3,7,8,9,10,11,12,13,15,16,17],interact:[6,7,8,9,10,11,12,13,14,15,16,17],interfac:[6,7,8,9,10,11,12,13,14,15,16,17],introduc:0,introduct:5,invoc:4,invok:[3,6],issu:[3,4,5],item:[4,7,8,9,16],its:[3,4,6,7,8,10,11,12,13,14,15,17],itself:6,johndo:6,judgement:0,juergen:[10,11,12,13,14,15,17],just:[3,4],keep:6,kei:[7,8,10,11,12,13,15,16,17],kernel:0,kind:[4,6],know:4,knowledg:[13,14,15],known:[0,3,4,12],larg:0,later:[10,13,14,15],latest:[],ldap:16,lead:3,leopold:[10,11,12,13,14,15,17],leopoldjuergen:[10,11,12,13,14,15,17],less:3,level:[3,4,6],librari:7,licens:5,like:0,line:[0,3],link:4,linkcheck:4,linux:[0,6],linuxon:6,list:[3,4,6,9,12,13,16],local:[4,6],localhost:[3,6],log:[4,5,6,7,8,9,10,11,12,13,14,15,16,17],log_fil:[3,7,8,9,10,11,12,13,14,15,16,17],logger:[3,7,8,9,10,11,12,13,14,15,16,17],logic:[0,3,7,8,9,10,11,12,13,14,15,16,17],longer:[3,6],lun:12,mac_address:3,machin:[3,6],maco:6,made:3,mai:[0,4,6,7,8,10,11,12,13,15,16,17],maier:[7,8,9,10,11,12,13,14,15,16,17],main:6,maintain:[3,7,8,9,10,11,12,13,14,15,16,17],major:4,make:[0,3,4,6],manag:[2,3,6,7,8,9,10,11,12,13,14,15,17],mani:0,mark:6,markdown:3,mask:12,master:[3,4],match:[3,7],matter:6,max:[9,13],maximum:9,maximum_memori:12,mean:[6,9],merg:4,messag:[3,5],metadata:4,method:6,migrat:3,mileston:4,min:9,minim:6,minimum:3,minor:4,mkvirtualenv:6,mnu:4,mock:[7,8,9,10,11,12,13,14,15,16,17],mode:[3,6,7,8,9,10,11,12,13,14,15,16,17],model:[7,8,10,11,12,13,15,16,17],modul:[2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17],modules_by_categori:[],more:[0,3],most:4,multipl:0,must:[0,4,6,7,8,9,10,11,12,13,14,15,17],mutual:9,my_:[7,8,9,10,11,12,13,14,15,16,17],my_adapter_nam:7,my_cpc_nam:[7,8,9,10,11,12,13,14,15,17],my_first_partition_nam:9,my_hba_nam:10,my_hmc_auth:[7,8,9,10,11,12,13,14,15,16,17],my_hmc_host:[7,8,9,10,11,12,13,14,15,16,17],my_nic_nam:11,my_partition_nam:[9,10,11,12,14,17],my_second_partition_nam:9,my_storage_group_nam:[13,14,15],my_storage_volume_nam:15,my_user_nam:16,my_vfunction_nam:17,myenv:6,name:[0,3,4,6,7,8,9,10,11,12,13,14,15,16,17],need:[0,3,4,6,7,8,9,10,11,12,13,14,15,16,17],neither:9,network:11,network_adapter_port_uri:11,next:0,nic1:11,nic:[1,3,5,6,12],nist:3,non:3,none:[3,7,8,9,10,11,12,13,14,15,16,17],noqa:3,note:[4,6,7,8,9,10,11,12,16,17],noth:6,now:3,number:[4,9],nvd:3,object:[7,8,9,10,11,12,13,14,15,16,17],object_uri:8,off:0,offici:12,old:3,omit:[7,8,10,11,12,13,15,16,17],onc:[3,4,12,13,16],one:0,ones:3,onli:[0,3,4,6,7,8,9,10,11,12,13,14,15,16,17],open:[0,3,4,6],openstack:0,oper:[4,6,7,8,9,10,11,12,13,14,15,16,17],option:[0,4],order:[0,4,7],org:[0,4],origin:[0,4],osa:11,osd:11,other:[0,3,6,7,9],otherwis:[0,4,7],our:[3,10,11],out:[0,4],output:3,outsid:0,over:0,packag:[3,4,5],page:[3,4,5],paramet:[3,4],parametererror:3,parent:13,part1:12,part:3,parti:0,partit:[1,3,5,6,7,8,13,15],partition_nam:[9,10,11,14,17],pass:[0,3],password:[6,7,8,9,10,11,12,13,14,15,16,17],patch:0,path:[6,7,8,9,10,11,12,13,14,15,16,17],pattern:16,paus:3,pbr:3,pchid:3,peopl:[0,4],perform:[3,4,9,13,14,15],perspect:6,pick:3,pip:6,plai:6,platform:6,playbook:[3,5],pleas:6,plu:[4,13,16],pluggabl:0,point:6,pollut:6,port:[3,7,10,11,13],possibl:[6,7,8,10,11,12,13,15,16,17],power:6,practic:0,prefer:4,prepar:4,prerequisit:4,presenc:[0,6],present:[7,10,11,13,15,16,17],presum:0,pretti:4,preview:3,previou:[4,6],previous:3,principl:6,problem:6,process:3,produc:0,project:[0,3,4],promot:3,prompt:6,propag:[3,7,8,9,10,11,12,13,14,15,16,17],properti:[3,7,8,9,10,11,12,13,15,16,17],provid:[0,5,7,8,10,11,12,13,15,16,17],publish:[3,4],pull:[0,4],purpos:[4,7,8,9,10,11,12,13,14,15,16,17],push:4,put:0,pycodestyl:3,pycrypto:3,pyflak:3,pylint:4,pypi:[3,6],pytest:4,python:[3,4,7,8,9,10,11,12,13,14,15,16,17],python_script:6,quaiti:3,question:6,rais:3,random:0,rang:9,raw:[7,8,9,10,11,12,13,14,15,16,17],reach:6,read:4,readthedoc:7,real:[3,4],reason:4,recap:6,recogn:[3,6],recommend:4,referenc:[3,16],regard:0,regardless:6,regist:[7,8,9,10,11,12,13,14,15,16,17],reject:3,relat:[3,6],releas:[3,5],release_:4,release_m:4,relev:4,remain:[7,8,9,10,11,12,13,15,16,17],remot:4,remov:[3,4],renam:7,renov:3,repo:[0,3,4],report:5,repositori:5,repres:4,request:[0,3,4,13,14],requir:[0,3,6],resourc:[1,3,5,6,7,8,10,11,12,13,15,16,17],respect:3,restart:6,restrict:3,result:3,retriev:3,review:4,right:[0,4,6],risk:6,roce:11,rockhopp:6,root:[3,7,8,9,10,11,12,13,14,15,16,17],rst:4,rule:[0,4,6,7,16],run:[4,6],safe:6,safeti:4,sai:0,same:[3,4],san:[12,13,14,15],saniti:4,sc27:2,scheur:[7,8,9,10,11,12,13,14,15,17],scheuran:[7,8,9,10,11,12,13,14,15,17],script:[3,6],search:5,section:[3,4,6],see:[0,3,4,6,7,8,9,10,11,13,14,15,16,17],seen:6,semant:[4,6],semver:4,sens:0,separ:12,server:16,servic:[2,6],session:[7,8,9,10,11,12,13,14,15,16,17],set:[0,3,5,6,7,8,9,10,11,12,13,14,15,16,17],setup:3,sever:3,sg1:13,sga1:14,share:[6,13],shell:[4,6],should:[0,3,4],show:[3,4],shown:[0,4,6],sign:0,signoff:0,simpli:6,sinc:3,size:15,some:[4,6,7,8,9,10,11,12,13,14,15,16,17],sometim:0,sound:0,sourc:[0,4],special:9,specif:[3,6,9],specifi:[3,4,6,7,8,9,10,11,12,13,14,15,16,17],specific:6,split:0,ssc_dns_server:3,ssc_ipv4_gatewai:3,stabl:[3,4,7],stable_:4,stable_m:4,stableinterfac:[7,8,9,10,11,12,13,14,15,16,17],stage:0,standard:16,start:[0,3,5,6,12],start_:4,start_m:4,state:[0,3,6,7,8,9,10,11,12,13,14,15,16,17],statement:3,statu:[3,4,6],step:[4,6],still:[0,3,4],stop:[3,6,12],storag:[1,3,5,8,10,12],storage_group:13,storage_group_attach:14,storage_group_nam:[14,15],storage_volum:15,str:[7,8,9,10,11,12,13,14,15,16,17],stream:4,string:[3,6,7,8,10,11,12,13,15,16,17],structur:3,subject:[0,6],subsequ:3,subset:[3,7,8],subsystem:[13,14,15],succe:4,success:[4,7,8,9,10,11,12,13,14,15,16,17],sudo:6,suffix:[4,6],summar:0,summari:0,support:[0,3,4,5,7,9,12],sure:4,sv1:15,sync:3,syntax:[7,8,10,11,12,13,15,16,17],system:[2,4,7,8,9,10,11,12,13,14,15,16,17],tab:4,tag:4,taken:6,target:[3,4,7,8,9,10,11,12,13,14,15,16,17],task:[3,6],tee:6,templat:0,temporarili:3,termin:[3,6],test:[0,2,3,5,6,7,8,9,10,11,12,13,14,15,16,17],test_partit:4,testcas:4,testopt:4,text:4,than:3,thei:[3,6],them:4,therefor:6,thi:[0,3,4,5,7,8,9,10,11,12,13,14,15,16,17],thing:[4,6],third:0,through:4,thu:[3,6],todai:4,top:4,topic:4,tracker:[4,6],transit:6,travi:[3,4],tree:6,trigger:4,tupl:9,two:[6,9],txt:6,type:[0,3,7,9,12,13,15,16],typeerror:3,unchang:[7,8,9,10,11,12,13,15,16,17],under:6,underscor:[3,7,8,10,11,12,13,15,16,17],understand:4,unicod:3,unit:4,unnecessari:3,unreach:6,until:4,updat:[1,3,4,5,10,11,12,13,15,16,17],upgrad:[3,6],upload:4,upon:4,upstream:4,uri:[7,8,12,13,16],usag:[3,9,12],usage_domain:9,use:[0,3,6],used:[7,8,9,10,11,12,13,14,15,16,17],useful:0,user1:16,user:[0,1,3,4,5,6],userid:[7,8,9,10,11,12,13,14,15,16,17],usernam:[7,8,9,10,11,12,13,14,15,16,17],uses:[3,4,6],using:[0,3,6,7,8,9,10,11,12,13,15,16,17],util:6,v7k:10,valid:[0,3,4,7],valu:3,variabl:[4,6,7,8,9,10,11,12,13,14,15,16,17],variant:4,variou:6,vars_exampl:6,vault:6,vault_exampl:6,verbos:4,verifi:[4,6],version:[2,5],vfunction1:17,via:[4,6,10,16],violat:6,virtual:[1,3,4,5,10,11,12,13],virtual_funct:17,virtual_switch_uri:11,virtualenv:6,virtualenvwrapp:6,vlan_typ:3,volum:[1,3,5,13],vuln:3,vulner:3,wai:3,wait:4,want:4,web:[2,4,6],welcom:0,well:[7,8,9,10,11,12,13,14,15,16,17],were:[3,9],what:[0,4,5],when:[3,4,6,10,11,12,13,15,16,17],whenev:4,where:[0,3,6,10,11,12,13,15,16,17],whether:[0,12,13,14,16],which:[3,4,6,7,8,9,10,11,12,13,14,15,16,17],whose:12,why:0,window:6,without:[0,3,4,6],work:[0,3,4,6],writeabl:[3,7,8,10,11,12,13,15,16,17],written:[3,6],wrong:0,wrote:0,wwpn:12,yaml:[7,8,10,11,12,13,15,16,17],yet:[3,4,12],yml:[3,4,6],you:[0,4,6],your:[0,4,6],z13:[6,10],z14:[6,10,13,14,15],z15:[3,6],zeroiz:7,zhmc:[3,4,6,12],zhmc_adapt:[1,3,5,12],zhmc_cpc:[1,3,5],zhmc_crypto_attach:[1,3,5],zhmc_hba:[1,5,12],zhmc_nic:[1,3,5,12],zhmc_partit:[1,3,5,10,11,17],zhmc_storage_group:[1,3,5,12],zhmc_storage_group_attach:[1,3,5,13],zhmc_storage_volum:[1,3,5],zhmc_user:[1,3,5],zhmc_virtual_funct:[1,5,12],zhmcclient:[3,4,6,7],zhmcclient_mock:[7,8,9,10,11,12,13,14,15,16,17]},titles:["Contributing","All modules","Appendix","Change log","Development","ibm.zhmc Ansible Galaxy collection 1.0.0-dev1","Introduction","zhmc_adapter \u2013 Update adapters and create Hipersocket adapters","zhmc_cpc \u2013 Update CPCs","zhmc_crypto_attachment \u2013 Attach crypto resources to partitions","zhmc_hba \u2013 Create HBAs in partitions","zhmc_nic \u2013 Create NICs in partitions","zhmc_partition \u2013 Create partitions","zhmc_storage_group \u2013 Create storage groups","zhmc_storage_group_attachment \u2013 Attach storage groups to partitions","zhmc_storage_volume \u2013 Create storage volumes","zhmc_user \u2013 Create HMC users","zhmc_virtual_function \u2013 Create virtual functions in partitions"],titleterms:{"function":17,"new":4,"return":[7,8,9,10,11,12,13,14,15,16,17],adapt:7,all:1,also:12,altern:6,ansibl:5,appendix:2,attach:[9,14],author:[7,8,9,10,11,12,13,14,15,16,17],bibliographi:2,build:4,chang:3,collect:5,commit:0,commun:[],compat:6,contribut:0,cpc:8,creat:[7,10,11,12,13,15,16,17],crypto:9,defin:[],deprec:6,dev1:[3,5],develop:4,document:4,environ:[4,6],exampl:[6,7,8,9,10,11,12,13,14,15,16,17],format:0,galaxi:5,group:[13,14],guid:[],hba:10,hipersocket:7,hmc:16,ibm:5,index:[],indic:5,instal:6,introduct:6,issu:6,level:[],licens:6,log:3,manag:[],messag:0,modul:1,nic:11,note:[13,14,15],packag:6,paramet:[7,8,9,10,11,12,13,14,15,16,17],partit:[9,10,11,12,14,17],playbook:6,provid:6,python:6,releas:4,report:6,repositori:4,requir:[7,8,9,10,11,12,13,14,15,16,17],resourc:9,see:12,set:4,standard:6,start:4,statu:[7,8,9,10,11,12,13,14,15,16,17],storag:[13,14,15],support:6,synopsi:[7,8,9,10,11,12,13,14,15,16,17],system:6,tabl:5,test:4,thi:6,updat:[7,8],user:16,valu:[7,8,9,10,11,12,13,14,15,16,17],verif:6,version:[3,4,6],virtual:[6,17],volum:15,what:6,zhmc:5,zhmc_adapt:7,zhmc_cpc:8,zhmc_crypto_attach:9,zhmc_hba:10,zhmc_nic:11,zhmc_partit:12,zhmc_storage_group:13,zhmc_storage_group_attach:14,zhmc_storage_volum:15,zhmc_user:16,zhmc_virtual_funct:17}}) \ No newline at end of file +Search.setIndex({docnames:["CONTRIBUTING","all_modules","appendix","changes","development","index","intro","modules/zhmc_adapter","modules/zhmc_cpc","modules/zhmc_crypto_attachment","modules/zhmc_hba","modules/zhmc_nic","modules/zhmc_partition","modules/zhmc_storage_group","modules/zhmc_storage_group_attachment","modules/zhmc_storage_volume","modules/zhmc_user","modules/zhmc_virtual_function"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,sphinx:56},filenames:["CONTRIBUTING.rst","all_modules.rst","appendix.rst","changes.rst","development.rst","index.rst","intro.rst","modules/zhmc_adapter.rst","modules/zhmc_cpc.rst","modules/zhmc_crypto_attachment.rst","modules/zhmc_hba.rst","modules/zhmc_nic.rst","modules/zhmc_partition.rst","modules/zhmc_storage_group.rst","modules/zhmc_storage_group_attachment.rst","modules/zhmc_storage_volume.rst","modules/zhmc_user.rst","modules/zhmc_virtual_function.rst"],objects:{},objnames:{},objtypes:{},terms:{"00000000001":12,"0128":11,"023f":11,"033f":17,"1024":12,"112":3,"123":17,"123f":10,"127":6,"12c":7,"141":3,"18074":3,"187":3,"2013":3,"2017":3,"2018":3,"2019":3,"2616":2,"2617":2,"2626":2,"2627":2,"2634":2,"2636":2,"2637":2,"2638":2,"755":6,"boolean":[3,12,13,16],"case":[3,6,7],"default":[0,3,4,6,9,10,11,12,13,15,16,17],"final":4,"float":3,"function":[1,3,4,5,6,12],"import":[0,4,6],"int":[9,13],"new":[0,3,5,6,7,8],"null":[6,7,8,9,10,11,12,13,14,15,16,17],"public":6,"return":3,"short":[0,4],"switch":[4,13,14,15],"true":[7,8,9,10,11,12,13,14,15,16,17],"try":4,"var":6,Added:3,Bus:10,For:[0,4,6,7,9,10,11,12,13,15,16,17],Into:0,That:4,The:[0,2,3,4,6,7,8,9,10,11,12,13,14,15,16,17],Then:[4,6],There:4,These:[4,6],Use:[0,7],Used:[11,13,15,16],Using:6,VFs:3,Will:[10,11,12,17],With:0,a13b:11,abc:17,abcdefabcdef:12,abil:[6,7],abl:6,about:[3,4,6,7,8,9,10,11,12,13,14,15,16,17],absent:[3,7,10,11,12,13,15,16,17],acc:[7,9],acceler:[6,17],acceptable_statu:[3,8],access:9,access_mod:[9,12],accordingli:[3,6],action:[3,6,13,14,15],activ:[4,6,8,12,14],actual:14,adapt:[1,3,5,6,8,9,10,11,12,13,17],adapter1:[7,12],adapter2:12,adapter_count:9,adapter_id:7,adapter_nam:[9,10,11,17],adapter_port:[10,11],adapter_port_uri:10,adapter_uri:17,add:[0,3,4],added:[9,12],adding:3,addit:[3,4,7,8,9,10,11,12,13,15,16,17],address:[0,7,8,9,10,11,12,13,14,15,16,17],adjust:[3,6],advantag:6,affect:0,after:[0,4,6,9,10,11,12,14,15,17],again:4,against:[3,4,13,14,15],all:[3,4,5,6,7,9,11,12],allow:[3,6,7],along:3,alpha:[3,4],alreadi:[3,4,6,7,10,11,12,13,15,16,17],also:[3,4,6,7,8,10,11,13,15,16,17],altern:3,alwai:6,amend:0,anco_dir:6,andi:[],andrea:[],ani:[3,4,6,10,11,12,13,14,15,17],ansibl:[2,3,4,6,10,11,12,13,17],ansible_collect:6,ansible_python_interpret:6,anyth:[7,8,9,12,13,14,15,16],apach:6,api:[0,2,3,6,7,8,9,10,11,12,13,15,16,17],appear:4,append:0,appendix:5,appli:[0,3,6,9,15],appveyor:3,arriv:4,artifici:[3,7,8,10,11,12,13,16,17],ask:4,assign:12,associ:[8,13,14,15],assum:[4,7,8,9,10,11,12,13,14,15,16,17],attach:[1,3,5,7,8,12,13,15],attent:4,attributeerror:3,authent:[6,7,8,9,10,11,12,13,14,15,16,17],author:4,autom:0,automat:[4,6,12],avail:[4,12],awai:6,back:[3,10,11,17],backward:6,bad:0,base:4,bash:6,becaus:[3,4,6,7,10,11,12,13,15,16,17],becom:[10,11,17],been:[4,6,7,10,11,12,13,15,16,17],befor:[0,4,6],being:[3,10,11,12,13,15,16,17],below:[0,3,7,8,12,13],besid:4,beta:3,between:[6,7],bibliographi:5,bin:6,blank:0,book:2,bool:[12,13,14,16],boot:[6,12],boot_devic:12,boot_logical_unit_numb:12,boot_network_devic:12,boot_network_nic_nam:12,boot_storage_devic:12,boot_storage_device_hba_nam:12,boot_storage_hba_nam:12,boot_world_wide_port_nam:12,bootabl:12,both:2,branch:[3,4],bring:3,browser:4,bug:[3,4],build:5,built:[4,6],call:6,can:[0,4,6,7,10,11,12,17],candid:13,cannot:[3,4,7,10,11,12,13,15,16,17],canon:[7,8],card:11,care:6,cat:6,caus:[3,4],cca:[7,9],certain:[3,13,16],certif:0,certifi:0,chang:[0,4,5,6,7,8,9,10,11,12,13,14,15,16,17],charact:3,check:[0,3,4,6,14],checkout:4,child:[3,8,12],chmod:6,choic:[7,8,9,10,11,12,13,14,15,16,17],circumvent:3,classic:[],clean:4,cleanup:[3,4],clobber:4,clone:4,close:4,cna:3,code:4,collect:[3,4,6],colon:0,com:4,combin:7,command:[4,6],comment:0,commit:[4,5],common:3,commun:2,compat:[0,3,5],complet:4,compli:0,compon:0,compris:0,concept:7,config:0,configur:[0,3,6,7,9,12],confirm:4,conflict:3,connect:[7,8,9,10,11,12,13,14,15,16,17],consid:[0,4,9],consist:3,consol:[2,6],construct:12,contain:[0,3,6,10,11,12,13,15,16,17],contribut:5,control:[6,9,12,13,16],control_domain:9,convers:3,cooki:0,copi:6,correct:4,correctli:[3,6],could:3,count:3,cover:[2,4],coverag:4,cpc1:8,cpc:[1,3,5,6,7,9,10,11,12,13,14,15,17],cpc_name:[7,9,10,11,12,13,14,15,17],creat:[0,1,3,4,5,6],create_partit:6,creation:[0,3],credenti:[6,7,8,9,10,11,12,13,14,15,16,17],cryp00:9,cryp01:9,crypto1:9,crypto:[1,3,5,7,12],crypto_adapter_nam:12,crypto_adapter_uri:12,crypto_configur:[9,12],crypto_domain_configur:12,crypto_numb:3,crypto_typ:[7,9],cryptographi:3,current:[4,6,13,14],cve:3,data:[3,7,8,10,11,12,13,15,16,17],date:4,dco:0,decim:[3,7,8,10,11,12,13,15,16,17],defin:[6,7,8,10,11,12,13,15,16,17],definit:[3,16],degrad:12,delet:[3,4,6,7,10,11,12,13,15,16,17],delete_partit:6,deliv:0,demonstr:0,depend:[3,6],deprec:[3,4,5],describ:[2,3,4,6,7,8,9,10,11,12,13,15,16,17],descript:[0,4,7,8,10,11,12,13,15,16,17],desir:[6,7,8,9,10,11,12,13,14,15,16,17],detach:[9,14],detail:[0,3,4,6,12],dev1:[4,6],dev:[3,6],dev_guid:[],devd:6,develop:[0,2,3,5,6],devic:12,device_numb:[10,11,17],dict:[7,8,9,10,11,12,13,14,15,16,17],dictionari:[3,7,8,9,10,11,12,13,14,15,16,17],did:3,difficulti:3,directli:16,directori:[3,4,6],disabl:3,discuss:0,displai:4,distribut:[3,6],doc:[3,4],docs_sourc:4,document:[2,3,5,6],doe:[3,4,6,7,8,9,10,11,12,13,14,15,16,17],domain:[3,9],domain_config:9,domain_index:12,domain_rang:9,done:[0,3,6,12],doubl:[4,6],dpm:3,drop:3,due:3,dure:[0,3],dynam:[],each:[0,4,7,8],eas:6,easi:4,easili:3,edit:[0,4],editor:0,effect:3,either:4,element:3,element_uri:7,email:0,emperor:6,empti:[3,4,7,10,11,12,13,15,16,17],enabl:3,encount:6,end2end:[3,4],end:[0,6],enhanc:[3,4],enrich:3,ensur:[6,7,8,9,10,11,12,13,14,15,16,17],env_python:6,environ:5,eot:6,ep11:[7,9],error:[3,6],etc:[4,6],even:[0,6],everyth:0,examin:3,exampl:[0,3,4,5],except:[3,7,10,11,12,13,15,16,17],exclus:9,execut:6,exist:[3,4,6,7,10,11,12,13,15,16,17],expand:[12,13,16],expand_crypto_adapt:[3,12],expand_storage_group:[3,12],expect:6,explain:0,explicitli:3,exploit:0,express:[3,7],extend:3,extens:4,fact:[3,6,7,8,9,10,11,12,13,14,15,16,17],fail:[4,6,13,14],faked_sess:[7,8,9,10,11,12,13,14,15,16,17],fakedsess:[7,8,9,10,11,12,13,14,15,16,17],fals:[7,8,9,10,11,12,13,14,15,16,17],famili:11,fcp:[7,10,12,13,15],featur:0,few:3,ficon:[3,7],field:12,file:[0,3,4,6,7,8,9,10,11,12,13,14,15,16,17],fill:0,filter:7,find:6,firmwar:[],first:0,fix:[3,4],flake8:[3,4],flexibl:3,flow:[7,8,9,10,11,12,13,14,15,16,17],folder:6,follow:[0,2,3,4,6,7,8,9,10,11,12,13,14,15,16,17],format:[3,5,12],forward:[],found:6,four:4,from:[3,4,6,9,12,13,14,15],fulfil:8,full:[3,4,13,16],fulli:6,function_numb:3,function_rang:3,further:0,ga1:2,ga2:2,galaxi:[3,4,6],gather:[3,6,7,8,9,10,11,12,13,14,15,16,17],gener:[3,4,6],get:[0,4,10,11,12,13,15,16,17],get_cpc_io:3,get_fact:3,git:[0,4],gitcop:0,github:[3,4],goal:6,going:[],good:0,got:6,gov:3,group:[1,3,5,8,12,15,16],guarante:[],guid:2,had:3,handl:3,happen:6,hardwar:[2,6],has:[3,4,6,7,8,9,10,11,12,13,14,15,16,17],have:[0,4,6,9,15],hba1:[10,12],hba:[1,3,5,6,12],help:[0,4],higher:6,hipersocket:[1,3,5,11],hmc:[1,2,3,5,6,7,8,9,10,11,12,13,14,15,17],hmc_auth:[7,8,9,10,11,12,13,14,15,16,17],hmc_host:[7,8,9,10,11,12,13,14,15,16,17],home:6,host:[3,6,10,12],hostnam:[7,8,9,10,11,12,13,14,15,16,17],how:[0,3],howev:4,html:[4,7],http:[3,4,7],hyphen:[3,7,8,9,10,11,12,13,15,16,17],ibm:[2,3,4,6],idempot:[3,6],identifi:[0,7],ifl_processor:12,ignor:[7,8,10,11,12,13,15,16,17],iii:6,imag:12,implement:[0,3,6],improv:3,includ:[0,3,4,6,7,8,12,13],inclus:9,incompat:[3,4,6],incorrect:3,increas:3,independ:4,index:[2,3,4,5,9,10,11,13],indic:[4,14,15],indirectli:16,inform:[3,10,11,12,17],initi:[3,6],initial_memori:12,input:[3,10,11,12,13,15,16,17],insert:4,instal:[3,4,5],instead:[0,3,7,8,9,10,11,12,13,14,15,16,17],instruct:6,integ:[3,7,8,9,10,11,12,13,15,16,17],interact:[6,7,8,9,10,11,12,13,14,15,16,17],interfac:[6,11],introduc:0,introduct:5,invoc:4,invok:[3,6],issu:[3,4,5],item:[4,7,8,9,16],its:[3,4,6,7,8,10,11,12,13,14,15,17],itself:6,johndo:6,judgement:0,juergen:[],just:[3,4],keep:6,kei:[7,8,10,11,12,13,15,16,17],kernel:0,kind:[4,6],know:4,knowledg:[13,14,15],known:[0,3,4,12],larg:0,later:[],latest:[],ldap:16,lead:3,leopold:[],leopoldjuergen:[],less:3,level:[3,4,6],librari:7,licens:5,like:0,line:[0,3],link:4,linkcheck:4,linux:[0,6],linuxon:6,list:[3,4,6,9,12,13,16],local:[4,6],localhost:[3,6],log:[4,5,6,7,8,9,10,11,12,13,14,15,16,17],log_fil:[3,7,8,9,10,11,12,13,14,15,16,17],logger:[3,7,8,9,10,11,12,13,14,15,16,17],logic:[0,3,7,8,9,10,11,12,13,14,15,16,17],longer:[3,6],lun:12,mac_address:3,machin:[3,6],maco:6,made:3,mai:[0,4,6,7,8,10,11,12,13,15,16,17],maier:[],main:6,maintain:3,major:4,make:[0,3,4,6],manag:[2,3,6,10,11,12,13,14,15,17],mani:0,mark:6,markdown:3,mask:12,master:[3,4],match:[3,7],matter:6,max:[9,13],maximum:9,maximum_memori:12,mean:[6,9],merg:4,messag:[3,5],metadata:4,method:6,migrat:3,mileston:4,min:9,minim:6,minimum:3,minor:4,mkvirtualenv:6,mnu:4,mock:[7,8,9,10,11,12,13,14,15,16,17],mode:[3,6,9,14],model:[7,8,10,11,12,13,15,16,17],modul:[2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17],modules_by_categori:[],more:[0,3],most:4,multipl:0,must:[0,4,6],mutual:9,my_:[7,8,9,10,11,12,13,14,15,16,17],my_adapter_nam:7,my_cpc_nam:[7,8,9,10,11,12,13,14,15,17],my_first_partition_nam:9,my_hba_nam:10,my_hmc_auth:[7,8,9,10,11,12,13,14,15,16,17],my_hmc_host:[7,8,9,10,11,12,13,14,15,16,17],my_nic_nam:11,my_partition_nam:[9,10,11,12,14,17],my_second_partition_nam:9,my_storage_group_nam:[13,14,15],my_storage_volume_nam:15,my_user_nam:16,my_vfunction_nam:17,myenv:6,name:[0,3,4,6,7,8,9,10,11,12,13,14,15,16,17],need:[0,3,4,6,9,10,11,12,17],neither:9,network:11,network_adapter_port_uri:11,next:0,nic1:11,nic:[1,3,5,6,12],nist:3,non:3,none:3,noqa:3,note:[4,6,7,8,9,10,11,12,16,17],noth:6,now:3,number:[4,9],nvd:3,object:[7,8,9,10,11,12,13,14,15,16,17],object_uri:8,off:0,offici:[],old:3,omit:[7,8,10,11,12,13,15,16,17],onc:[3,4,12,13,16],one:0,ones:3,onli:[0,3,4,6,7,8,9,10,11,12,13,14,15,16,17],open:[0,3,4,6],openstack:0,oper:[4,6],option:[0,4],order:[0,4,7],org:[0,4],origin:[0,4],osa:11,osd:11,other:[0,3,6,7,9],otherwis:[0,4,7],our:[3,10,11],out:[0,4],output:3,outsid:0,over:0,packag:[3,4,5],page:[3,4,5],paramet:[3,4],parametererror:3,parent:13,part1:12,part:3,parti:0,partit:[1,3,5,6,8,13],partition_nam:[9,10,11,14,17],pass:[0,3],password:[6,7,8,9,10,11,12,13,14,15,16,17],patch:0,path:[6,7,8,9,10,11,12,13,14,15,16,17],pattern:16,paus:3,pbr:3,pchid:3,peopl:[0,4],perform:[3,4,9,13,14,15],perspect:6,pick:3,pip:6,plai:6,platform:6,playbook:[3,5],pleas:6,plu:[4,13,16],pluggabl:0,point:6,pollut:6,port:[3,7,10,11,13],possibl:[6,7,8,10,11,12,13,15,16,17],power:6,practic:0,prefer:4,prepar:4,prerequisit:4,presenc:[0,6],present:[7,10,11,13,15,16,17],presum:0,pretti:4,preview:3,previou:[4,6],previous:3,principl:6,problem:6,process:3,produc:0,project:[0,3,4],promot:3,prompt:6,propag:[3,7,8,9,10,11,12,13,14,15,16,17],properti:[3,7,8,9,10,11,12,13,15,16,17],provid:[0,5,7,8,10,11,12,13,15,16,17],publish:[3,4],pull:[0,4],purpos:[4,7,8,9,10,11,12,13,14,15,16,17],push:4,put:0,pycodestyl:3,pycrypto:3,pyflak:3,pylint:4,pypi:[3,6],pytest:4,python:[3,4,7,8,9,10,11,12,13,14,15,16,17],python_script:6,quaiti:3,question:6,rais:3,random:0,rang:9,raw:[7,8,9,10,11,12,13,14,15,16,17],reach:6,read:4,readthedoc:7,real:[3,4],reason:4,recap:6,recogn:[3,6],recommend:4,referenc:[3,16],regard:0,regardless:6,regist:[7,8,9,10,11,12,13,14,15,16,17],reject:3,relat:[3,6],releas:[3,5],release_:4,release_m:4,relev:4,remain:[7,8,9,10,11,12,13,15,16,17],remot:4,remov:[3,4],renam:7,renov:3,repo:[0,3,4],report:5,repositori:5,repres:4,request:[0,3,4,13,14],requir:[0,3,6,7,8,9,10,11,12,13,14,15,16,17],resourc:[1,3,5,6,7,8,10,11,12,13,15,16,17],respect:3,restart:6,restrict:3,result:3,retriev:3,review:4,right:[0,4,6],risk:6,roce:11,rockhopp:6,root:[3,7,8,9,10,11,12,13,14,15,16,17],rst:4,rule:[0,4,6,7,16],run:[4,6],safe:6,safeti:4,sai:0,same:[3,4],san:[12,13,14,15],saniti:4,sc27:2,scheur:[],scheuran:[],script:[3,6],search:5,section:[3,4,6],see:[0,3,4,6,13,16],seen:6,semant:[4,6],semver:4,sens:0,separ:12,server:16,servic:[2,6],session:[7,8,9,10,11,12,13,14,15,16,17],set:[0,3,5,6,7,8,9,10,11,12,13,14,15,16,17],setup:3,sever:3,sg1:13,sga1:14,share:[6,13],shell:[4,6],should:[0,3,4],show:[3,4],shown:[0,4,6],sign:0,signoff:0,simpli:6,sinc:3,size:15,some:[4,6,7,8,9,10,11,12,13,14,15,16,17],sometim:0,sound:0,sourc:[0,4],special:9,specif:[3,6,9],specifi:[3,4,6,7,8,9,10,11,12,13,14,15,16,17],specific:6,split:0,ssc_dns_server:3,ssc_ipv4_gatewai:3,stabl:[3,4,7],stable_:4,stable_m:4,stableinterfac:[],stage:0,standard:16,start:[0,3,5,6,12],start_:4,start_m:4,state:[0,3,6,7,8,9,10,11,12,13,14,15,16,17],statement:3,statu:[3,4,6,7,8,12,14],step:[4,6],still:[0,3,4],stop:[3,6,12],storag:[1,3,5,8,12],storage_group:13,storage_group_attach:14,storage_group_nam:[14,15],storage_volum:15,str:[7,8,9,10,11,12,13,14,15,16,17],stream:4,string:[3,6,7,8,10,11,12,13,15,16,17],structur:3,subject:[0,6],subsequ:3,subset:[3,7,8],subsystem:[13,14,15],succe:4,success:[4,7,8,9,10,11,12,13,14,15,16,17],sudo:6,suffix:[4,6],summar:0,summari:0,support:[0,3,4,5,7,9,12],sure:4,sv1:15,sync:3,syntax:[7,8,10,11,12,13,15,16,17],system:[2,4,7,8,9,10,11,12,13,14,15,16,17],tab:4,tag:4,taken:6,target:[3,4,7,8,10,11,12,13,15,16,17],task:[3,6],tee:6,templat:0,temporarili:3,termin:[3,6],test:[0,2,3,5,6,7,8,9,10,11,12,13,14,15,16,17],test_partit:4,testcas:4,testopt:4,text:4,than:3,thei:[3,6],them:4,therefor:6,thi:[0,3,4,5,7,8,9,10,11,12,13,14,15,16,17],thing:[4,6],third:0,through:4,thu:[3,6],todai:4,top:4,topic:4,tracker:[4,6],transit:6,travi:[3,4],tree:6,trigger:4,tupl:9,two:[6,9],txt:6,type:[0,3,7,8,9,10,11,12,13,14,15,16,17],typeerror:3,unchang:[7,8,9,10,11,12,13,15,16,17],under:6,underscor:[3,7,8,10,11,12,13,15,16,17],understand:4,unicod:3,unit:4,unnecessari:3,unreach:6,until:4,updat:[1,3,4,5,10,11,12,13,15,16,17],upgrad:[3,6],upload:4,upon:4,upstream:4,uri:[7,8,12,13,16],usag:[3,9,12],usage_domain:9,use:[0,3,6],used:[7,8,9,10,11,12,13,14,15,16,17],useful:0,user1:16,user:[0,1,3,4,5,6],userid:[7,8,9,10,11,12,13,14,15,16,17],usernam:[7,8,9,10,11,12,13,14,15,16,17],uses:[3,4,6],using:[0,3,6,7,8,9,10,11,12,13,15,16,17],util:6,v7k:10,valid:[0,3,4,7],valu:3,variabl:[4,6,7,8,9,10,11,12,13,14,15,16,17],variant:4,variou:6,vars_exampl:6,vault:6,vault_exampl:6,verbos:4,verifi:[4,6],version:[2,5],vfunction1:17,via:[4,6,16],violat:6,virtual:[1,3,4,5,10,11,12,13],virtual_funct:17,virtual_switch_uri:11,virtualenv:6,virtualenvwrapp:6,vlan_typ:3,volum:[1,3,5,13],vuln:3,vulner:3,wai:3,wait:4,want:4,web:[2,4,6],welcom:0,well:[7,8,9,10,11,12,13,14,15,16,17],were:[3,9],what:[0,4,5],when:[3,4,6,10,11,12,13,15,16,17],whenev:4,where:[0,3,6,10,11,12,13,15,16,17],whether:[0,12,13,14,16],which:[3,4,6,7,8,9,10,11,12,13,14,15,16,17],whose:12,why:0,window:6,without:[0,3,4,6],work:[0,3,4,6],writeabl:[3,7,8,10,11,12,13,15,16,17],written:[3,6],wrong:0,wrote:0,wwpn:12,yaml:[7,8,10,11,12,13,15,16,17],yet:[3,4,12],yml:[3,4,6],you:[0,4,6],your:[0,4,6],z13:6,z14:6,z15:[3,6],zeroiz:7,zhmc:[3,4,6,12],zhmc_adapt:[1,3,5,12],zhmc_cpc:[1,3,5],zhmc_crypto_attach:[1,3,5],zhmc_hba:[1,5,12],zhmc_nic:[1,3,5,12],zhmc_partit:[1,3,5,10,11,17],zhmc_storage_group:[1,3,5,12],zhmc_storage_group_attach:[1,3,5,13],zhmc_storage_volum:[1,3,5],zhmc_user:[1,3,5],zhmc_virtual_funct:[1,5,12],zhmcclient:[3,4,6,7],zhmcclient_mock:[7,8,9,10,11,12,13,14,15,16,17]},titles:["Contributing","All modules","Appendix","Change log","Development","ibm.zhmc Ansible Galaxy collection 1.0.0-dev1","Introduction","zhmc_adapter \u2013 Update adapters and create Hipersocket adapters","zhmc_cpc \u2013 Update CPCs","zhmc_crypto_attachment \u2013 Attach crypto resources to partitions","zhmc_hba \u2013 Create HBAs in partitions","zhmc_nic \u2013 Create NICs in partitions","zhmc_partition \u2013 Create partitions","zhmc_storage_group \u2013 Create storage groups","zhmc_storage_group_attachment \u2013 Attach storage groups to partitions","zhmc_storage_volume \u2013 Create storage volumes","zhmc_user \u2013 Create HMC users","zhmc_virtual_function \u2013 Create virtual functions in partitions"],titleterms:{"function":17,"new":4,"return":[7,8,9,10,11,12,13,14,15,16,17],adapt:7,all:1,also:12,altern:6,ansibl:5,appendix:2,attach:[9,14],author:[],bibliographi:2,build:4,chang:3,collect:5,commit:0,commun:[],compat:6,contribut:0,cpc:8,creat:[7,10,11,12,13,15,16,17],crypto:9,defin:[],deprec:6,dev1:[3,5],develop:4,document:4,environ:[4,6],exampl:[6,7,8,9,10,11,12,13,14,15,16,17],format:0,galaxi:5,group:[13,14],guid:[],hba:10,hipersocket:7,hmc:16,ibm:5,index:[],indic:5,instal:6,introduct:6,issu:6,level:[],licens:6,log:3,manag:[],messag:0,modul:1,nic:11,note:[13,14,15],packag:6,paramet:[7,8,9,10,11,12,13,14,15,16,17],partit:[9,10,11,12,14,17],playbook:6,provid:6,python:6,releas:4,report:6,repositori:4,requir:[],resourc:9,see:12,set:4,standard:6,start:4,statu:[],storag:[13,14,15],support:6,synopsi:[7,8,9,10,11,12,13,14,15,16,17],system:6,tabl:5,test:4,thi:6,updat:[7,8],user:16,valu:[7,8,9,10,11,12,13,14,15,16,17],verif:6,version:[3,4,6],virtual:[6,17],volum:15,what:6,zhmc:5,zhmc_adapt:7,zhmc_cpc:8,zhmc_crypto_attach:9,zhmc_hba:10,zhmc_nic:11,zhmc_partit:12,zhmc_storage_group:13,zhmc_storage_group_attach:14,zhmc_storage_volum:15,zhmc_user:16,zhmc_virtual_funct:17}}) \ No newline at end of file diff --git a/docs_source/modules/zhmc_adapter.rst b/docs_source/modules/zhmc_adapter.rst index 2783559c0..0299a9107 100644 --- a/docs_source/modules/zhmc_adapter.rst +++ b/docs_source/modules/zhmc_adapter.rst @@ -1,9 +1,14 @@ + +:github_url: https://github.com/IBM/ibm_zos_zosmf/tree/master/plugins/modules/zhmc_adapter.py + .. _zhmc_adapter_module: zhmc_adapter -- Update adapters and create Hipersocket adapters =============================================================== + + .. contents:: :local: :depth: 1 @@ -11,100 +16,143 @@ zhmc_adapter -- Update adapters and create Hipersocket adapters Synopsis -------- +- Gather facts about an adapter of a CPC (Z system), including its ports. +- Update the properties of an adapter and its ports. +- Create or delete a Hipersocket adapter. -Gather facts about an adapter of a CPC (Z system), including its ports. -Update the properties of an adapter and its ports. -Create or delete a Hipersocket adapter. +Parameters +---------- -Requirements ------------- -The below requirements are needed on the host that executes this module. -- Access to the WS API of the HMC of the targeted Z system (see :term:`HMC API`). The targeted Z system must be in the Dynamic Partition Manager (DPM) operational mode. + +hmc_host + The hostname or IP address of the HMC. + | **required**: True + | **type**: str -Parameters ----------- - hmc_host (True, str, None) - The hostname or IP address of the HMC. + +hmc_auth + The authentication credentials for the HMC, as a dictionary of ``userid``, ``password``. + + + | **required**: True + | **type**: dict + + + userid + The userid (username) for authenticating with the HMC. - hmc_auth (True, dict, None) - The authentication credentials for the HMC, as a dictionary of ``userid``, ``password``. + | **required**: True + | **type**: str - userid (True, str, None) - The userid (username) for authenticating with the HMC. + + password + The password for authenticating with the HMC. - password (True, str, None) - The password for authenticating with the HMC. + | **required**: True + | **type**: str - name (True, str, None) - The name of the target adapter. In case of renaming an adapter, this is the new name of the adapter. + +name + The name of the target adapter. In case of renaming an adapter, this is the new name of the adapter. - cpc_name (True, str, None) - The name of the target CPC. + | **required**: True + | **type**: str - match (False, dict, None) - Only for ``state=set``: Match properties for identifying the target adapter in the set of adapters in the CPC, if an adapter with the name specified in the ``name`` module parameter does not exist in that set. This parameter will be ignored otherwise. - Use of this parameter allows renaming an adapter: The ``name`` module parameter specifies the new name of the target adapter, and the ``match`` module parameter identifies the adapter to be renamed. This can be combined with other property updates by using the ``properties`` module parameter. + +cpc_name + The name of the target CPC. - The parameter is a dictionary. The key of each dictionary item is the property name as specified in the data model for adapter resources, with underscores instead of hyphens. The value of each dictionary item is the match value for the property (in YAML syntax). Integer properties may also be provided as decimal strings. - The specified match properties follow the rules of filtering for the zhmcclient library as described in https://python-zhmcclient.readthedocs.io/en/stable/concepts.html#filtering + | **required**: True + | **type**: str - The possible match properties are all properties in the data model for adapter resources, including ``name``. + +match + Only for ``state=set``: Match properties for identifying the target adapter in the set of adapters in the CPC, if an adapter with the name specified in the ``name`` module parameter does not exist in that set. This parameter will be ignored otherwise. - state (True, str, None) - The desired state for the attachment: + Use of this parameter allows renaming an adapter: The ``name`` module parameter specifies the new name of the target adapter, and the ``match`` module parameter identifies the adapter to be renamed. This can be combined with other property updates by using the ``properties`` module parameter. - * ``set``: Ensures that an existing adapter has the specified properties. + The parameter is a dictionary. The key of each dictionary item is the property name as specified in the data model for adapter resources, with underscores instead of hyphens. The value of each dictionary item is the match value for the property (in YAML syntax). Integer properties may also be provided as decimal strings. - * ``present``: Ensures that a Hipersockets adapter exists and has the specified properties. + The specified match properties follow the rules of filtering for the zhmcclient library as described in https://python-zhmcclient.readthedocs.io/en/stable/concepts.html#filtering - * ``absent``: Ensures that a Hipersockets adapter does not exist. + The possible match properties are all properties in the data model for adapter resources, including ``name``. - * ``facts``: Does not change anything on the adapter and returns the adapter properties including its ports. + | **required**: False + | **type**: dict - properties (False, dict, None) - Only for ``state=set|present``: New values for the properties of the adapter. Properties omitted in this dictionary will remain unchanged. This parameter will be ignored for other states. - The parameter is a dictionary. The key of each dictionary item is the property name as specified in the data model for adapter 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. + +state + The desired state for the attachment: - The possible properties in this dictionary are the properties defined as writeable in the data model for adapter resources, with the following exceptions: + * ``set``: Ensures that an existing adapter has the specified properties. - * ``name``: Cannot be specified as a property because the name has already been specified in the ``name`` module parameter. + * ``present``: Ensures that a Hipersockets adapter exists and has the specified properties. - * ``type``: The desired adapter type can be specified in order to support adapters that can change their type (e.g. the FICON Express adapter can change its type between 'not-configured', 'fcp' and 'fc'). + * ``absent``: Ensures that a Hipersockets adapter does not exist. - * ``crypto_type``: The crypto type can be specified in order to support the ability of the Crypto Express adapters to change their crypto type. Valid values are 'ep11', 'cca' and 'acc'. Changing to 'acc' will zeroize the crypto adapter. + * ``facts``: Does not change anything on the adapter and returns the adapter properties including its ports. - log_file (False, str, None) - 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**: True + | **type**: str + | **choices**: set, present, absent, facts - faked_session (False, raw, None) - A ``zhmcclient_mock.FakedSession`` object that has a mocked HMC set up. If not null, this session will be used instead of connecting to the HMC specified in ``hmc_host``. This is used for testing purposes only. + +properties + Only for ``state=set|present``: New values for the properties of the adapter. Properties omitted in this dictionary will remain unchanged. This parameter will be ignored for other states. + The parameter is a dictionary. The key of each dictionary item is the property name as specified in the data model for adapter 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 adapter resources, with the following exceptions: + * ``name``: Cannot be specified as a property because the name has already been specified in the ``name`` module parameter. + * ``type``: The desired adapter type can be specified in order to support adapters that can change their type (e.g. the FICON Express adapter can change its type between 'not-configured', 'fcp' and 'fc'). + * ``crypto_type``: The crypto type can be specified in order to support the ability of the Crypto Express adapters to change their crypto type. Valid values are 'ep11', 'cca' and 'acc'. Changing to 'acc' will zeroize the crypto adapter. + + + | **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 + + + +faked_session + A ``zhmcclient_mock.FakedSession`` object that has a mocked HMC set up. If not null, this session will be used instead of connecting to the HMC specified in ``hmc_host``. This is used for testing purposes only. + + + | **required**: False + | **type**: raw @@ -114,64 +162,71 @@ Examples .. code-block:: yaml+jinja - - --- - # Note: The following examples assume that some variables named 'my_*' are set. - - - name: Gather facts about an existing adapter - zhmc_adapter: - hmc_host: "{{ my_hmc_host }}" - hmc_auth: "{{ my_hmc_auth }}" - cpc_name: "{{ my_cpc_name }}" - name: "{{ my_adapter_name }}" - state: facts - register: adapter1 - - - name: Ensure an existing adapter has the desired property values - zhmc_adapter: - hmc_host: "{{ my_hmc_host }}" - hmc_auth: "{{ my_hmc_auth }}" - cpc_name: "{{ my_cpc_name }}" - name: "{{ my_adapter_name }}" - state: set - properties: - description: "This is adapter {{ my_adapter_name }}" - register: adapter1 - - - name: "Ensure the existing adapter identified by its name or adapter ID has - the desired name and property values" - zhmc_adapter: - hmc_host: "{{ my_hmc_host }}" - hmc_auth: "{{ my_hmc_auth }}" - cpc_name: "{{ my_cpc_name }}" - name: "{{ my_adapter_name }}" - match: - adapter_id: "12C" - state: set - properties: - description: "This is adapter {{ my_adapter_name }}" - register: adapter1 - - - name: "Ensure a Hipersockets adapter exists and has the desired property - values" - zhmc_adapter: - hmc_host: "{{ my_hmc_host }}" - hmc_auth: "{{ my_hmc_auth }}" - cpc_name: "{{ my_cpc_name }}" - name: "{{ my_adapter_name }}" - state: present - properties: - type: hipersockets - description: "This is Hipersockets adapter {{ my_adapter_name }}" - register: adapter1 - - - name: "Ensure a Hipersockets adapter does not exist" - zhmc_adapter: - hmc_host: "{{ my_hmc_host }}" - hmc_auth: "{{ my_hmc_auth }}" - cpc_name: "{{ my_cpc_name }}" - name: "{{ my_adapter_name }}" - state: absent + + --- + # Note: The following examples assume that some variables named 'my_*' are set. + + - name: Gather facts about an existing adapter + zhmc_adapter: + hmc_host: "{{ my_hmc_host }}" + hmc_auth: "{{ my_hmc_auth }}" + cpc_name: "{{ my_cpc_name }}" + name: "{{ my_adapter_name }}" + state: facts + register: adapter1 + + - name: Ensure an existing adapter has the desired property values + zhmc_adapter: + hmc_host: "{{ my_hmc_host }}" + hmc_auth: "{{ my_hmc_auth }}" + cpc_name: "{{ my_cpc_name }}" + name: "{{ my_adapter_name }}" + state: set + properties: + description: "This is adapter {{ my_adapter_name }}" + register: adapter1 + + - name: "Ensure the existing adapter identified by its name or adapter ID has + the desired name and property values" + zhmc_adapter: + hmc_host: "{{ my_hmc_host }}" + hmc_auth: "{{ my_hmc_auth }}" + cpc_name: "{{ my_cpc_name }}" + name: "{{ my_adapter_name }}" + match: + adapter_id: "12C" + state: set + properties: + description: "This is adapter {{ my_adapter_name }}" + register: adapter1 + + - name: "Ensure a Hipersockets adapter exists and has the desired property + values" + zhmc_adapter: + hmc_host: "{{ my_hmc_host }}" + hmc_auth: "{{ my_hmc_auth }}" + cpc_name: "{{ my_cpc_name }}" + name: "{{ my_adapter_name }}" + state: present + properties: + type: hipersockets + description: "This is Hipersockets adapter {{ my_adapter_name }}" + register: adapter1 + + - name: "Ensure a Hipersockets adapter does not exist" + zhmc_adapter: + hmc_host: "{{ my_hmc_host }}" + hmc_auth: "{{ my_hmc_auth }}" + cpc_name: "{{ my_cpc_name }}" + name: "{{ my_adapter_name }}" + state: absent + + + + + + + @@ -179,62 +234,74 @@ Examples Return Values ------------- -cpc (success, dict, ) - For ``state=absent``, an empty dictionary. - For ``state=set|present|facts``, a dictionary with the properties of the adapter, including additional artificial properties as described below. + cpc + For ``state=absent``, an empty dictionary. + + For ``state=set|present|facts``, a dictionary with the properties of the adapter, including additional artificial properties as described below. + + + | **returned**: success + | **type**: dict + + + name + Adapter name + + + | **type**: str + + + + {property} + Additional properties of the adapter, as described in the :term:`HMC API` (using hyphens (-) in the property names). + + | **type**: - name (, str, ) - Adapter name - {property} (, any, ) - Additional properties of the adapter, as described in the :term:`HMC API` (using hyphens (-) in the property names). + ports + Artificial property for the ports of the adapter, with a subset of its properties. - ports (, dict, ) - Artificial property for the ports of the adapter, with a subset of its properties. + | **type**: dict - {name} (, dict, ) - Port name + {name} + Port name - name (, str, ) - Port name + | **type**: dict - status (, str, ) - Status of the port + name + Port name - element_uri (, str, ) - Canonical URI of the port + | **type**: str + status + Status of the port + | **type**: str -Status ------- + element_uri + Canonical URI of the port + | **type**: str -- This module is guaranteed to have backward compatible interface changes going forward. *[stableinterface]* -- This module is maintained by community. -Authors -~~~~~~~ -- Andreas Maier (@andy-maier) -- Andreas Scheuring (@scheuran) diff --git a/docs_source/modules/zhmc_cpc.rst b/docs_source/modules/zhmc_cpc.rst index 9d30ec1bf..796023811 100644 --- a/docs_source/modules/zhmc_cpc.rst +++ b/docs_source/modules/zhmc_cpc.rst @@ -1,9 +1,14 @@ + +:github_url: https://github.com/IBM/ibm_zos_zosmf/tree/master/plugins/modules/zhmc_cpc.py + .. _zhmc_cpc_module: zhmc_cpc -- Update CPCs ======================= + + .. contents:: :local: :depth: 1 @@ -11,73 +16,107 @@ zhmc_cpc -- Update CPCs Synopsis -------- +- Gather facts about a CPC (Z system), including its adapters and partitions. +- Update the properties of a CPC. -Gather facts about a CPC (Z system), including its adapters and partitions. -Update the properties of a CPC. -Requirements ------------- -The below requirements are needed on the host that executes this module. +Parameters +---------- -- Access to the WS API of the HMC of the targeted Z system (see :term:`HMC API`). The targeted Z system must be in the Dynamic Partition Manager (DPM) operational mode + +hmc_host + The hostname or IP address of the HMC. -Parameters ----------- + | **required**: True + | **type**: str + + + +hmc_auth + The authentication credentials for the HMC, as a dictionary of ``userid``, ``password``. + + + | **required**: True + | **type**: dict + + + + userid + The userid (username) for authenticating with the HMC. + + + | **required**: True + | **type**: str + - hmc_host (True, str, None) - The hostname or IP address of the HMC. + + password + The password for authenticating with the HMC. - hmc_auth (True, dict, None) - The authentication credentials for the HMC, as a dictionary of ``userid``, ``password``. + | **required**: True + | **type**: str - userid (True, str, None) - The userid (username) for authenticating with the HMC. + +name + The name of the target CPC. - password (True, str, None) - The password for authenticating with the HMC. + | **required**: True + | **type**: str - name (True, str, None) - The name of the target CPC. + +state + The desired state for the attachment: + * ``set``: Ensures that the CPC has the specified properties. - state (True, str, None) - The desired state for the attachment: + * ``facts``: Does not change anything on the CPC and returns the CPC properties including its child resources. - * ``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. + | **required**: True + | **type**: str + | **choices**: set, facts - properties (False, dict, None) - 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``. + +properties + 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 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. + The possible properties in this dictionary are the properties defined as writeable in the data model for CPC resources. - log_file (False, str, None) - 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**: dict - faked_session (False, raw, None) - A ``zhmcclient_mock.FakedSession`` object that has a mocked HMC set up. If not null, this session will be used instead of connecting to the HMC specified in ``hmc_host``. This is used for testing purposes only. + +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 + +faked_session + A ``zhmcclient_mock.FakedSession`` object that has a mocked HMC set up. If not null, this session will be used instead of connecting to the HMC specified in ``hmc_host``. This is used for testing purposes only. + | **required**: False + | **type**: raw + @@ -86,28 +125,35 @@ Examples .. code-block:: yaml+jinja - - --- - # Note: The following examples assume that some variables named 'my_*' are set. + + --- + # 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 }}" + + + + + - - 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 }}" @@ -115,104 +161,156 @@ Examples Return Values ------------- -cpc (success, dict, ) - A dictionary with the properties of the CPC, including additional artificial properties as described below. + cpc + A dictionary with the properties of the CPC, including additional artificial properties as described below. + + + | **returned**: success + | **type**: dict + + + name + CPC name + + + | **type**: str + + + + {property} + Additional properties of the CPC, as described in the :term:`HMC API` (using hyphens (-) in the property names). + + + | **type**: + + + + partitions + Artificial property for the defined partitions of the CPC, with a subset of its properties. + + + | **type**: dict + + + {name} + Partition name + + + | **type**: dict + + + name + Partition name + + + | **type**: str + + + + status + Status of the partition + + + | **type**: str + + + + object_uri + Canonical URI of the partition + + + | **type**: str + + + + + + + + adapters + Artificial property for the adapters of the CPC, with a subset of its properties. - name (, str, ) - CPC name + | **type**: dict - {property} (, any, ) - Additional properties of the CPC, as described in the :term:`HMC API` (using hyphens (-) in the property names). + {name} + Adapter name - partitions (, dict, ) - Artificial property for the defined partitions of the CPC, with a subset of its properties. + | **type**: dict - {name} (, dict, ) - Partition name + name + Adapter name - name (, str, ) - Partition name + | **type**: str - status (, str, ) - Status of the partition - object_uri (, str, ) - Canonical URI of the partition + status + Status of the adapter + | **type**: str - adapters (, dict, ) - Artificial property for the adapters of the CPC, with a subset of its properties. + object_uri + Canonical URI of the adapter - {name} (, dict, ) - Adapter name + | **type**: str - name (, str, ) - Adapter name - status (, str, ) - Status of the adapter - object_uri (, str, ) - Canonical URI of the adapter + storage-groups + Artificial property for the storage groups associated with the CPC, with a subset of its properties. - storage-groups (, dict, ) - Artificial property for the storage groups associated with the CPC, with a subset of its properties. + | **type**: dict - {name} (, dict, ) - Storage group name + {name} + Storage group name - name (, str, ) - Storage group name + | **type**: dict - fulfillment-status (, str, ) - Fulfillment status of the storage group + name + Storage group name - object_uri (, str, ) - Canonical URI of the storage group + | **type**: str + fulfillment-status + Fulfillment status of the storage group + | **type**: str -Status ------- + object_uri + Canonical URI of the storage group + | **type**: str -- This module is guaranteed to have backward compatible interface changes going forward. *[stableinterface]* -- This module is maintained by community. -Authors -~~~~~~~ -- Andreas Maier (@andy-maier) -- Andreas Scheuring (@scheuran) diff --git a/docs_source/modules/zhmc_crypto_attachment.rst b/docs_source/modules/zhmc_crypto_attachment.rst index 33900ece3..1d31791ad 100644 --- a/docs_source/modules/zhmc_crypto_attachment.rst +++ b/docs_source/modules/zhmc_crypto_attachment.rst @@ -1,9 +1,14 @@ + +:github_url: https://github.com/IBM/ibm_zos_zosmf/tree/master/plugins/modules/zhmc_crypto_attachment.py + .. _zhmc_crypto_attachment_module: zhmc_crypto_attachment -- Attach crypto resources to partitions =============================================================== + + .. contents:: :local: :depth: 1 @@ -11,93 +16,157 @@ zhmc_crypto_attachment -- Attach crypto resources to partitions Synopsis -------- +- Gather facts about the attachment of crypto adapters and crypto domains to a partition of a CPC (Z system). +- Attach a range of crypto domains and a number of crypto adapters to a partition. +- Detach all crypto domains and all crypto adapters from a partition. -Gather facts about the attachment of crypto adapters and crypto domains to a partition of a CPC (Z system). -Attach a range of crypto domains and a number of crypto adapters to a partition. -Detach all crypto domains and all crypto adapters from a partition. +Parameters +---------- -Requirements ------------- -The below requirements are needed on the host that executes this module. -- Access to the WS API of the HMC of the targeted Z system (see :term:`HMC API`). The targeted Z system must be in the Dynamic Partition Manager (DPM) operational mode. + +hmc_host + The hostname or IP address of the HMC. + | **required**: True + | **type**: str + + + +hmc_auth + The authentication credentials for the HMC, as a dictionary of ``userid``, ``password``. + + + | **required**: True + | **type**: dict + + + + userid + The userid (username) for authenticating with the HMC. + + + | **required**: True + | **type**: str -Parameters ----------- - hmc_host (True, str, None) - The hostname or IP address of the HMC. + + password + The password for authenticating with the HMC. - hmc_auth (True, dict, None) - The authentication credentials for the HMC, as a dictionary of ``userid``, ``password``. + | **required**: True + | **type**: str - userid (True, str, None) - The userid (username) for authenticating with the HMC. + +cpc_name + The name of the CPC that has the partition and the crypto adapters. - password (True, str, None) - The password for authenticating with the HMC. + | **required**: True + | **type**: str - cpc_name (True, str, None) - The name of the CPC that has the partition and the crypto adapters. + +partition_name + The name of the partition to which the crypto domains and crypto adapters are attached. - partition_name (True, str, None) - The name of the partition to which the crypto domains and crypto adapters are attached. + | **required**: True + | **type**: str - state (True, str, None) - The desired state for the attachment: + +state + The desired state for the attachment: - * ``attached``: Ensures that the specified number of crypto adapters of the specified crypto type, and the specified range of domain index numbers in the specified access mode are attached to the partition. + * ``attached``: Ensures that the specified number of crypto adapters of the specified crypto type, and the specified range of domain index numbers in the specified access mode are attached to the partition. - * ``detached``: Ensures that no crypto adapter and no crypto domains are attached to the partition. + * ``detached``: Ensures that no crypto adapter and no crypto domains are attached to the partition. - * ``facts``: Does not change anything on the attachment and returns the crypto configuration of the partition. + * ``facts``: Does not change anything on the attachment and returns the crypto configuration of the partition. - adapter_count (False, int, -1) - Only for ``state=attach``: The number of crypto adapters the partition needs to have attached. The special value -1 means all adapters of the desired crypto type in the CPC. The ``adapter_names`` and ``adapter_count`` parameters are mutually exclusive; if neither is specified the default for ``adapter_count`` applies. + | **required**: True + | **type**: str + | **choices**: attached, detached, facts - adapter_names (False, list, []) - Only for ``state=attach``: The names of the crypto adapters the partition needs to have attached. The ``adapter_names`` and ``adapter_count`` parameters are mutually exclusive; if neither is specified the default for ``adapter_count`` applies. + +adapter_count + Only for ``state=attach``: The number of crypto adapters the partition needs to have attached. The special value -1 means all adapters of the desired crypto type in the CPC. The ``adapter_names`` and ``adapter_count`` parameters are mutually exclusive; if neither is specified the default for ``adapter_count`` applies. - domain_range (False, list, [0, -1]) - Only for ``state=attach``: The domain range the partition needs to have attached, as a tuple of integers (min, max) that specify the inclusive range of domain index numbers. Other domains attached to the partition remain unchanged. The special value -1 for the max item means the maximum supported domain index number. + | **required**: False + | **type**: int + | **default**: -1 - access_mode (False, str, usage) - Only for ``state=attach``: The access mode in which the crypto domains specified in ``domain_range`` need to be attached. + +adapter_names + Only for ``state=attach``: The names of the crypto adapters the partition needs to have attached. The ``adapter_names`` and ``adapter_count`` parameters are mutually exclusive; if neither is specified the default for ``adapter_count`` applies. - crypto_type (False, str, ep11) - Only for ``state=attach``: The crypto type of the crypto adapters that will be considered for attaching. + | **required**: False + | **type**: list - log_file (False, str, None) - 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. + +domain_range + Only for ``state=attach``: The domain range the partition needs to have attached, as a tuple of integers (min, max) that specify the inclusive range of domain index numbers. Other domains attached to the partition remain unchanged. The special value -1 for the max item means the maximum supported domain index number. - faked_session (False, raw, None) - A ``zhmcclient_mock.FakedSession`` object that has a mocked HMC set up. If not null, this session will be used instead of connecting to the HMC specified in ``hmc_host``. This is used for testing purposes only. + | **required**: False + | **type**: list + | **default**: [0, -1] + +access_mode + Only for ``state=attach``: The access mode in which the crypto domains specified in ``domain_range`` need to be attached. + | **required**: False + | **type**: str + | **default**: usage + | **choices**: usage, control + +crypto_type + Only for ``state=attach``: The crypto type of the crypto adapters that will be considered for attaching. + + + | **required**: False + | **type**: str + | **default**: ep11 + | **choices**: ep11, cca, acc + + + +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 + + + +faked_session + A ``zhmcclient_mock.FakedSession`` object that has a mocked HMC set up. If not null, this session will be used instead of connecting to the HMC specified in ``hmc_host``. This is used for testing purposes only. + + + | **required**: False + | **type**: raw + @@ -106,66 +175,73 @@ Examples .. code-block:: yaml+jinja - - --- - # Note: The following examples assume that some variables named 'my_*' are set. - - - name: Gather facts about the crypto configuration of a partition - zhmc_crypto_attachment: - hmc_host: "{{ my_hmc_host }}" - hmc_auth: "{{ my_hmc_auth }}" - cpc_name: "{{ my_cpc_name }}" - partition_name: "{{ my_partition_name }}" - state: facts - register: crypto1 - - - name: Ensure domain 0 on all ep11 adapters is attached in usage mode - zhmc_crypto_attachment: - hmc_host: "{{ my_hmc_host }}" - hmc_auth: "{{ my_hmc_auth }}" - cpc_name: "{{ my_cpc_name }}" - partition_name: "{{ my_first_partition_name }}" - state: attached - crypto_type: ep11 - adapter_count: -1 - domain_range: 0,0 - access_mode: usage - - - name: Ensure domains 1-max on all ep11 adapters are attached in control mode - zhmc_crypto_attachment: - hmc_host: "{{ my_hmc_host }}" - hmc_auth: "{{ my_hmc_auth }}" - cpc_name: "{{ my_cpc_name }}" - partition_name: "{{ my_first_partition_name }}" - state: attached - crypto_type: ep11 - adapter_count: -1 - domain_range: 1,-1 - access_mode: control - - - name: Ensure domains 0-max on 1 ep11 adapter are attached to in usage mode - zhmc_crypto_attachment: - hmc_host: "{{ my_hmc_host }}" - hmc_auth: "{{ my_hmc_auth }}" - cpc_name: "{{ my_cpc_name }}" - partition_name: "{{ my_second_partition_name }}" - state: attached - crypto_type: ep11 - adapter_count: 1 - domain_range: 0,-1 - access_mode: usage - - - name: Ensure domains 0-max on two specific ep11 adapters are attached - zhmc_crypto_attachment: - hmc_host: "{{ my_hmc_host }}" - hmc_auth: "{{ my_hmc_auth }}" - cpc_name: "{{ my_cpc_name }}" - partition_name: "{{ my_second_partition_name }}" - state: attached - crypto_type: ep11 - adapter_names: [CRYP00, CRYP01] - domain_range: 0,-1 - access_mode: usage + + --- + # Note: The following examples assume that some variables named 'my_*' are set. + + - name: Gather facts about the crypto configuration of a partition + zhmc_crypto_attachment: + hmc_host: "{{ my_hmc_host }}" + hmc_auth: "{{ my_hmc_auth }}" + cpc_name: "{{ my_cpc_name }}" + partition_name: "{{ my_partition_name }}" + state: facts + register: crypto1 + + - name: Ensure domain 0 on all ep11 adapters is attached in usage mode + zhmc_crypto_attachment: + hmc_host: "{{ my_hmc_host }}" + hmc_auth: "{{ my_hmc_auth }}" + cpc_name: "{{ my_cpc_name }}" + partition_name: "{{ my_first_partition_name }}" + state: attached + crypto_type: ep11 + adapter_count: -1 + domain_range: 0,0 + access_mode: usage + + - name: Ensure domains 1-max on all ep11 adapters are attached in control mode + zhmc_crypto_attachment: + hmc_host: "{{ my_hmc_host }}" + hmc_auth: "{{ my_hmc_auth }}" + cpc_name: "{{ my_cpc_name }}" + partition_name: "{{ my_first_partition_name }}" + state: attached + crypto_type: ep11 + adapter_count: -1 + domain_range: 1,-1 + access_mode: control + + - name: Ensure domains 0-max on 1 ep11 adapter are attached to in usage mode + zhmc_crypto_attachment: + hmc_host: "{{ my_hmc_host }}" + hmc_auth: "{{ my_hmc_auth }}" + cpc_name: "{{ my_cpc_name }}" + partition_name: "{{ my_second_partition_name }}" + state: attached + crypto_type: ep11 + adapter_count: 1 + domain_range: 0,-1 + access_mode: usage + + - name: Ensure domains 0-max on two specific ep11 adapters are attached + zhmc_crypto_attachment: + hmc_host: "{{ my_hmc_host }}" + hmc_auth: "{{ my_hmc_auth }}" + cpc_name: "{{ my_cpc_name }}" + partition_name: "{{ my_second_partition_name }}" + state: attached + crypto_type: ep11 + adapter_names: [CRYP00, CRYP01] + domain_range: 0,-1 + access_mode: usage + + + + + + + @@ -173,88 +249,125 @@ Examples Return Values ------------- -crypto_configuration (success, dict, ) - For ``state=detached|attached|facts``, the crypto configuration of the partition after the changes performed by the module. + + crypto_configuration + For ``state=detached|attached|facts``, the crypto configuration of the partition after the changes performed by the module. + + + | **returned**: success + | **type**: dict + + + {name} + Partition name + + + | **type**: dict + + + adapters + Attached adapters + + + | **type**: dict + + + {name} + Adapter name + + + | **type**: dict + + + name + Adapter name + + + | **type**: str + + + + {property} + Additional properties of the adapter, as described in the :term:`HMC API` (using hyphens (-) in the property names). + + + | **type**: + + + + + - {name} (, dict, ) - Partition name + domain_config + Attached crypto domains - adapters (, dict, ) - Attached adapters + | **type**: dict - {name} (, dict, ) - Adapter name + {index} + Crypto domain index - name (, str, ) - Adapter name + | **type**: dict - {property} (, any, ) - Additional properties of the adapter, as described in the :term:`HMC API` (using hyphens (-) in the property names). + {access_mode} + Access mode ('control' or 'usage'). + | **type**: str - domain_config (, dict, ) - Attached crypto domains - {index} (, dict, ) - Crypto domain index - {access_mode} (, str, ) - Access mode ('control' or 'usage'). + usage_domains + Domain index numbers of the crypto domains attached in usage mode + | **type**: list - usage_domains (, list, ) - Domain index numbers of the crypto domains attached in usage mode - control_domains (, list, ) - Domain index numbers of the crypto domains attached in control mode + control_domains + Domain index numbers of the crypto domains attached in control mode + | **type**: list -changes (success, dict, ) - For ``state=detached|attached|facts``, a dictionary with the changes performed. - added-adapters (, list, ) - Names of the adapters that were added to the partition - added-domains (, list, ) - Domain index numbers of the crypto domains that were added to the partition + changes + For ``state=detached|attached|facts``, a dictionary with the changes performed. + | **returned**: success + | **type**: dict + added-adapters + Names of the adapters that were added to the partition -Status ------- + | **type**: list -- This module is guaranteed to have backward compatible interface changes going forward. *[stableinterface]* + added-domains + Domain index numbers of the crypto domains that were added to the partition -- This module is maintained by community. + | **type**: list -Authors -~~~~~~~ -- Andreas Maier (@andy-maier) -- Andreas Scheuring (@scheuran) diff --git a/docs_source/modules/zhmc_hba.rst b/docs_source/modules/zhmc_hba.rst index 01639c787..4fbcee238 100644 --- a/docs_source/modules/zhmc_hba.rst +++ b/docs_source/modules/zhmc_hba.rst @@ -1,9 +1,14 @@ + +:github_url: https://github.com/IBM/ibm_zos_zosmf/tree/master/plugins/modules/zhmc_hba.py + .. _zhmc_hba_module: zhmc_hba -- Create HBAs in partitions ===================================== + + .. contents:: :local: :depth: 1 @@ -11,89 +16,132 @@ 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. -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 below requirements are needed on the host that executes this module. +Parameters +---------- -- Access to the WS API of the HMC of the targeted Z system (see :term:`HMC API`). The targeted Z system must be in the Dynamic Partition Manager (DPM) operational mode. -- The targeted Z system must be a z13 generation. The z14 and later generations manage HBAs automatically via the "dpm-storage-management" firmware feature. + +hmc_host + The hostname or IP address of the HMC. -Parameters ----------- + | **required**: True + | **type**: str + + + +hmc_auth + The authentication credentials for the HMC, as a dictionary of ``userid``, ``password``. + + + | **required**: True + | **type**: dict + + + + userid + The userid (username) for authenticating with the HMC. + + + | **required**: True + | **type**: str - hmc_host (True, str, None) - The hostname or IP address of the HMC. + + password + The password for authenticating with the HMC. - hmc_auth (True, dict, None) - The authentication credentials for the HMC, as a dictionary of ``userid``, ``password``. + | **required**: True + | **type**: str - userid (True, str, None) - The userid (username) for authenticating with the HMC. - password (True, str, None) - The password for authenticating with the HMC. + +cpc_name + The name of the CPC with the partition containing the HBA. + | **required**: True + | **type**: str - cpc_name (True, str, None) - The name of the CPC with the partition containing the HBA. + +partition_name + The name of the partition containing the HBA. - partition_name (True, str, None) - The name of the partition containing the HBA. + | **required**: True + | **type**: str - name (True, str, None) - The name of the target HBA that is managed. If the HBA needs to be created, this value becomes its name. + +name + The name of the target HBA that is managed. If the HBA needs to be created, this value becomes its name. - state (True, str, None) - The desired state for the target HBA: - ``absent``: Ensures that the HBA does not exist in the specified partition. + | **required**: True + | **type**: str - ``present``: Ensures that the HBA exists in the specified partition and has the specified properties. + +state + The desired state for the target HBA: - properties (False, dict, None) - 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``. + ``absent``: Ensures that the HBA does not exist in the specified partition. - 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: + ``present``: Ensures that the HBA exists in the specified partition and has the specified properties. - * ``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``. + | **required**: True + | **type**: str + | **choices**: absent, present - * ``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 + 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``. - 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. + 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. - log_file (False, str, None) - 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. + * ``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. - faked_session (False, raw, None) - A ``zhmcclient_mock.FakedSession`` object that has a mocked HMC set up. If not null, this session will be used instead of connecting to the HMC specified in ``hmc_host``. This is used for testing purposes only. + * ``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 + + + +faked_session + A ``zhmcclient_mock.FakedSession`` object that has a mocked HMC set up. If not null, this session will be used instead of connecting to the HMC specified in ``hmc_host``. This is used for testing purposes only. + + + | **required**: False + | **type**: raw @@ -103,74 +151,72 @@ Examples .. code-block:: yaml+jinja - - --- - # 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 + + --- + # 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 -------------- -hba (success, dict, ) - For ``state=absent``, an empty dictionary. - For ``state=present``, a dictionary with the resource properties of the HBA after changes, if any. - name (, str, ) - HBA name - {property} (, any, ) - Additional properties of the HBA, as described in the :term:`HMC API` (using hyphens (-) in the property names). +Return Values +------------- + + + hba + For ``state=absent``, an empty dictionary. + + For ``state=present``, a dictionary with the resource properties of the HBA after changes, if any. + + + | **returned**: success + | **type**: dict + name + HBA name -Status ------- + | **type**: str -- This module is guaranteed to have backward compatible interface changes going forward. *[stableinterface]* + {property} + Additional properties of the HBA, as described in the :term:`HMC API` (using hyphens (-) in the property names). -- This module is maintained by community. + | **type**: -Authors -~~~~~~~ -- Andreas Maier (@andy-maier) -- Andreas Scheuring (@scheuran) -- Juergen Leopold (@leopoldjuergen) diff --git a/docs_source/modules/zhmc_nic.rst b/docs_source/modules/zhmc_nic.rst index 2077ecb89..cd86111ed 100644 --- a/docs_source/modules/zhmc_nic.rst +++ b/docs_source/modules/zhmc_nic.rst @@ -1,9 +1,14 @@ + +:github_url: https://github.com/IBM/ibm_zos_zosmf/tree/master/plugins/modules/zhmc_nic.py + .. _zhmc_nic_module: zhmc_nic -- Create NICs in partitions ===================================== + + .. contents:: :local: :depth: 1 @@ -11,88 +16,132 @@ zhmc_nic -- Create NICs in partitions Synopsis -------- +- Create, update, or delete a NIC (virtual Network Interface Card) in a partition of a CPC (Z system). +- Note that the Ansible module zhmc_partition can be used to gather facts about existing NICs of a partition. -Create, update, or delete a NIC (virtual Network Interface Card) in a partition of a CPC (Z system). -Note that the Ansible module zhmc_partition can be used to gather facts about existing NICs of a partition. -Requirements ------------- -The below requirements are needed on the host that executes this module. +Parameters +---------- -- Access to the WS API of the HMC of the targeted Z system (see :term:`HMC API`). The targeted Z system must be in the Dynamic Partition Manager (DPM) operational mode. + +hmc_host + The hostname or IP address of the HMC. -Parameters ----------- + | **required**: True + | **type**: str + + + +hmc_auth + The authentication credentials for the HMC, as a dictionary of ``userid``, ``password``. + + + | **required**: True + | **type**: dict + + + + userid + The userid (username) for authenticating with the HMC. + + + | **required**: True + | **type**: str - hmc_host (True, str, None) - The hostname or IP address of the HMC. + + password + The password for authenticating with the HMC. - hmc_auth (True, dict, None) - The authentication credentials for the HMC, as a dictionary of ``userid``, ``password``. + | **required**: True + | **type**: str - userid (True, str, None) - The userid (username) for authenticating with the HMC. - password (True, str, None) - The password for authenticating with the HMC. + +cpc_name + The name of the CPC with the partition containing the NIC. + | **required**: True + | **type**: str - cpc_name (True, str, None) - The name of the CPC with the partition containing the NIC. + +partition_name + The name of the partition containing the NIC. - partition_name (True, str, None) - The name of the partition containing the NIC. + | **required**: True + | **type**: str - name (True, str, None) - The name of the target NIC that is managed. If the NIC needs to be created, this value becomes its name. + +name + The name of the target NIC that is managed. If the NIC needs to be created, this value becomes its name. - state (True, str, None) - The desired state for the target NIC: - ``absent``: Ensures that the NIC does not exist in the specified partition. + | **required**: True + | **type**: str - ``present``: Ensures that the NIC exists in the specified partition and has the specified properties. + +state + The desired state for the target NIC: - properties (False, dict, None) - Dictionary with input properties for the NIC, 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``. + ``absent``: Ensures that the NIC does not exist in the specified partition. - The possible input properties in this dictionary are the properties defined as writeable in the data model for NIC resources (where the property names contain underscores instead of hyphens), with the following exceptions: + ``present``: Ensures that the NIC exists in the specified partition and has the specified properties. - * ``name``: Cannot be specified because the name has already been specified in the ``name`` module parameter. - * ``network_adapter_port_uri`` and ``virtual_switch_uri``: Cannot be specified because this information is specified using the artificial properties ``adapter_name`` and ``adapter_port``. + | **required**: True + | **type**: str + | **choices**: absent, present - * ``adapter_name``: The name of the adapter that has the port backing the target NIC. Used for all adapter families (ROCE, OSA, Hipersockets). - * ``adapter_port``: The port index of the adapter port backing the target NIC. Used for all adapter families (ROCE, OSA, Hipersockets). + +properties + Dictionary with input properties for the NIC, 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``. - Properties omitted in this dictionary will remain unchanged when the NIC already exists, and will get the default value defined in the data model for NICs when the NIC is being created. + The possible input properties in this dictionary are the properties defined as writeable in the data model for NIC 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. - log_file (False, str, None) - 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. + * ``network_adapter_port_uri`` and ``virtual_switch_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 NIC. Used for all adapter families (ROCE, OSA, Hipersockets). - faked_session (False, raw, None) - A ``zhmcclient_mock.FakedSession`` object that has a mocked HMC set up. If not null, this session will be used instead of connecting to the HMC specified in ``hmc_host``. This is used for testing purposes only. + * ``adapter_port``: The port index of the adapter port backing the target NIC. Used for all adapter families (ROCE, OSA, Hipersockets). + Properties omitted in this dictionary will remain unchanged when the NIC already exists, and will get the default value defined in the data model for NICs when the NIC 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 + + + +faked_session + A ``zhmcclient_mock.FakedSession`` object that has a mocked HMC set up. If not null, this session will be used instead of connecting to the HMC specified in ``hmc_host``. This is used for testing purposes only. + + + | **required**: False + | **type**: raw @@ -102,74 +151,72 @@ Examples .. code-block:: yaml+jinja - - --- - # Note: The following examples assume that some variables named 'my_*' are set. - - - name: Ensure NIC 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_nic_name }}" - state: present - properties: - adapter_name: "OSD 0128 A13B-13" - adapter_port: 0 - description: "The port to our data network" - device_number: "023F" - register: nic1 - - - name: Ensure NIC 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_nic_name }}" - state: absent + + --- + # Note: The following examples assume that some variables named 'my_*' are set. + - name: Ensure NIC 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_nic_name }}" + state: present + properties: + adapter_name: "OSD 0128 A13B-13" + adapter_port: 0 + description: "The port to our data network" + device_number: "023F" + register: nic1 + - name: Ensure NIC 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_nic_name }}" + state: absent -Return Values -------------- -nic (success, dict, ) - For ``state=absent``, an empty dictionary. - For ``state=present``, a dictionary with the resource properties of the NIC after changes, if any. - name (, str, ) - NIC name - {property} (, any, ) - Additional properties of the NIC, as described in the :term:`HMC API` (using hyphens (-) in the property names). +Return Values +------------- + + + nic + For ``state=absent``, an empty dictionary. + + For ``state=present``, a dictionary with the resource properties of the NIC after changes, if any. + + + | **returned**: success + | **type**: dict + name + NIC name -Status ------- + | **type**: str -- This module is guaranteed to have backward compatible interface changes going forward. *[stableinterface]* + {property} + Additional properties of the NIC, as described in the :term:`HMC API` (using hyphens (-) in the property names). -- This module is maintained by community. + | **type**: -Authors -~~~~~~~ -- Andreas Maier (@andy-maier) -- Andreas Scheuring (@scheuran) -- Juergen Leopold (@leopoldjuergen) diff --git a/docs_source/modules/zhmc_partition.rst b/docs_source/modules/zhmc_partition.rst index dddaec6b2..a494a45b6 100644 --- a/docs_source/modules/zhmc_partition.rst +++ b/docs_source/modules/zhmc_partition.rst @@ -1,9 +1,14 @@ + +:github_url: https://github.com/IBM/ibm_zos_zosmf/tree/master/plugins/modules/zhmc_partition.py + .. _zhmc_partition_module: zhmc_partition -- Create partitions =================================== + + .. contents:: :local: :depth: 1 @@ -11,117 +16,154 @@ zhmc_partition -- Create partitions Synopsis -------- +- Gather facts about a partition of a CPC (Z system), including its HBAs, NICs, and virtual functions. +- Create, update, or delete a partition. The HBAs, NICs, and virtual functions of the partition are managed by separate Ansible modules. +- Start or stop a partition. -Gather facts about a partition of a CPC (Z system), including its HBAs, NICs, and virtual functions. -Create, update, or delete a partition. The HBAs, NICs, and virtual functions of the partition are managed by separate Ansible modules. -Start or stop a partition. +Parameters +---------- -Requirements ------------- -The below requirements are needed on the host that executes this module. -- Access to the WS API of the HMC of the targeted Z system (see :term:`HMC API`). The targeted Z system must be in the Dynamic Partition Manager (DPM) operational mode. + +hmc_host + The hostname or IP address of the HMC. + | **required**: True + | **type**: str -Parameters ----------- - hmc_host (True, str, None) - The hostname or IP address of the HMC. + +hmc_auth + The authentication credentials for the HMC, as a dictionary of userid, password. - hmc_auth (True, dict, None) - The authentication credentials for the HMC, as a dictionary of userid, password. + | **required**: True + | **type**: dict - userid (True, str, None) - The userid (username) for authenticating with the HMC. + + userid + The userid (username) for authenticating with the HMC. - password (True, str, None) - The password for authenticating with the HMC. + | **required**: True + | **type**: str + + password + The password for authenticating with the HMC. - cpc_name (True, str, None) - The name of the CPC with the target partition. + | **required**: True + | **type**: str - name (True, str, None) - The name of the target partition. - state (True, str, None) - The desired state for the target partition: + +cpc_name + The name of the CPC with the target partition. - ``absent``: Ensures that the partition does not exist in the specified CPC. - ``stopped``: Ensures that the partition exists in the specified CPC, has the specified properties, and is in the 'stopped' status. + | **required**: True + | **type**: str - ``active``: Ensures that the partition exists in the specified CPC, has the specified properties, and is in the 'active' or 'degraded' status. - ``facts``: Does not change anything on the partition and returns the partition properties and the properties of its child resources (HBAs, NICs, and virtual functions). + +name + The name of the target partition. - properties (False, dict, None) - Dictionary with input properties for the partition, for ``state=stopped`` and ``state=active``. 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``. + | **required**: True + | **type**: str - The possible input properties in this dictionary are the properties defined as writeable in the data model for Partition 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. + +state + The desired state for the target partition: - * ``type``: Cannot be changed once the partition exists, because updating it is not supported. + ``absent``: Ensures that the partition does not exist in the specified CPC. - * ``boot_storage_device``: Cannot be specified because this information is specified using the artificial property ``boot_storage_hba_name``. + ``stopped``: Ensures that the partition exists in the specified CPC, has the specified properties, and is in the 'stopped' status. - * ``boot_network_device``: Cannot be specified because this information is specified using the artificial property ``boot_network_nic_name``. + ``active``: Ensures that the partition exists in the specified CPC, has the specified properties, and is in the 'active' or 'degraded' status. - * ``boot_storage_hba_name``: The name of the HBA whose URI is used to construct ``boot_storage_device``. Specifying it requires that the partition exists. + ``facts``: Does not change anything on the partition and returns the partition properties and the properties of its child resources (HBAs, NICs, and virtual functions). - * ``boot_network_nic_name``: The name of the NIC whose URI is used to construct ``boot_network_device``. Specifying it requires that the partition exists. - * ``crypto_configuration``: The crypto configuration for the partition, in the format of the ``crypto-configuration`` property of the partition (see :term:`HMC API` for details), with the exception that adapters are specified with their names in field ``crypto_adapter_names`` instead of their URIs in field ``crypto_adapter_uris``. If the ``crypto_adapter_names`` field is null, all crypto adapters of the CPC will be used. + | **required**: True + | **type**: str + | **choices**: absent, stopped, active, facts - Properties omitted in this dictionary will remain unchanged when the partition already exists, and will get the default value defined in the data model for partitions in the :term:`HMC API` when the partition is being created. + +properties + Dictionary with input properties for the partition, for ``state=stopped`` and ``state=active``. 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``. - expand_storage_groups (False, bool, False) - Boolean that controls whether the returned partition contains an additional artificial property 'storage-groups' that is the list of storage groups attached to the partition, with properties as described for the zhmc_storage_group module with expand=true. + The possible input properties in this dictionary are the properties defined as writeable in the data model for Partition 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. - expand_crypto_adapters (False, bool, False) - Boolean that controls whether the returned partition contains an additional artificial property 'crypto-adapters' in its 'crypto-configuration' property that is the list of crypto adapters attached to the partition, with properties as described for the zhmc_adapter module. + * ``type``: Cannot be changed once the partition exists, because updating it is not supported. + * ``boot_storage_device``: Cannot be specified because this information is specified using the artificial property ``boot_storage_hba_name``. - log_file (False, str, None) - 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. + * ``boot_network_device``: Cannot be specified because this information is specified using the artificial property ``boot_network_nic_name``. + * ``boot_storage_hba_name``: The name of the HBA whose URI is used to construct ``boot_storage_device``. Specifying it requires that the partition exists. - faked_session (False, raw, None) - A ``zhmcclient_mock.FakedSession`` object that has a mocked HMC set up. If not null, this session will be used instead of connecting to the HMC specified in ``hmc_host``. This is used for testing purposes only. + * ``boot_network_nic_name``: The name of the NIC whose URI is used to construct ``boot_network_device``. Specifying it requires that the partition exists. + * ``crypto_configuration``: The crypto configuration for the partition, in the format of the ``crypto-configuration`` property of the partition (see :term:`HMC API` for details), with the exception that adapters are specified with their names in field ``crypto_adapter_names`` instead of their URIs in field ``crypto_adapter_uris``. If the ``crypto_adapter_names`` field is null, all crypto adapters of the CPC will be used. + Properties omitted in this dictionary will remain unchanged when the partition already exists, and will get the default value defined in the data model for partitions in the :term:`HMC API` when the partition is being created. + | **required**: False + | **type**: dict + +expand_storage_groups + Boolean that controls whether the returned partition contains an additional artificial property 'storage-groups' that is the list of storage groups attached to the partition, with properties as described for the zhmc_storage_group module with expand=true. -See Also --------- -.. seealso:: + | **required**: False + | **type**: bool + + + +expand_crypto_adapters + Boolean that controls whether the returned partition contains an additional artificial property 'crypto-adapters' in its 'crypto-configuration' property that is the list of crypto adapters attached to the partition, with properties as described for the zhmc_adapter module. + + + | **required**: False + | **type**: bool + + + +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 + + + +faked_session + A ``zhmcclient_mock.FakedSession`` object that has a mocked HMC set up. If not null, this session will be used instead of connecting to the HMC specified in ``hmc_host``. This is used for testing purposes only. + + + | **required**: False + | **type**: raw + - :ref:`zhmc_hba_module` - The official documentation on the **zhmc_hba** module. - :ref:`zhmc_nic_module` - The official documentation on the **zhmc_nic** module. - :ref:`zhmc_virtual_function_module` - The official documentation on the **zhmc_virtual_function** module. Examples @@ -129,84 +171,99 @@ Examples .. code-block:: yaml+jinja - - --- - # Note: The following examples assume that some variables named 'my_*' are set. - - # Because configuring LUN masking in the SAN requires the host WWPN, and the - # host WWPN is automatically assigned and will be known only after an HBA has - # been added to the partition, the partition needs to be created in stopped - # state. Also, because the HBA has not yet been created, the boot - # configuration cannot be done yet: - - name: Ensure the partition exists and is stopped - zhmc_partition: - hmc_host: "{{ my_hmc_host }}" - hmc_auth: "{{ my_hmc_auth }}" - cpc_name: "{{ my_cpc_name }}" - name: "{{ my_partition_name }}" - state: stopped - properties: - description: "zhmc Ansible modules: Example partition 1" - ifl_processors: 2 - initial_memory: 1024 - maximum_memory: 1024 - register: part1 - - # After an HBA has been added (see Ansible module zhmc_hba), and LUN masking - # has been configured in the SAN, and a bootable image is available at the - # configured LUN and target WWPN, the partition can be configured for boot - # from the FCP LUN and can be started: - - name: Configure boot device and start the partition - zhmc_partition: - hmc_host: "{{ my_hmc_host }}" - hmc_auth: "{{ my_hmc_auth }}" - cpc_name: "{{ my_cpc_name }}" - name: "{{ my_partition_name }}" - state: active - properties: - boot_device: storage-adapter - boot_storage_device_hba_name: hba1 - boot_logical_unit_number: 00000000001 - boot_world_wide_port_name: abcdefabcdef - register: part1 - - - name: Ensure the partition does not exist - zhmc_partition: - hmc_host: "{{ my_hmc_host }}" - hmc_auth: "{{ my_hmc_auth }}" - cpc_name: "{{ my_cpc_name }}" - name: "{{ my_partition_name }}" - state: absent - - - name: Define crypto configuration - zhmc_partition: - hmc_host: "{{ my_hmc_host }}" - hmc_auth: "{{ my_hmc_auth }}" - cpc_name: "{{ my_cpc_name }}" - name: "{{ my_partition_name }}" - state: active - properties: - crypto_configuration: - crypto_adapter_names: - - adapter1 - - adapter2 - crypto_domain_configurations: - - domain_index: 0 - access_mode: control-usage - - domain_index: 1 - access_mode: control - register: part1 - - - name: Gather facts about a partition - zhmc_partition: - hmc_host: "{{ my_hmc_host }}" - hmc_auth: "{{ my_hmc_auth }}" - cpc_name: "{{ my_cpc_name }}" - name: "{{ my_partition_name }}" - state: facts - expand_storage_groups: true - expand_crypto_adapters: true - register: part1 + + --- + # Note: The following examples assume that some variables named 'my_*' are set. + + # Because configuring LUN masking in the SAN requires the host WWPN, and the + # host WWPN is automatically assigned and will be known only after an HBA has + # been added to the partition, the partition needs to be created in stopped + # state. Also, because the HBA has not yet been created, the boot + # configuration cannot be done yet: + - name: Ensure the partition exists and is stopped + zhmc_partition: + hmc_host: "{{ my_hmc_host }}" + hmc_auth: "{{ my_hmc_auth }}" + cpc_name: "{{ my_cpc_name }}" + name: "{{ my_partition_name }}" + state: stopped + properties: + description: "zhmc Ansible modules: Example partition 1" + ifl_processors: 2 + initial_memory: 1024 + maximum_memory: 1024 + register: part1 + + # After an HBA has been added (see Ansible module zhmc_hba), and LUN masking + # has been configured in the SAN, and a bootable image is available at the + # configured LUN and target WWPN, the partition can be configured for boot + # from the FCP LUN and can be started: + - name: Configure boot device and start the partition + zhmc_partition: + hmc_host: "{{ my_hmc_host }}" + hmc_auth: "{{ my_hmc_auth }}" + cpc_name: "{{ my_cpc_name }}" + name: "{{ my_partition_name }}" + state: active + properties: + boot_device: storage-adapter + boot_storage_device_hba_name: hba1 + boot_logical_unit_number: 00000000001 + boot_world_wide_port_name: abcdefabcdef + register: part1 + + - name: Ensure the partition does not exist + zhmc_partition: + hmc_host: "{{ my_hmc_host }}" + hmc_auth: "{{ my_hmc_auth }}" + cpc_name: "{{ my_cpc_name }}" + name: "{{ my_partition_name }}" + state: absent + + - name: Define crypto configuration + zhmc_partition: + hmc_host: "{{ my_hmc_host }}" + hmc_auth: "{{ my_hmc_auth }}" + cpc_name: "{{ my_cpc_name }}" + name: "{{ my_partition_name }}" + state: active + properties: + crypto_configuration: + crypto_adapter_names: + - adapter1 + - adapter2 + crypto_domain_configurations: + - domain_index: 0 + access_mode: control-usage + - domain_index: 1 + access_mode: control + register: part1 + + - name: Gather facts about a partition + zhmc_partition: + hmc_host: "{{ my_hmc_host }}" + hmc_auth: "{{ my_hmc_auth }}" + cpc_name: "{{ my_cpc_name }}" + name: "{{ my_partition_name }}" + state: facts + expand_storage_groups: true + expand_crypto_adapters: true + register: part1 + + + + + + + +See Also +-------- + +.. seealso:: + + - :ref:`zhmc_hba_module` + - :ref:`zhmc_nic_module` + - :ref:`zhmc_virtual_function_module` @@ -214,82 +271,109 @@ Examples Return Values ------------- -partition (success, dict, ) - For ``state=absent``, an empty dictionary. - For ``state=stopped`` and ``state=active``, a dictionary with the resource properties of the partition after changes, if any. + partition + For ``state=absent``, an empty dictionary. + + For ``state=stopped`` and ``state=active``, a dictionary with the resource properties of the partition after changes, if any. + + For ``state=facts``, a dictionary with the resource properties of the partition, including its child resources as described below. + + + | **returned**: success + | **type**: dict + + + name + Partition name + + + | **type**: str + + + + {property} + Additional properties of the partition, as described in the :term:`HMC API` (using hyphens (-) in the property names). + + + | **type**: + + + + hbas + HBAs of the partition (for ``state=facts``). + + + | **type**: list + + + name + HBA name + + + | **type**: str + - For ``state=facts``, a dictionary with the resource properties of the partition, including its child resources as described below. + {property} + Additional properties of the HBA, as described in the :term:`HMC API` (using hyphens (-) in the property names). - name (, str, ) - Partition name + | **type**: - {property} (, any, ) - Additional properties of the partition, as described in the :term:`HMC API` (using hyphens (-) in the property names). - hbas (, list, ) - HBAs of the partition (for ``state=facts``). - name (, str, ) - HBA name + nics + NICs of the partition (for ``state=facts``). - {property} (, any, ) - Additional properties of the HBA, as described in the :term:`HMC API` (using hyphens (-) in the property names). + | **type**: list + name + NIC name - nics (, list, ) - NICs of the partition (for ``state=facts``). + | **type**: str - name (, str, ) - NIC name - {property} (, any, ) - Additional properties of the NIC, as described in the :term:`HMC API` (using hyphens (-) in the property names). + {property} + Additional properties of the NIC, as described in the :term:`HMC API` (using hyphens (-) in the property names). + | **type**: - virtual-functions (, list, ) - Virtual functions of the partition (for ``state=facts``). - name (, str, ) - VF name - {property} (, any, ) - Additional properties of the VF, as described in the :term:`HMC API` (using hyphens (-) in the property names). + virtual-functions + Virtual functions of the partition (for ``state=facts``). + | **type**: list + name + VF name + | **type**: str -Status ------- + {property} + Additional properties of the VF, as described in the :term:`HMC API` (using hyphens (-) in the property names). -- This module is guaranteed to have backward compatible interface changes going forward. *[stableinterface]* + | **type**: -- This module is maintained by community. -Authors -~~~~~~~ -- Andreas Maier (@andy-maier) -- Andreas Scheuring (@scheuran) -- Juergen Leopold (@leopoldjuergen) diff --git a/docs_source/modules/zhmc_storage_group.rst b/docs_source/modules/zhmc_storage_group.rst index cbebc01ff..6ca7bb4fe 100644 --- a/docs_source/modules/zhmc_storage_group.rst +++ b/docs_source/modules/zhmc_storage_group.rst @@ -1,9 +1,14 @@ + +:github_url: https://github.com/IBM/ibm_zos_zosmf/tree/master/plugins/modules/zhmc_storage_group.py + .. _zhmc_storage_group_module: zhmc_storage_group -- Create storage groups =========================================== + + .. contents:: :local: :depth: 1 @@ -11,93 +16,130 @@ zhmc_storage_group -- Create storage groups Synopsis -------- +- Gather facts about a storage group associated with a CPC (Z system), including its storage volumes and virtual storage resources. +- Create, delete, or update a storage group associated with a CPC. -Gather facts about a storage group associated with a CPC (Z system), including its storage volumes and virtual storage resources. -Create, delete, or update a storage group associated with a CPC. -Requirements ------------- -The below requirements are needed on the host that executes this module. +Parameters +---------- -- Access to the WS API of the HMC of the targeted Z system (see :term:`HMC API`). The targeted Z system must be in the Dynamic Partition Manager (DPM) operational mode. -- The Z system must be of generation z14 or later, to have the "dpm-storage-management" firmware feature. + +hmc_host + The hostname or IP address of the HMC. -Parameters ----------- + | **required**: True + | **type**: str - hmc_host (True, str, None) - The hostname or IP address of the HMC. + +hmc_auth + The authentication credentials for the HMC, as a dictionary of ``userid``, ``password``. - hmc_auth (True, dict, None) - The authentication credentials for the HMC, as a dictionary of ``userid``, ``password``. + | **required**: True + | **type**: dict - userid (True, str, None) - The userid (username) for authenticating with the HMC. + + userid + The userid (username) for authenticating with the HMC. - password (True, str, None) - The password for authenticating with the HMC. + | **required**: True + | **type**: str - cpc_name (True, str, None) - The name of the CPC associated with the target storage group. + + password + The password for authenticating with the HMC. - name (True, str, None) - The name of the target storage group. + | **required**: True + | **type**: str - state (True, str, None) - The desired state for the target storage group: - * ``absent``: Ensures that the storage group does not exist. If the storage group is currently attached to any partitions, the module will fail. + +cpc_name + The name of the CPC associated with the target storage group. - * ``present``: Ensures that the storage group exists and is associated with the specified CPC, and has the specified properties. The attachment state of the storage group to a partition is not changed. - * ``facts``: Does not change anything on the storage group and returns the storage group properties. + | **required**: True + | **type**: str - properties (False, dict, None) - Dictionary with desired properties for the storage group. Used for ``state=present``; ignored for ``state=absent|facts``. Dictionary key is the property name with underscores instead of hyphens, and dictionary value is the property value in YAML syntax. Integer properties may also be provided as decimal strings. + +name + The name of the target storage group. - The possible input properties in this dictionary are the properties defined as writeable in the data model for Storage Group 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. + | **required**: True + | **type**: str - * ``type``: Cannot be changed once the storage group exists. - Properties omitted in this dictionary will remain unchanged when the storage group already exists, and will get the default value defined in the data model for storage groups in the :term:`HMC API` when the storage group is being created. + +state + The desired state for the target storage group: + * ``absent``: Ensures that the storage group does not exist. If the storage group is currently attached to any partitions, the module will fail. - expand (False, bool, False) - Boolean that controls whether the returned storage group contains additional artificial properties that expand certain URI or name properties to the full set of resource properties (see description of return values of this module). + * ``present``: Ensures that the storage group exists and is associated with the specified CPC, and has the specified properties. The attachment state of the storage group to a partition is not changed. + * ``facts``: Does not change anything on the storage group and returns the storage group properties. - log_file (False, str, None) - 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**: True + | **type**: str + | **choices**: absent, present, facts - faked_session (False, raw, None) - A ``zhmcclient_mock.FakedSession`` object that has a mocked HMC set up. If not null, this session will be used instead of connecting to the HMC specified in ``hmc_host``. This is used for testing purposes only. + +properties + Dictionary with desired properties for the storage group. Used for ``state=present``; ignored for ``state=absent|facts``. Dictionary key is the property name with underscores instead of hyphens, and dictionary value is the property value in YAML syntax. Integer properties may also be provided as decimal strings. + The possible input properties in this dictionary are the properties defined as writeable in the data model for Storage Group 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. + * ``type``: Cannot be changed once the storage group exists. -Notes ------ + Properties omitted in this dictionary will remain unchanged when the storage group already exists, and will get the default value defined in the data model for storage groups in the :term:`HMC API` when the storage group is being created. -.. note:: - - This module manages only the knowledge of the Z system about its storage, but does not perform any actions against the storage subsystems or SAN switches attached to the Z system. - - Attachment of storage groups to and from partitions is managed by the Ansible module zhmc_storage_group_attachment. + + | **required**: False + | **type**: dict + + + +expand + Boolean that controls whether the returned storage group contains additional artificial properties that expand certain URI or name properties to the full set of resource properties (see description of return values of this module). + + + | **required**: False + | **type**: bool + + + +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 + + + +faked_session + A ``zhmcclient_mock.FakedSession`` object that has a mocked HMC set up. If not null, this session will be used instead of connecting to the HMC specified in ``hmc_host``. This is used for testing purposes only. + + + | **required**: False + | **type**: raw @@ -107,43 +149,58 @@ Examples .. code-block:: yaml+jinja - - --- - # Note: The following examples assume that some variables named 'my_*' are set. - - - name: Gather facts about a storage group - zhmc_storage_group: - hmc_host: "{{ my_hmc_host }}" - hmc_auth: "{{ my_hmc_auth }}" - cpc_name: "{{ my_cpc_name }}" - name: "{{ my_storage_group_name }}" - state: facts - expand: true - register: sg1 - - - name: Ensure the storage group does not exist - zhmc_storage_group: - hmc_host: "{{ my_hmc_host }}" - hmc_auth: "{{ my_hmc_auth }}" - cpc_name: "{{ my_cpc_name }}" - name: "{{ my_storage_group_name }}" - state: absent - - - name: Ensure the storage group exists - zhmc_storage_group: - hmc_host: "{{ my_hmc_host }}" - hmc_auth: "{{ my_hmc_auth }}" - cpc_name: "{{ my_cpc_name }}" - name: "{{ my_storage_group_name }}" - state: present - expand: true - properties: - description: "Example storage group 1" - type: fcp - shared: false - connectivity: 4 - max-partitions: 1 - register: sg1 + + --- + # Note: The following examples assume that some variables named 'my_*' are set. + + - name: Gather facts about a storage group + zhmc_storage_group: + hmc_host: "{{ my_hmc_host }}" + hmc_auth: "{{ my_hmc_auth }}" + cpc_name: "{{ my_cpc_name }}" + name: "{{ my_storage_group_name }}" + state: facts + expand: true + register: sg1 + + - name: Ensure the storage group does not exist + zhmc_storage_group: + hmc_host: "{{ my_hmc_host }}" + hmc_auth: "{{ my_hmc_auth }}" + cpc_name: "{{ my_cpc_name }}" + name: "{{ my_storage_group_name }}" + state: absent + + - name: Ensure the storage group exists + zhmc_storage_group: + hmc_host: "{{ my_hmc_host }}" + hmc_auth: "{{ my_hmc_auth }}" + cpc_name: "{{ my_cpc_name }}" + name: "{{ my_storage_group_name }}" + state: present + expand: true + properties: + description: "Example storage group 1" + type: fcp + shared: false + connectivity: 4 + max-partitions: 1 + register: sg1 + + + + + +Notes +----- + +.. note:: + This module manages only the knowledge of the Z system about its storage, but does not perform any actions against the storage subsystems or SAN switches attached to the Z system. + + Attachment of storage groups to and from partitions is managed by the Ansible module zhmc_storage_group_attachment. + + + @@ -151,119 +208,187 @@ Examples Return Values ------------- -storage_group (success, dict, ) - For ``state=absent``, an empty dictionary. - For ``state=present|facts``, a dictionary with the resource properties of the target storage group, plus additional artificial properties as described below. + storage_group + For ``state=absent``, an empty dictionary. + + For ``state=present|facts``, a dictionary with the resource properties of the target storage group, plus additional artificial properties as described below. + + + | **returned**: success + | **type**: dict + + + name + Storage group name + + + | **type**: str + + + + {property} + Additional properties of the storage group, as described in the :term:`HMC API` (using hyphens (-) in the property names). + + + | **type**: + + + + attached-partition-names + Names of the partitions to which the storage group is attached. + + + | **type**: list + + + + cpc-name + Name of the CPC that is associated to this storage group. + + + | **type**: str + + + + candidate-adapter-ports + Only if expand was requested: List of candidate storage adapter ports of the storage group. + + + | **returned**: success+expand + | **type**: list + + + name + Storage port name + + + | **type**: str + + + + index + Storage port index + + + | **type**: int + + + + {property} + Additional properties of the storage port, as described in the :term:`HMC API` (using hyphens (-) in the property names). + + + | **type**: + + + + parent-adapter + Storage adapter of the port. + + + | **type**: dict + + + name + Storage adapter name + + + | **type**: str - name (, str, ) - Storage group name + {property} + Additional properties of the storage adapter, as described in the :term:`HMC API` (using hyphens (-) in the property names). - {property} (, any, ) - Additional properties of the storage group, as described in the :term:`HMC API` (using hyphens (-) in the property names). + | **type**: - attached-partition-names (, list, ) - Names of the partitions to which the storage group is attached. - cpc-name (, str, ) - Name of the CPC that is associated to this storage group. - candidate-adapter-ports (success+expand, list, ) - Only if expand was requested: List of candidate storage adapter ports of the storage group. - name (, str, ) - Storage port name + storage-volumes + Only if expand was requested: List of storage volumes of the storage group. - index (, int, ) - Storage port index + | **returned**: success+expand + | **type**: list - {property} (, any, ) - Additional properties of the storage port, as described in the :term:`HMC API` (using hyphens (-) in the property names). + name + Storage volume name - parent-adapter (, dict, ) - Storage adapter of the port. + | **type**: str - name (, str, ) - Storage adapter name + {property} + Additional properties of the storage volume, as described in the :term:`HMC API` (using hyphens (-) in the property names). - {property} (, any, ) - Additional properties of the storage adapter, as described in the :term:`HMC API` (using hyphens (-) in the property names). + | **type**: - storage-volumes (success+expand, list, ) - Only if expand was requested: List of storage volumes of the storage group. - name (, str, ) - Storage volume name + virtual-storage-resources + Only if expand was requested: List of virtual storage resources of the storage group. - {property} (, any, ) - Additional properties of the storage volume, as described in the :term:`HMC API` (using hyphens (-) in the property names). + | **returned**: success+expand + | **type**: list + {property} + Properties of the virtual storage resource, as described in the :term:`HMC API` (using hyphens (-) in the property names). - virtual-storage-resources (success+expand, list, ) - Only if expand was requested: List of virtual storage resources of the storage group. + | **type**: - {property} (, any, ) - Properties of the virtual storage resource, as described in the :term:`HMC API` (using hyphens (-) in the property names). - attached-partitions (success+expand, list, ) - Only if expand was requested: List of partitions to which the storage group is attached. + attached-partitions + Only if expand was requested: List of partitions to which the storage group is attached. - {property} (, any, ) - Properties of the partition, as described in the :term:`HMC API` (using hyphens (-) in the property names). + | **returned**: success+expand + | **type**: list - cpc (success+expand, list, ) - Only if expand was requested: The CPC that is associated to this storage group. + {property} + Properties of the partition, as described in the :term:`HMC API` (using hyphens (-) in the property names). - {property} (, any, ) - Properties of the CPC, as described in the :term:`HMC API` (using hyphens (-) in the property names). + | **type**: + cpc + Only if expand was requested: The CPC that is associated to this storage group. -Status ------- + | **returned**: success+expand + | **type**: list + {property} + Properties of the CPC, as described in the :term:`HMC API` (using hyphens (-) in the property names). -- This module is guaranteed to have backward compatible interface changes going forward. *[stableinterface]* + | **type**: -- This module is maintained by community. -Authors -~~~~~~~ -- Andreas Maier (@andy-maier) -- Andreas Scheuring (@scheuran) -- Juergen Leopold (@leopoldjuergen) diff --git a/docs_source/modules/zhmc_storage_group_attachment.rst b/docs_source/modules/zhmc_storage_group_attachment.rst index fb7926031..93b608a07 100644 --- a/docs_source/modules/zhmc_storage_group_attachment.rst +++ b/docs_source/modules/zhmc_storage_group_attachment.rst @@ -1,9 +1,14 @@ + +:github_url: https://github.com/IBM/ibm_zos_zosmf/tree/master/plugins/modules/zhmc_storage_group_attachment.py + .. _zhmc_storage_group_attachment_module: zhmc_storage_group_attachment -- Attach storage groups to partitions ==================================================================== + + .. contents:: :local: :depth: 1 @@ -11,80 +16,113 @@ zhmc_storage_group_attachment -- Attach storage groups to partitions Synopsis -------- +- Gather facts about the attachment of a storage group to a partition of a CPC (Z system). +- Attach and detach a storage group to and from a partition. -Gather facts about the attachment of a storage group to a partition of a CPC (Z system). -Attach and detach a storage group to and from a partition. -Requirements ------------- -The below requirements are needed on the host that executes this module. +Parameters +---------- -- Access to the WS API of the HMC of the targeted Z system (see :term:`HMC API`). The targeted Z system must be in the Dynamic Partition Manager (DPM) operational mode. -- The Z system must be of generation z14 or later, to have the "dpm-storage-management" firmware feature. + +hmc_host + The hostname or IP address of the HMC. -Parameters ----------- + | **required**: True + | **type**: str - hmc_host (True, str, None) - The hostname or IP address of the HMC. + +hmc_auth + The authentication credentials for the HMC, as a dictionary of ``userid``, ``password``. - hmc_auth (True, dict, None) - The authentication credentials for the HMC, as a dictionary of ``userid``, ``password``. + | **required**: True + | **type**: dict - userid (True, str, None) - The userid (username) for authenticating with the HMC. + + userid + The userid (username) for authenticating with the HMC. - password (True, str, None) - The password for authenticating with the HMC. + | **required**: True + | **type**: str - cpc_name (True, str, None) - The name of the CPC that has the partition and is associated with the storage group. + + password + The password for authenticating with the HMC. - storage_group_name (True, str, None) - The name of the storage group for the attachment. + | **required**: True + | **type**: str - partition_name (True, str, None) - The name of the partition for the attachment. + +cpc_name + The name of the CPC that has the partition and is associated with the storage group. - state (True, str, None) - The desired state for the attachment: - * ``detached``: Ensures that the storage group is not attached to the partition. If the storage group is currently attached to the partition and the partition is currently active, the module will fail. + | **required**: True + | **type**: str - * ``attached``: Ensures that the storage group is attached to the partition. - * ``facts``: Does not change anything on the attachment and returns the attachment status. + +storage_group_name + The name of the storage group for the attachment. - log_file (False, str, None) - 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**: True + | **type**: str - faked_session (False, raw, None) - A ``zhmcclient_mock.FakedSession`` object that has a mocked HMC set up. If not null, this session will be used instead of connecting to the HMC specified in ``hmc_host``. This is used for testing purposes only. + +partition_name + The name of the partition for the attachment. + | **required**: True + | **type**: str + +state + The desired state for the attachment: -Notes ------ + * ``detached``: Ensures that the storage group is not attached to the partition. If the storage group is currently attached to the partition and the partition is currently active, the module will fail. + + * ``attached``: Ensures that the storage group is attached to the partition. + + * ``facts``: Does not change anything on the attachment and returns the attachment status. + + + | **required**: True + | **type**: str + | **choices**: detached, attached, facts + + + +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. -.. note:: - - This module manages only the knowledge of the Z system about its storage, but does not perform any actions against the storage subsystems or SAN switches attached to the Z system. + + | **required**: False + | **type**: str + + + +faked_session + A ``zhmcclient_mock.FakedSession`` object that has a mocked HMC set up. If not null, this session will be used instead of connecting to the HMC specified in ``hmc_host``. This is used for testing purposes only. + + + | **required**: False + | **type**: raw @@ -94,73 +132,73 @@ Examples .. code-block:: yaml+jinja - - --- - # Note: The following examples assume that some variables named 'my_*' are set. - - - name: Gather facts about the attachment - zhmc_storage_group_attachment: - hmc_host: "{{ my_hmc_host }}" - hmc_auth: "{{ my_hmc_auth }}" - cpc_name: "{{ my_cpc_name }}" - storage_group_name: "{{ my_storage_group_name }}" - partition_name: "{{ my_partition_name }}" - state: facts - register: sga1 - - - name: Ensure the storage group is attached to the partition - zhmc_storage_group_attachment: - hmc_host: "{{ my_hmc_host }}" - hmc_auth: "{{ my_hmc_auth }}" - cpc_name: "{{ my_cpc_name }}" - storage_group_name: "{{ my_storage_group_name }}" - partition_name: "{{ my_partition_name }}" - state: attached - - - name: "Ensure the storage group is not attached to the partition." - zhmc_storage_group_attachment: - hmc_host: "{{ my_hmc_host }}" - hmc_auth: "{{ my_hmc_auth }}" - cpc_name: "{{ my_cpc_name }}" - storage_group_name: "{{ my_storage_group_name }}" - partition_name: "{{ my_partition_name }}" - state: detached + + --- + # Note: The following examples assume that some variables named 'my_*' are set. + - name: Gather facts about the attachment + zhmc_storage_group_attachment: + hmc_host: "{{ my_hmc_host }}" + hmc_auth: "{{ my_hmc_auth }}" + cpc_name: "{{ my_cpc_name }}" + storage_group_name: "{{ my_storage_group_name }}" + partition_name: "{{ my_partition_name }}" + state: facts + register: sga1 + - name: Ensure the storage group is attached to the partition + zhmc_storage_group_attachment: + hmc_host: "{{ my_hmc_host }}" + hmc_auth: "{{ my_hmc_auth }}" + cpc_name: "{{ my_cpc_name }}" + storage_group_name: "{{ my_storage_group_name }}" + partition_name: "{{ my_partition_name }}" + state: attached + - name: "Ensure the storage group is not attached to the partition." + zhmc_storage_group_attachment: + hmc_host: "{{ my_hmc_host }}" + hmc_auth: "{{ my_hmc_auth }}" + cpc_name: "{{ my_cpc_name }}" + storage_group_name: "{{ my_storage_group_name }}" + partition_name: "{{ my_partition_name }}" + state: detached -Return Values -------------- -storage_group_attachment (success, dict, ) - Attachment state of the storage group. If no check mode was requested, the attachment state after any changes is returned. If check mode was requested, the actual attachment state is returned. - attached (, bool, ) - Attachment state of the storage group: Indicates whether the storage group is attached to the partition. + +Notes +----- + +.. note:: + This module manages only the knowledge of the Z system about its storage, but does not perform any actions against the storage subsystems or SAN switches attached to the Z system. + -Status ------- +Return Values +------------- + + + storage_group_attachment + Attachment state of the storage group. If no check mode was requested, the attachment state after any changes is returned. If check mode was requested, the actual attachment state is returned. + | **returned**: success + | **type**: dict -- This module is guaranteed to have backward compatible interface changes going forward. *[stableinterface]* + attached + Attachment state of the storage group: Indicates whether the storage group is attached to the partition. -- This module is maintained by community. + | **type**: bool -Authors -~~~~~~~ -- Andreas Maier (@andy-maier) -- Andreas Scheuring (@scheuran) -- Juergen Leopold (@leopoldjuergen) diff --git a/docs_source/modules/zhmc_storage_volume.rst b/docs_source/modules/zhmc_storage_volume.rst index 6851d0fe8..e35a07f02 100644 --- a/docs_source/modules/zhmc_storage_volume.rst +++ b/docs_source/modules/zhmc_storage_volume.rst @@ -1,9 +1,14 @@ + +:github_url: https://github.com/IBM/ibm_zos_zosmf/tree/master/plugins/modules/zhmc_storage_volume.py + .. _zhmc_storage_volume_module: zhmc_storage_volume -- Create storage volumes ============================================= + + .. contents:: :local: :depth: 1 @@ -11,90 +16,128 @@ zhmc_storage_volume -- Create storage volumes Synopsis -------- +- Gather facts about a storage volume in a storage group associated with a CPC (Z system). +- Create, delete, or update a storage volume in a storage group associated with a CPC. -Gather facts about a storage volume in a storage group associated with a CPC (Z system). -Create, delete, or update a storage volume in a storage group associated with a CPC. -Requirements ------------- -The below requirements are needed on the host that executes this module. +Parameters +---------- -- Access to the WS API of the HMC of the targeted Z system (see :term:`HMC API`). The targeted Z system must be in the Dynamic Partition Manager (DPM) operational mode. -- The Z system must be of generation z14 or later, to have the "dpm-storage-management" firmware feature. + +hmc_host + The hostname or IP address of the HMC. -Parameters ----------- + | **required**: True + | **type**: str - hmc_host (True, str, None) - The hostname or IP address of the HMC. + +hmc_auth + The authentication credentials for the HMC, as a dictionary of ``userid``, ``password``. - hmc_auth (True, dict, None) - The authentication credentials for the HMC, as a dictionary of ``userid``, ``password``. + | **required**: True + | **type**: dict - userid (True, str, None) - The userid (username) for authenticating with the HMC. + + userid + The userid (username) for authenticating with the HMC. - password (True, str, None) - The password for authenticating with the HMC. + | **required**: True + | **type**: str - cpc_name (True, str, None) - The name of the CPC associated with the storage group containing the target storage volume. + + password + The password for authenticating with the HMC. - storage_group_name (True, str, None) - The name of the storage group containing the target storage volume. + | **required**: True + | **type**: str - name (True, str, None) - The name of the target storage volume. + +cpc_name + The name of the CPC associated with the storage group containing the target storage volume. - state (True, str, None) - The desired state for the target storage volume: - * ``absent``: Ensures that the storage volume does not exist in the specified storage group. + | **required**: True + | **type**: str - * ``present``: Ensures that the storage volume exists in the specified storage group, and has the specified properties. - * ``facts``: Does not change anything on the storage volume and returns the storage volume properties. + +storage_group_name + The name of the storage group containing the target storage volume. - properties (False, dict, None) - Dictionary with desired properties for the storage volume. Used for ``state=present``; ignored for ``state=absent|facts``. Dictionary key is the property name with underscores instead of hyphens, and dictionary value is the property value in YAML syntax. Integer properties may also be provided as decimal strings. + | **required**: True + | **type**: str - The possible input properties in this dictionary are the properties defined as writeable in the data model for Storage Volume 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. + +name + The name of the target storage volume. - Properties omitted in this dictionary will remain unchanged when the storage volume already exists, and will get the default value defined in the data model for storage volumes in the :term:`HMC API` when the storage volume is being created. + | **required**: True + | **type**: str - log_file (False, str, None) - 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. + +state + The desired state for the target storage volume: - faked_session (False, raw, None) - A ``zhmcclient_mock.FakedSession`` object that has a mocked HMC set up. If not null, this session will be used instead of connecting to the HMC specified in ``hmc_host``. This is used for testing purposes only. + * ``absent``: Ensures that the storage volume does not exist in the specified storage group. + * ``present``: Ensures that the storage volume exists in the specified storage group, and has the specified properties. + * ``facts``: Does not change anything on the storage volume and returns the storage volume properties. + | **required**: True + | **type**: str + | **choices**: absent, present, facts -Notes ------ -.. note:: - - This module manages only the knowledge of the Z system about its storage, but does not perform any actions against the storage subsystems or SAN switches attached to the Z system. + +properties + Dictionary with desired properties for the storage volume. Used for ``state=present``; ignored for ``state=absent|facts``. Dictionary key is the property name with underscores instead of hyphens, and dictionary value is the property value in YAML syntax. Integer properties may also be provided as decimal strings. + + The possible input properties in this dictionary are the properties defined as writeable in the data model for Storage Volume 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. + + Properties omitted in this dictionary will remain unchanged when the storage volume already exists, and will get the default value defined in the data model for storage volumes in the :term:`HMC API` when the storage volume 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 + + + +faked_session + A ``zhmcclient_mock.FakedSession`` object that has a mocked HMC set up. If not null, this session will be used instead of connecting to the HMC specified in ``hmc_host``. This is used for testing purposes only. + + + | **required**: False + | **type**: raw @@ -104,41 +147,54 @@ Examples .. code-block:: yaml+jinja - - --- - # Note: The following examples assume that some variables named 'my_*' are set. - - - name: Gather facts about a storage volume - zhmc_storage_volume: - hmc_host: "{{ my_hmc_host }}" - hmc_auth: "{{ my_hmc_auth }}" - cpc_name: "{{ my_cpc_name }}" - storage_group_name: "{{ my_storage_group_name }}" - name: "{{ my_storage_volume_name }}" - state: facts - register: sv1 - - - name: Ensure the storage volume does not exist - zhmc_storage_volume: - hmc_host: "{{ my_hmc_host }}" - hmc_auth: "{{ my_hmc_auth }}" - cpc_name: "{{ my_cpc_name }}" - storage_group_name: "{{ my_storage_group_name }}" - name: "{{ my_storage_volume_name }}" - state: absent - - - name: Ensure the storage volume exists - zhmc_storage_volume: - hmc_host: "{{ my_hmc_host }}" - hmc_auth: "{{ my_hmc_auth }}" - cpc_name: "{{ my_cpc_name }}" - storage_group_name: "{{ my_storage_group_name }}" - name: "{{ my_storage_volume_name }}" - state: present - properties: - description: "Example storage volume 1" - size: 1 - register: sv1 + + --- + # Note: The following examples assume that some variables named 'my_*' are set. + + - name: Gather facts about a storage volume + zhmc_storage_volume: + hmc_host: "{{ my_hmc_host }}" + hmc_auth: "{{ my_hmc_auth }}" + cpc_name: "{{ my_cpc_name }}" + storage_group_name: "{{ my_storage_group_name }}" + name: "{{ my_storage_volume_name }}" + state: facts + register: sv1 + + - name: Ensure the storage volume does not exist + zhmc_storage_volume: + hmc_host: "{{ my_hmc_host }}" + hmc_auth: "{{ my_hmc_auth }}" + cpc_name: "{{ my_cpc_name }}" + storage_group_name: "{{ my_storage_group_name }}" + name: "{{ my_storage_volume_name }}" + state: absent + + - name: Ensure the storage volume exists + zhmc_storage_volume: + hmc_host: "{{ my_hmc_host }}" + hmc_auth: "{{ my_hmc_auth }}" + cpc_name: "{{ my_cpc_name }}" + storage_group_name: "{{ my_storage_group_name }}" + name: "{{ my_storage_volume_name }}" + state: present + properties: + description: "Example storage volume 1" + size: 1 + register: sv1 + + + + + +Notes +----- + +.. note:: + This module manages only the knowledge of the Z system about its storage, but does not perform any actions against the storage subsystems or SAN switches attached to the Z system. + + + @@ -146,45 +202,40 @@ Examples Return Values ------------- -storage_volume (success, dict, ) - For ``state=absent``, an empty dictionary. - - For ``state=present|facts``, a dictionary with the resource properties of the storage volume, indicating the state after changes from this module (if any) have been applied. + storage_volume + For ``state=absent``, an empty dictionary. - name (, str, ) - Storage volume name + For ``state=present|facts``, a dictionary with the resource properties of the storage volume, indicating the state after changes from this module (if any) have been applied. - {property} (, any, ) - Additional properties of the storage volume, as described in the :term:`HMC API` (using hyphens (-) in the property names). + | **returned**: success + | **type**: dict - type (, str, ) - Type of the storage volume ('fc' or 'fcp'), as defined in its storage group. + name + Storage volume name + | **type**: str + {property} + Additional properties of the storage volume, as described in the :term:`HMC API` (using hyphens (-) in the property names). -Status ------- + | **type**: -- This module is guaranteed to have backward compatible interface changes going forward. *[stableinterface]* + type + Type of the storage volume ('fc' or 'fcp'), as defined in its storage group. -- This module is maintained by community. + | **type**: str -Authors -~~~~~~~ -- Andreas Maier (@andy-maier) -- Andreas Scheuring (@scheuran) -- Juergen Leopold (@leopoldjuergen) diff --git a/docs_source/modules/zhmc_user.rst b/docs_source/modules/zhmc_user.rst index b81f6cd18..19caa5c69 100644 --- a/docs_source/modules/zhmc_user.rst +++ b/docs_source/modules/zhmc_user.rst @@ -1,9 +1,14 @@ + +:github_url: https://github.com/IBM/ibm_zos_zosmf/tree/master/plugins/modules/zhmc_user.py + .. _zhmc_user_module: zhmc_user -- Create HMC users ============================= + + .. contents:: :local: :depth: 1 @@ -11,91 +16,130 @@ zhmc_user -- Create HMC users Synopsis -------- +- Gather facts about a user on an HMC of a Z system. +- Create, delete, or update a user on an HMC. + -Gather facts about a user on an HMC of a Z system. -Create, delete, or update a user on an HMC. +Parameters +---------- -Requirements ------------- -The below requirements are needed on the host that executes this module. -- Access to the WS API of the HMC of the targeted Z system (see :term:`HMC API`). The targeted Z system can be in any operational mode (classic, DPM) + +hmc_host + The hostname or IP address of the HMC. + | **required**: True + | **type**: str + + + +hmc_auth + The authentication credentials for the HMC, as a dictionary of ``userid``, ``password``. + + + | **required**: True + | **type**: dict + + + + userid + The userid (username) for authenticating with the HMC. + + + | **required**: True + | **type**: str + + + + password + The password for authenticating with the HMC. -Parameters ----------- - hmc_host (True, str, None) - The hostname or IP address of the HMC. + | **required**: True + | **type**: str - hmc_auth (True, dict, None) - The authentication credentials for the HMC, as a dictionary of ``userid``, ``password``. + +name + The userid of the target user (i.e. the 'name' property of the User object). - userid (True, str, None) - The userid (username) for authenticating with the HMC. + | **required**: True + | **type**: str - password (True, str, None) - The password for authenticating with the HMC. + +state + The desired state for the target user: + * ``absent``: Ensures that the user does not exist. - name (True, str, None) - The userid of the target user (i.e. the 'name' property of the User object). + * ``present``: Ensures that the user exists and has the specified properties. + * ``facts``: Does not change anything on the user and returns the user properties. - state (True, str, None) - The desired state for the target user: - * ``absent``: Ensures that the user does not exist. + | **required**: True + | **type**: str + | **choices**: absent, present, facts - * ``present``: Ensures that the user exists and has the specified properties. - * ``facts``: Does not change anything on the user and returns the user properties. + +properties + Dictionary with desired properties for the user. Used for ``state=present``; ignored for ``state=absent|facts``. Dictionary key is the property name with underscores instead of hyphens, and dictionary value is the property value in YAML syntax. Integer properties may also be provided as decimal strings. + The possible input properties in this dictionary are the properties defined as writeable in the data model for User resources (where the property names contain underscores instead of hyphens), with the following exceptions: - properties (False, dict, None) - Dictionary with desired properties for the user. Used for ``state=present``; ignored for ``state=absent|facts``. Dictionary key is the property name with underscores instead of hyphens, and dictionary value is the property value in YAML syntax. Integer properties may also be provided as decimal strings. + * ``name``: Cannot be specified because the name has already been specified in the ``name`` module parameter. - The possible input properties in this dictionary are the properties defined as writeable in the data model for User resources (where the property names contain underscores instead of hyphens), with the following exceptions: + * ``type``: Cannot be changed once the user exists. - * ``name``: Cannot be specified because the name has already been specified in the ``name`` module parameter. + * ``user-pattern-uri``: Cannot be set directly, but indirectly via the artificial property ``user-pattern-name``. - * ``type``: Cannot be changed once the user exists. + * ``password-rule-uri``: Cannot be set directly, but indirectly via the artificial property ``password-rule-name``. - * ``user-pattern-uri``: Cannot be set directly, but indirectly via the artificial property ``user-pattern-name``. + * ``ldap-server-definition-uri``: Cannot be set directly, but indirectly via the artificial property ``ldap-server-definition-name``. - * ``password-rule-uri``: Cannot be set directly, but indirectly via the artificial property ``password-rule-name``. + * ``default-group-uri``: Cannot be set directly, but indirectly via the artificial property ``default-group-name``. - * ``ldap-server-definition-uri``: Cannot be set directly, but indirectly via the artificial property ``ldap-server-definition-name``. + Properties omitted in this dictionary will remain unchanged when the user already exists, and will get the default value defined in the data model for users in the :term:`HMC API` when the user is being created. - * ``default-group-uri``: Cannot be set directly, but indirectly via the artificial property ``default-group-name``. - Properties omitted in this dictionary will remain unchanged when the user already exists, and will get the default value defined in the data model for users in the :term:`HMC API` when the user is being created. + | **required**: False + | **type**: dict - expand (False, bool, False) - Boolean that controls whether the returned user contains additional artificial properties that expand certain URI or name properties to the full set of resource properties (see description of return values of this module). + +expand + Boolean that controls whether the returned user contains additional artificial properties that expand certain URI or name properties to the full set of resource properties (see description of return values of this module). - log_file (False, str, None) - 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**: bool - faked_session (False, raw, None) - A ``zhmcclient_mock.FakedSession`` object that has a mocked HMC set up. If not null, this session will be used instead of connecting to the HMC specified in ``hmc_host``. This is used for testing purposes only. + +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 + +faked_session + A ``zhmcclient_mock.FakedSession`` object that has a mocked HMC set up. If not null, this session will be used instead of connecting to the HMC specified in ``hmc_host``. This is used for testing purposes only. + | **required**: False + | **type**: raw + @@ -104,37 +148,44 @@ Examples .. code-block:: yaml+jinja - - --- - # Note: The following examples assume that some variables named 'my_*' are set. - - - name: Gather facts about a user - zhmc_user: - hmc_host: "{{ my_hmc_host }}" - hmc_auth: "{{ my_hmc_auth }}" - name: "{{ my_user_name }}" - state: facts - expand: true - register: user1 - - - name: Ensure the user does not exist - zhmc_user: - hmc_host: "{{ my_hmc_host }}" - hmc_auth: "{{ my_hmc_auth }}" - name: "{{ my_user_name }}" - state: absent - - - name: Ensure the user exists - zhmc_user: - hmc_host: "{{ my_hmc_host }}" - hmc_auth: "{{ my_hmc_auth }}" - name: "{{ my_user_name }}" - state: present - expand: true - properties: - description: "Example user 1" - type: standard - register: user1 + + --- + # Note: The following examples assume that some variables named 'my_*' are set. + + - name: Gather facts about a user + zhmc_user: + hmc_host: "{{ my_hmc_host }}" + hmc_auth: "{{ my_hmc_auth }}" + name: "{{ my_user_name }}" + state: facts + expand: true + register: user1 + + - name: Ensure the user does not exist + zhmc_user: + hmc_host: "{{ my_hmc_host }}" + hmc_auth: "{{ my_hmc_auth }}" + name: "{{ my_user_name }}" + state: absent + + - name: Ensure the user exists + zhmc_user: + hmc_host: "{{ my_hmc_host }}" + hmc_auth: "{{ my_hmc_auth }}" + name: "{{ my_user_name }}" + state: present + expand: true + properties: + description: "Example user 1" + type: standard + register: user1 + + + + + + + @@ -142,55 +193,64 @@ Examples Return Values ------------- -user (success, dict, ) - For ``state=absent``, an empty dictionary. - For ``state=present|facts``, a dictionary with the resource properties of the target user, plus additional artificial properties as described in the following list items. + user + For ``state=absent``, an empty dictionary. + + For ``state=present|facts``, a dictionary with the resource properties of the target user, plus additional artificial properties as described in the following list items. + + + | **returned**: success + | **type**: dict + + + name + User name + + + | **type**: str + - name (, str, ) - User name + {property} + Additional properties of the user, as described in the :term:`HMC API` (using hyphens (-) in the property names). - {property} (, any, ) - Additional properties of the user, as described in the :term:`HMC API` (using hyphens (-) in the property names). + | **type**: - user-pattern-name (, str, ) - Name of the user pattern referenced by property ``user-pattern-uri``. + user-pattern-name + Name of the user pattern referenced by property ``user-pattern-uri``. - password-rule-name (, str, ) - Name of the password rule referenced by property ``password-rule-uri``. + | **type**: str - ldap-server-definition-name (, str, ) - Name of the LDAP server definition referenced by property ``ldap-server-definition-uri``. - default-group-name (, str, ) - Name of the group referenced by property ``default-group-uri``. + password-rule-name + Name of the password rule referenced by property ``password-rule-uri``. + | **type**: str + ldap-server-definition-name + Name of the LDAP server definition referenced by property ``ldap-server-definition-uri``. -Status ------- + | **type**: str -- This module is guaranteed to have backward compatible interface changes going forward. *[stableinterface]* + default-group-name + Name of the group referenced by property ``default-group-uri``. -- This module is maintained by community. + | **type**: str -Authors -~~~~~~~ -- Andreas Maier (@andy-maier) diff --git a/docs_source/modules/zhmc_virtual_function.rst b/docs_source/modules/zhmc_virtual_function.rst index 04ca69468..d4338785e 100644 --- a/docs_source/modules/zhmc_virtual_function.rst +++ b/docs_source/modules/zhmc_virtual_function.rst @@ -1,9 +1,14 @@ + +:github_url: https://github.com/IBM/ibm_zos_zosmf/tree/master/plugins/modules/zhmc_virtual_function.py + .. _zhmc_virtual_function_module: zhmc_virtual_function -- Create virtual functions in partitions =============================================================== + + .. contents:: :local: :depth: 1 @@ -11,86 +16,130 @@ zhmc_virtual_function -- Create virtual functions in partitions Synopsis -------- +- Create, update, or delete a virtual function in a partition of a CPC (Z system). +- Note that the Ansible module zhmc_partition can be used to gather facts about existing virtual functions of a partition. -Create, update, or delete a virtual function in a partition of a CPC (Z system). -Note that the Ansible module zhmc_partition can be used to gather facts about existing virtual functions of a partition. -Requirements ------------- -The below requirements are needed on the host that executes this module. +Parameters +---------- -- Access to the WS API of the HMC of the targeted Z system (see :term:`HMC API`). The targeted Z system must be in the Dynamic Partition Manager (DPM) operational mode. + +hmc_host + The hostname or IP address of the HMC. -Parameters ----------- + | **required**: True + | **type**: str + + + +hmc_auth + The authentication credentials for the HMC, as a dictionary of ``userid``, ``password``. + + + | **required**: True + | **type**: dict + + + + userid + The userid (username) for authenticating with the HMC. + + + | **required**: True + | **type**: str - hmc_host (True, str, None) - The hostname or IP address of the HMC. + + password + The password for authenticating with the HMC. - hmc_auth (True, dict, None) - The authentication credentials for the HMC, as a dictionary of ``userid``, ``password``. + | **required**: True + | **type**: str - userid (True, str, None) - The userid (username) for authenticating with the HMC. - password (True, str, None) - The password for authenticating with the HMC. + +cpc_name + The name of the CPC with the partition containing the virtual function. + | **required**: True + | **type**: str - cpc_name (True, str, None) - The name of the CPC with the partition containing the virtual function. + +partition_name + The name of the partition containing the virtual function. - partition_name (True, str, None) - The name of the partition containing the virtual function. + | **required**: True + | **type**: str - name (True, str, None) - The name of the target virtual function that is managed. If the virtual function needs to be created, this value becomes its name. + +name + The name of the target virtual function that is managed. If the virtual function needs to be created, this value becomes its name. - state (True, str, None) - The desired state for the target virtual function: - ``absent``: Ensures that the virtual function does not exist in the specified partition. + | **required**: True + | **type**: str - ``present``: Ensures that the virtual function exists in the specified partition and has the specified properties. + +state + The desired state for the target virtual function: - properties (False, dict, None) - Dictionary with input properties for the virtual function, 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``. + ``absent``: Ensures that the virtual function does not exist in the specified partition. - The possible input properties in this dictionary are the properties defined as writeable in the data model for Virtual Function resources (where the property names contain underscores instead of hyphens), with the following exceptions: + ``present``: Ensures that the virtual function exists in the specified partition and has the specified properties. - * ``name``: Cannot be specified because the name has already been specified in the ``name`` module parameter. - * ``adapter_uri``: Cannot be specified because this information is specified using the artificial property ``adapter_name``. + | **required**: True + | **type**: str + | **choices**: absent, present - * ``adapter_name``: The name of the adapter that backs the target virtual function. - Properties omitted in this dictionary will remain unchanged when the virtual function already exists, and will get the default value defined in the data model for virtual functions when the virtual function is being created. + +properties + Dictionary with input properties for the virtual function, 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 Virtual Function resources (where the property names contain underscores instead of hyphens), with the following exceptions: - log_file (False, str, None) - 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``: Cannot be specified because the name has already been specified in the ``name`` module parameter. + * ``adapter_uri``: Cannot be specified because this information is specified using the artificial property ``adapter_name``. - faked_session (False, raw, None) - A ``zhmcclient_mock.FakedSession`` object that has a mocked HMC set up. If not null, this session will be used instead of connecting to the HMC specified in ``hmc_host``. This is used for testing purposes only. + * ``adapter_name``: The name of the adapter that backs the target virtual function. + Properties omitted in this dictionary will remain unchanged when the virtual function already exists, and will get the default value defined in the data model for virtual functions when the virtual function 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 + + + +faked_session + A ``zhmcclient_mock.FakedSession`` object that has a mocked HMC set up. If not null, this session will be used instead of connecting to the HMC specified in ``hmc_host``. This is used for testing purposes only. + + + | **required**: False + | **type**: raw @@ -100,73 +149,71 @@ Examples .. code-block:: yaml+jinja - - --- - # Note: The following examples assume that some variables named 'my_*' are set. - - - name: Ensure virtual function 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_vfunction_name }}" - state: present - properties: - adapter_name: "ABC-123" - description: "The accelerator adapter" - device_number: "033F" - register: vfunction1 - - - name: Ensure virtual function 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_vfunction_name }}" - state: absent + + --- + # Note: The following examples assume that some variables named 'my_*' are set. + - name: Ensure virtual function 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_vfunction_name }}" + state: present + properties: + adapter_name: "ABC-123" + description: "The accelerator adapter" + device_number: "033F" + register: vfunction1 + - name: Ensure virtual function 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_vfunction_name }}" + state: absent -Return Values -------------- -virtual_function (success, dict, ) - For ``state=absent``, an empty dictionary. - For ``state=present``, a dictionary with the resource properties of the virtual function (after changes, if any). - name (, str, ) - Virtual function name - {property} (, any, ) - Additional properties of the virtual function, as described in the :term:`HMC API` (using hyphens (-) in the property names). +Return Values +------------- + + + virtual_function + For ``state=absent``, an empty dictionary. + + For ``state=present``, a dictionary with the resource properties of the virtual function (after changes, if any). + + + | **returned**: success + | **type**: dict + name + Virtual function name -Status ------- + | **type**: str -- This module is guaranteed to have backward compatible interface changes going forward. *[stableinterface]* + {property} + Additional properties of the virtual function, as described in the :term:`HMC API` (using hyphens (-) in the property names). -- This module is maintained by community. + | **type**: -Authors -~~~~~~~ -- Andreas Maier (@andy-maier) -- Andreas Scheuring (@scheuran) -- Juergen Leopold (@leopoldjuergen)