From 857201f28e693c1d7245b829a931b86e2d563bcb Mon Sep 17 00:00:00 2001 From: Andreas Maier Date: Mon, 2 Sep 2024 09:16:18 +0200 Subject: [PATCH] Updated .rst files to match new RST generator Signed-off-by: Andreas Maier --- docs/source/modules/zhmc_adapter.rst | 42 +++++----- docs/source/modules/zhmc_adapter_list.rst | 20 ++--- docs/source/modules/zhmc_console.rst | 36 ++++----- docs/source/modules/zhmc_cpc.rst | 50 ++++++------ docs/source/modules/zhmc_cpc_capacity.rst | 36 ++++----- docs/source/modules/zhmc_cpc_list.rst | 14 ++-- .../source/modules/zhmc_crypto_attachment.rst | 30 +++---- docs/source/modules/zhmc_hba.rst | 32 ++++---- .../modules/zhmc_ldap_server_definition.rst | 30 +++---- .../zhmc_ldap_server_definition_list.rst | 10 +-- docs/source/modules/zhmc_lpar.rst | 68 ++++++++-------- docs/source/modules/zhmc_lpar_command.rst | 18 ++--- docs/source/modules/zhmc_lpar_list.rst | 22 +++--- docs/source/modules/zhmc_lpar_messages.rst | 10 +-- docs/source/modules/zhmc_nic.rst | 34 ++++---- docs/source/modules/zhmc_nic_list.rst | 12 +-- docs/source/modules/zhmc_partition.rst | 78 +++++++++---------- .../source/modules/zhmc_partition_command.rst | 16 ++-- docs/source/modules/zhmc_partition_list.rst | 22 +++--- .../modules/zhmc_partition_messages.rst | 10 +-- docs/source/modules/zhmc_password_rule.rst | 30 +++---- .../modules/zhmc_password_rule_list.rst | 12 +-- docs/source/modules/zhmc_session.rst | 34 ++++---- docs/source/modules/zhmc_storage_group.rst | 56 ++++++------- .../modules/zhmc_storage_group_attachment.rst | 18 ++--- docs/source/modules/zhmc_storage_volume.rst | 32 ++++---- docs/source/modules/zhmc_user.rst | 76 +++++++++--------- docs/source/modules/zhmc_user_list.rst | 14 ++-- docs/source/modules/zhmc_user_pattern.rst | 34 ++++---- .../source/modules/zhmc_user_pattern_list.rst | 18 ++--- docs/source/modules/zhmc_user_role.rst | 74 +++++++++--------- docs/source/modules/zhmc_user_role_list.rst | 14 ++-- docs/source/modules/zhmc_versions.rst | 12 +-- docs/source/modules/zhmc_virtual_function.rst | 30 +++---- 34 files changed, 522 insertions(+), 522 deletions(-) diff --git a/docs/source/modules/zhmc_adapter.rst b/docs/source/modules/zhmc_adapter.rst index 3d8b0b81..4a89040b 100644 --- a/docs/source/modules/zhmc_adapter.rst +++ b/docs/source/modules/zhmc_adapter.rst @@ -52,35 +52,35 @@ hmc_auth userid - The userid (username) for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The userid (username) for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str password - The password for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The password for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str session_id - HMC session ID to be used. This is mutually exclusive with providing \ :literal:`hmc\_auth.userid`\ and \ :literal:`hmc\_auth.password`\ and can be created as described in the \ :ref:`zhmc\_session module `\ . + HMC session ID to be used. This is mutually exclusive with providing :literal:`hmc\_auth.userid` and :literal:`hmc\_auth.password` and can be created as described in the :ref:`zhmc\_session module `. | **required**: False | **type**: str ca_certs - Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the \ :envvar:`REQUESTS\_CA\_BUNDLE`\ environment variable or the path name in the \ :envvar:`CURL\_CA\_BUNDLE`\ environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. + Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the :envvar:`REQUESTS\_CA\_BUNDLE` environment variable or the path name in the :envvar:`CURL\_CA\_BUNDLE` environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. | **required**: False | **type**: str verify - If True (default), verify the HMC certificate as specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter. If False, ignore what is specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter and do not verify the HMC certificate. + If True (default), verify the HMC certificate as specified in the :literal:`hmc\_auth.ca\_certs` parameter. If False, ignore what is specified in the :literal:`hmc\_auth.ca\_certs` parameter and do not verify the HMC certificate. | **required**: False | **type**: bool @@ -103,15 +103,15 @@ name match - Only for \ :literal:`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 \ :literal:`name`\ module parameter does not exist in that set. This parameter will be ignored otherwise. + Only for :literal:`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 :literal:`name` module parameter does not exist in that set. This parameter will be ignored otherwise. - Use of this parameter allows renaming an adapter: The \ :literal:`name`\ module parameter specifies the new name of the target adapter, and the \ :literal:`match`\ module parameter identifies the adapter to be renamed. This can be combined with other property updates by using the \ :literal:`properties`\ module parameter. + Use of this parameter allows renaming an adapter: The :literal:`name` module parameter specifies the new name of the target adapter, and the :literal:`match` module parameter identifies the adapter to be renamed. This can be combined with other property updates by using the :literal:`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 \ :literal:`name`\ . + The possible match properties are all properties in the data model for adapter resources, including :literal:`name`. | **required**: False | **type**: dict @@ -120,13 +120,13 @@ match state The desired state for the adapter. All states are fully idempotent within the limits of the properties that can be changed: - \* \ :literal:`set`\ : Ensures that an existing adapter has the specified properties. + \* :literal:`set`\ : Ensures that an existing adapter has the specified properties. - \* \ :literal:`present`\ : Ensures that a Hipersockets adapter exists and has the specified properties. + \* :literal:`present`\ : Ensures that a Hipersockets adapter exists and has the specified properties. - \* \ :literal:`absent`\ : Ensures that a Hipersockets adapter does not exist. + \* :literal:`absent`\ : Ensures that a Hipersockets adapter does not exist. - \* \ :literal:`facts`\ : Returns the adapter properties including its ports. + \* :literal:`facts`\ : Returns the adapter properties including its ports. | **required**: True | **type**: str @@ -134,17 +134,17 @@ state properties - Only for \ :literal:`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. + Only for :literal:`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: - \* \ :literal:`name`\ : Cannot be specified as a property because the name has already been specified in the \ :literal:`name`\ module parameter. + \* :literal:`name`\ : Cannot be specified as a property because the name has already been specified in the :literal:`name` module parameter. - \* \ :literal:`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 \ :literal:`not-configured`\ , \ :literal:`fcp`\ and \ :literal:`fc`\ ). + \* :literal:`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 :literal:`not-configured`\ , :literal:`fcp` and :literal:`fc`\ ). - \* \ :literal:`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 \ :literal:`ep11`\ , \ :literal:`cca`\ and \ :literal:`acc`\ . Changing to \ :literal:`acc`\ will zeroize the crypto adapter. + \* :literal:`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 :literal:`ep11`\ , :literal:`cca` and :literal:`acc`. Changing to :literal:`acc` will zeroize the crypto adapter. | **required**: False | **type**: dict @@ -243,7 +243,7 @@ Return Values changed - Indicates if any change has been made by the module. For \ :literal:`state=facts`\ , always will be false. + Indicates if any change has been made by the module. For :literal:`state=facts`\ , always will be false. | **returned**: always | **type**: bool @@ -255,9 +255,9 @@ msg | **type**: str adapter - For \ :literal:`state=absent`\ , an empty dictionary. + For :literal:`state=absent`\ , an empty dictionary. - For \ :literal:`state=set|present|facts`\ , the adapter and its ports. + For :literal:`state=set|present|facts`\ , the adapter and its ports. | **returned**: success | **type**: dict @@ -309,7 +309,7 @@ adapter | **type**: str {property} - Additional properties of the adapter, as described in the data model of the 'Adapter' object in the \ :ref:`HMC API `\ book. The property names have hyphens (-) as described in that book. + Additional properties of the adapter, as described in the data model of the 'Adapter' object in the :ref:`HMC API ` book. The property names have hyphens (-) as described in that book. | **type**: raw @@ -325,7 +325,7 @@ adapter | **type**: str {property} - Additional properties of the port, as described in the data model of the 'Network Port' or 'Storage Port' element object of the 'Adapter' object in the \ :ref:`HMC API `\ book. The property names have hyphens (-) as described in that book. In case of unconfigured FICON adapters, the property list is short. + Additional properties of the port, as described in the data model of the 'Network Port' or 'Storage Port' element object of the 'Adapter' object in the :ref:`HMC API ` book. The property names have hyphens (-) as described in that book. In case of unconfigured FICON adapters, the property list is short. | **type**: raw diff --git a/docs/source/modules/zhmc_adapter_list.rst b/docs/source/modules/zhmc_adapter_list.rst index 4b7b7fd8..5d46dea9 100644 --- a/docs/source/modules/zhmc_adapter_list.rst +++ b/docs/source/modules/zhmc_adapter_list.rst @@ -51,35 +51,35 @@ hmc_auth userid - The userid (username) for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The userid (username) for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str password - The password for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The password for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str session_id - HMC session ID to be used. This is mutually exclusive with providing \ :literal:`hmc\_auth.userid`\ and \ :literal:`hmc\_auth.password`\ and can be created as described in the \ :ref:`zhmc\_session module `\ . + HMC session ID to be used. This is mutually exclusive with providing :literal:`hmc\_auth.userid` and :literal:`hmc\_auth.password` and can be created as described in the :ref:`zhmc\_session module `. | **required**: False | **type**: str ca_certs - Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the \ :envvar:`REQUESTS\_CA\_BUNDLE`\ environment variable or the path name in the \ :envvar:`CURL\_CA\_BUNDLE`\ environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. + Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the :envvar:`REQUESTS\_CA\_BUNDLE` environment variable or the path name in the :envvar:`CURL\_CA\_BUNDLE` environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. | **required**: False | **type**: str verify - If True (default), verify the HMC certificate as specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter. If False, ignore what is specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter and do not verify the HMC certificate. + If True (default), verify the HMC certificate as specified in the :literal:`hmc\_auth.ca\_certs` parameter. If False, ignore what is specified in the :literal:`hmc\_auth.ca\_certs` parameter and do not verify the HMC certificate. | **required**: False | **type**: bool @@ -134,7 +134,7 @@ status additional_properties List of additional properties to be returned for each adapter, in addition to the default properties (see result description). - Mutually exclusive with \ :literal:`full\_properties`\ . + Mutually exclusive with :literal:`full\_properties`. The property names are specified with underscores instead of hyphens. @@ -148,9 +148,9 @@ additional_properties full_properties If True, all properties of each adapter will be returned. Default: False. - Mutually exclusive with \ :literal:`additional\_properties`\ . + Mutually exclusive with :literal:`additional\_properties`. - Note: Setting this to True causes a loop of 'Get Adapter Properties' operations to be executed. It is preferable from a performance perspective to use the \ :literal:`additional\_properties`\ parameter instead. + Note: Setting this to True causes a loop of 'Get Adapter Properties' operations to be executed. It is preferable from a performance perspective to use the :literal:`additional\_properties` parameter instead. | **required**: False | **type**: bool @@ -227,7 +227,7 @@ msg | **type**: str adapters - The list of adapters, with a subset of their properties. For details on the properties, see the data model of the 'Adapter' resource (see \ :ref:`HMC API `\ ) + The list of adapters, with a subset of their properties. For details on the properties, see the data model of the 'Adapter' resource (see :ref:`HMC API `\ ) | **returned**: success | **type**: list @@ -278,7 +278,7 @@ adapters | **type**: str {additional_property} - Additional properties requested via \ :literal:`full\_properties`\ or \ :literal:`additional\_properties`\ . The property names will have underscores instead of hyphens. + Additional properties requested via :literal:`full\_properties` or :literal:`additional\_properties`. The property names will have underscores instead of hyphens. | **type**: raw diff --git a/docs/source/modules/zhmc_console.rst b/docs/source/modules/zhmc_console.rst index 828f6ff9..fc472e79 100644 --- a/docs/source/modules/zhmc_console.rst +++ b/docs/source/modules/zhmc_console.rst @@ -23,8 +23,8 @@ Synopsis Requirements ------------ -- For \ :literal:`state=facts`\ , no specific task or object-access permissions are required. -- For \ :literal:`state=upgrade`\ , task permission to the 'Single Step Console Internal Code' task is required. +- For :literal:`state=facts`\ , no specific task or object-access permissions are required. +- For :literal:`state=upgrade`\ , task permission to the 'Single Step Console Internal Code' task is required. @@ -50,35 +50,35 @@ hmc_auth userid - The userid (username) for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The userid (username) for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str password - The password for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The password for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str session_id - HMC session ID to be used. This is mutually exclusive with providing \ :literal:`hmc\_auth.userid`\ and \ :literal:`hmc\_auth.password`\ and can be created as described in the \ :ref:`zhmc\_session module `\ . + HMC session ID to be used. This is mutually exclusive with providing :literal:`hmc\_auth.userid` and :literal:`hmc\_auth.password` and can be created as described in the :ref:`zhmc\_session module `. | **required**: False | **type**: str ca_certs - Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the \ :envvar:`REQUESTS\_CA\_BUNDLE`\ environment variable or the path name in the \ :envvar:`CURL\_CA\_BUNDLE`\ environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. + Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the :envvar:`REQUESTS\_CA\_BUNDLE` environment variable or the path name in the :envvar:`CURL\_CA\_BUNDLE` environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. | **required**: False | **type**: str verify - If True (default), verify the HMC certificate as specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter. If False, ignore what is specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter and do not verify the HMC certificate. + If True (default), verify the HMC certificate as specified in the :literal:`hmc\_auth.ca\_certs` parameter. If False, ignore what is specified in the :literal:`hmc\_auth.ca\_certs` parameter and do not verify the HMC certificate. | **required**: False | **type**: bool @@ -89,9 +89,9 @@ hmc_auth state The action to be performed on the HMC: - \* \ :literal:`facts`\ : Returns facts about the HMC. + \* :literal:`facts`\ : Returns facts about the HMC. - \* \ :literal:`upgrade`\ : Upgrades the firmware of the HMC and returns the new facts after the upgrade. If the HMC firmware is already at the requested bundle level, nothing is changed and the module succeeds. + \* :literal:`upgrade`\ : Upgrades the firmware of the HMC and returns the new facts after the upgrade. If the HMC firmware is already at the requested bundle level, nothing is changed and the module succeeds. | **required**: True | **type**: str @@ -99,9 +99,9 @@ state bundle_level - Name of the bundle to be installed on the HMC (e.g. \ :literal:`H71`\ ) + Name of the bundle to be installed on the HMC (e.g. :literal:`H71`\ ) - Required for \ :literal:`state=upgrade`\ + Required for :literal:`state=upgrade` | **required**: False | **type**: str @@ -118,11 +118,11 @@ upgrade_timeout backup_location_type Type of backup location for the HMC backup that is performed: - \* \ :literal:`ftp`\ : The FTP server that was used for the last console backup as defined on the 'Configure Backup Settings' user interface task in the HMC GUI. + \* :literal:`ftp`\ : The FTP server that was used for the last console backup as defined on the 'Configure Backup Settings' user interface task in the HMC GUI. - \* \ :literal:`usb`\ : The USB storage device mounted to the HMC. + \* :literal:`usb`\ : The USB storage device mounted to the HMC. - Optional for \ :literal:`state=upgrade`\ , default: \ :literal:`usb`\ + Optional for :literal:`state=upgrade`\ , default: :literal:`usb` | **required**: False | **type**: str @@ -133,7 +133,7 @@ backup_location_type accept_firmware Accept the previous bundle level before installing the new level. - Optional for \ :literal:`state=upgrade`\ , default: True + Optional for :literal:`state=upgrade`\ , default: True | **required**: False | **type**: bool @@ -188,7 +188,7 @@ Return Values changed - Indicates if any change has been made by the module. For \ :literal:`state=facts`\ , always will be false. + Indicates if any change has been made by the module. For :literal:`state=facts`\ , always will be false. | **returned**: always | **type**: bool @@ -222,7 +222,7 @@ hmc | **type**: str {property} - Additional properties of the Console object representing the targeted HMC, as described in the data model of the 'Console' object in the \ :ref:`HMC API `\ book. Note that the set of properties has been extended over the past HMC versions, so you will get less properties on older HMC versions. The property names have hyphens (-) as described in that book. + Additional properties of the Console object representing the targeted HMC, as described in the data model of the 'Console' object in the :ref:`HMC API ` book. Note that the set of properties has been extended over the past HMC versions, so you will get less properties on older HMC versions. The property names have hyphens (-) as described in that book. | **type**: raw @@ -232,7 +232,7 @@ hmc | **type**: dict {property} - The properties returned from the 'Query API Version' operation, as described in the \ :ref:`HMC API `\ book. Note that the set of properties has been extended over the past HMC versions, so you will get less properties on older HMC versions. The property names have hyphens (-) as described in that book. + The properties returned from the 'Query API Version' operation, as described in the :ref:`HMC API ` book. Note that the set of properties has been extended over the past HMC versions, so you will get less properties on older HMC versions. The property names have hyphens (-) as described in that book. | **type**: raw diff --git a/docs/source/modules/zhmc_cpc.rst b/docs/source/modules/zhmc_cpc.rst index 90a6e8b2..2451751e 100644 --- a/docs/source/modules/zhmc_cpc.rst +++ b/docs/source/modules/zhmc_cpc.rst @@ -53,35 +53,35 @@ hmc_auth userid - The userid (username) for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The userid (username) for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str password - The password for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The password for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str session_id - HMC session ID to be used. This is mutually exclusive with providing \ :literal:`hmc\_auth.userid`\ and \ :literal:`hmc\_auth.password`\ and can be created as described in the \ :ref:`zhmc\_session module `\ . + HMC session ID to be used. This is mutually exclusive with providing :literal:`hmc\_auth.userid` and :literal:`hmc\_auth.password` and can be created as described in the :ref:`zhmc\_session module `. | **required**: False | **type**: str ca_certs - Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the \ :envvar:`REQUESTS\_CA\_BUNDLE`\ environment variable or the path name in the \ :envvar:`CURL\_CA\_BUNDLE`\ environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. + Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the :envvar:`REQUESTS\_CA\_BUNDLE` environment variable or the path name in the :envvar:`CURL\_CA\_BUNDLE` environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. | **required**: False | **type**: str verify - If True (default), verify the HMC certificate as specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter. If False, ignore what is specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter and do not verify the HMC certificate. + If True (default), verify the HMC certificate as specified in the :literal:`hmc\_auth.ca\_certs` parameter. If False, ignore what is specified in the :literal:`hmc\_auth.ca\_certs` parameter and do not verify the HMC certificate. | **required**: False | **type**: bool @@ -99,15 +99,15 @@ name state The desired state for the CPC. All states are fully idempotent within the limits of the properties that can be changed: - \* \ :literal:`inactive`\ : Ensures the CPC is inactive. + \* :literal:`inactive`\ : Ensures the CPC is inactive. - \* \ :literal:`active`\ : Ensures the CPC is active and then ensures that the CPC has the specified properties. The operational mode of the CPC cannot be changed. + \* :literal:`active`\ : Ensures the CPC is active and then ensures that the CPC has the specified properties. The operational mode of the CPC cannot be changed. - \* \ :literal:`set`\ : Ensures that the CPC has the specified properties. + \* :literal:`set`\ : Ensures that the CPC has the specified properties. - \* \ :literal:`facts`\ : Returns the CPC properties including its child resources. + \* :literal:`facts`\ : Returns the CPC properties including its child resources. - \* \ :literal:`upgrade`\ : Upgrades the firmware of the SE of the CPC and returns the new facts after the upgrade. If the SE firmware is already at the requested bundle level, nothing is changed and the module succeeds. + \* :literal:`upgrade`\ : Upgrades the firmware of the SE of the CPC and returns the new facts after the upgrade. If the SE firmware is already at the requested bundle level, nothing is changed and the module succeeds. | **required**: True | **type**: str @@ -115,13 +115,13 @@ state select_properties - Limits the returned properties of the CPC to those specified in this parameter plus those specified in the \ :literal:`properties`\ parameter. + Limits the returned properties of the CPC to those specified in this parameter plus those specified in the :literal:`properties` parameter. The properties can be specified with underscores or hyphens in their names. Null indicates not to limit the returned properties in this way. - This parameter is ignored for \ :literal:`state`\ values that cause no properties to be returned. + This parameter is ignored for :literal:`state` values that cause no properties to be returned. The returned child resources (adapters, partitions, storage groups) cannot be excluded using this parameter. @@ -133,18 +133,18 @@ select_properties activation_profile_name - The name of the reset activation profile to be used when activating the CPC in the classic operational mode, for \ :literal:`state=active`\ . This parameter is ignored when the CPC is in classic mode and was already active, and when the CPC is in DPM mode. + The name of the reset activation profile to be used when activating the CPC in the classic operational mode, for :literal:`state=active`. This parameter is ignored when the CPC is in classic mode and was already active, and when the CPC is in DPM mode. Default: The reset activation profile specified in the 'next-activation-profile-name' property of the CPC. - This parameter is not allowed for the other \ :literal:`state`\ values. + This parameter is not allowed for the other :literal:`state` values. | **required**: False | **type**: str properties - Only for \ :literal:`state=set`\ and \ :literal:`state=active`\ : New values for the properties of the CPC. Properties omitted in this dictionary will remain unchanged. This parameter will be ignored for other \ :literal:`state`\ values. + Only for :literal:`state=set` and :literal:`state=active`\ : New values for the properties of the CPC. Properties omitted in this dictionary will remain unchanged. This parameter will be ignored for other :literal:`state` values. 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. @@ -155,9 +155,9 @@ properties bundle_level - Name of the bundle to be installed on the SE of the CPC (e.g. \ :literal:`S71`\ ) + Name of the bundle to be installed on the SE of the CPC (e.g. :literal:`S71`\ ) - Required for \ :literal:`state=upgrade`\ + Required for :literal:`state=upgrade` | **required**: False | **type**: str @@ -174,7 +174,7 @@ upgrade_timeout accept_firmware Accept the previous bundle level before installing the new level. - Optional for \ :literal:`state=upgrade`\ , default: True + Optional for :literal:`state=upgrade`\ , default: True | **required**: False | **type**: bool @@ -258,7 +258,7 @@ Return Values changed - Indicates if any change has been made by the module. For \ :literal:`state=facts`\ , always will be false. + Indicates if any change has been made by the module. For :literal:`state=facts`\ , always will be false. | **returned**: always | **type**: bool @@ -270,9 +270,9 @@ msg | **type**: str cpc - For \ :literal:`state=inactive`\ , an empty dictionary. + For :literal:`state=inactive`\ , an empty dictionary. - For \ :literal:`state=active|set|facts|upgrade`\ , the resource properties of the CPC after after any specified updates have been applied, and its adapters, partitions, and storage groups. + For :literal:`state=active|set|facts|upgrade`\ , the resource properties of the CPC after after any specified updates have been applied, and its adapters, partitions, and storage groups. | **returned**: success | **type**: dict @@ -339,12 +339,12 @@ cpc | **type**: str {property} - Additional properties of the CPC, as described in the data model of the 'CPC' object in the \ :ref:`HMC API `\ book. The property names have hyphens (-) as described in that book. + Additional properties of the CPC, as described in the data model of the 'CPC' object in the :ref:`HMC API ` book. The property names have hyphens (-) as described in that book. | **type**: raw adapters - The adapters of the CPC, with a subset of their properties. For details, see the \ :ref:`HMC API `\ book. + The adapters of the CPC, with a subset of their properties. For details, see the :ref:`HMC API ` book. | **type**: list | **elements**: dict @@ -381,7 +381,7 @@ cpc partitions - The defined partitions of the CPC, with a subset of their properties. For details, see the \ :ref:`HMC API `\ book. + The defined partitions of the CPC, with a subset of their properties. For details, see the :ref:`HMC API ` book. | **type**: list | **elements**: dict @@ -408,7 +408,7 @@ cpc storage-groups - The storage groups associated with the CPC, with a subset of their properties. For details, see the \ :ref:`HMC API `\ book. + The storage groups associated with the CPC, with a subset of their properties. For details, see the :ref:`HMC API ` book. | **type**: list | **elements**: dict diff --git a/docs/source/modules/zhmc_cpc_capacity.rst b/docs/source/modules/zhmc_cpc_capacity.rst index 504849f5..783af1d8 100644 --- a/docs/source/modules/zhmc_cpc_capacity.rst +++ b/docs/source/modules/zhmc_cpc_capacity.rst @@ -18,7 +18,7 @@ Synopsis -------- - Gather facts about the processor capacity of a CPC (Z system). - Update the processor capacity of a CPC (Z system) via adding or removing temporary capacity (On/Off CoD). -- For details on processor capacity on demand, see the \ :ref:`Capacity on Demand User's Guide `\ . +- For details on processor capacity on demand, see the :ref:`Capacity on Demand User's Guide `. Requirements @@ -52,35 +52,35 @@ hmc_auth userid - The userid (username) for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The userid (username) for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str password - The password for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The password for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str session_id - HMC session ID to be used. This is mutually exclusive with providing \ :literal:`hmc\_auth.userid`\ and \ :literal:`hmc\_auth.password`\ and can be created as described in the \ :ref:`zhmc\_session module `\ . + HMC session ID to be used. This is mutually exclusive with providing :literal:`hmc\_auth.userid` and :literal:`hmc\_auth.password` and can be created as described in the :ref:`zhmc\_session module `. | **required**: False | **type**: str ca_certs - Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the \ :envvar:`REQUESTS\_CA\_BUNDLE`\ environment variable or the path name in the \ :envvar:`CURL\_CA\_BUNDLE`\ environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. + Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the :envvar:`REQUESTS\_CA\_BUNDLE` environment variable or the path name in the :envvar:`CURL\_CA\_BUNDLE` environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. | **required**: False | **type**: str verify - If True (default), verify the HMC certificate as specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter. If False, ignore what is specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter and do not verify the HMC certificate. + If True (default), verify the HMC certificate as specified in the :literal:`hmc\_auth.ca\_certs` parameter. If False, ignore what is specified in the :literal:`hmc\_auth.ca\_certs` parameter and do not verify the HMC certificate. | **required**: False | **type**: bool @@ -98,9 +98,9 @@ name state The desired state for the operation: - \* \ :literal:`set`\ : Ensures that the CPC has the specified specialty processor capacity and the specified software model, and returns the resulting processor capacity of the CPC. + \* :literal:`set`\ : Ensures that the CPC has the specified specialty processor capacity and the specified software model, and returns the resulting processor capacity of the CPC. - \* \ :literal:`facts`\ : Does not change anything on the CPC and returns the current processor capacity of the CPC. + \* :literal:`facts`\ : Does not change anything on the CPC and returns the current processor capacity of the CPC. | **required**: True | **type**: str @@ -110,7 +110,7 @@ state record_id The ID of the capacity record to be used for any updates of the processor capacity. - Required for \ :literal:`state=set`\ . + Required for :literal:`state=set`. | **required**: False | **type**: str @@ -126,13 +126,13 @@ software_model software_model_direction - Indicates the direction of the capacity change for general purpose processors in \ :literal:`software\_model`\ , relative to the current software model: + Indicates the direction of the capacity change for general purpose processors in :literal:`software\_model`\ , relative to the current software model: - \* \ :literal:`increase`\ : The specified software model defines more general purpose processors than the current software model. + \* :literal:`increase`\ : The specified software model defines more general purpose processors than the current software model. - \* \ :literal:`decrease`\ : The specified software model defines less general purpose processors than the current software model. + \* :literal:`decrease`\ : The specified software model defines less general purpose processors than the current software model. - Ignored when \ :literal:`software\_model`\ is null, not provided, or specifies the current software model. Otherwise required. + Ignored when :literal:`software\_model` is null, not provided, or specifies the current software model. Otherwise required. | **required**: False | **type**: str @@ -140,13 +140,13 @@ software_model_direction specialty_processors - The target number of specialty processors to be active. Processor types not provided will not be changed. Target numbers of general purpose processors can be set via the \ :literal:`software\_model`\ parameter. + The target number of specialty processors to be active. Processor types not provided will not be changed. Target numbers of general purpose processors can be set via the :literal:`software\_model` parameter. - Each item in the dictionary identifies the target number of processors of one type of specialty processor. The key identifies the type of specialty processor (\ :literal:`icf`\ , \ :literal:`ifl`\ , \ :literal:`iip`\ , \ :literal:`sap`\ ), and the value is the target number of processors of that type. Note that the target number is the number of permanently activated processors plus the number of temporarily activated processors. + Each item in the dictionary identifies the target number of processors of one type of specialty processor. The key identifies the type of specialty processor (\ :literal:`icf`\ , :literal:`ifl`\ , :literal:`iip`\ , :literal:`sap`\ ), and the value is the target number of processors of that type. Note that the target number is the number of permanently activated processors plus the number of temporarily activated processors. The target number for each processor type may be larger, equal or lower than the current number, but it must not be lower than the number of permanent processors of that type. - If the target number of processors is not installed in the CPC, the \ :literal:`force`\ parameter controls what happens. + If the target number of processors is not installed in the CPC, the :literal:`force` parameter controls what happens. If null, empty or not provided, the specialty processor capacity will remain unchanged. @@ -155,7 +155,7 @@ specialty_processors test_activation - Indicates that test resources instead of real resources from the capacity record should be activated. Test resources are automatically deactivated after 24h. This is mainly used for Capacity Backup Upgrade (CBU) test activations. For details, see the \ :ref:`Capacity on Demand User's Guide `\ . + Indicates that test resources instead of real resources from the capacity record should be activated. Test resources are automatically deactivated after 24h. This is mainly used for Capacity Backup Upgrade (CBU) test activations. For details, see the :ref:`Capacity on Demand User's Guide `. | **required**: False | **type**: bool @@ -229,7 +229,7 @@ Return Values changed - Indicates if any change has been made by the module. For \ :literal:`state=facts`\ , always will be false. + Indicates if any change has been made by the module. For :literal:`state=facts`\ , always will be false. | **returned**: always | **type**: bool diff --git a/docs/source/modules/zhmc_cpc_list.rst b/docs/source/modules/zhmc_cpc_list.rst index 5a71e619..cc11ee6f 100644 --- a/docs/source/modules/zhmc_cpc_list.rst +++ b/docs/source/modules/zhmc_cpc_list.rst @@ -48,35 +48,35 @@ hmc_auth userid - The userid (username) for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The userid (username) for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str password - The password for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The password for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str session_id - HMC session ID to be used. This is mutually exclusive with providing \ :literal:`hmc\_auth.userid`\ and \ :literal:`hmc\_auth.password`\ and can be created as described in the \ :ref:`zhmc\_session module `\ . + HMC session ID to be used. This is mutually exclusive with providing :literal:`hmc\_auth.userid` and :literal:`hmc\_auth.password` and can be created as described in the :ref:`zhmc\_session module `. | **required**: False | **type**: str ca_certs - Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the \ :envvar:`REQUESTS\_CA\_BUNDLE`\ environment variable or the path name in the \ :envvar:`CURL\_CA\_BUNDLE`\ environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. + Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the :envvar:`REQUESTS\_CA\_BUNDLE` environment variable or the path name in the :envvar:`CURL\_CA\_BUNDLE` environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. | **required**: False | **type**: str verify - If True (default), verify the HMC certificate as specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter. If False, ignore what is specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter and do not verify the HMC certificate. + If True (default), verify the HMC certificate as specified in the :literal:`hmc\_auth.ca\_certs` parameter. If False, ignore what is specified in the :literal:`hmc\_auth.ca\_certs` parameter and do not verify the HMC certificate. | **required**: False | **type**: bool @@ -192,7 +192,7 @@ cpcs | **type**: bool status - The current status of the CPC. For details, see the description of the 'status' property in the data model of the 'CPC' resource (see \ :ref:`HMC API `\ ). Only included for managed CPCs. + The current status of the CPC. For details, see the description of the 'status' property in the data model of the 'CPC' resource (see :ref:`HMC API `\ ). Only included for managed CPCs. | **type**: str @@ -212,7 +212,7 @@ cpcs | **type**: str {additional_property} - Additional properties requested via \ :literal:`full\_properties`\ . The property names will have underscores instead of hyphens. + Additional properties requested via :literal:`full\_properties`. The property names will have underscores instead of hyphens. | **type**: raw diff --git a/docs/source/modules/zhmc_crypto_attachment.rst b/docs/source/modules/zhmc_crypto_attachment.rst index 03fc85c4..38f329bc 100644 --- a/docs/source/modules/zhmc_crypto_attachment.rst +++ b/docs/source/modules/zhmc_crypto_attachment.rst @@ -52,35 +52,35 @@ hmc_auth userid - The userid (username) for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The userid (username) for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str password - The password for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The password for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str session_id - HMC session ID to be used. This is mutually exclusive with providing \ :literal:`hmc\_auth.userid`\ and \ :literal:`hmc\_auth.password`\ and can be created as described in the \ :ref:`zhmc\_session module `\ . + HMC session ID to be used. This is mutually exclusive with providing :literal:`hmc\_auth.userid` and :literal:`hmc\_auth.password` and can be created as described in the :ref:`zhmc\_session module `. | **required**: False | **type**: str ca_certs - Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the \ :envvar:`REQUESTS\_CA\_BUNDLE`\ environment variable or the path name in the \ :envvar:`CURL\_CA\_BUNDLE`\ environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. + Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the :envvar:`REQUESTS\_CA\_BUNDLE` environment variable or the path name in the :envvar:`CURL\_CA\_BUNDLE` environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. | **required**: False | **type**: str verify - If True (default), verify the HMC certificate as specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter. If False, ignore what is specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter and do not verify the HMC certificate. + If True (default), verify the HMC certificate as specified in the :literal:`hmc\_auth.ca\_certs` parameter. If False, ignore what is specified in the :literal:`hmc\_auth.ca\_certs` parameter and do not verify the HMC certificate. | **required**: False | **type**: bool @@ -105,11 +105,11 @@ partition_name state The desired state for the crypto attachment. All states are fully idempotent within the limits of the properties that can be changed: - \* \ :literal:`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. + \* :literal:`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. - \* \ :literal:`detached`\ : Ensures that no crypto adapter and no crypto domains are attached to the partition. + \* :literal:`detached`\ : Ensures that no crypto adapter and no crypto domains are attached to the partition. - \* \ :literal:`facts`\ : Returns the crypto configuration of the partition. + \* :literal:`facts`\ : Returns the crypto configuration of the partition. | **required**: True | **type**: str @@ -117,14 +117,14 @@ state adapter_count - Only for \ :literal:`state=attached`\ : 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 \ :literal:`adapter\_names`\ and \ :literal:`adapter\_count`\ parameters are mutually exclusive and one of them must be specified. + Only for :literal:`state=attached`\ : 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 :literal:`adapter\_names` and :literal:`adapter\_count` parameters are mutually exclusive and one of them must be specified. | **required**: False | **type**: int crypto_type - Only for \ :literal:`state=attached`\ : The crypto type of the crypto adapters that will be selected from when \ :literal:`adapter\_count`\ is specified. Ignored when \ :literal:`adapter\_names`\ is specified. + Only for :literal:`state=attached`\ : The crypto type of the crypto adapters that will be selected from when :literal:`adapter\_count` is specified. Ignored when :literal:`adapter\_names` is specified. | **required**: False | **type**: str @@ -133,7 +133,7 @@ crypto_type adapter_names - Only for \ :literal:`state=attached`\ : The names of the crypto adapters the partition needs to have attached. The \ :literal:`adapter\_names`\ and \ :literal:`adapter\_count`\ parameters are mutually exclusive and one of them must be specified. + Only for :literal:`state=attached`\ : The names of the crypto adapters the partition needs to have attached. The :literal:`adapter\_names` and :literal:`adapter\_count` parameters are mutually exclusive and one of them must be specified. | **required**: False | **type**: list @@ -141,7 +141,7 @@ adapter_names domain_range - Only for \ :literal:`state=attached`\ : 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. + Only for :literal:`state=attached`\ : 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 @@ -150,7 +150,7 @@ domain_range access_mode - Only for \ :literal:`state=attached`\ : The access mode in which the crypto domains specified in \ :literal:`domain\_range`\ need to be attached. + Only for :literal:`state=attached`\ : The access mode in which the crypto domains specified in :literal:`domain\_range` need to be attached. | **required**: False | **type**: str @@ -246,7 +246,7 @@ Return Values changed - Indicates if any change has been made by the module. For \ :literal:`state=facts`\ , always will be false. + Indicates if any change has been made by the module. For :literal:`state=facts`\ , always will be false. | **returned**: always | **type**: bool @@ -342,7 +342,7 @@ crypto_configuration | **type**: str {property} - Additional properties of the adapter, as described in the data model of the 'Adapter' object in the \ :ref:`HMC API `\ book. The property names have hyphens (-) as described in that book. + Additional properties of the adapter, as described in the data model of the 'Adapter' object in the :ref:`HMC API ` book. The property names have hyphens (-) as described in that book. | **type**: raw diff --git a/docs/source/modules/zhmc_hba.rst b/docs/source/modules/zhmc_hba.rst index 91398200..cfe079d4 100644 --- a/docs/source/modules/zhmc_hba.rst +++ b/docs/source/modules/zhmc_hba.rst @@ -51,35 +51,35 @@ hmc_auth userid - The userid (username) for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The userid (username) for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str password - The password for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The password for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str session_id - HMC session ID to be used. This is mutually exclusive with providing \ :literal:`hmc\_auth.userid`\ and \ :literal:`hmc\_auth.password`\ and can be created as described in the \ :ref:`zhmc\_session module `\ . + HMC session ID to be used. This is mutually exclusive with providing :literal:`hmc\_auth.userid` and :literal:`hmc\_auth.password` and can be created as described in the :ref:`zhmc\_session module `. | **required**: False | **type**: str ca_certs - Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the \ :envvar:`REQUESTS\_CA\_BUNDLE`\ environment variable or the path name in the \ :envvar:`CURL\_CA\_BUNDLE`\ environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. + Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the :envvar:`REQUESTS\_CA\_BUNDLE` environment variable or the path name in the :envvar:`CURL\_CA\_BUNDLE` environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. | **required**: False | **type**: str verify - If True (default), verify the HMC certificate as specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter. If False, ignore what is specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter and do not verify the HMC certificate. + If True (default), verify the HMC certificate as specified in the :literal:`hmc\_auth.ca\_certs` parameter. If False, ignore what is specified in the :literal:`hmc\_auth.ca\_certs` parameter and do not verify the HMC certificate. | **required**: False | **type**: bool @@ -111,9 +111,9 @@ name state The desired state for the HBA. All states are fully idempotent within the limits of the properties that can be changed: - \* \ :literal:`absent`\ : Ensures that the HBA does not exist in the specified partition. + \* :literal:`absent`\ : Ensures that the HBA does not exist in the specified partition. - \* \ :literal:`present`\ : Ensures that the HBA exists in the specified partition and has the specified properties. + \* :literal:`present`\ : Ensures that the HBA exists in the specified partition and has the specified properties. | **required**: True | **type**: str @@ -121,17 +121,17 @@ state properties - Dictionary with input properties for the HBA, for \ :literal:`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 \ :literal:`state=absent`\ . + Dictionary with input properties for the HBA, for :literal:`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 :literal:`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: - \* \ :literal:`name`\ : Cannot be specified because the name has already been specified in the \ :literal:`name`\ module parameter. + \* :literal:`name`\ : Cannot be specified because the name has already been specified in the :literal:`name` module parameter. - \* \ :literal:`adapter\_port\_uri`\ : Cannot be specified because this information is specified using the artificial properties \ :literal:`adapter\_name`\ and \ :literal:`adapter\_port`\ . + \* :literal:`adapter\_port\_uri`\ : Cannot be specified because this information is specified using the artificial properties :literal:`adapter\_name` and :literal:`adapter\_port`. - \* \ :literal:`adapter\_name`\ : The name of the adapter that has the port backing the target HBA. Cannot be changed after the HBA exists. + \* :literal:`adapter\_name`\ : The name of the adapter that has the port backing the target HBA. Cannot be changed after the HBA exists. - \* \ :literal:`adapter\_port`\ : The port index of the adapter port backing the target HBA. Cannot be changed after the HBA exists. + \* :literal:`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. @@ -195,7 +195,7 @@ Return Values changed - Indicates if any change has been made by the module. For \ :literal:`state=facts`\ , always will be false. + Indicates if any change has been made by the module. For :literal:`state=facts`\ , always will be false. | **returned**: always | **type**: bool @@ -207,9 +207,9 @@ msg | **type**: str hba - For \ :literal:`state=absent`\ , an empty dictionary. + For :literal:`state=absent`\ , an empty dictionary. - For \ :literal:`state=present`\ , the resource properties of the HBA after any changes. + For :literal:`state=present`\ , the resource properties of the HBA after any changes. | **returned**: success | **type**: dict @@ -220,7 +220,7 @@ hba | **type**: str {property} - Additional properties of the HBA, as described in the data model of the 'HBA' element object of the 'Partition' object in the \ :ref:`HMC API `\ book. The property names have hyphens (-) as described in that book. + Additional properties of the HBA, as described in the data model of the 'HBA' element object of the 'Partition' object in the :ref:`HMC API ` book. The property names have hyphens (-) as described in that book. | **type**: raw diff --git a/docs/source/modules/zhmc_ldap_server_definition.rst b/docs/source/modules/zhmc_ldap_server_definition.rst index 7c43dae6..b7a3bb91 100644 --- a/docs/source/modules/zhmc_ldap_server_definition.rst +++ b/docs/source/modules/zhmc_ldap_server_definition.rst @@ -49,35 +49,35 @@ hmc_auth userid - The userid (username) for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The userid (username) for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str password - The password for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The password for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str session_id - HMC session ID to be used. This is mutually exclusive with providing \ :literal:`hmc\_auth.userid`\ and \ :literal:`hmc\_auth.password`\ and can be created as described in the \ :ref:`zhmc\_session module `\ . + HMC session ID to be used. This is mutually exclusive with providing :literal:`hmc\_auth.userid` and :literal:`hmc\_auth.password` and can be created as described in the :ref:`zhmc\_session module `. | **required**: False | **type**: str ca_certs - Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the \ :envvar:`REQUESTS\_CA\_BUNDLE`\ environment variable or the path name in the \ :envvar:`CURL\_CA\_BUNDLE`\ environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. + Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the :envvar:`REQUESTS\_CA\_BUNDLE` environment variable or the path name in the :envvar:`CURL\_CA\_BUNDLE` environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. | **required**: False | **type**: str verify - If True (default), verify the HMC certificate as specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter. If False, ignore what is specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter and do not verify the HMC certificate. + If True (default), verify the HMC certificate as specified in the :literal:`hmc\_auth.ca\_certs` parameter. If False, ignore what is specified in the :literal:`hmc\_auth.ca\_certs` parameter and do not verify the HMC certificate. | **required**: False | **type**: bool @@ -97,11 +97,11 @@ name state The desired state for the LDAP Server Definition. All states are fully idempotent within the limits of the properties that can be changed: - \* \ :literal:`absent`\ : Ensures that the LDAP Server Definition does not exist. + \* :literal:`absent`\ : Ensures that the LDAP Server Definition does not exist. - \* \ :literal:`present`\ : Ensures that the LDAP Server Definition exists and has the specified properties. + \* :literal:`present`\ : Ensures that the LDAP Server Definition exists and has the specified properties. - \* \ :literal:`facts`\ : Returns the LDAP Server Definition properties. + \* :literal:`facts`\ : Returns the LDAP Server Definition properties. | **required**: True | **type**: str @@ -109,13 +109,13 @@ state properties - Dictionary with desired properties for the LDAP Server Definition. Used for \ :literal:`state=present`\ ; ignored for \ :literal:`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. + Dictionary with desired properties for the LDAP Server Definition. Used for :literal:`state=present`\ ; ignored for :literal:`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 LDAP Server Definition resources (where the property names contain underscores instead of hyphens), with the following exceptions: - \* \ :literal:`name`\ : Cannot be specified because the name has already been specified in the \ :literal:`name`\ module parameter. + \* :literal:`name`\ : Cannot be specified because the name has already been specified in the :literal:`name` module parameter. - Properties omitted in this dictionary will remain unchanged when the LDAP Server Definition already exists, and will get the default value defined in the data model for LDAP Server Definitions in the \ :ref:`HMC API `\ book when the LDAP Server Definition is being created. + Properties omitted in this dictionary will remain unchanged when the LDAP Server Definition already exists, and will get the default value defined in the data model for LDAP Server Definitions in the :ref:`HMC API ` book when the LDAP Server Definition is being created. | **required**: False | **type**: dict @@ -180,7 +180,7 @@ Return Values changed - Indicates if any change has been made by the module. For \ :literal:`state=facts`\ , always will be false. + Indicates if any change has been made by the module. For :literal:`state=facts`\ , always will be false. | **returned**: always | **type**: bool @@ -192,9 +192,9 @@ msg | **type**: str ldap_server_definition - For \ :literal:`state=absent`\ , an empty dictionary. + For :literal:`state=absent`\ , an empty dictionary. - For \ :literal:`state=present|facts`\ , a dictionary with the resource properties of the target LDAP Server Definition. + For :literal:`state=present|facts`\ , a dictionary with the resource properties of the target LDAP Server Definition. | **returned**: success | **type**: dict @@ -228,7 +228,7 @@ ldap_server_definition | **type**: str {property} - Additional properties of the LDAP Server Definition, as described in the data model of the 'LDAP Server Definition' object in the \ :ref:`HMC API `\ book. The property names have hyphens (-) as described in that book. + Additional properties of the LDAP Server Definition, as described in the data model of the 'LDAP Server Definition' object in the :ref:`HMC API ` book. The property names have hyphens (-) as described in that book. | **type**: raw diff --git a/docs/source/modules/zhmc_ldap_server_definition_list.rst b/docs/source/modules/zhmc_ldap_server_definition_list.rst index ef645ebf..3b6653a1 100644 --- a/docs/source/modules/zhmc_ldap_server_definition_list.rst +++ b/docs/source/modules/zhmc_ldap_server_definition_list.rst @@ -48,35 +48,35 @@ hmc_auth userid - The userid (username) for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The userid (username) for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str password - The password for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The password for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str session_id - HMC session ID to be used. This is mutually exclusive with providing \ :literal:`hmc\_auth.userid`\ and \ :literal:`hmc\_auth.password`\ and can be created as described in the \ :ref:`zhmc\_session module `\ . + HMC session ID to be used. This is mutually exclusive with providing :literal:`hmc\_auth.userid` and :literal:`hmc\_auth.password` and can be created as described in the :ref:`zhmc\_session module `. | **required**: False | **type**: str ca_certs - Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the \ :envvar:`REQUESTS\_CA\_BUNDLE`\ environment variable or the path name in the \ :envvar:`CURL\_CA\_BUNDLE`\ environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. + Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the :envvar:`REQUESTS\_CA\_BUNDLE` environment variable or the path name in the :envvar:`CURL\_CA\_BUNDLE` environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. | **required**: False | **type**: str verify - If True (default), verify the HMC certificate as specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter. If False, ignore what is specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter and do not verify the HMC certificate. + If True (default), verify the HMC certificate as specified in the :literal:`hmc\_auth.ca\_certs` parameter. If False, ignore what is specified in the :literal:`hmc\_auth.ca\_certs` parameter and do not verify the HMC certificate. | **required**: False | **type**: bool diff --git a/docs/source/modules/zhmc_lpar.rst b/docs/source/modules/zhmc_lpar.rst index c0a78635..3275f833 100644 --- a/docs/source/modules/zhmc_lpar.rst +++ b/docs/source/modules/zhmc_lpar.rst @@ -55,35 +55,35 @@ hmc_auth userid - The userid (username) for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The userid (username) for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str password - The password for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The password for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str session_id - HMC session ID to be used. This is mutually exclusive with providing \ :literal:`hmc\_auth.userid`\ and \ :literal:`hmc\_auth.password`\ and can be created as described in the \ :ref:`zhmc\_session module `\ . + HMC session ID to be used. This is mutually exclusive with providing :literal:`hmc\_auth.userid` and :literal:`hmc\_auth.password` and can be created as described in the :ref:`zhmc\_session module `. | **required**: False | **type**: str ca_certs - Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the \ :envvar:`REQUESTS\_CA\_BUNDLE`\ environment variable or the path name in the \ :envvar:`CURL\_CA\_BUNDLE`\ environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. + Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the :envvar:`REQUESTS\_CA\_BUNDLE` environment variable or the path name in the :envvar:`CURL\_CA\_BUNDLE` environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. | **required**: False | **type**: str verify - If True (default), verify the HMC certificate as specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter. If False, ignore what is specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter and do not verify the HMC certificate. + If True (default), verify the HMC certificate as specified in the :literal:`hmc\_auth.ca\_certs` parameter. If False, ignore what is specified in the :literal:`hmc\_auth.ca\_certs` parameter and do not verify the HMC certificate. | **required**: False | **type**: bool @@ -108,19 +108,19 @@ name state The desired state for the LPAR: - \* \ :literal:`inactive`\ : Ensures that the LPAR is inactive (i.e. status 'not-activated'), unless the LPAR is currently operating and the \ :literal:`force`\ parameter was not set to True. Properties cannot be updated. The LPAR is deactivated if needed. + \* :literal:`inactive`\ : Ensures that the LPAR is inactive (i.e. status 'not-activated'), unless the LPAR is currently operating and the :literal:`force` parameter was not set to True. Properties cannot be updated. The LPAR is deactivated if needed. - \* \ :literal:`active`\ : Ensures that the LPAR is at least active (i.e. status is 'not-operating', 'operating' or 'exceptions'), and then ensures that the LPAR properties have the specified values. The LPAR is activated if needed using the 'Activate Logical Partition' operation. In certain cases, that operation will automatically load the LPAR. For details, see the \ :literal:`activation\_profile\_name`\ parameter. + \* :literal:`active`\ : Ensures that the LPAR is at least active (i.e. status is 'not-operating', 'operating' or 'exceptions'), and then ensures that the LPAR properties have the specified values. The LPAR is activated if needed using the 'Activate Logical Partition' operation. In certain cases, that operation will automatically load the LPAR. For details, see the :literal:`activation\_profile\_name` parameter. - \* \ :literal:`loaded`\ : Ensures that the LPAR is loaded (i.e. status is 'operating' or 'exceptions'), and then ensures that the LPAR properties have the specified values. The LPAR is first activated if needed using the 'Activate Logical Partition' operation, and then loaded if needed using the 'Load Logical Partition' operation. For details, see the \ :literal:`activation\_profile\_name`\ parameter. + \* :literal:`loaded`\ : Ensures that the LPAR is loaded (i.e. status is 'operating' or 'exceptions'), and then ensures that the LPAR properties have the specified values. The LPAR is first activated if needed using the 'Activate Logical Partition' operation, and then loaded if needed using the 'Load Logical Partition' operation. For details, see the :literal:`activation\_profile\_name` parameter. - \* \ :literal:`reset\_clear`\ : Performs the 'Reset Clear' HMC operation on the LPAR. This initializes the LPAR for loading by clearing its pending interruptions, resetting its channel subsystem, resetting its processors, and clearing its memory). The LPAR must be in status 'not-operating', 'operating', or 'exceptions'. If the LPAR status is 'operating' or 'exceptions', the operation will fail unless the \ :literal:`force`\ parameter is set to True. Properties cannot be updated. + \* :literal:`reset\_clear`\ : Performs the 'Reset Clear' HMC operation on the LPAR. This initializes the LPAR for loading by clearing its pending interruptions, resetting its channel subsystem, resetting its processors, and clearing its memory). The LPAR must be in status 'not-operating', 'operating', or 'exceptions'. If the LPAR status is 'operating' or 'exceptions', the operation will fail unless the :literal:`force` parameter is set to True. Properties cannot be updated. - \* \ :literal:`reset\_normal`\ : Performs the 'Reset Normal' HMC operation on the LPAR. This initializes the LPAR for loading by clearing its pending interruptions, resetting its channel subsystem, and resetting its processors). It does not clear the memory. The LPAR must be in status 'not-operating', 'operating', or 'exceptions'. If the LPAR status is 'operating' or 'exceptions', the operation will fail unless the \ :literal:`force`\ parameter is set to True. Properties cannot be updated. + \* :literal:`reset\_normal`\ : Performs the 'Reset Normal' HMC operation on the LPAR. This initializes the LPAR for loading by clearing its pending interruptions, resetting its channel subsystem, and resetting its processors). It does not clear the memory. The LPAR must be in status 'not-operating', 'operating', or 'exceptions'. If the LPAR status is 'operating' or 'exceptions', the operation will fail unless the :literal:`force` parameter is set to True. Properties cannot be updated. - \* \ :literal:`set`\ : Ensures that the LPAR properties have the specified values. Requires that the LPAR is at least active (i.e. status is 'not-operating', 'operating' or 'exceptions') but does not activate the LPAR if that is not the case. + \* :literal:`set`\ : Ensures that the LPAR properties have the specified values. Requires that the LPAR is at least active (i.e. status is 'not-operating', 'operating' or 'exceptions') but does not activate the LPAR if that is not the case. - \* \ :literal:`facts`\ : Returns the current LPAR properties. + \* :literal:`facts`\ : Returns the current LPAR properties. In all cases, the LPAR must exist. @@ -130,13 +130,13 @@ state select_properties - Limits the returned properties of the LPAR to those specified in this parameter plus those specified in the \ :literal:`properties`\ parameter. + Limits the returned properties of the LPAR to those specified in this parameter plus those specified in the :literal:`properties` parameter. The properties can be specified with underscores or hyphens in their names. Null indicates not to limit the returned properties in this way. - This parameter is ignored for \ :literal:`state`\ values that cause no properties to be returned. + This parameter is ignored for :literal:`state` values that cause no properties to be returned. The specified properties are passed to the 'Get Logical Partition Properties' HMC operation using the 'properties' query parameter and save time for the HMC to pull together all properties. @@ -146,9 +146,9 @@ select_properties activation_profile_name - The name of the image or load activation profile to be used when the LPAR needs to be activated, for \ :literal:`state=active`\ and \ :literal:`state=loaded`\ . + The name of the image or load activation profile to be used when the LPAR needs to be activated, for :literal:`state=active` and :literal:`state=loaded`. - This parameter is not allowed for the other \ :literal:`state`\ values. + This parameter is not allowed for the other :literal:`state` values. Default: The image or load activation profile specified in the 'next-activation-profile-name' property of the LPAR is used when the LPAR needs to be activated. @@ -161,9 +161,9 @@ activation_profile_name load_address - The hexadecimal address of an I/O device that provides access to the control program to be loaded, for \ :literal:`state=loaded`\ . + The hexadecimal address of an I/O device that provides access to the control program to be loaded, for :literal:`state=loaded`. - This parameter is not allowed for the other \ :literal:`state`\ values. + This parameter is not allowed for the other :literal:`state` values. This parameter is used only when the LPAR is explicitly loaded using the 'Load Logical Partition' operation. It is not used when the LPAR is automatically loaded during the 'Activate Logical Partition' operation. @@ -174,9 +174,9 @@ load_address load_parameter - A parameter string that is passed to the control program when loading it, for \ :literal:`state=loaded`\ . + A parameter string that is passed to the control program when loading it, for :literal:`state=loaded`. - This parameter is not allowed for the other \ :literal:`state`\ values. + This parameter is not allowed for the other :literal:`state` values. This parameter is used only when the LPAR is explicitly loaded using the 'Load Logical Partition' operation. It is not used when the LPAR is automatically loaded during the 'Activate Logical Partition' operation. @@ -185,9 +185,9 @@ load_parameter clear_indicator - Controls whether memory is cleared before performing the load, for \ :literal:`state=loaded`\ . + Controls whether memory is cleared before performing the load, for :literal:`state=loaded`. - This parameter is not allowed for the other \ :literal:`state`\ values. + This parameter is not allowed for the other :literal:`state` values. This parameter is used only when the LPAR is explicitly loaded using the 'Load Logical Partition' operation. It is not used when the LPAR is automatically loaded during the 'Activate Logical Partition' operation. @@ -197,9 +197,9 @@ clear_indicator store_status_indicator - Controls whether the current values of CPU timer, clock comparator, program status word, and the contents of the processor registers are stored to their assigned absolute storage locations, for \ :literal:`state=loaded`\ . + Controls whether the current values of CPU timer, clock comparator, program status word, and the contents of the processor registers are stored to their assigned absolute storage locations, for :literal:`state=loaded`. - This parameter is not allowed for the other \ :literal:`state`\ values. + This parameter is not allowed for the other :literal:`state` values. This parameter is used only when the LPAR is explicitly loaded using the 'Load Logical Partition' operation. It is not used when the LPAR is automatically loaded during the 'Activate Logical Partition' operation. @@ -208,7 +208,7 @@ store_status_indicator timeout - Timeout in seconds, for the HMC operation to complete, for \ :literal:`state=inactive`\ , \ :literal:`state=active`\ and \ :literal:`state=loaded`\ . + Timeout in seconds, for the HMC operation to complete, for :literal:`state=inactive`\ , :literal:`state=active` and :literal:`state=loaded`. | **required**: False | **type**: int @@ -216,7 +216,7 @@ timeout status_timeout - Timeout in seconds, for reaching the desired status after the HMC operation completed, for \ :literal:`state=inactive`\ , \ :literal:`state=active`\ and \ :literal:`state=loaded`\ . + Timeout in seconds, for reaching the desired status after the HMC operation completed, for :literal:`state=inactive`\ , :literal:`state=active` and :literal:`state=loaded`. | **required**: False | **type**: int @@ -247,20 +247,20 @@ force os_ipl_token - Setting this parameter for \ :literal:`state=reset\_clear`\ or \ :literal:`state=reset\_normal`\ requests that the corresponding HMC operations only be performed if the provided value matches the current value of the 'os-ipl-token' property of the LPAR, and be rejected otherwise. Note that the 'os-ipl-token' property of the LPAR is set by the operating system and is set only by some operating systems, such as z/OS. This parameter is ignored for other \ :literal:`state`\ values. + Setting this parameter for :literal:`state=reset\_clear` or :literal:`state=reset\_normal` requests that the corresponding HMC operations only be performed if the provided value matches the current value of the 'os-ipl-token' property of the LPAR, and be rejected otherwise. Note that the 'os-ipl-token' property of the LPAR is set by the operating system and is set only by some operating systems, such as z/OS. This parameter is ignored for other :literal:`state` values. | **required**: False | **type**: str properties - Dictionary with new values for the LPAR properties, for \ :literal:`state=active`\ , \ :literal:`state=loaded`\ and \ :literal:`state=set`\ . 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. + Dictionary with new values for the LPAR properties, for :literal:`state=active`\ , :literal:`state=loaded` and :literal:`state=set`. 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. The possible input properties in this dictionary are the properties defined as writeable in the data model for LPAR resources (where the property names contain underscores instead of hyphens). Properties omitted in this dictionary will not be updated. - This parameter is not allowed for the other \ :literal:`state`\ values. + This parameter is not allowed for the other :literal:`state` values. | **required**: False | **type**: dict @@ -376,7 +376,7 @@ Return Values changed - Indicates if any change has been made by the module. For \ :literal:`state=facts`\ , always will be false. + Indicates if any change has been made by the module. For :literal:`state=facts`\ , always will be false. | **returned**: always | **type**: bool @@ -388,11 +388,11 @@ msg | **type**: str lpar - For \ :literal:`state=inactive|reset\_clear|reset\_normal`\ , an empty dictionary. + For :literal:`state=inactive|reset\_clear|reset\_normal`\ , an empty dictionary. - For \ :literal:`state=active|loaded|set|facts`\ , the resource properties of the LPAR after after any specified updates have been applied. + For :literal:`state=active|loaded|set|facts`\ , the resource properties of the LPAR after after any specified updates have been applied. - Note that the returned properties may show different values than the ones that were specified as input for the update. For example, memory properties may be rounded up, hexadecimal strings may be shown with a different representation format, and other properties may change as a result of updating some properties. For details, see the data model of the 'Logical Partition' object in the \ :ref:`HMC API `\ book. + Note that the returned properties may show different values than the ones that were specified as input for the update. For example, memory properties may be rounded up, hexadecimal strings may be shown with a different representation format, and other properties may change as a result of updating some properties. For details, see the data model of the 'Logical Partition' object in the :ref:`HMC API ` book. | **returned**: success | **type**: dict @@ -560,7 +560,7 @@ lpar | **type**: str {property} - Additional properties of the LPAR, as described in the data model of the 'Logical Partition' object in the \ :ref:`HMC API `\ book. The property names have hyphens (-) as described in that book. + Additional properties of the LPAR, as described in the data model of the 'Logical Partition' object in the :ref:`HMC API ` book. The property names have hyphens (-) as described in that book. | **type**: raw diff --git a/docs/source/modules/zhmc_lpar_command.rst b/docs/source/modules/zhmc_lpar_command.rst index fec81ee8..a8149fad 100644 --- a/docs/source/modules/zhmc_lpar_command.rst +++ b/docs/source/modules/zhmc_lpar_command.rst @@ -53,35 +53,35 @@ hmc_auth userid - The userid (username) for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The userid (username) for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str password - The password for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The password for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str session_id - HMC session ID to be used. This is mutually exclusive with providing \ :literal:`hmc\_auth.userid`\ and \ :literal:`hmc\_auth.password`\ and can be created as described in the \ :ref:`zhmc\_session module `\ . + HMC session ID to be used. This is mutually exclusive with providing :literal:`hmc\_auth.userid` and :literal:`hmc\_auth.password` and can be created as described in the :ref:`zhmc\_session module `. | **required**: False | **type**: str ca_certs - Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the \ :envvar:`REQUESTS\_CA\_BUNDLE`\ environment variable or the path name in the \ :envvar:`CURL\_CA\_BUNDLE`\ environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. + Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the :envvar:`REQUESTS\_CA\_BUNDLE` environment variable or the path name in the :envvar:`CURL\_CA\_BUNDLE` environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. | **required**: False | **type**: str verify - If True (default), verify the HMC certificate as specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter. If False, ignore what is specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter and do not verify the HMC certificate. + If True (default), verify the HMC certificate as specified in the :literal:`hmc\_auth.ca\_certs` parameter. If False, ignore what is specified in the :literal:`hmc\_auth.ca\_certs` parameter and do not verify the HMC certificate. | **required**: False | **type**: bool @@ -160,7 +160,7 @@ Return Values changed Indicates if any change has been made by the module. - This will always be true, because it is not clear whether the command has performed a change. Note that a playbook using this module with a command that does not perform a change can override that by specifying \ :literal:`changed\_when: false`\ . + This will always be true, because it is not clear whether the command has performed a change. Note that a playbook using this module with a command that does not perform a change can override that by specifying :literal:`changed\_when: false`. | **returned**: always | **type**: bool @@ -176,11 +176,11 @@ output The format of each message text depends on the type of OS. Typical formats are, showing the message with the command: - z/VM: \ :literal:`04:30:02 Q CPLEVEL`\ + z/VM: :literal:`04:30:02 Q CPLEVEL` - z/OS: \ :literal:`D T`\ + z/OS: :literal:`D T` - Linux: \ :literal:`uname -a`\ + Linux: :literal:`uname -a` | **returned**: success | **type**: list diff --git a/docs/source/modules/zhmc_lpar_list.rst b/docs/source/modules/zhmc_lpar_list.rst index 3220f9b4..e292183d 100644 --- a/docs/source/modules/zhmc_lpar_list.rst +++ b/docs/source/modules/zhmc_lpar_list.rst @@ -51,35 +51,35 @@ hmc_auth userid - The userid (username) for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The userid (username) for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str password - The password for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The password for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str session_id - HMC session ID to be used. This is mutually exclusive with providing \ :literal:`hmc\_auth.userid`\ and \ :literal:`hmc\_auth.password`\ and can be created as described in the \ :ref:`zhmc\_session module `\ . + HMC session ID to be used. This is mutually exclusive with providing :literal:`hmc\_auth.userid` and :literal:`hmc\_auth.password` and can be created as described in the :ref:`zhmc\_session module `. | **required**: False | **type**: str ca_certs - Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the \ :envvar:`REQUESTS\_CA\_BUNDLE`\ environment variable or the path name in the \ :envvar:`CURL\_CA\_BUNDLE`\ environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. + Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the :envvar:`REQUESTS\_CA\_BUNDLE` environment variable or the path name in the :envvar:`CURL\_CA\_BUNDLE` environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. | **required**: False | **type**: str verify - If True (default), verify the HMC certificate as specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter. If False, ignore what is specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter and do not verify the HMC certificate. + If True (default), verify the HMC certificate as specified in the :literal:`hmc\_auth.ca\_certs` parameter. If False, ignore what is specified in the :literal:`hmc\_auth.ca\_certs` parameter and do not verify the HMC certificate. | **required**: False | **type**: bool @@ -99,7 +99,7 @@ cpc_name additional_properties List of additional properties to be returned for each LPAR, in addition to the default properties (see result description). - Mutually exclusive with \ :literal:`full\_properties`\ . + Mutually exclusive with :literal:`full\_properties`. The property names are specified with underscores instead of hyphens. @@ -113,9 +113,9 @@ additional_properties full_properties If True, all properties of each LPAR will be returned. Default: False. - Mutually exclusive with \ :literal:`additional\_properties`\ . + Mutually exclusive with :literal:`additional\_properties`. - Note: Setting this to True causes a loop of 'Get Logical Partition Properties' operations to be executed. It is preferable from a performance perspective to use the \ :literal:`additional\_properties`\ parameter instead. + Note: Setting this to True causes a loop of 'Get Logical Partition Properties' operations to be executed. It is preferable from a performance perspective to use the :literal:`additional\_properties` parameter instead. | **required**: False | **type**: bool @@ -214,7 +214,7 @@ lpars | **type**: str status - The current status of the LPAR. For details, see the description of the 'status' property in the data model of the 'Logical Partition' resource (see \ :ref:`HMC API `\ ). + The current status of the LPAR. For details, see the description of the 'status' property in the data model of the 'Logical Partition' resource (see :ref:`HMC API `\ ). | **type**: str @@ -224,12 +224,12 @@ lpars | **type**: bool activation_mode - The activation mode of the LPAR. For details, see the description of the 'activation-mode' property in the data model of the 'Logical Partition' resource (see \ :ref:`HMC API `\ ). + The activation mode of the LPAR. For details, see the description of the 'activation-mode' property in the data model of the 'Logical Partition' resource (see :ref:`HMC API `\ ). | **type**: str {additional_property} - Additional properties requested via \ :literal:`full\_properties`\ or \ :literal:`additional\_properties`\ . The property names will have underscores instead of hyphens. + Additional properties requested via :literal:`full\_properties` or :literal:`additional\_properties`. The property names will have underscores instead of hyphens. | **type**: raw diff --git a/docs/source/modules/zhmc_lpar_messages.rst b/docs/source/modules/zhmc_lpar_messages.rst index 32f50938..af46fd48 100644 --- a/docs/source/modules/zhmc_lpar_messages.rst +++ b/docs/source/modules/zhmc_lpar_messages.rst @@ -51,35 +51,35 @@ hmc_auth userid - The userid (username) for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The userid (username) for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str password - The password for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The password for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str session_id - HMC session ID to be used. This is mutually exclusive with providing \ :literal:`hmc\_auth.userid`\ and \ :literal:`hmc\_auth.password`\ and can be created as described in the \ :ref:`zhmc\_session module `\ . + HMC session ID to be used. This is mutually exclusive with providing :literal:`hmc\_auth.userid` and :literal:`hmc\_auth.password` and can be created as described in the :ref:`zhmc\_session module `. | **required**: False | **type**: str ca_certs - Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the \ :envvar:`REQUESTS\_CA\_BUNDLE`\ environment variable or the path name in the \ :envvar:`CURL\_CA\_BUNDLE`\ environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. + Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the :envvar:`REQUESTS\_CA\_BUNDLE` environment variable or the path name in the :envvar:`CURL\_CA\_BUNDLE` environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. | **required**: False | **type**: str verify - If True (default), verify the HMC certificate as specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter. If False, ignore what is specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter and do not verify the HMC certificate. + If True (default), verify the HMC certificate as specified in the :literal:`hmc\_auth.ca\_certs` parameter. If False, ignore what is specified in the :literal:`hmc\_auth.ca\_certs` parameter and do not verify the HMC certificate. | **required**: False | **type**: bool diff --git a/docs/source/modules/zhmc_nic.rst b/docs/source/modules/zhmc_nic.rst index 7c0dd977..9db08155 100644 --- a/docs/source/modules/zhmc_nic.rst +++ b/docs/source/modules/zhmc_nic.rst @@ -52,35 +52,35 @@ hmc_auth userid - The userid (username) for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The userid (username) for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str password - The password for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The password for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str session_id - HMC session ID to be used. This is mutually exclusive with providing \ :literal:`hmc\_auth.userid`\ and \ :literal:`hmc\_auth.password`\ and can be created as described in the \ :ref:`zhmc\_session module `\ . + HMC session ID to be used. This is mutually exclusive with providing :literal:`hmc\_auth.userid` and :literal:`hmc\_auth.password` and can be created as described in the :ref:`zhmc\_session module `. | **required**: False | **type**: str ca_certs - Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the \ :envvar:`REQUESTS\_CA\_BUNDLE`\ environment variable or the path name in the \ :envvar:`CURL\_CA\_BUNDLE`\ environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. + Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the :envvar:`REQUESTS\_CA\_BUNDLE` environment variable or the path name in the :envvar:`CURL\_CA\_BUNDLE` environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. | **required**: False | **type**: str verify - If True (default), verify the HMC certificate as specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter. If False, ignore what is specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter and do not verify the HMC certificate. + If True (default), verify the HMC certificate as specified in the :literal:`hmc\_auth.ca\_certs` parameter. If False, ignore what is specified in the :literal:`hmc\_auth.ca\_certs` parameter and do not verify the HMC certificate. | **required**: False | **type**: bool @@ -112,11 +112,11 @@ name state The desired state for the NIC. All states are fully idempotent within the limits of the properties that can be changed: - \* \ :literal:`absent`\ : Ensures that the NIC does not exist in the specified partition. + \* :literal:`absent`\ : Ensures that the NIC does not exist in the specified partition. - \* \ :literal:`present`\ : Ensures that the NIC exists in the specified partition and has the specified properties. + \* :literal:`present`\ : Ensures that the NIC exists in the specified partition and has the specified properties. - \* \ :literal:`facts`\ : Returns the NIC properties. + \* :literal:`facts`\ : Returns the NIC properties. | **required**: True | **type**: str @@ -124,17 +124,17 @@ state properties - Dictionary with input properties for the NIC, for \ :literal:`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 \ :literal:`state=absent`\ . + Dictionary with input properties for the NIC, for :literal:`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 :literal:`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: - \* \ :literal:`name`\ : Cannot be specified because the name has already been specified in the \ :literal:`name`\ module parameter. + \* :literal:`name`\ : Cannot be specified because the name has already been specified in the :literal:`name` module parameter. - \* \ :literal:`network\_adapter\_port\_uri`\ and \ :literal:`virtual\_switch\_uri`\ : Cannot be specified because this information is specified using the artificial properties \ :literal:`adapter\_name`\ and \ :literal:`adapter\_port`\ . + \* :literal:`network\_adapter\_port\_uri` and :literal:`virtual\_switch\_uri`\ : Cannot be specified because this information is specified using the artificial properties :literal:`adapter\_name` and :literal:`adapter\_port`. - \* \ :literal:`adapter\_name`\ : The name of the adapter that has the port backing the target NIC. Used for all adapter families (ROCE, OSA, Hipersockets). + \* :literal:`adapter\_name`\ : The name of the adapter that has the port backing the target NIC. Used for all adapter families (ROCE, OSA, Hipersockets). - \* \ :literal:`adapter\_port`\ : The port index of the adapter port backing the target NIC. Used for all adapter families (ROCE, OSA, Hipersockets). + \* :literal:`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. @@ -208,7 +208,7 @@ Return Values changed - Indicates if any change has been made by the module. For \ :literal:`state=facts`\ , always will be false. + Indicates if any change has been made by the module. For :literal:`state=facts`\ , always will be false. | **returned**: always | **type**: bool @@ -220,9 +220,9 @@ msg | **type**: str nic - For \ :literal:`state=absent`\ , an empty dictionary. + For :literal:`state=absent`\ , an empty dictionary. - For \ :literal:`state=present|facts`\ , the resource properties of the NIC after any changes. + For :literal:`state=present|facts`\ , the resource properties of the NIC after any changes. | **returned**: success | **type**: dict @@ -258,7 +258,7 @@ nic | **type**: str {property} - Additional properties of the NIC, as described in the data model of the 'NIC' element object of the 'Partition' object in the \ :ref:`HMC API `\ book. The property names have hyphens (-) as described in that book. + Additional properties of the NIC, as described in the data model of the 'NIC' element object of the 'Partition' object in the :ref:`HMC API ` book. The property names have hyphens (-) as described in that book. | **type**: raw diff --git a/docs/source/modules/zhmc_nic_list.rst b/docs/source/modules/zhmc_nic_list.rst index 0f757235..326b08b9 100644 --- a/docs/source/modules/zhmc_nic_list.rst +++ b/docs/source/modules/zhmc_nic_list.rst @@ -48,35 +48,35 @@ hmc_auth userid - The userid (username) for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The userid (username) for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str password - The password for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The password for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str session_id - HMC session ID to be used. This is mutually exclusive with providing \ :literal:`hmc\_auth.userid`\ and \ :literal:`hmc\_auth.password`\ and can be created as described in the \ :ref:`zhmc\_session module `\ . + HMC session ID to be used. This is mutually exclusive with providing :literal:`hmc\_auth.userid` and :literal:`hmc\_auth.password` and can be created as described in the :ref:`zhmc\_session module `. | **required**: False | **type**: str ca_certs - Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the \ :envvar:`REQUESTS\_CA\_BUNDLE`\ environment variable or the path name in the \ :envvar:`CURL\_CA\_BUNDLE`\ environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. + Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the :envvar:`REQUESTS\_CA\_BUNDLE` environment variable or the path name in the :envvar:`CURL\_CA\_BUNDLE` environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. | **required**: False | **type**: str verify - If True (default), verify the HMC certificate as specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter. If False, ignore what is specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter and do not verify the HMC certificate. + If True (default), verify the HMC certificate as specified in the :literal:`hmc\_auth.ca\_certs` parameter. If False, ignore what is specified in the :literal:`hmc\_auth.ca\_certs` parameter and do not verify the HMC certificate. | **required**: False | **type**: bool @@ -198,7 +198,7 @@ nics | **type**: str {additional_property} - Additional properties requested via \ :literal:`full\_properties`\ . The property names will have underscores instead of hyphens. + Additional properties requested via :literal:`full\_properties`. The property names will have underscores instead of hyphens. | **type**: raw diff --git a/docs/source/modules/zhmc_partition.rst b/docs/source/modules/zhmc_partition.rst index 539115c9..8300c547 100644 --- a/docs/source/modules/zhmc_partition.rst +++ b/docs/source/modules/zhmc_partition.rst @@ -52,35 +52,35 @@ hmc_auth userid - The userid (username) for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The userid (username) for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str password - The password for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The password for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str session_id - HMC session ID to be used. This is mutually exclusive with providing \ :literal:`hmc\_auth.userid`\ and \ :literal:`hmc\_auth.password`\ and can be created as described in the \ :ref:`zhmc\_session module `\ . + HMC session ID to be used. This is mutually exclusive with providing :literal:`hmc\_auth.userid` and :literal:`hmc\_auth.password` and can be created as described in the :ref:`zhmc\_session module `. | **required**: False | **type**: str ca_certs - Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the \ :envvar:`REQUESTS\_CA\_BUNDLE`\ environment variable or the path name in the \ :envvar:`CURL\_CA\_BUNDLE`\ environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. + Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the :envvar:`REQUESTS\_CA\_BUNDLE` environment variable or the path name in the :envvar:`CURL\_CA\_BUNDLE` environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. | **required**: False | **type**: str verify - If True (default), verify the HMC certificate as specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter. If False, ignore what is specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter and do not verify the HMC certificate. + If True (default), verify the HMC certificate as specified in the :literal:`hmc\_auth.ca\_certs` parameter. If False, ignore what is specified in the :literal:`hmc\_auth.ca\_certs` parameter and do not verify the HMC certificate. | **required**: False | **type**: bool @@ -105,17 +105,17 @@ name state The desired state for the partition. All states are fully idempotent within the limits of the properties that can be changed: - \* \ :literal:`absent`\ : Ensures that the partition does not exist in the specified CPC. + \* :literal:`absent`\ : Ensures that the partition does not exist in the specified CPC. - \* \ :literal:`stopped`\ : Ensures that the partition exists in the specified CPC, has the specified properties, and is in one of the inactive statuses ('stopped', 'terminated', 'paused', 'reservation-error'). + \* :literal:`stopped`\ : Ensures that the partition exists in the specified CPC, has the specified properties, and is in one of the inactive statuses ('stopped', 'terminated', 'paused', 'reservation-error'). - \* \ :literal:`active`\ : Ensures that the partition exists in the specified CPC, has the specified properties, and is in one of the active statuses ('active', 'degraded'). + \* :literal:`active`\ : Ensures that the partition exists in the specified CPC, has the specified properties, and is in one of the active statuses ('active', 'degraded'). - \* \ :literal:`mount\_iso`\ : Ensures that an ISO image with the specified name is mounted to the partition, and that the specified INS file is set. The content of a currnetly mounted ISO image is not verified. + \* :literal:`mount\_iso`\ : Ensures that an ISO image with the specified name is mounted to the partition, and that the specified INS file is set. The content of a currnetly mounted ISO image is not verified. - \* \ :literal:`unmount\_iso`\ : Ensures that no ISO image is unmounted to the partition. + \* :literal:`unmount\_iso`\ : Ensures that no ISO image is unmounted to the partition. - \* \ :literal:`facts`\ : Returns the partition properties and the properties of its child resources (HBAs, NICs, and virtual functions). + \* :literal:`facts`\ : Returns the partition properties and the properties of its child resources (HBAs, NICs, and virtual functions). | **required**: True | **type**: str @@ -123,13 +123,13 @@ state select_properties - Limits the returned properties of the partition to those specified in this parameter plus those specified in the \ :literal:`properties`\ parameter. + Limits the returned properties of the partition to those specified in this parameter plus those specified in the :literal:`properties` parameter. The properties can be specified with underscores or hyphens in their names. Null indicates not to limit the returned properties in this way. - This parameter is ignored for \ :literal:`state`\ values that cause no properties to be returned. + This parameter is ignored for :literal:`state` values that cause no properties to be returned. The specified properties are passed to the 'Get Partition Properties' HMC operation using the 'properties' query parameter and save time for the HMC to pull together all properties. @@ -139,36 +139,36 @@ select_properties properties - Dictionary with input properties for the partition, for \ :literal:`state=stopped`\ and \ :literal:`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 \ :literal:`state=absent`\ . + Dictionary with input properties for the partition, for :literal:`state=stopped` and :literal:`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 :literal:`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: - \* \ :literal:`name`\ : Cannot be specified because the name has already been specified in the \ :literal:`name`\ module parameter. + \* :literal:`name`\ : Cannot be specified because the name has already been specified in the :literal:`name` module parameter. - \* \ :literal:`type`\ : Cannot be changed once the partition exists, because updating it is not supported. + \* :literal:`type`\ : Cannot be changed once the partition exists, because updating it is not supported. - \* \ :literal:`boot\_storage\_device`\ : Cannot be specified because this information is specified using the artificial property \ :literal:`boot\_storage\_hba\_name`\ . + \* :literal:`boot\_storage\_device`\ : Cannot be specified because this information is specified using the artificial property :literal:`boot\_storage\_hba\_name`. - \* \ :literal:`boot\_network\_device`\ : Cannot be specified because this information is specified using the artificial property \ :literal:`boot\_network\_nic\_name`\ . + \* :literal:`boot\_network\_device`\ : Cannot be specified because this information is specified using the artificial property :literal:`boot\_network\_nic\_name`. - \* \ :literal:`boot\_storage\_hba\_name`\ : The name of the HBA whose URI is used to construct \ :literal:`boot\_storage\_device`\ . Specifying it requires that the partition exists. Only valid when the partition is on a z13. + \* :literal:`boot\_storage\_hba\_name`\ : The name of the HBA whose URI is used to construct :literal:`boot\_storage\_device`. Specifying it requires that the partition exists. Only valid when the partition is on a z13. - \* \ :literal:`boot\_storage\_group\_name`\ : The name of the storage group that contains the boot volume specified with \ :literal:`boot\_storage\_volume\_name`\ . + \* :literal:`boot\_storage\_group\_name`\ : The name of the storage group that contains the boot volume specified with :literal:`boot\_storage\_volume\_name`. - \* \ :literal:`boot\_storage\_volume\_name`\ : The name of the storage volume in storage group \ :literal:`boot\_storage\_group\_name`\ whose URI is used to construct \ :literal:`boot\_storage\_volume`\ . This property is mutually exclusive with \ :literal:`boot\_storage\_volume`\ . Specifying it requires that the partition and storage group exist. Only valid when the partition is on a z14 or later. + \* :literal:`boot\_storage\_volume\_name`\ : The name of the storage volume in storage group :literal:`boot\_storage\_group\_name` whose URI is used to construct :literal:`boot\_storage\_volume`. This property is mutually exclusive with :literal:`boot\_storage\_volume`. Specifying it requires that the partition and storage group exist. Only valid when the partition is on a z14 or later. - \* \ :literal:`boot\_network\_nic\_name`\ : The name of the NIC whose URI is used to construct \ :literal:`boot\_network\_device`\ . Specifying it requires that the partition exists. + \* :literal:`boot\_network\_nic\_name`\ : The name of the NIC whose URI is used to construct :literal:`boot\_network\_device`. Specifying it requires that the partition exists. - \* \ :literal:`crypto\_configuration`\ : The crypto configuration for the partition, in the format of the \ :literal:`crypto-configuration`\ property of the partition (see \ :ref:`HMC API `\ for details), with the exception that adapters are specified with their names in field \ :literal:`crypto\_adapter\_names`\ instead of their URIs in field \ :literal:`crypto\_adapter\_uris`\ . If the \ :literal:`crypto\_adapter\_names`\ field is null, all crypto adapters of the CPC will be used. + \* :literal:`crypto\_configuration`\ : The crypto configuration for the partition, in the format of the :literal:`crypto-configuration` property of the partition (see :ref:`HMC API ` for details), with the exception that adapters are specified with their names in field :literal:`crypto\_adapter\_names` instead of their URIs in field :literal:`crypto\_adapter\_uris`. If the :literal:`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 \ :ref:`HMC API `\ book when the partition is being created. + 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 :ref:`HMC API ` book when the partition is being created. | **required**: False | **type**: dict image_name - Name of the ISO image for \ :literal:`state=iso\_mount`\ (required). Not permitted for any other \ :literal:`state`\ values. + Name of the ISO image for :literal:`state=iso\_mount` (required). Not permitted for any other :literal:`state` values. This value is shown in the 'boot-iso-image-name' property of the partition. @@ -179,16 +179,16 @@ image_name image_file - Path name of the local ISO image file for \ :literal:`state=iso\_mount`\ (required). Not permitted for any other \ :literal:`state`\ values. + Path name of the local ISO image file for :literal:`state=iso\_mount` (required). Not permitted for any other :literal:`state` values. - When mounting an ISO image, this file is opened for reading and its content is sent to the HMC using the 'Mount ISO Image' operation. This file is not used when an image with the name specified in \ :literal:`image\_name`\ was already mounted. + When mounting an ISO image, this file is opened for reading and its content is sent to the HMC using the 'Mount ISO Image' operation. This file is not used when an image with the name specified in :literal:`image\_name` was already mounted. | **required**: False | **type**: str ins_file - Path name of the INS file within the ISO image that will be used when booting from the ISO image for \ :literal:`state=iso\_mount`\ (required). Not permitted for any other \ :literal:`state`\ values. + Path name of the INS file within the ISO image that will be used when booting from the ISO image for :literal:`state=iso\_mount` (required). Not permitted for any other :literal:`state` values. This value is shown in the 'boot-iso-ins-file' property of the partition. @@ -199,14 +199,14 @@ ins_file expand_storage_groups - Boolean that controls whether the returned partition contains an additional artificial property \ :literal:`partition.storage-groups`\ that is the list of storage groups attached to the partition, with properties as described for the zhmc\_storage\_group module with \ :literal:`expand=true`\ . + Boolean that controls whether the returned partition contains an additional artificial property :literal:`partition.storage-groups` that is the list of storage groups attached to the partition, with properties as described for the zhmc\_storage\_group module with :literal:`expand=true`. | **required**: False | **type**: bool expand_crypto_adapters - Boolean that controls whether the returned partition contains an additional artificial property \ :literal:`crypto-adapters`\ in its \ :literal:`crypto-configuration`\ property that is the list of crypto adapters attached to the partition, with properties as described for the zhmc\_adapter module. + Boolean that controls whether the returned partition contains an additional artificial property :literal:`crypto-adapters` in its :literal:`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 @@ -352,7 +352,7 @@ Return Values changed - Indicates if any change has been made by the module. For \ :literal:`state=facts`\ , always will be false. + Indicates if any change has been made by the module. For :literal:`state=facts`\ , always will be false. | **returned**: always | **type**: bool @@ -364,9 +364,9 @@ msg | **type**: str partition - For \ :literal:`state=absent|iso\_mount|iso\_unmount`\ , an empty dictionary. + For :literal:`state=absent|iso\_mount|iso\_unmount`\ , an empty dictionary. - For \ :literal:`state=stopped|active|facts`\ , the resource properties of the partition after any changes, including its child resources as described below. + For :literal:`state=stopped|active|facts`\ , the resource properties of the partition after any changes, including its child resources as described below. | **returned**: success | **type**: dict @@ -515,7 +515,7 @@ partition | **type**: str {property} - Additional properties of the partition, as described in the data model of the 'Partition' object in the \ :ref:`HMC API `\ book. The property names have hyphens (-) as described in that book. + Additional properties of the partition, as described in the data model of the 'Partition' object in the :ref:`HMC API ` book. The property names have hyphens (-) as described in that book. | **type**: raw @@ -531,7 +531,7 @@ partition | **type**: str {property} - Additional properties of the HBA, as described in the data model of the 'HBA' element object of the 'Partition' object in the \ :ref:`HMC API `\ book. The property names have hyphens (-) as described in that book. + Additional properties of the HBA, as described in the data model of the 'HBA' element object of the 'Partition' object in the :ref:`HMC API ` book. The property names have hyphens (-) as described in that book. | **type**: raw @@ -548,7 +548,7 @@ partition | **type**: str {property} - Additional properties of the NIC, as described in the data model of the 'NIC' element object of the 'Partition' object in the \ :ref:`HMC API `\ book. The property names have hyphens (-) as described in that book. + Additional properties of the NIC, as described in the data model of the 'NIC' element object of the 'Partition' object in the :ref:`HMC API ` book. The property names have hyphens (-) as described in that book. | **type**: raw @@ -565,13 +565,13 @@ partition | **type**: str {property} - Additional properties of the virtual function, as described in the data model of the 'Virtual Function' element object of the 'Partition' object in the \ :ref:`HMC API `\ book. The property names have hyphens (-) as described in that book. + Additional properties of the virtual function, as described in the data model of the 'Virtual Function' element object of the 'Partition' object in the :ref:`HMC API ` book. The property names have hyphens (-) as described in that book. | **type**: raw storage-groups - Storage groups attached to the partition. Only present for \ :literal:`expand\_storage\_groups=true`\ . + Storage groups attached to the partition. Only present for :literal:`expand\_storage\_groups=true`. | **type**: list | **elements**: dict @@ -582,7 +582,7 @@ partition | **type**: str {property} - Additional properties of the storage group, as described for the zhmc\_storage\_group module with \ :literal:`expand=true`\ . + Additional properties of the storage group, as described for the zhmc\_storage\_group module with :literal:`expand=true`. | **type**: raw diff --git a/docs/source/modules/zhmc_partition_command.rst b/docs/source/modules/zhmc_partition_command.rst index 8094469f..64ee10a6 100644 --- a/docs/source/modules/zhmc_partition_command.rst +++ b/docs/source/modules/zhmc_partition_command.rst @@ -53,35 +53,35 @@ hmc_auth userid - The userid (username) for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The userid (username) for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str password - The password for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The password for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str session_id - HMC session ID to be used. This is mutually exclusive with providing \ :literal:`hmc\_auth.userid`\ and \ :literal:`hmc\_auth.password`\ and can be created as described in the \ :ref:`zhmc\_session module `\ . + HMC session ID to be used. This is mutually exclusive with providing :literal:`hmc\_auth.userid` and :literal:`hmc\_auth.password` and can be created as described in the :ref:`zhmc\_session module `. | **required**: False | **type**: str ca_certs - Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the \ :envvar:`REQUESTS\_CA\_BUNDLE`\ environment variable or the path name in the \ :envvar:`CURL\_CA\_BUNDLE`\ environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. + Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the :envvar:`REQUESTS\_CA\_BUNDLE` environment variable or the path name in the :envvar:`CURL\_CA\_BUNDLE` environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. | **required**: False | **type**: str verify - If True (default), verify the HMC certificate as specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter. If False, ignore what is specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter and do not verify the HMC certificate. + If True (default), verify the HMC certificate as specified in the :literal:`hmc\_auth.ca\_certs` parameter. If False, ignore what is specified in the :literal:`hmc\_auth.ca\_certs` parameter and do not verify the HMC certificate. | **required**: False | **type**: bool @@ -160,7 +160,7 @@ Return Values changed Indicates if any change has been made by the module. - This will always be true, because it is not clear whether the command has performed a change. Note that a playbook using this module with a command that does not perform a change can override that by specifying \ :literal:`changed\_when: false`\ . + This will always be true, because it is not clear whether the command has performed a change. Note that a playbook using this module with a command that does not perform a change can override that by specifying :literal:`changed\_when: false`. | **returned**: always | **type**: bool @@ -176,9 +176,9 @@ output The format of each message text depends on the type of OS. Typical formats are, showing the message with the command: - z/VM: \ :literal:`04:30:02 Q CPLEVEL`\ + z/VM: :literal:`04:30:02 Q CPLEVEL` - Linux: \ :literal:`uname -a`\ + Linux: :literal:`uname -a` | **returned**: success | **type**: list diff --git a/docs/source/modules/zhmc_partition_list.rst b/docs/source/modules/zhmc_partition_list.rst index 320b3fa2..cf3ff675 100644 --- a/docs/source/modules/zhmc_partition_list.rst +++ b/docs/source/modules/zhmc_partition_list.rst @@ -19,7 +19,7 @@ Synopsis - List partitions on a specific CPC (Z system) or on all managed CPCs. - CPCs in classic mode are ignored (i.e. do not lead to a failure). - Partitions for which the user has no object access permission are ignored (i.e. do not lead to a failure). -- On HMCs with version 2.14.0 or higher and when the \ :literal:`additional\_properties`\ module parameter is not used, the "List Permitted Partitions" operation is used by this module. Otherwise, the managed CPCs are listed and then the partitions on each desired CPC or CPCs are listed. This improves the execution time of the module on newer HMCs but does not affect the module result data. +- On HMCs with version 2.14.0 or higher and when the :literal:`additional\_properties` module parameter is not used, the "List Permitted Partitions" operation is used by this module. Otherwise, the managed CPCs are listed and then the partitions on each desired CPC or CPCs are listed. This improves the execution time of the module on newer HMCs but does not affect the module result data. Requirements @@ -51,35 +51,35 @@ hmc_auth userid - The userid (username) for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The userid (username) for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str password - The password for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The password for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str session_id - HMC session ID to be used. This is mutually exclusive with providing \ :literal:`hmc\_auth.userid`\ and \ :literal:`hmc\_auth.password`\ and can be created as described in the \ :ref:`zhmc\_session module `\ . + HMC session ID to be used. This is mutually exclusive with providing :literal:`hmc\_auth.userid` and :literal:`hmc\_auth.password` and can be created as described in the :ref:`zhmc\_session module `. | **required**: False | **type**: str ca_certs - Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the \ :envvar:`REQUESTS\_CA\_BUNDLE`\ environment variable or the path name in the \ :envvar:`CURL\_CA\_BUNDLE`\ environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. + Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the :envvar:`REQUESTS\_CA\_BUNDLE` environment variable or the path name in the :envvar:`CURL\_CA\_BUNDLE` environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. | **required**: False | **type**: str verify - If True (default), verify the HMC certificate as specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter. If False, ignore what is specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter and do not verify the HMC certificate. + If True (default), verify the HMC certificate as specified in the :literal:`hmc\_auth.ca\_certs` parameter. If False, ignore what is specified in the :literal:`hmc\_auth.ca\_certs` parameter and do not verify the HMC certificate. | **required**: False | **type**: bool @@ -99,7 +99,7 @@ cpc_name additional_properties List of additional properties to be returned for each partition, in addition to the default properties (see result description). - Mutually exclusive with \ :literal:`full\_properties`\ . + Mutually exclusive with :literal:`full\_properties`. The property names are specified with underscores instead of hyphens. @@ -113,9 +113,9 @@ additional_properties full_properties If True, all properties of each partition will be returned. Default: False. - Mutually exclusive with \ :literal:`additional\_properties`\ . + Mutually exclusive with :literal:`additional\_properties`. - Note: Setting this to True causes a loop of 'Get Partition Properties' operations to be executed. It is preferable from a performance perspective to use the \ :literal:`additional\_properties`\ parameter instead. + Note: Setting this to True causes a loop of 'Get Partition Properties' operations to be executed. It is preferable from a performance perspective to use the :literal:`additional\_properties` parameter instead. | **required**: False | **type**: bool @@ -219,7 +219,7 @@ partitions | **type**: str status - The current status of the partition. For details, see the description of the 'status' property in the data model of the 'Logical Partition' resource (see \ :ref:`HMC API `\ ). + The current status of the partition. For details, see the description of the 'status' property in the data model of the 'Logical Partition' resource (see :ref:`HMC API `\ ). | **type**: str @@ -229,7 +229,7 @@ partitions | **type**: bool {additional_property} - Additional properties requested via \ :literal:`full\_properties`\ or \ :literal:`additional\_properties`\ . The property names will have underscores instead of hyphens. + Additional properties requested via :literal:`full\_properties` or :literal:`additional\_properties`. The property names will have underscores instead of hyphens. | **type**: raw diff --git a/docs/source/modules/zhmc_partition_messages.rst b/docs/source/modules/zhmc_partition_messages.rst index 65f40fc9..337c4a3a 100644 --- a/docs/source/modules/zhmc_partition_messages.rst +++ b/docs/source/modules/zhmc_partition_messages.rst @@ -51,35 +51,35 @@ hmc_auth userid - The userid (username) for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The userid (username) for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str password - The password for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The password for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str session_id - HMC session ID to be used. This is mutually exclusive with providing \ :literal:`hmc\_auth.userid`\ and \ :literal:`hmc\_auth.password`\ and can be created as described in the \ :ref:`zhmc\_session module `\ . + HMC session ID to be used. This is mutually exclusive with providing :literal:`hmc\_auth.userid` and :literal:`hmc\_auth.password` and can be created as described in the :ref:`zhmc\_session module `. | **required**: False | **type**: str ca_certs - Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the \ :envvar:`REQUESTS\_CA\_BUNDLE`\ environment variable or the path name in the \ :envvar:`CURL\_CA\_BUNDLE`\ environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. + Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the :envvar:`REQUESTS\_CA\_BUNDLE` environment variable or the path name in the :envvar:`CURL\_CA\_BUNDLE` environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. | **required**: False | **type**: str verify - If True (default), verify the HMC certificate as specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter. If False, ignore what is specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter and do not verify the HMC certificate. + If True (default), verify the HMC certificate as specified in the :literal:`hmc\_auth.ca\_certs` parameter. If False, ignore what is specified in the :literal:`hmc\_auth.ca\_certs` parameter and do not verify the HMC certificate. | **required**: False | **type**: bool diff --git a/docs/source/modules/zhmc_password_rule.rst b/docs/source/modules/zhmc_password_rule.rst index ec00da60..990a531a 100644 --- a/docs/source/modules/zhmc_password_rule.rst +++ b/docs/source/modules/zhmc_password_rule.rst @@ -49,35 +49,35 @@ hmc_auth userid - The userid (username) for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The userid (username) for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str password - The password for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The password for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str session_id - HMC session ID to be used. This is mutually exclusive with providing \ :literal:`hmc\_auth.userid`\ and \ :literal:`hmc\_auth.password`\ and can be created as described in the \ :ref:`zhmc\_session module `\ . + HMC session ID to be used. This is mutually exclusive with providing :literal:`hmc\_auth.userid` and :literal:`hmc\_auth.password` and can be created as described in the :ref:`zhmc\_session module `. | **required**: False | **type**: str ca_certs - Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the \ :envvar:`REQUESTS\_CA\_BUNDLE`\ environment variable or the path name in the \ :envvar:`CURL\_CA\_BUNDLE`\ environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. + Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the :envvar:`REQUESTS\_CA\_BUNDLE` environment variable or the path name in the :envvar:`CURL\_CA\_BUNDLE` environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. | **required**: False | **type**: str verify - If True (default), verify the HMC certificate as specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter. If False, ignore what is specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter and do not verify the HMC certificate. + If True (default), verify the HMC certificate as specified in the :literal:`hmc\_auth.ca\_certs` parameter. If False, ignore what is specified in the :literal:`hmc\_auth.ca\_certs` parameter and do not verify the HMC certificate. | **required**: False | **type**: bool @@ -95,11 +95,11 @@ name state The desired state for the HMC password rule. All states are fully idempotent within the limits of the properties that can be changed: - \* \ :literal:`absent`\ : Ensures that the password rule does not exist. + \* :literal:`absent`\ : Ensures that the password rule does not exist. - \* \ :literal:`present`\ : Ensures that the password rule exists and has the specified properties. + \* :literal:`present`\ : Ensures that the password rule exists and has the specified properties. - \* \ :literal:`facts`\ : Returns the password rule properties. + \* :literal:`facts`\ : Returns the password rule properties. | **required**: True | **type**: str @@ -107,13 +107,13 @@ state properties - Dictionary with desired properties for the password rule. Used for \ :literal:`state=present`\ ; ignored for \ :literal:`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. + Dictionary with desired properties for the password rule. Used for :literal:`state=present`\ ; ignored for :literal:`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 Password Rule resources (where the property names contain underscores instead of hyphens), with the following exceptions: - \* \ :literal:`name`\ : Cannot be specified because the name has already been specified in the \ :literal:`name`\ module parameter. + \* :literal:`name`\ : Cannot be specified because the name has already been specified in the :literal:`name` module parameter. - Properties omitted in this dictionary will remain unchanged when the password rule already exists, and will get the default value defined in the data model for password rules in the \ :ref:`HMC API `\ book when the password rule is being created. + Properties omitted in this dictionary will remain unchanged when the password rule already exists, and will get the default value defined in the data model for password rules in the :ref:`HMC API ` book when the password rule is being created. | **required**: False | **type**: dict @@ -176,7 +176,7 @@ Return Values changed - Indicates if any change has been made by the module. For \ :literal:`state=facts`\ , always will be false. + Indicates if any change has been made by the module. For :literal:`state=facts`\ , always will be false. | **returned**: always | **type**: bool @@ -188,9 +188,9 @@ msg | **type**: str password_rule - For \ :literal:`state=absent`\ , an empty dictionary. + For :literal:`state=absent`\ , an empty dictionary. - For \ :literal:`state=present|facts`\ , a dictionary with the resource properties of the target password rule. + For :literal:`state=present|facts`\ , a dictionary with the resource properties of the target password rule. | **returned**: success | **type**: dict @@ -248,7 +248,7 @@ password_rule | **type**: str {property} - Additional properties of the password rule, as described in the data model of the 'Password Rule' object in the \ :ref:`HMC API `\ book. The property names have hyphens (-) as described in that book. + Additional properties of the password rule, as described in the data model of the 'Password Rule' object in the :ref:`HMC API ` book. The property names have hyphens (-) as described in that book. | **type**: raw diff --git a/docs/source/modules/zhmc_password_rule_list.rst b/docs/source/modules/zhmc_password_rule_list.rst index 9b56f3a3..34141e16 100644 --- a/docs/source/modules/zhmc_password_rule_list.rst +++ b/docs/source/modules/zhmc_password_rule_list.rst @@ -48,35 +48,35 @@ hmc_auth userid - The userid (username) for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The userid (username) for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str password - The password for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The password for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str session_id - HMC session ID to be used. This is mutually exclusive with providing \ :literal:`hmc\_auth.userid`\ and \ :literal:`hmc\_auth.password`\ and can be created as described in the \ :ref:`zhmc\_session module `\ . + HMC session ID to be used. This is mutually exclusive with providing :literal:`hmc\_auth.userid` and :literal:`hmc\_auth.password` and can be created as described in the :ref:`zhmc\_session module `. | **required**: False | **type**: str ca_certs - Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the \ :envvar:`REQUESTS\_CA\_BUNDLE`\ environment variable or the path name in the \ :envvar:`CURL\_CA\_BUNDLE`\ environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. + Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the :envvar:`REQUESTS\_CA\_BUNDLE` environment variable or the path name in the :envvar:`CURL\_CA\_BUNDLE` environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. | **required**: False | **type**: str verify - If True (default), verify the HMC certificate as specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter. If False, ignore what is specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter and do not verify the HMC certificate. + If True (default), verify the HMC certificate as specified in the :literal:`hmc\_auth.ca\_certs` parameter. If False, ignore what is specified in the :literal:`hmc\_auth.ca\_certs` parameter and do not verify the HMC certificate. | **required**: False | **type**: bool @@ -167,7 +167,7 @@ password_rules | **type**: str {additional_property} - Additional properties requested via \ :literal:`full\_properties`\ . The property names will have underscores instead of hyphens. + Additional properties requested via :literal:`full\_properties`. The property names will have underscores instead of hyphens. | **type**: raw diff --git a/docs/source/modules/zhmc_session.rst b/docs/source/modules/zhmc_session.rst index 5fe26756..03e162cb 100644 --- a/docs/source/modules/zhmc_session.rst +++ b/docs/source/modules/zhmc_session.rst @@ -16,8 +16,8 @@ zhmc_session -- Manage HMC sessions across tasks Synopsis -------- -- Create a session on the HMC for use by other ibm\_zhmc modules, with \ :literal:`action=create`\ . -- Delete a session on the HMC, with \ :literal:`action=delete`\ . +- Create a session on the HMC for use by other ibm\_zhmc modules, with :literal:`action=create`. +- Delete a session on the HMC, with :literal:`action=delete`. - This module can be used in order to create an HMC session once and then use it for multiple tasks that use ibm\_zhmc modules, reducing the number of HMC sessions that need to be created, to just one. When this module is not used, each ibm\_zhmc module invocation will create and delete a separate HMC session. @@ -48,7 +48,7 @@ hmc_auth userid The userid (username) for creating the HMC session. - Required for \ :literal:`action=create`\ , not permitted for \ :literal:`action=delete`\ . + Required for :literal:`action=create`\ , not permitted for :literal:`action=delete`. | **required**: False | **type**: str @@ -57,7 +57,7 @@ hmc_auth password The password for creating the HMC session. - Required for \ :literal:`action=create`\ , not permitted for \ :literal:`action=delete`\ . + Required for :literal:`action=create`\ , not permitted for :literal:`action=delete`. | **required**: False | **type**: str @@ -66,25 +66,25 @@ hmc_auth session_id Session ID of the HMC session to be deleted. - Required for \ :literal:`action=delete`\ , not permitted for \ :literal:`action=create`\ . + Required for :literal:`action=delete`\ , not permitted for :literal:`action=create`. | **required**: False | **type**: str ca_certs - Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the \ :envvar:`REQUESTS\_CA\_BUNDLE`\ environment variable or the path name in the \ :envvar:`CURL\_CA\_BUNDLE`\ environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. + Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the :envvar:`REQUESTS\_CA\_BUNDLE` environment variable or the path name in the :envvar:`CURL\_CA\_BUNDLE` environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. - Optional for \ :literal:`action=create`\ , not permitted for \ :literal:`action=delete`\ . + Optional for :literal:`action=create`\ , not permitted for :literal:`action=delete`. | **required**: False | **type**: str verify - If True (default), verify the HMC certificate as specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter. If False, ignore what is specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter and do not verify the HMC certificate. + If True (default), verify the HMC certificate as specified in the :literal:`hmc\_auth.ca\_certs` parameter. If False, ignore what is specified in the :literal:`hmc\_auth.ca\_certs` parameter and do not verify the HMC certificate. - Optional for \ :literal:`action=create`\ , not permitted for \ :literal:`action=delete`\ . + Optional for :literal:`action=create`\ , not permitted for :literal:`action=delete`. | **required**: False | **type**: bool @@ -95,9 +95,9 @@ hmc_auth action The action to perform for the HMC session. Since an HMC session does not have a name, it is not possible to specify the desired end state in an idempotent manner, so this module uses actions: - \* \ :literal:`create`\ : Create a new session on the HMC and verify that the credentials are valid. Requires \ :literal:`hmc\_auth.userid`\ and \ :literal:`hmc\_auth.password`\ and uses \ :literal:`hmc\_auth.ca\_certs`\ and \ :literal:`hmc\_auth.verify`\ if provided. + \* :literal:`create`\ : Create a new session on the HMC and verify that the credentials are valid. Requires :literal:`hmc\_auth.userid` and :literal:`hmc\_auth.password` and uses :literal:`hmc\_auth.ca\_certs` and :literal:`hmc\_auth.verify` if provided. - \* \ :literal:`delete`\ : Delete the specified session on the HMC. No longer existing sessions are tolerated. Requires \ :literal:`hmc\_auth.session\_id`\ . + \* :literal:`delete`\ : Delete the specified session on the HMC. No longer existing sessions are tolerated. Requires :literal:`hmc\_auth.session\_id`. | **required**: True | **type**: str @@ -175,15 +175,15 @@ msg | **type**: str hmc_host - The hostname or IP address of the HMC that was actually used for the session creation, for \ :literal:`action=create`\ . This value must be specified as \ :literal:`hmc\_host`\ for \ :literal:`action=delete`\ . + The hostname or IP address of the HMC that was actually used for the session creation, for :literal:`action=create`. This value must be specified as :literal:`hmc\_host` for :literal:`action=delete`. - For \ :literal:`action=delete`\ , returns the null value. + For :literal:`action=delete`\ , returns the null value. | **returned**: success | **type**: str hmc_auth - Credentials for the HMC session, for use by other tasks. This return value should be protected with \ :literal:`no\_log=true`\ for \ :literal:`action=create`\ , since it contains the HMC session ID. For \ :literal:`action=delete`\ , the same structure is returned, just with null values. This can be used to reset the variable that was set for \ :literal:`action=create`\ . + Credentials for the HMC session, for use by other tasks. This return value should be protected with :literal:`no\_log=true` for :literal:`action=create`\ , since it contains the HMC session ID. For :literal:`action=delete`\ , the same structure is returned, just with null values. This can be used to reset the variable that was set for :literal:`action=create`. | **returned**: success | **type**: dict @@ -198,17 +198,17 @@ hmc_auth } session_id - New HMC session ID for \ :literal:`action=create`\ , or null for \ :literal:`action=delete`\ . + New HMC session ID for :literal:`action=create`\ , or null for :literal:`action=delete`. | **type**: str ca_certs - Value of \ :literal:`hmc\_auth.ca\_certs`\ input parameter for \ :literal:`action=create`\ , or null for \ :literal:`action=delete`\ . + Value of :literal:`hmc\_auth.ca\_certs` input parameter for :literal:`action=create`\ , or null for :literal:`action=delete`. | **type**: str verify - Value of \ :literal:`hmc\_auth.verify`\ input parameter for \ :literal:`action=create`\ , or null for \ :literal:`action=delete`\ . + Value of :literal:`hmc\_auth.verify` input parameter for :literal:`action=create`\ , or null for :literal:`action=delete`. | **type**: bool diff --git a/docs/source/modules/zhmc_storage_group.rst b/docs/source/modules/zhmc_storage_group.rst index 2f792e79..ca84cdf5 100644 --- a/docs/source/modules/zhmc_storage_group.rst +++ b/docs/source/modules/zhmc_storage_group.rst @@ -51,35 +51,35 @@ hmc_auth userid - The userid (username) for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The userid (username) for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str password - The password for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The password for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str session_id - HMC session ID to be used. This is mutually exclusive with providing \ :literal:`hmc\_auth.userid`\ and \ :literal:`hmc\_auth.password`\ and can be created as described in the \ :ref:`zhmc\_session module `\ . + HMC session ID to be used. This is mutually exclusive with providing :literal:`hmc\_auth.userid` and :literal:`hmc\_auth.password` and can be created as described in the :ref:`zhmc\_session module `. | **required**: False | **type**: str ca_certs - Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the \ :envvar:`REQUESTS\_CA\_BUNDLE`\ environment variable or the path name in the \ :envvar:`CURL\_CA\_BUNDLE`\ environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. + Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the :envvar:`REQUESTS\_CA\_BUNDLE` environment variable or the path name in the :envvar:`CURL\_CA\_BUNDLE` environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. | **required**: False | **type**: str verify - If True (default), verify the HMC certificate as specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter. If False, ignore what is specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter and do not verify the HMC certificate. + If True (default), verify the HMC certificate as specified in the :literal:`hmc\_auth.ca\_certs` parameter. If False, ignore what is specified in the :literal:`hmc\_auth.ca\_certs` parameter and do not verify the HMC certificate. | **required**: False | **type**: bool @@ -104,13 +104,13 @@ name state The desired state for the storage group. All states are fully idempotent within the limits of the properties that can be changed, unless otherwise stated: - \* \ :literal:`absent`\ : Ensures that the storage group does not exist. If the storage group is currently attached to any partitions, the module will fail (this is an idempotency limitation). + \* :literal:`absent`\ : Ensures that the storage group does not exist. If the storage group is currently attached to any partitions, the module will fail (this is an idempotency limitation). - \* \ :literal:`present`\ : Ensures that the storage group exists and is associated with the specified CPC, and has the specified properties. The attachment state of an already existing storage group to a partition is not changed. + \* :literal:`present`\ : Ensures that the storage group exists and is associated with the specified CPC, and has the specified properties. The attachment state of an already existing storage group to a partition is not changed. - \* \ :literal:`discover`\ : Triggers LUN discovery. If \ :literal:`discover\_wait`\ is specified, waits for completion of the discovery. Requires that the storage group exists and is of type 'fcp'. + \* :literal:`discover`\ : Triggers LUN discovery. If :literal:`discover\_wait` is specified, waits for completion of the discovery. Requires that the storage group exists and is of type 'fcp'. - \* \ :literal:`facts`\ : Returns the storage group properties. + \* :literal:`facts`\ : Returns the storage group properties. | **required**: True | **type**: str @@ -118,15 +118,15 @@ state properties - Dictionary with desired properties for the storage group. Used for \ :literal:`state=present`\ ; ignored for \ :literal:`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. + Dictionary with desired properties for the storage group. Used for :literal:`state=present`\ ; ignored for :literal:`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: - \* \ :literal:`name`\ : Cannot be specified because the name has already been specified in the \ :literal:`name`\ module parameter. + \* :literal:`name`\ : Cannot be specified because the name has already been specified in the :literal:`name` module parameter. - \* \ :literal:`type`\ : Cannot be changed once the storage group exists. + \* :literal:`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 \ :ref:`HMC API `\ book when the storage group is being created. + 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 :ref:`HMC API ` book when the storage group is being created. | **required**: False | **type**: dict @@ -140,14 +140,14 @@ expand discover_wait - Boolean that controls whether to wait for completion of the FCP discovery for \ :literal:`state=discover`\ . + Boolean that controls whether to wait for completion of the FCP discovery for :literal:`state=discover`. | **required**: False | **type**: bool discover_timeout - Timeout in seconds for how long to wait for completion of the FCP discovery for \ :literal:`state=discover`\ . + Timeout in seconds for how long to wait for completion of the FCP discovery for :literal:`state=discover`. | **required**: False | **type**: int @@ -237,7 +237,7 @@ Return Values changed - Indicates if any change has been made by the module. For \ :literal:`state=facts`\ , always will be false. + Indicates if any change has been made by the module. For :literal:`state=facts`\ , always will be false. | **returned**: always | **type**: bool @@ -249,9 +249,9 @@ msg | **type**: str storage_group - For \ :literal:`state=absent`\ , an empty dictionary. + For :literal:`state=absent`\ , an empty dictionary. - For \ :literal:`state=present|facts|discover`\ , the resource properties of the target storage group after any changes, plus additional artificial properties as described below. + For :literal:`state=present|facts|discover`\ , the resource properties of the target storage group after any changes, plus additional artificial properties as described below. | **returned**: success | **type**: dict @@ -473,7 +473,7 @@ storage_group | **type**: str {property} - Additional properties of the storage group, as described in the data model of the 'Storage Group' object in the \ :ref:`HMC API `\ book. The property names have hyphens (-) as described in that book. + Additional properties of the storage group, as described in the data model of the 'Storage Group' object in the :ref:`HMC API ` book. The property names have hyphens (-) as described in that book. | **type**: raw @@ -484,7 +484,7 @@ storage_group | **elements**: str candidate-adapter-ports - Only present if \ :literal:`expand=true`\ : List of candidate storage adapter ports of the storage group. Will be empty for storage group types other than FCP. + Only present if :literal:`expand=true`\ : List of candidate storage adapter ports of the storage group. Will be empty for storage group types other than FCP. | **returned**: success+expand | **type**: list @@ -501,7 +501,7 @@ storage_group | **type**: int {property} - Additional properties of the storage port, as described in the data model of the 'Storage Port' element object of the 'Adapter' object in the \ :ref:`HMC API `\ book. The property names have hyphens (-) as described in that book. + Additional properties of the storage port, as described in the data model of the 'Storage Port' element object of the 'Adapter' object in the :ref:`HMC API ` book. The property names have hyphens (-) as described in that book. | **type**: raw @@ -516,14 +516,14 @@ storage_group | **type**: str {property} - Additional properties of the storage adapter, as described in the data model of the 'Adapter' object in the \ :ref:`HMC API `\ book. The property names have hyphens (-) as described in that book. + Additional properties of the storage adapter, as described in the data model of the 'Adapter' object in the :ref:`HMC API ` book. The property names have hyphens (-) as described in that book. | **type**: raw storage-volumes - Only present if \ :literal:`expand=true`\ : Storage volumes of the storage group. + Only present if :literal:`expand=true`\ : Storage volumes of the storage group. | **returned**: success+expand | **type**: list @@ -535,33 +535,33 @@ storage_group | **type**: str {property} - Additional properties of the storage volume, as described in the data model of the 'Storage Volume' element object of the 'Storage Group' object in the \ :ref:`HMC API `\ book. The property names have hyphens (-) as described in that book. + Additional properties of the storage volume, as described in the data model of the 'Storage Volume' element object of the 'Storage Group' object in the :ref:`HMC API ` book. The property names have hyphens (-) as described in that book. | **type**: raw virtual-storage-resources - Only present if \ :literal:`expand=true`\ : Virtual storage resources of the storage group. Will be empty for storage group types other than FCP. + Only present if :literal:`expand=true`\ : Virtual storage resources of the storage group. Will be empty for storage group types other than FCP. | **returned**: success+expand | **type**: list | **elements**: dict {property} - Properties of the virtual storage resource, as described in the data model of the 'Virtual Storage Resource' element object of the 'Storage Group' object in the \ :ref:`HMC API `\ book. The property names have hyphens (-) as described in that book. + Properties of the virtual storage resource, as described in the data model of the 'Virtual Storage Resource' element object of the 'Storage Group' object in the :ref:`HMC API ` book. The property names have hyphens (-) as described in that book. | **type**: raw attached-partitions - Only present if \ :literal:`expand=true`\ : Partitions to which the storage group is attached. + Only present if :literal:`expand=true`\ : Partitions to which the storage group is attached. | **returned**: success+expand | **type**: list | **elements**: dict {property} - Properties of the partition, as described in the data model of the 'Partition' object in the \ :ref:`HMC API `\ book. The property names have hyphens (-) as described in that book. + Properties of the partition, as described in the data model of the 'Partition' object in the :ref:`HMC API ` book. The property names have hyphens (-) as described in that book. | **type**: raw diff --git a/docs/source/modules/zhmc_storage_group_attachment.rst b/docs/source/modules/zhmc_storage_group_attachment.rst index b7b964c7..bdd3386f 100644 --- a/docs/source/modules/zhmc_storage_group_attachment.rst +++ b/docs/source/modules/zhmc_storage_group_attachment.rst @@ -51,35 +51,35 @@ hmc_auth userid - The userid (username) for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The userid (username) for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str password - The password for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The password for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str session_id - HMC session ID to be used. This is mutually exclusive with providing \ :literal:`hmc\_auth.userid`\ and \ :literal:`hmc\_auth.password`\ and can be created as described in the \ :ref:`zhmc\_session module `\ . + HMC session ID to be used. This is mutually exclusive with providing :literal:`hmc\_auth.userid` and :literal:`hmc\_auth.password` and can be created as described in the :ref:`zhmc\_session module `. | **required**: False | **type**: str ca_certs - Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the \ :envvar:`REQUESTS\_CA\_BUNDLE`\ environment variable or the path name in the \ :envvar:`CURL\_CA\_BUNDLE`\ environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. + Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the :envvar:`REQUESTS\_CA\_BUNDLE` environment variable or the path name in the :envvar:`CURL\_CA\_BUNDLE` environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. | **required**: False | **type**: str verify - If True (default), verify the HMC certificate as specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter. If False, ignore what is specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter and do not verify the HMC certificate. + If True (default), verify the HMC certificate as specified in the :literal:`hmc\_auth.ca\_certs` parameter. If False, ignore what is specified in the :literal:`hmc\_auth.ca\_certs` parameter and do not verify the HMC certificate. | **required**: False | **type**: bool @@ -111,11 +111,11 @@ partition_name state The desired state for the storage group attachment. All states are fully idempotent within the limits of the properties that can be changed, unless otherwise stated: - \* \ :literal:`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 (this is an idempotency limitation). + \* :literal:`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 (this is an idempotency limitation). - \* \ :literal:`attached`\ : Ensures that the storage group is attached to the partition. + \* :literal:`attached`\ : Ensures that the storage group is attached to the partition. - \* \ :literal:`facts`\ : Returns the attachment status. + \* :literal:`facts`\ : Returns the attachment status. | **required**: True | **type**: str @@ -188,7 +188,7 @@ Return Values changed - Indicates if any change has been made by the module. For \ :literal:`state=facts`\ , always will be false. + Indicates if any change has been made by the module. For :literal:`state=facts`\ , always will be false. | **returned**: always | **type**: bool diff --git a/docs/source/modules/zhmc_storage_volume.rst b/docs/source/modules/zhmc_storage_volume.rst index c65d3544..bb352a90 100644 --- a/docs/source/modules/zhmc_storage_volume.rst +++ b/docs/source/modules/zhmc_storage_volume.rst @@ -51,35 +51,35 @@ hmc_auth userid - The userid (username) for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The userid (username) for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str password - The password for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The password for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str session_id - HMC session ID to be used. This is mutually exclusive with providing \ :literal:`hmc\_auth.userid`\ and \ :literal:`hmc\_auth.password`\ and can be created as described in the \ :ref:`zhmc\_session module `\ . + HMC session ID to be used. This is mutually exclusive with providing :literal:`hmc\_auth.userid` and :literal:`hmc\_auth.password` and can be created as described in the :ref:`zhmc\_session module `. | **required**: False | **type**: str ca_certs - Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the \ :envvar:`REQUESTS\_CA\_BUNDLE`\ environment variable or the path name in the \ :envvar:`CURL\_CA\_BUNDLE`\ environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. + Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the :envvar:`REQUESTS\_CA\_BUNDLE` environment variable or the path name in the :envvar:`CURL\_CA\_BUNDLE` environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. | **required**: False | **type**: str verify - If True (default), verify the HMC certificate as specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter. If False, ignore what is specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter and do not verify the HMC certificate. + If True (default), verify the HMC certificate as specified in the :literal:`hmc\_auth.ca\_certs` parameter. If False, ignore what is specified in the :literal:`hmc\_auth.ca\_certs` parameter and do not verify the HMC certificate. | **required**: False | **type**: bool @@ -111,11 +111,11 @@ name state The desired state for the storage volume. All states are fully idempotent within the limits of the properties that can be changed: - \* \ :literal:`absent`\ : Ensures that the storage volume does not exist in the specified storage group. + \* :literal:`absent`\ : Ensures that the storage volume does not exist in the specified storage group. - \* \ :literal:`present`\ : Ensures that the storage volume exists in the specified storage group, and has the specified properties. + \* :literal:`present`\ : Ensures that the storage volume exists in the specified storage group, and has the specified properties. - \* \ :literal:`facts`\ : Returns the storage volume properties. + \* :literal:`facts`\ : Returns the storage volume properties. | **required**: True | **type**: str @@ -123,13 +123,13 @@ state properties - Dictionary with desired properties for the storage volume. Used for \ :literal:`state=present`\ ; ignored for \ :literal:`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. + Dictionary with desired properties for the storage volume. Used for :literal:`state=present`\ ; ignored for :literal:`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: - \* \ :literal:`name`\ : Cannot be specified because the name has already been specified in the \ :literal:`name`\ module parameter. + \* :literal:`name`\ : Cannot be specified because the name has already been specified in the :literal:`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 \ :ref:`HMC API `\ book when the storage volume is being created. + 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 :ref:`HMC API ` book when the storage volume is being created. | **required**: False | **type**: dict @@ -205,7 +205,7 @@ Return Values changed - Indicates if any change has been made by the module. For \ :literal:`state=facts`\ , always will be false. + Indicates if any change has been made by the module. For :literal:`state=facts`\ , always will be false. | **returned**: always | **type**: bool @@ -217,9 +217,9 @@ msg | **type**: str storage_volume - For \ :literal:`state=absent`\ , an empty dictionary. + For :literal:`state=absent`\ , an empty dictionary. - For \ :literal:`state=present|facts`\ , the resource properties of the storage volume after any changes. + For :literal:`state=present|facts`\ , the resource properties of the storage volume after any changes. | **returned**: success | **type**: dict @@ -256,12 +256,12 @@ storage_volume | **type**: str type - Type of the storage volume (\ :literal:`fc`\ or \ :literal:`fcp`\ ), as defined in its storage group. + Type of the storage volume (\ :literal:`fc` or :literal:`fcp`\ ), as defined in its storage group. | **type**: str {property} - Additional properties of the storage volume, as described in the data model of the 'Storage Volume' element object of the 'Storage Group' object in the \ :ref:`HMC API `\ book. The property names have hyphens (-) as described in that book. + Additional properties of the storage volume, as described in the data model of the 'Storage Volume' element object of the 'Storage Group' object in the :ref:`HMC API ` book. The property names have hyphens (-) as described in that book. | **type**: raw diff --git a/docs/source/modules/zhmc_user.rst b/docs/source/modules/zhmc_user.rst index 80758405..798351ea 100644 --- a/docs/source/modules/zhmc_user.rst +++ b/docs/source/modules/zhmc_user.rst @@ -50,35 +50,35 @@ hmc_auth userid - The userid (username) for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The userid (username) for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str password - The password for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The password for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str session_id - HMC session ID to be used. This is mutually exclusive with providing \ :literal:`hmc\_auth.userid`\ and \ :literal:`hmc\_auth.password`\ and can be created as described in the \ :ref:`zhmc\_session module `\ . + HMC session ID to be used. This is mutually exclusive with providing :literal:`hmc\_auth.userid` and :literal:`hmc\_auth.password` and can be created as described in the :ref:`zhmc\_session module `. | **required**: False | **type**: str ca_certs - Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the \ :envvar:`REQUESTS\_CA\_BUNDLE`\ environment variable or the path name in the \ :envvar:`CURL\_CA\_BUNDLE`\ environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. + Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the :envvar:`REQUESTS\_CA\_BUNDLE` environment variable or the path name in the :envvar:`CURL\_CA\_BUNDLE` environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. | **required**: False | **type**: str verify - If True (default), verify the HMC certificate as specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter. If False, ignore what is specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter and do not verify the HMC certificate. + If True (default), verify the HMC certificate as specified in the :literal:`hmc\_auth.ca\_certs` parameter. If False, ignore what is specified in the :literal:`hmc\_auth.ca\_certs` parameter and do not verify the HMC certificate. | **required**: False | **type**: bool @@ -96,11 +96,11 @@ name state The desired state for the HMC user. All states are fully idempotent within the limits of the properties that can be changed: - \* \ :literal:`absent`\ : Ensures that the user does not exist. + \* :literal:`absent`\ : Ensures that the user does not exist. - \* \ :literal:`present`\ : Ensures that the user exists and has the specified properties. + \* :literal:`present`\ : Ensures that the user exists and has the specified properties. - \* \ :literal:`facts`\ : Returns the user properties. + \* :literal:`facts`\ : Returns the user properties. | **required**: True | **type**: str @@ -108,32 +108,32 @@ state properties - Dictionary with desired properties for the user. Used for \ :literal:`state=present`\ ; ignored for \ :literal:`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. + Dictionary with desired properties for the user. Used for :literal:`state=present`\ ; ignored for :literal:`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: - \* \ :literal:`name`\ : Cannot be specified because the name has already been specified in the \ :literal:`name`\ module parameter. + \* :literal:`name`\ : Cannot be specified because the name has already been specified in the :literal:`name` module parameter. - \* \ :literal:`type`\ : Cannot be changed once the user exists. + \* :literal:`type`\ : Cannot be changed once the user exists. - \* \ :literal:`user\_roles`\ : Cannot be set directly, but indirectly via the artificial property \ :literal:`user\_role\_names`\ which replaces the current user roles, if specified. + \* :literal:`user\_roles`\ : Cannot be set directly, but indirectly via the artificial property :literal:`user\_role\_names` which replaces the current user roles, if specified. - \* \ :literal:`user\_pattern\_uri`\ : Cannot be set directly, but indirectly via the artificial property \ :literal:`user\_pattern\_name`\ . + \* :literal:`user\_pattern\_uri`\ : Cannot be set directly, but indirectly via the artificial property :literal:`user\_pattern\_name`. - \* \ :literal:`password\_rule\_uri`\ : Cannot be set directly, but indirectly via the artificial property \ :literal:`password\_rule\_name`\ . + \* :literal:`password\_rule\_uri`\ : Cannot be set directly, but indirectly via the artificial property :literal:`password\_rule\_name`. - \* \ :literal:`ldap\_server\_definition\_uri`\ : Cannot be set directly, but indirectly via the artificial property \ :literal:`ldap\_server\_definition\_name`\ . + \* :literal:`ldap\_server\_definition\_uri`\ : Cannot be set directly, but indirectly via the artificial property :literal:`ldap\_server\_definition\_name`. - \* \ :literal:`default\_group\_uri`\ : Cannot be set directly, but indirectly via the artificial property \ :literal:`default\_group\_name`\ . + \* :literal:`default\_group\_uri`\ : Cannot be set directly, but indirectly via the artificial property :literal:`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 \ :ref:`HMC API `\ book when the user is being created. + 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 :ref:`HMC API ` book when the user is being created. | **required**: False | **type**: dict expand - Deprecated: The \ :literal:`expand`\ parameter is deprecated because the returned password rule, user role, user pattern and LDAP server definition objects have an independent lifecycle, so the same objects are returned when invoking this module in a loop through all users. Use the respective other modules of this collection to get the properties of these objects. + Deprecated: The :literal:`expand` parameter is deprecated because the returned password rule, user role, user pattern and LDAP server definition objects have an independent lifecycle, so the same objects are returned when invoking this module in a loop through all users. Use the respective other modules of this collection to get the properties of these objects. 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). @@ -205,7 +205,7 @@ Return Values changed - Indicates if any change has been made by the module. For \ :literal:`state=facts`\ , always will be false. + Indicates if any change has been made by the module. For :literal:`state=facts`\ , always will be false. | **returned**: always | **type**: bool @@ -217,9 +217,9 @@ msg | **type**: str user - For \ :literal:`state=absent`\ , an empty dictionary. + For :literal:`state=absent`\ , an empty dictionary. - For \ :literal:`state=present|facts`\ , a dictionary with the resource properties of the target user, plus additional artificial properties as described in the following list items. + For :literal:`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 @@ -277,78 +277,78 @@ user | **type**: str {property} - Additional properties of the user, as described in the data model of the 'User' object in the \ :ref:`HMC API `\ book. The property names have hyphens (-) as described in that book. + Additional properties of the user, as described in the data model of the 'User' object in the :ref:`HMC API ` book. The property names have hyphens (-) as described in that book. | **type**: raw user-role-names - Name of the user roles referenced by property \ :literal:`user-roles`\ . + Name of the user roles referenced by property :literal:`user-roles`. | **type**: str user-role-objects - Deprecated: This result property is deprecated because the \ :literal:`expand`\ parameter is deprecated. + Deprecated: This result property is deprecated because the :literal:`expand` parameter is deprecated. - Only if \ :literal:`expand=true`\ : User roles referenced by property \ :literal:`user-roles`\ . + Only if :literal:`expand=true`\ : User roles referenced by property :literal:`user-roles`. | **type**: dict {property} - Properties of the user role, as described in the data model of the 'User Pattern' object in the \ :ref:`HMC API `\ book. The property names have hyphens (-) as described in that book. + Properties of the user role, as described in the data model of the 'User Pattern' object in the :ref:`HMC API ` book. The property names have hyphens (-) as described in that book. | **type**: raw user-pattern-name - Only for users with \ :literal:`type=pattern`\ : Name of the user pattern referenced by property \ :literal:`user-pattern-uri`\ . + Only for users with :literal:`type=pattern`\ : Name of the user pattern referenced by property :literal:`user-pattern-uri`. | **type**: str user-pattern - Deprecated: This result property is deprecated because the \ :literal:`expand`\ parameter is deprecated. + Deprecated: This result property is deprecated because the :literal:`expand` parameter is deprecated. - Only for users with \ :literal:`type=pattern`\ and if \ :literal:`expand=true`\ : User pattern referenced by property \ :literal:`user-pattern-uri`\ . + Only for users with :literal:`type=pattern` and if :literal:`expand=true`\ : User pattern referenced by property :literal:`user-pattern-uri`. | **type**: dict {property} - Properties of the user pattern, as described in the data model of the 'User Pattern' object in the \ :ref:`HMC API `\ book. The property names have hyphens (-) as described in that book. + Properties of the user pattern, as described in the data model of the 'User Pattern' object in the :ref:`HMC API ` book. The property names have hyphens (-) as described in that book. | **type**: raw password-rule-name - Only for users with \ :literal:`authentication-type=local`\ : Name of the password rule referenced by property \ :literal:`password-rule-uri`\ . + Only for users with :literal:`authentication-type=local`\ : Name of the password rule referenced by property :literal:`password-rule-uri`. | **type**: str password-rule - Deprecated: This result property is deprecated because the \ :literal:`expand`\ parameter is deprecated. + Deprecated: This result property is deprecated because the :literal:`expand` parameter is deprecated. - Only for users with \ :literal:`authentication-type=local`\ and if \ :literal:`expand=true`\ : Password rule referenced by property \ :literal:`password-rule-uri`\ . + Only for users with :literal:`authentication-type=local` and if :literal:`expand=true`\ : Password rule referenced by property :literal:`password-rule-uri`. | **type**: dict {property} - Properties of the password rule, as described in the data model of the 'Password Rule' object in the \ :ref:`HMC API `\ book. The property names have hyphens (-) as described in that book. + Properties of the password rule, as described in the data model of the 'Password Rule' object in the :ref:`HMC API ` book. The property names have hyphens (-) as described in that book. | **type**: raw ldap-server-definition-name - Only for users with \ :literal:`authentication-type=ldap`\ : Name of the LDAP server definition referenced by property \ :literal:`ldap-server-definition-uri`\ . + Only for users with :literal:`authentication-type=ldap`\ : Name of the LDAP server definition referenced by property :literal:`ldap-server-definition-uri`. | **type**: str ldap-server-definition - Deprecated: This result property is deprecated because the \ :literal:`expand`\ parameter is deprecated. + Deprecated: This result property is deprecated because the :literal:`expand` parameter is deprecated. - Only for users with \ :literal:`authentication-type=ldap`\ and if \ :literal:`expand=true`\ : LDAP server definition referenced by property \ :literal:`ldap-server-definition-uri`\ . + Only for users with :literal:`authentication-type=ldap` and if :literal:`expand=true`\ : LDAP server definition referenced by property :literal:`ldap-server-definition-uri`. | **type**: dict {property} - Properties of the LDAP server definition, as described in the data model of the 'LDAP Server Definition' object in the \ :ref:`HMC API `\ book. The property names have hyphens (-) as described in that book. + Properties of the LDAP server definition, as described in the data model of the 'LDAP Server Definition' object in the :ref:`HMC API ` book. The property names have hyphens (-) as described in that book. | **type**: raw diff --git a/docs/source/modules/zhmc_user_list.rst b/docs/source/modules/zhmc_user_list.rst index be221bd5..39ab46f6 100644 --- a/docs/source/modules/zhmc_user_list.rst +++ b/docs/source/modules/zhmc_user_list.rst @@ -48,35 +48,35 @@ hmc_auth userid - The userid (username) for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The userid (username) for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str password - The password for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The password for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str session_id - HMC session ID to be used. This is mutually exclusive with providing \ :literal:`hmc\_auth.userid`\ and \ :literal:`hmc\_auth.password`\ and can be created as described in the \ :ref:`zhmc\_session module `\ . + HMC session ID to be used. This is mutually exclusive with providing :literal:`hmc\_auth.userid` and :literal:`hmc\_auth.password` and can be created as described in the :ref:`zhmc\_session module `. | **required**: False | **type**: str ca_certs - Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the \ :envvar:`REQUESTS\_CA\_BUNDLE`\ environment variable or the path name in the \ :envvar:`CURL\_CA\_BUNDLE`\ environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. + Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the :envvar:`REQUESTS\_CA\_BUNDLE` environment variable or the path name in the :envvar:`CURL\_CA\_BUNDLE` environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. | **required**: False | **type**: str verify - If True (default), verify the HMC certificate as specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter. If False, ignore what is specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter and do not verify the HMC certificate. + If True (default), verify the HMC certificate as specified in the :literal:`hmc\_auth.ca\_certs` parameter. If False, ignore what is specified in the :literal:`hmc\_auth.ca\_certs` parameter and do not verify the HMC certificate. | **required**: False | **type**: bool @@ -169,12 +169,12 @@ users | **type**: str type - Type of the user (\ :literal:`standard`\ , \ :literal:`template`\ , \ :literal:`pattern-based`\ , \ :literal:`system-defined`\ ) + Type of the user (\ :literal:`standard`\ , :literal:`template`\ , :literal:`pattern-based`\ , :literal:`system-defined`\ ) | **type**: str {additional_property} - Additional properties requested via \ :literal:`full\_properties`\ . The property names will have underscores instead of hyphens. + Additional properties requested via :literal:`full\_properties`. The property names will have underscores instead of hyphens. | **type**: raw diff --git a/docs/source/modules/zhmc_user_pattern.rst b/docs/source/modules/zhmc_user_pattern.rst index db96d454..2a19eb6e 100644 --- a/docs/source/modules/zhmc_user_pattern.rst +++ b/docs/source/modules/zhmc_user_pattern.rst @@ -49,35 +49,35 @@ hmc_auth userid - The userid (username) for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The userid (username) for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str password - The password for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The password for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str session_id - HMC session ID to be used. This is mutually exclusive with providing \ :literal:`hmc\_auth.userid`\ and \ :literal:`hmc\_auth.password`\ and can be created as described in the \ :ref:`zhmc\_session module `\ . + HMC session ID to be used. This is mutually exclusive with providing :literal:`hmc\_auth.userid` and :literal:`hmc\_auth.password` and can be created as described in the :ref:`zhmc\_session module `. | **required**: False | **type**: str ca_certs - Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the \ :envvar:`REQUESTS\_CA\_BUNDLE`\ environment variable or the path name in the \ :envvar:`CURL\_CA\_BUNDLE`\ environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. + Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the :envvar:`REQUESTS\_CA\_BUNDLE` environment variable or the path name in the :envvar:`CURL\_CA\_BUNDLE` environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. | **required**: False | **type**: str verify - If True (default), verify the HMC certificate as specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter. If False, ignore what is specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter and do not verify the HMC certificate. + If True (default), verify the HMC certificate as specified in the :literal:`hmc\_auth.ca\_certs` parameter. If False, ignore what is specified in the :literal:`hmc\_auth.ca\_certs` parameter and do not verify the HMC certificate. | **required**: False | **type**: bool @@ -95,11 +95,11 @@ name state The desired state for the HMC user pattern. All states are fully idempotent within the limits of the properties that can be changed: - \* \ :literal:`absent`\ : Ensures that the user pattern does not exist. + \* :literal:`absent`\ : Ensures that the user pattern does not exist. - \* \ :literal:`present`\ : Ensures that the user pattern exists and has the specified properties. + \* :literal:`present`\ : Ensures that the user pattern exists and has the specified properties. - \* \ :literal:`facts`\ : Returns the user pattern properties. + \* :literal:`facts`\ : Returns the user pattern properties. | **required**: True | **type**: str @@ -107,15 +107,15 @@ state properties - Dictionary with desired properties for the user pattern. Used for \ :literal:`state=present`\ ; ignored for \ :literal:`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. + Dictionary with desired properties for the user pattern. Used for :literal:`state=present`\ ; ignored for :literal:`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 Pattern resources (where the property names contain underscores instead of hyphens), with the following exceptions: - \* \ :literal:`name`\ : Cannot be specified because the name has already been specified in the \ :literal:`name`\ module parameter. + \* :literal:`name`\ : Cannot be specified because the name has already been specified in the :literal:`name` module parameter. - \* \ :literal:`...\_uri`\ : Cannot be set directly, but indirectly via the corresponding artificial property \ :literal:`...\_name`\ . An empty string for the name will set the URI to null. + \* :literal:`...\_uri`\ : Cannot be set directly, but indirectly via the corresponding artificial property :literal:`...\_name`. An empty string for the name will set the URI to null. - Properties omitted in this dictionary will remain unchanged when the user pattern already exists, and will get the default value defined in the data model for user patterns in the \ :ref:`HMC API `\ book when the user pattern is being created. + Properties omitted in this dictionary will remain unchanged when the user pattern already exists, and will get the default value defined in the data model for user patterns in the :ref:`HMC API ` book when the user pattern is being created. | **required**: False | **type**: dict @@ -178,7 +178,7 @@ Return Values changed - Indicates if any change has been made by the module. For \ :literal:`state=facts`\ , always will be false. + Indicates if any change has been made by the module. For :literal:`state=facts`\ , always will be false. | **returned**: always | **type**: bool @@ -190,9 +190,9 @@ msg | **type**: str user_pattern - For \ :literal:`state=absent`\ , an empty dictionary. + For :literal:`state=absent`\ , an empty dictionary. - For \ :literal:`state=present|facts`\ , a dictionary with the resource properties of the target user pattern and some additional artificial properties. + For :literal:`state=present|facts`\ , a dictionary with the resource properties of the target user pattern and some additional artificial properties. | **returned**: success | **type**: dict @@ -239,9 +239,9 @@ user_pattern | **type**: str {property} - Additional properties of the user pattern, as described in the data model of the 'User Pattern' object in the \ :ref:`HMC API `\ book. The property names will have underscores instead of hyphens. + Additional properties of the user pattern, as described in the data model of the 'User Pattern' object in the :ref:`HMC API ` book. The property names will have underscores instead of hyphens. - The items in the \ :literal:`ldap\_group\_to\_template\_mappings`\ property have an additional item \ :literal:`template-name`\ which is the name of the resource object referenced by \ :literal:`template-uri`\ . + The items in the :literal:`ldap\_group\_to\_template\_mappings` property have an additional item :literal:`template-name` which is the name of the resource object referenced by :literal:`template-uri`. | **type**: raw diff --git a/docs/source/modules/zhmc_user_pattern_list.rst b/docs/source/modules/zhmc_user_pattern_list.rst index 0b154866..0aebe832 100644 --- a/docs/source/modules/zhmc_user_pattern_list.rst +++ b/docs/source/modules/zhmc_user_pattern_list.rst @@ -48,35 +48,35 @@ hmc_auth userid - The userid (username) for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The userid (username) for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str password - The password for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The password for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str session_id - HMC session ID to be used. This is mutually exclusive with providing \ :literal:`hmc\_auth.userid`\ and \ :literal:`hmc\_auth.password`\ and can be created as described in the \ :ref:`zhmc\_session module `\ . + HMC session ID to be used. This is mutually exclusive with providing :literal:`hmc\_auth.userid` and :literal:`hmc\_auth.password` and can be created as described in the :ref:`zhmc\_session module `. | **required**: False | **type**: str ca_certs - Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the \ :envvar:`REQUESTS\_CA\_BUNDLE`\ environment variable or the path name in the \ :envvar:`CURL\_CA\_BUNDLE`\ environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. + Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the :envvar:`REQUESTS\_CA\_BUNDLE` environment variable or the path name in the :envvar:`CURL\_CA\_BUNDLE` environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. | **required**: False | **type**: str verify - If True (default), verify the HMC certificate as specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter. If False, ignore what is specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter and do not verify the HMC certificate. + If True (default), verify the HMC certificate as specified in the :literal:`hmc\_auth.ca\_certs` parameter. If False, ignore what is specified in the :literal:`hmc\_auth.ca\_certs` parameter and do not verify the HMC certificate. | **required**: False | **type**: bool @@ -143,7 +143,7 @@ msg | **type**: str user_patterns - The list of User Patterns, with a subset or all of their properties, dependent on \ :literal:`full\_properties`\ . + The list of User Patterns, with a subset or all of their properties, dependent on :literal:`full\_properties`. | **returned**: success | **type**: list @@ -178,14 +178,14 @@ user_patterns type The style in which the user pattern is expressed, as one of the following values: - \ :literal:`glob-like`\ - Glob-like pattern as used in file names, supporting the special characters \ :literal:`\*`\ and \ :literal:`?`\ . + :literal:`glob-like` - Glob-like pattern as used in file names, supporting the special characters :literal:`\*` and :literal:`?`. - \ :literal:`regular-expression`\ - Regular expression pattern using \ :ref:`Java regular expressions `\ . + :literal:`regular-expression` - Regular expression pattern using :ref:`Java regular expressions `. | **type**: str {additional_property} - Additional properties requested via \ :literal:`full\_properties`\ , as described in the data model of the 'User Pattern' object in the \ :ref:`HMC API `\ book. The property names will have underscores instead of hyphens. + Additional properties requested via :literal:`full\_properties`\ , as described in the data model of the 'User Pattern' object in the :ref:`HMC API ` book. The property names will have underscores instead of hyphens. | **type**: raw diff --git a/docs/source/modules/zhmc_user_role.rst b/docs/source/modules/zhmc_user_role.rst index bf6d4aa5..1a9949a4 100644 --- a/docs/source/modules/zhmc_user_role.rst +++ b/docs/source/modules/zhmc_user_role.rst @@ -49,35 +49,35 @@ hmc_auth userid - The userid (username) for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The userid (username) for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str password - The password for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The password for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str session_id - HMC session ID to be used. This is mutually exclusive with providing \ :literal:`hmc\_auth.userid`\ and \ :literal:`hmc\_auth.password`\ and can be created as described in the \ :ref:`zhmc\_session module `\ . + HMC session ID to be used. This is mutually exclusive with providing :literal:`hmc\_auth.userid` and :literal:`hmc\_auth.password` and can be created as described in the :ref:`zhmc\_session module `. | **required**: False | **type**: str ca_certs - Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the \ :envvar:`REQUESTS\_CA\_BUNDLE`\ environment variable or the path name in the \ :envvar:`CURL\_CA\_BUNDLE`\ environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. + Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the :envvar:`REQUESTS\_CA\_BUNDLE` environment variable or the path name in the :envvar:`CURL\_CA\_BUNDLE` environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. | **required**: False | **type**: str verify - If True (default), verify the HMC certificate as specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter. If False, ignore what is specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter and do not verify the HMC certificate. + If True (default), verify the HMC certificate as specified in the :literal:`hmc\_auth.ca\_certs` parameter. If False, ignore what is specified in the :literal:`hmc\_auth.ca\_certs` parameter and do not verify the HMC certificate. | **required**: False | **type**: bool @@ -95,11 +95,11 @@ name state The desired state for the HMC user role. All states are fully idempotent within the limits of the properties that can be changed: - \* \ :literal:`absent`\ : Ensures that the user role does not exist. + \* :literal:`absent`\ : Ensures that the user role does not exist. - \* \ :literal:`present`\ : Ensures that the user role exists and has the specified properties. + \* :literal:`present`\ : Ensures that the user role exists and has the specified properties. - \* \ :literal:`facts`\ : Returns the user role properties. + \* :literal:`facts`\ : Returns the user role properties. | **required**: True | **type**: str @@ -107,19 +107,19 @@ state properties - Dictionary with desired properties for the user role. Used for \ :literal:`state=present`\ ; ignored for \ :literal:`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. + Dictionary with desired properties for the user role. Used for :literal:`state=present`\ ; ignored for :literal:`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 role resources (where the property names contain underscores instead of hyphens), with the following exceptions: - \* \ :literal:`name`\ : Cannot be specified because the name has already been specified in the \ :literal:`name`\ module parameter. + \* :literal:`name`\ : Cannot be specified because the name has already been specified in the :literal:`name` module parameter. - \* \ :literal:`associated\_system\_defined\_user\_role\_uri`\ : Cannot be specified because this information is specified using the artificial property \ :literal:`associated\_system\_defined\_user\_role\_name`\ . + \* :literal:`associated\_system\_defined\_user\_role\_uri`\ : Cannot be specified because this information is specified using the artificial property :literal:`associated\_system\_defined\_user\_role\_name`. - \* \ :literal:`associated\_system\_defined\_user\_role\_name`\ : The name of the associated system-defined user role. + \* :literal:`associated\_system\_defined\_user\_role\_name`\ : The name of the associated system-defined user role. - \* \ :literal:`permissions`\ : Can be specified as if it were writeable. + \* :literal:`permissions`\ : Can be specified as if it were writeable. - Properties omitted in this dictionary will remain unchanged when the user role already exists, and will get the default value defined in the data model for user roles in the \ :ref:`HMC API `\ book when the user role is being created. + Properties omitted in this dictionary will remain unchanged when the user role already exists, and will get the default value defined in the data model for user roles in the :ref:`HMC API ` book when the user role is being created. | **required**: False | **type**: dict @@ -135,7 +135,7 @@ properties associated_system_defined_user_role_name The name of the associated system-defined user role. Specifying it requires that the referenced user role exists. - Optional, default: \ :literal:`hmc-operator-tasks`\ . + Optional, default: :literal:`hmc-operator-tasks`. | **required**: False | **type**: str @@ -144,7 +144,7 @@ properties permissions The permissions for this user role. - This property is represented different from its description in the \ :ref:`HMC API `\ : The property is a list of permissions. Each list item is a dictionary that specifies a single permission item, any required scoping items, and optional option items. + This property is represented different from its description in the :ref:`HMC API `\ : The property is a list of permissions. Each list item is a dictionary that specifies a single permission item, any required scoping items, and optional option items. | **required**: False | **type**: list @@ -159,14 +159,14 @@ properties view_only - Option item only for \ :literal:`task`\ : Indicates whether the task's view-only version is subject of the permission. Only certain tasks have a view-only version. Default: true. + Option item only for :literal:`task`\ : Indicates whether the task's view-only version is subject of the permission. Only certain tasks have a view-only version. Default: true. | **required**: False | **type**: bool class - Permission item: Object permission to all objects of the specified resource class (= value of \ :literal:`class`\ property). + Permission item: Object permission to all objects of the specified resource class (= value of :literal:`class` property). | **required**: False | **type**: str @@ -180,7 +180,7 @@ properties include_members - Option item only for \ :literal:`group`\ : Indicates whether the group members are included in the permission. Default: false. + Option item only for :literal:`group`\ : Indicates whether the group members are included in the permission. Default: false. | **required**: False | **type**: bool @@ -198,7 +198,7 @@ properties partition Permission item: Object permission to the partition with the specified name on the specified CPC (in DPM mode). - Requires \ :literal:`cpc`\ to be specified as a scoping item. + Requires :literal:`cpc` to be specified as a scoping item. | **required**: False | **type**: str @@ -207,7 +207,7 @@ properties lpar Permission item: Object permission to the LPAR with the specified name on the specified CPC (in classic mode). - Requires \ :literal:`cpc`\ to be specified as a scoping item. + Requires :literal:`cpc` to be specified as a scoping item. | **required**: False | **type**: str @@ -216,7 +216,7 @@ properties adapter Permission item: Object permission to the adapter with the specified name on the specified CPC (in DPM mode). - Requires \ :literal:`cpc`\ to be specified as a scoping item. + Requires :literal:`cpc` to be specified as a scoping item. | **required**: False | **type**: str @@ -225,7 +225,7 @@ properties storage_group Permission item: Object permission to the storage group with the specified name that is associated with the specified CPC (in DPM mode). - Requires \ :literal:`cpc`\ to be specified as a scoping item. + Requires :literal:`cpc` to be specified as a scoping item. | **required**: False | **type**: str @@ -234,7 +234,7 @@ properties storage_group_template Permission item: Object permission to the storage group template with the specified name that is associated with the specified CPC (in DPM mode). - Requires \ :literal:`cpc`\ to be specified as a scoping item. + Requires :literal:`cpc` to be specified as a scoping item. | **required**: False | **type**: str @@ -313,7 +313,7 @@ Return Values changed - Indicates if any change has been made by the module. For \ :literal:`state=facts`\ , always will be false. + Indicates if any change has been made by the module. For :literal:`state=facts`\ , always will be false. | **returned**: always | **type**: bool @@ -325,9 +325,9 @@ msg | **type**: str user_role - For \ :literal:`state=absent`\ , an empty dictionary. + For :literal:`state=absent`\ , an empty dictionary. - For \ :literal:`state=present|facts`\ , a dictionary with the resource properties of the target user role. + For :literal:`state=present|facts`\ , a dictionary with the resource properties of the target user role. | **returned**: success | **type**: dict @@ -387,7 +387,7 @@ user_role permissions The permissions for this user role. - This property is represented different from its description in the \ :ref:`HMC API `\ : The property is a list of permissions. Each list item is a dictionary that specifies a single permission item, any needed scoping items, and any applicable option items. + This property is represented different from its description in the :ref:`HMC API `\ : The property is a list of permissions. Each list item is a dictionary that specifies a single permission item, any needed scoping items, and any applicable option items. | **type**: list | **elements**: dict @@ -398,12 +398,12 @@ user_role | **type**: str view_only - Option item present for \ :literal:`task`\ : Indicates whether the task's view-only version is subject of the permission. Only certain tasks have a view-only version, but the option item will be present for all tasks. + Option item present for :literal:`task`\ : Indicates whether the task's view-only version is subject of the permission. Only certain tasks have a view-only version, but the option item will be present for all tasks. | **type**: bool class - Permission item: Object permission to all objects of the specified resource class (= value of \ :literal:`class`\ property). + Permission item: Object permission to all objects of the specified resource class (= value of :literal:`class` property). | **type**: str @@ -413,7 +413,7 @@ user_role | **type**: str include_members - Option item present for \ :literal:`group`\ : Indicates whether the group members are included in the permission. The option item will be present for all groups. + Option item present for :literal:`group`\ : Indicates whether the group members are included in the permission. The option item will be present for all groups. | **type**: bool @@ -427,41 +427,41 @@ user_role partition Permission item: Object permission to the partition with the specified name on the specified CPC (in DPM mode). - \ :literal:`cpc`\ will be present as a scoping item. + :literal:`cpc` will be present as a scoping item. | **type**: str lpar Permission item: Object permission to the LPAR with the specified name on the specified CPC (in classic mode). - \ :literal:`cpc`\ will be present as a scoping item. + :literal:`cpc` will be present as a scoping item. | **type**: str adapter Permission item: Object permission to the adapter with the specified name on the specified CPC (in DPM mode). - \ :literal:`cpc`\ will be present as a scoping item. + :literal:`cpc` will be present as a scoping item. | **type**: str storage_group Permission item: Object permission to the storage group with the specified name that is associated with the specified CPC (in DPM mode). - \ :literal:`cpc`\ will be present as a scoping item. + :literal:`cpc` will be present as a scoping item. | **type**: str storage_group_template Permission item: Object permission to the storage group template with the specified name that is associated with the specified CPC (in DPM mode). - \ :literal:`cpc`\ will be present as a scoping item. + :literal:`cpc` will be present as a scoping item. | **type**: str {property} - Additional properties of the user role, as described in the data model of the 'User Role' object in the \ :ref:`HMC API `\ book. The property names have hyphens (-) as described in that book. + Additional properties of the user role, as described in the data model of the 'User Role' object in the :ref:`HMC API ` book. The property names have hyphens (-) as described in that book. | **type**: raw diff --git a/docs/source/modules/zhmc_user_role_list.rst b/docs/source/modules/zhmc_user_role_list.rst index 937cf30a..ce8bb637 100644 --- a/docs/source/modules/zhmc_user_role_list.rst +++ b/docs/source/modules/zhmc_user_role_list.rst @@ -48,35 +48,35 @@ hmc_auth userid - The userid (username) for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The userid (username) for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str password - The password for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The password for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str session_id - HMC session ID to be used. This is mutually exclusive with providing \ :literal:`hmc\_auth.userid`\ and \ :literal:`hmc\_auth.password`\ and can be created as described in the \ :ref:`zhmc\_session module `\ . + HMC session ID to be used. This is mutually exclusive with providing :literal:`hmc\_auth.userid` and :literal:`hmc\_auth.password` and can be created as described in the :ref:`zhmc\_session module `. | **required**: False | **type**: str ca_certs - Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the \ :envvar:`REQUESTS\_CA\_BUNDLE`\ environment variable or the path name in the \ :envvar:`CURL\_CA\_BUNDLE`\ environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. + Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the :envvar:`REQUESTS\_CA\_BUNDLE` environment variable or the path name in the :envvar:`CURL\_CA\_BUNDLE` environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. | **required**: False | **type**: str verify - If True (default), verify the HMC certificate as specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter. If False, ignore what is specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter and do not verify the HMC certificate. + If True (default), verify the HMC certificate as specified in the :literal:`hmc\_auth.ca\_certs` parameter. If False, ignore what is specified in the :literal:`hmc\_auth.ca\_certs` parameter and do not verify the HMC certificate. | **required**: False | **type**: bool @@ -169,12 +169,12 @@ user_roles | **type**: str type - Type of the user role (\ :literal:`system-defined`\ , \ :literal:`user-defined`\ ) + Type of the user role (\ :literal:`system-defined`\ , :literal:`user-defined`\ ) | **type**: str {additional_property} - Additional properties requested via \ :literal:`full\_properties`\ . The property names will have underscores instead of hyphens. + Additional properties requested via :literal:`full\_properties`. The property names will have underscores instead of hyphens. | **type**: raw diff --git a/docs/source/modules/zhmc_versions.rst b/docs/source/modules/zhmc_versions.rst index 0644642f..0116d3e8 100644 --- a/docs/source/modules/zhmc_versions.rst +++ b/docs/source/modules/zhmc_versions.rst @@ -48,35 +48,35 @@ hmc_auth userid - The userid (username) for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The userid (username) for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str password - The password for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The password for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str session_id - HMC session ID to be used. This is mutually exclusive with providing \ :literal:`hmc\_auth.userid`\ and \ :literal:`hmc\_auth.password`\ and can be created as described in the \ :ref:`zhmc\_session module `\ . + HMC session ID to be used. This is mutually exclusive with providing :literal:`hmc\_auth.userid` and :literal:`hmc\_auth.password` and can be created as described in the :ref:`zhmc\_session module `. | **required**: False | **type**: str ca_certs - Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the \ :envvar:`REQUESTS\_CA\_BUNDLE`\ environment variable or the path name in the \ :envvar:`CURL\_CA\_BUNDLE`\ environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. + Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the :envvar:`REQUESTS\_CA\_BUNDLE` environment variable or the path name in the :envvar:`CURL\_CA\_BUNDLE` environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. | **required**: False | **type**: str verify - If True (default), verify the HMC certificate as specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter. If False, ignore what is specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter and do not verify the HMC certificate. + If True (default), verify the HMC certificate as specified in the :literal:`hmc\_auth.ca\_certs` parameter. If False, ignore what is specified in the :literal:`hmc\_auth.ca\_certs` parameter and do not verify the HMC certificate. | **required**: False | **type**: bool @@ -241,7 +241,7 @@ versions | **type**: str status - The current status of the CPC. For details, see the description of the 'status' property in the data model of the 'CPC' resource (see \ :ref:`HMC API `\ ). + The current status of the CPC. For details, see the description of the 'status' property in the data model of the 'CPC' resource (see :ref:`HMC API `\ ). | **type**: str diff --git a/docs/source/modules/zhmc_virtual_function.rst b/docs/source/modules/zhmc_virtual_function.rst index 15daf050..9307a3a6 100644 --- a/docs/source/modules/zhmc_virtual_function.rst +++ b/docs/source/modules/zhmc_virtual_function.rst @@ -51,35 +51,35 @@ hmc_auth userid - The userid (username) for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The userid (username) for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str password - The password for authenticating with the HMC. This is mutually exclusive with providing \ :literal:`hmc\_auth.session\_id`\ . + The password for authenticating with the HMC. This is mutually exclusive with providing :literal:`hmc\_auth.session\_id`. | **required**: False | **type**: str session_id - HMC session ID to be used. This is mutually exclusive with providing \ :literal:`hmc\_auth.userid`\ and \ :literal:`hmc\_auth.password`\ and can be created as described in the \ :ref:`zhmc\_session module `\ . + HMC session ID to be used. This is mutually exclusive with providing :literal:`hmc\_auth.userid` and :literal:`hmc\_auth.password` and can be created as described in the :ref:`zhmc\_session module `. | **required**: False | **type**: str ca_certs - Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the \ :envvar:`REQUESTS\_CA\_BUNDLE`\ environment variable or the path name in the \ :envvar:`CURL\_CA\_BUNDLE`\ environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. + Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the :envvar:`REQUESTS\_CA\_BUNDLE` environment variable or the path name in the :envvar:`CURL\_CA\_BUNDLE` environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the 'certifi' Python package are used for verifying the HMC certificate. | **required**: False | **type**: str verify - If True (default), verify the HMC certificate as specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter. If False, ignore what is specified in the \ :literal:`hmc\_auth.ca\_certs`\ parameter and do not verify the HMC certificate. + If True (default), verify the HMC certificate as specified in the :literal:`hmc\_auth.ca\_certs` parameter. If False, ignore what is specified in the :literal:`hmc\_auth.ca\_certs` parameter and do not verify the HMC certificate. | **required**: False | **type**: bool @@ -111,9 +111,9 @@ name state The desired state for the virtual function. All states are fully idempotent within the limits of the properties that can be changed: - \* \ :literal:`absent`\ : Ensures that the virtual function does not exist in the specified partition. + \* :literal:`absent`\ : Ensures that the virtual function does not exist in the specified partition. - \* \ :literal:`present`\ : Ensures that the virtual function exists in the specified partition and has the specified properties. + \* :literal:`present`\ : Ensures that the virtual function exists in the specified partition and has the specified properties. | **required**: True | **type**: str @@ -121,15 +121,15 @@ state properties - Dictionary with input properties for the virtual function, for \ :literal:`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 \ :literal:`state=absent`\ . + Dictionary with input properties for the virtual function, for :literal:`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 :literal:`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: - \* \ :literal:`name`\ : Cannot be specified because the name has already been specified in the \ :literal:`name`\ module parameter. + \* :literal:`name`\ : Cannot be specified because the name has already been specified in the :literal:`name` module parameter. - \* \ :literal:`adapter\_uri`\ : Cannot be specified because this information is specified using the artificial property \ :literal:`adapter\_name`\ . + \* :literal:`adapter\_uri`\ : Cannot be specified because this information is specified using the artificial property :literal:`adapter\_name`. - \* \ :literal:`adapter\_name`\ : The name of the adapter that backs the target virtual function. + \* :literal:`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. @@ -192,7 +192,7 @@ Return Values changed - Indicates if any change has been made by the module. For \ :literal:`state=facts`\ , always will be false. + Indicates if any change has been made by the module. For :literal:`state=facts`\ , always will be false. | **returned**: always | **type**: bool @@ -204,9 +204,9 @@ msg | **type**: str virtual_function - For \ :literal:`state=absent`\ , an empty dictionary. + For :literal:`state=absent`\ , an empty dictionary. - For \ :literal:`state=present`\ , the resource properties of the virtual function after any changes. + For :literal:`state=present`\ , the resource properties of the virtual function after any changes. | **returned**: success | **type**: dict @@ -217,7 +217,7 @@ virtual_function | **type**: str {property} - Additional properties of the virtual function, as described in the data model of the 'Virtual Function' element object of the 'Partition' object in the \ :ref:`HMC API `\ book. The property names have hyphens (-) as described in that book. + Additional properties of the virtual function, as described in the data model of the 'Virtual Function' element object of the 'Partition' object in the :ref:`HMC API ` book. The property names have hyphens (-) as described in that book. | **type**: raw