Skip to main content

cluster agent connection show

Contributors
Suggest changes
PDFs

Display Cloud Agent connections

Availability: This command is available to cluster administrators at the advanced privilege level.

Description

This command displays the connections that have been established to help external managers manage the cluster.

Parameters

{ [-fields <fieldname>,…​]

If you specify the -fields <fieldname>, …​ parameter, the command output also includes the specified field or fields. You can use '-fields ?' to display the fields to specify.

| [-instance ] }

If you specify the -instance parameter, the command displays detailed information about all fields.

[-name <text>] - Name (privilege: advanced)

Selects the connections that match the supplied name.

[-uuid <UUID>] - UUID (privilege: advanced)

Selects the connections that match the supplied UUID.

[-destination <text>] - Destination URL (privilege: advanced)

Selects the connections that match the supplied destination.

[-state {connecting|connected|error|disabled|partial|static}] - State (privilege: advanced)

Selects the connections that match the supplied state. The state can have one of the following values:

  • connecting - The agent is in the process of establishing the connection.

  • connected - The connection is up and active.

  • error - The connection is down due to a problem. See error-message and error-time for details.

  • disabled - The connection has been administratively disabled.

  • partial - The connection has been partially established and is not ready to deliver messages.

  • static - The agent is of static instance type and does not require an external connection.

[-use-proxy {true|false}] - Use Proxy (privilege: advanced)

Establish this connection through an HTTP proxy server associated with this connection's IPspace

[-subscribe-address <text>] - Subscribe Address (privilege: advanced)

AMQP address to which ONTAP will subscribe. Defaults to "ontap.agent.manager".

[-publish-address <text>] - Publish Address (privilege: advanced)

AMQP address to which ONTAP will publish. Defaults to "ontap.agent.cluster".

[-certificate-uuid <UUID>] - Authentication Certificate UUID (privilege: advanced)

Selects the connections that match the supplied certificate UUID.

[-csr-url <text>] - Authentication CSR URL (privilege: advanced)

URL to send certicate signing request (CSR) that will be used for authenticating with the destination.

[-manager-token <text>] - Manager Token (privilege: advanced)

Selects the connections that match the supplied manager token.

[-ipspace <IPspace>] - IPspace for Connection (privilege: advanced)

The IPspace to use for the connection

[-error-code <integer>] - Last Error Code (privilege: advanced)

Selects the connections that match the supplied error code.

[-error-message <text>] - Last Error Message (privilege: advanced)

Selects the connections that match the supplied error message.

[-error-time <MM/DD/YYYY HH:MM:SS>] - Last Error Time (privilege: advanced)

Selects the connections that match the supplied error time.

[-node <nodename>] - Node Owning the Connection (privilege: advanced)

The node owning the connection

[-msg-recv-total <integer>] - Total Messages Received from Manager (privilege: advanced)

Total messages received from manager

[-msg-recv-manifest <integer>] - Total Manifest Messages Received from Manager (privilege: advanced)

Total manifest messages received from manager

[-msg-recv-baseline-request <integer>] - Total baseline.request Messages Received from Manager (privilege: advanced)

Total baseline.request messages received from manager

[-msg-recv-counters-request <integer>] - Total counters.request Messages Received from Manager (privilege: advanced)

Total counters.request messages received from manager

[-msg-recv-connection-status <integer>] - Total Connection Status Messages Received from Manager (privilege: advanced)

Total connection status messages received from manager

[-msg-recv-connection-modify <integer>] - Total Connection Modify Messages Received from Manager (privilege: advanced)

Total connection modify messages received from manager

[-msg-recv-agent-status <integer>] - Total agent.status.request Messages Received from Manager (privilege: advanced)

Total agent.status.request Messages received from Manager

[-msg-recv-subscription-create <integer>] - Total Subscription Create Messages Received from Manager (privilege: advanced)

Total subscription create messages received from manager

[-msg-recv-subscription-delete <integer>] - Total Subscription Delete Messages Received from Manager (privilege: advanced)

Total subscription delete messages received from manager

[-msg-recv-unknown <integer>] - Total Unknown Messages Received from Manager (privilege: advanced)

Total unknown messages received from manager

[-msg-send-total <integer>] - Total Messages Sent to Manager (privilege: advanced)

Total messages sent to manager

[-msg-send-manifest-request <integer>] - Total manifest.request Messages Sent to Manager (privilege: advanced)

Total manifest.request messages sent to manager

[-msg-send-baseline <integer>] - Total Baseline Messages Sent to Manager (privilege: advanced)

Total baseline messages sent to manager

[-msg-send-counters <integer>] - Total Counters Messages Sent to Manager (privilege: advanced)

Total counters messages sent to manager

[-msg-send-connection-status <integer>] - Total Connection Status Messages Sent to Manager (privilege: advanced)

Total connection status messages sent to manager

[-msg-send-subscription-status <integer>] - Total Subscription Status Messages Sent to Manager (privilege: advanced)

Total subscription status messages received from manager

[-msg-send-errors <integer>] - Total Error Messages Sent to Manager (privilege: advanced)

Total error messages sent to manager

[-msg-delivery-errors <integer>] - Total Errors Encountered Attempting to Send/receive (privilege: advanced)

Total errors encountered attempting to send/receive

[-msg-send-topicrelay <integer>] - Total ONTAP PubSub Topic Messages Sent to Manager (privilege: advanced)

Total ONTAP PubSub Topic messages sent to manager

[-msg-send-agent-status-details <integer>] - Total agent.status Messages Sent to Manager (privilege: advanced)

Total agent.status Messages sent to Manager

[-msg-connection-total <integer>] - Total Connection Attempts (privilege: advanced)

Total connection attempts

[-msg-connection-errors <integer>] - Total Connection Errors (privilege: advanced)

Total connection errors

[-msg-transport-errors <integer>] - Total Transport Errors (privilege: advanced)

Total transport errors

[-application <text>] - Client Application (privilege: advanced)

Selects the connections that match the supplied application.

[-application-url <text>] - Application URL (privilege: advanced)

Selects the connections that match the supplied application URL.

[-idle-timeout <integer>] - Idle Timeout (in seconds) (privilege: advanced)

AMQP idle timeout. Defaults to 0. If set, the local peer will disconnect if it does not receive AMQP frames within the timeout.

[-address-family {unknown|ipv4|ipv6}] - Address Family (privilege: advanced)

Specify address family.

[-auto-delete-error-minutes {<integer>|-}] - Time to Auto-delete when disconnected (in minutes) (privilege: advanced)

Specify time to live in minutes for cloud agent connection in error state. Connection will be deleted if it stays in error state beyond this time.

Examples

cluster-1::> cluster agent connection show
Name          Destination                   State      Application    Use Proxy
------------- ----------------------------- ---------- -------------- ---------
cloudinsights amqpws://172.31.50.251        connected  Cloud Insights false