Views:

List all agents

clish agent show
Purpose: Displays the list of all registered agents or detailed information about a specific agent List All Agents clish agent show 
Agent Name  Hostname  State       Attrs             Version
----------  --------  ----------  ----------------  -------
demo-1      -         running     C:Y K:OK H:✓      v1.0.0
demo-2      -         onboarding  C:N K:MISS H:✓    v1.0.0
page 1/1
Attributes Explanation:
  • C: Connection State (Y=Connected, N=Disconnected, ?=Unknown)
  • K: Credential State (OK=Configured, MISS=Missing/Invalid, ?=Unknown)
  • H: Health Status (✓=Healthy, ✗=Unhealthy, ?=Unknown)
Show specific agent details:
clish agent show --instance <agent-name>
Example:
clish agent show --instance demo-1
Example Output:
Agent Name       : demo-1
Agent ID         : f461e289-c396-4f5b-8119-bea0a697d513
Device Hostname  : -
State            : running
Health           : healthy
ONTAP Connected  : connected
Credential       : configured
Log Level        : info
Quarantine       : disabled
Agent Version    : v1.0.0
Last Seen        : -
Reason           : -
Available Flags:
  • --instance <name>: Show details for specific agent
  • --page <number>: Page number for agent list (default: 1)

Create an agent instance

clish agent create
Purpose: Create a new agent instance
clish agent create --name <agent-name>
Example:
clish agent create --name demo-3
Example Output:
Agent 'demo03' created successfully with ID: f461e289-c396-4f5b-8119-bea0a697d513
Requirements:
  • Agent name must match pattern: ^[a-zA-Z0-9_-]{1,20}$. This mean that it must less then 20 characters, and contain only alpha-numeric characters and the following special characters: ^[]-_{}$
  • Name must be unique across all agents

Create an onboarding token

clish agent onboarding-token issue
Purpose: Generate an onboarding token for agent registration
clish agent onboarding-token issue --instance <agent-name>
Example:
clish agent onboarding-token issue --instance demo-1
Example Output:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fweJf36POk6yJV_adQssw5c
Usage Notes
  • Token is required for agent initial connection
  • Token has limited validity period
  • Agent must use this token for WebSocket connection establishment

Update ONTAP SVM credentials

clish agent credential modify
Purpose: Update ONTAP SVM credentials for an agent
clish agent credential modify --instance <agent-name>
Example:
clish agent credential modify --instance demo-1
# Interactive prompts: 
# username: admin 
# password: [hidden input]
Example Output:
Credentials updated successfully
Security Notes
  • Password input is hidden during entry
  • Credentials are stored in Kubernetes Secrets
  • Only affects the specified agent instanc

Display agent log levels

clish agent loglevel show
Purpose: Display current log level for an agent
clish agent loglevel show --instance <agent-name>
Example:
clish agent loglevel show --instance demo-1
Example Output:
Log Level for demo-1 : info

Modify agent log level

clish agent loglevel modify
Purpose: Change log level for an agent
clish agent loglevel modify --instance <agent-name> --loglevel <level>
Example:
clish agent loglevel modify --instance demo-1 --loglevel debug
Example Output:
Log level for demo-1 set to debug
Available Log Levels
  • info: Standard operational logging
  • warning: Warning and error messages only
  • error: Error messages only

Display quarantine settings

clish agent quarantine show
Purpose: Display quarantine settings for an agent
clish agent quarantine show --instance <agent-name>
Example:
clish agent quarantine show --instance demo-1
Example Output:
Quarantine for demo-1 : disabled

Modify quarantine functionality

clish agent quarantine modify
Purpose: Enable or disable quarantine functionality for an agent
clish agent quarantine modify --instance <agent-name> --enabled <true|false>
Examples:
# Enable quarantine
clish agent quarantine modify --instance demo-1 --enabled true

# Disable quarantine  
clish agent quarantine modify --instance demo-1 --enabled false
Example Output:
Quarantine for demo-1 set to enabled