From 7add8824c7f89aa15935105187095e7909b230ad Mon Sep 17 00:00:00 2001 From: Andreas Maier Date: Sun, 19 Jan 2025 19:17:40 +0100 Subject: [PATCH] Update .rst files due to new formatting Signed-off-by: Andreas Maier --- docs/source/modules/zhmc_adapter.rst | 4 ++-- docs/source/modules/zhmc_cpc.rst | 2 +- docs/source/modules/zhmc_ldap_server_definition.rst | 4 ++-- docs/source/modules/zhmc_lpar.rst | 4 ++-- docs/source/modules/zhmc_nic.rst | 2 +- docs/source/modules/zhmc_partition.rst | 4 ++-- docs/source/modules/zhmc_password_rule.rst | 4 ++-- docs/source/modules/zhmc_storage_group.rst | 4 ++-- docs/source/modules/zhmc_storage_volume.rst | 4 ++-- docs/source/modules/zhmc_user.rst | 4 ++-- docs/source/modules/zhmc_user_pattern.rst | 4 ++-- docs/source/modules/zhmc_user_role.rst | 4 ++-- 12 files changed, 22 insertions(+), 22 deletions(-) diff --git a/docs/source/modules/zhmc_adapter.rst b/docs/source/modules/zhmc_adapter.rst index 4a89040b..98304eb5 100644 --- a/docs/source/modules/zhmc_adapter.rst +++ b/docs/source/modules/zhmc_adapter.rst @@ -134,7 +134,7 @@ 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. @@ -257,7 +257,7 @@ msg adapter 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 diff --git a/docs/source/modules/zhmc_cpc.rst b/docs/source/modules/zhmc_cpc.rst index 2451751e..e9a06c2a 100644 --- a/docs/source/modules/zhmc_cpc.rst +++ b/docs/source/modules/zhmc_cpc.rst @@ -272,7 +272,7 @@ msg cpc 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 diff --git a/docs/source/modules/zhmc_ldap_server_definition.rst b/docs/source/modules/zhmc_ldap_server_definition.rst index 473b0b32..efc57251 100644 --- a/docs/source/modules/zhmc_ldap_server_definition.rst +++ b/docs/source/modules/zhmc_ldap_server_definition.rst @@ -109,7 +109,7 @@ 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: @@ -194,7 +194,7 @@ msg ldap_server_definition 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 diff --git a/docs/source/modules/zhmc_lpar.rst b/docs/source/modules/zhmc_lpar.rst index cada73dd..c3703226 100644 --- a/docs/source/modules/zhmc_lpar.rst +++ b/docs/source/modules/zhmc_lpar.rst @@ -388,9 +388,9 @@ 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. diff --git a/docs/source/modules/zhmc_nic.rst b/docs/source/modules/zhmc_nic.rst index 9db08155..e20aa64b 100644 --- a/docs/source/modules/zhmc_nic.rst +++ b/docs/source/modules/zhmc_nic.rst @@ -222,7 +222,7 @@ msg nic 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 diff --git a/docs/source/modules/zhmc_partition.rst b/docs/source/modules/zhmc_partition.rst index 0d3faf26..6f383e21 100644 --- a/docs/source/modules/zhmc_partition.rst +++ b/docs/source/modules/zhmc_partition.rst @@ -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 diff --git a/docs/source/modules/zhmc_password_rule.rst b/docs/source/modules/zhmc_password_rule.rst index 990a531a..de4c9f25 100644 --- a/docs/source/modules/zhmc_password_rule.rst +++ b/docs/source/modules/zhmc_password_rule.rst @@ -107,7 +107,7 @@ 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: @@ -190,7 +190,7 @@ msg password_rule 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 diff --git a/docs/source/modules/zhmc_storage_group.rst b/docs/source/modules/zhmc_storage_group.rst index ca84cdf5..bbeb6ff4 100644 --- a/docs/source/modules/zhmc_storage_group.rst +++ b/docs/source/modules/zhmc_storage_group.rst @@ -118,7 +118,7 @@ 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: @@ -251,7 +251,7 @@ msg storage_group 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 diff --git a/docs/source/modules/zhmc_storage_volume.rst b/docs/source/modules/zhmc_storage_volume.rst index bb352a90..fe252c99 100644 --- a/docs/source/modules/zhmc_storage_volume.rst +++ b/docs/source/modules/zhmc_storage_volume.rst @@ -123,7 +123,7 @@ 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: @@ -219,7 +219,7 @@ msg storage_volume 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 diff --git a/docs/source/modules/zhmc_user.rst b/docs/source/modules/zhmc_user.rst index a762718d..a70ceed5 100644 --- a/docs/source/modules/zhmc_user.rst +++ b/docs/source/modules/zhmc_user.rst @@ -108,7 +108,7 @@ 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: @@ -219,7 +219,7 @@ msg user 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 diff --git a/docs/source/modules/zhmc_user_pattern.rst b/docs/source/modules/zhmc_user_pattern.rst index 2a19eb6e..f2fc3b17 100644 --- a/docs/source/modules/zhmc_user_pattern.rst +++ b/docs/source/modules/zhmc_user_pattern.rst @@ -107,7 +107,7 @@ 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: @@ -192,7 +192,7 @@ msg user_pattern 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 diff --git a/docs/source/modules/zhmc_user_role.rst b/docs/source/modules/zhmc_user_role.rst index 1a9949a4..fae17b9a 100644 --- a/docs/source/modules/zhmc_user_role.rst +++ b/docs/source/modules/zhmc_user_role.rst @@ -107,7 +107,7 @@ 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: @@ -327,7 +327,7 @@ msg user_role 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