Skip to content

Commit

Permalink
Update .rst files due to new formatting
Browse files Browse the repository at this point in the history
Signed-off-by: Andreas Maier <[email protected]>
  • Loading branch information
andy-maier committed Jan 19, 2025
1 parent 3241fef commit 7add882
Show file tree
Hide file tree
Showing 12 changed files with 22 additions and 22 deletions.
4 changes: 2 additions & 2 deletions docs/source/modules/zhmc_adapter.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/source/modules/zhmc_cpc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/source/modules/zhmc_ldap_server_definition.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/source/modules/zhmc_lpar.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <HMC API>` book.

Expand Down
2 changes: 1 addition & 1 deletion docs/source/modules/zhmc_nic.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/source/modules/zhmc_partition.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/source/modules/zhmc_password_rule.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/source/modules/zhmc_storage_group.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/source/modules/zhmc_storage_volume.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/source/modules/zhmc_user.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/source/modules/zhmc_user_pattern.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/source/modules/zhmc_user_role.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 7add882

Please sign in to comment.