NetApp ONTAP Security icon

NetApp ONTAP Security

Manage NetApp ONTAP security settings, users, roles, and certificates

Actions34

Account → Lock

AI-generated

Summary

Lock a specified user account on a NetApp ONTAP cluster to disable access.

Inputs

  • Cluster Host (required) — Hostname or IP address of the ONTAP cluster management LIF to connect to.
  • Port — HTTPS port for the ONTAP REST API, defaults to 443.
  • Account (required) — Identifier for the user account to lock, specified by owner UUID and account name concatenated with a slash, selected via resource locator by name.
  • Options — Optional parameters including a 'Fields' string to specify a comma-separated list of fields to include in the response (use * for all).

Output shape

A single JSON object representing the locked user account or job status.

The operation returns the updated account data indicating the account is locked. If the operation triggers an asynchronous job, the node waits for completion before returning the job details. Errors are returned if the account cannot be locked or if communication fails.

Examples

Example 1: Lock a user account by specifying the ONTAP cluster host, port, and account identifier.

Set 'Cluster Host' to the ONTAP cluster address, provide the account identifier via resource locator by name, choose the 'Lock' operation on the 'Account' resource, and optionally specify response fields in 'Options'.

Links

Discussion