Skip to content

LustreRootSquashConfiguration

Source code in docs_src/capo_fsx/types/lustre_root_squash_configuration.py
class LustreRootSquashConfiguration(TypedDict, closed=True):
    root_squash: NotRequired["capo_fsx.types.lustre_root_squash.LustreRootSquash"]
    """<p>You enable root squash by setting a user ID (UID) and group ID (GID) for the file system in the format <code>UID:GID</code> (for example, <code>365534:65534</code>). The UID and GID values can range from <code>0</code> to <code>4294967294</code>:</p> <ul> <li> <p>A non-zero value for UID and GID enables root squash. The UID and GID values can be different, but each must be a non-zero value.</p> </li> <li> <p>A value of <code>0</code> (zero) for UID and GID indicates root, and therefore disables root squash.</p> </li> </ul> <p>When root squash is enabled, the user ID and group ID of a root user accessing the file system are re-mapped to the UID and GID you provide.</p>"""
    no_squash_nids: NotRequired[
        "capo_fsx.types.lustre_no_squash_nids.LustreNoSquashNids"
    ]
    """<p>When root squash is enabled, you can optionally specify an array of NIDs of clients for which root squash does not apply. A client NID is a Lustre Network Identifier used to uniquely identify a client. You can specify the NID as either a single address or a range of addresses:</p> <ul> <li> <p>A single address is described in standard Lustre NID format by specifying the client’s IP address followed by the Lustre network ID (for example, <code>10.0.1.6@tcp</code>).</p> </li> <li> <p>An address range is described using a dash to separate the range (for example, <code>10.0.[2-10].[1-255]@tcp</code>).</p> </li> </ul>"""

no_squash_nids instance-attribute

no_squash_nids: NotRequired[LustreNoSquashNids]

When root squash is enabled, you can optionally specify an array of NIDs of clients for which root squash does not apply. A client NID is a Lustre Network Identifier used to uniquely identify a client. You can specify the NID as either a single address or a range of addresses:

  • A single address is described in standard Lustre NID format by specifying the client’s IP address followed by the Lustre network ID (for example, 10.0.1.6@tcp).

  • An address range is described using a dash to separate the range (for example, 10.0.[2-10].[1-255]@tcp).

root_squash instance-attribute

root_squash: NotRequired[LustreRootSquash]

You enable root squash by setting a user ID (UID) and group ID (GID) for the file system in the format UID:GID (for example, 365534:65534). The UID and GID values can range from 0 to 4294967294:

  • A non-zero value for UID and GID enables root squash. The UID and GID values can be different, but each must be a non-zero value.

  • A value of 0 (zero) for UID and GID indicates root, and therefore disables root squash.

When root squash is enabled, the user ID and group ID of a root user accessing the file system are re-mapped to the UID and GID you provide.