manage_agent_partnership

Overrides Enterprise Manager's default behavior of automatically assigning partner agents to agents. A partner agent is an agent that, in addition to its other functions, is assigned to another agent as its partner in order to remotely monitor the availability of that agent and its host. A partner agent is typically in close network proximity, for example, in the same subnet, with the agent that it remotely monitors. An agent can be a partner (remote monitor) of multiple agents. An agent can only have one partner agent assigned to it.

This verb is not meant to be commonly used. It is provided to support special circumstances where an administrator might want to explicitly assign agent partnerships or exclude agents from being partners or exclude agents from being remotely monitored by other agents.

Format

Standard Mode

emcli manage_storage_access
          [-add_agent_partnership]
          [-remove_agent_partnership]
          [-enable_agent_partnership]
          [-disable_agent_partnership]
          [-partner_agent="partneragent"]
          [-monitored_agent="monitoredagent"]

Interactive or Script Mode

manage_agent_partnership(
          [add_agent_partnership=True/False]
          [,remove_agent_partnership=True/False]
          [,enable_agent_partnership=True/False]
          [,disable_agent_partnership=True/False]
          [,partner_agent="partneragent"]
          [,monitored_agent="monitoredagent"]
          )

[ ]  indicates that the parameter is optional. 

Parameters

• add_agent_partnership

  Assigns a partner agent to an agent. You must also specify the monitored_agent and partner_agent parameters.

• remove_agent_partnership

  Removes the partnership between a partner agent and the agent that it monitors. For a remotely monitored agent, to remove the relationship between itself and its partner agent, the monitored_agent parameter must be specified. The partner_agent can be optionally specified. For a partner agent to remove the relationships between itself and all agents that it remotely monitors, the partner_agent parameter must be specified. If the monitored_agent parameter is not specified, then all partnerships that the partner agent currently has will be deleted.

• disable_agent_partnership

  Prevents an agent from being a partner agent or from being a monitored agent depending on the additional parameters used. If the partner_agent parameter is used, then it prevents the specified agent from being a partner agent (remotely monitoring other agents). If the monitored_agent parameter is used, it prevents the specified agent from being remotely monitored by any agent.

• enable_agent_partnership

  Enables an agent to become a partner agent or a monitored agent based on the additional parameters used. If the partner_agent parameter is used, it enables the specified agent to be a partner agent (remotely monitor other agents). If the monitored_agent parameter is used, it enables the specified agent to be remotely monitored by another agent. Only one of these actions can be specified.

• monitored_agent

  The name of the agent that is remotely monitored by another agent. It is typically in the form

  host:port

  , for example

  myhost.example.com:1830

  .

• partner_agent

  The name of the agent that will remotely monitor the availability of another agent and its host. It is typically in the form

  host:port

  , for example m

  yhost.example.com:1830

  .

Exit Codes

0 if successful. A non-zero value indicates that verb processing was unsuccessful.

Output

Example 1

This example assigns agent2 as the partner agent for agent1:

emcli manage_agent_partnership
          -add_agent_partnership
          -monitored_agent=agent1.example.com:1830 
          -partner_agent=agent2.example.com:1833

Example 2

This example unassigns agent2 as the partner agent for agent1. If agent1 does not have a partner agent, then an exception is thrown.

emcli manage_agent_partnership
          -remove_agent_partnership
          -monitored_agent=agent1.example.com:1830
          -partner_agent=agent2.example.com:1833

Example 3

This example unassigns agent2 as the partner agent for all the agents that it remotely monitors. If agent1 is not a partner agent for any agent, then an exception is thrown.

emcli manage_agent_partnership
          -remove_agent_partnership
          -partner_agent=agent2.example.com:1833

Example 4

This example prevents agent3 from being assigned a partner agent. This means agent3 cannot be remotely monitored by another agent.

emcli manage_agent_partnership
          -disable_agent_partnership
          -monitored_agent=agent3.example.com:1830

Example 5

This example prevents agent4 from being a partner agent for any agent. This means agent4 cannot be used to remotely monitor other agents.

emcli manage_agent_partnership
          -disable_agent_partnership
          -partner_agent=agent4.example.com:1833

Example 6

This example allows agent3 to be assigned a partner agent to remotely monitor it.

emcli manage_agent_partnership
          -enable_agent_partnership
          -monitored_agent= agent3.example.com:1830

Example 7

This example allows agent4 to become a partner for other agents. This means agent4 can be used to remotely monitor other agents.

emcli manage_agent_partnership
          -enable_agent_partnership
          -partner_agent= agent4.example.com:1833