Skip to content

Commit

Permalink
Updated .rst files to match new RST generator
Browse files Browse the repository at this point in the history
Signed-off-by: Andreas Maier <maiera@de.ibm.com>
  • Loading branch information
andy-maier committed Sep 2, 2024
1 parent e407f68 commit 857201f
Show file tree
Hide file tree
Showing 34 changed files with 522 additions and 522 deletions.
42 changes: 21 additions & 21 deletions docs/source/modules/zhmc_adapter.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <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 <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
Expand All @@ -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
Expand All @@ -120,31 +120,31 @@ 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
| **choices**: set, present, absent, facts

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
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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 <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 <HMC API>` book. The property names have hyphens (-) as described in that book.

| **type**: raw
Expand All @@ -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 <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 <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
Expand Down
20 changes: 10 additions & 10 deletions docs/source/modules/zhmc_adapter_list.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <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 <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
Expand Down Expand Up @@ -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.

Expand All @@ -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
Expand Down Expand Up @@ -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 <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 <HMC API>`\ )

| **returned**: success
| **type**: list
Expand Down Expand Up @@ -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
Expand Down
Loading

0 comments on commit 857201f

Please sign in to comment.