Example use case scenarios to create a staging policy

Attributes

Description

agentSelectionCriteria

Set of conditions based on which the agents are identified to apply the policy

The syntax is  "agentIdentifier operator \"value\""
where,

• agentIdentifier refers to the agent attributes, based on which the agent is identified. The supported identifiers are as follows:
  
  • agentName—Host name of the computer on which the BMC PATROL Agent is installed
  • agentPort—Port number through which the Integration Service connects with the agent
  • agentVersion—Version of the BMC PATROL Agent
  • agentOS—Operating system of the computer on which the BMC PATROL Agent is installed
  • agentIP—IP address of the computer on which the BMC PATROL Agent is installed
  • agentTag—Tag name of the BMC PATROL Agent
  • integrationService—Display name of the Integration Service
  • childServer—Host name of the Child Server that is registered with Central Monitoring Administration

• operator refers to the condition that relates the agent identifier and its value. The supported operators vary according to the agent identifiers. For the list of the supported operators, see Supported-operators-for-the-agentSelectionCriteria-parameter.
• value refers to the string value to search

precedence

Priority for the policy. The supported values are numbers between 0 and 999 with 999 being the lowest priority and 0 being the top priority. 

The default value is 999.

tenant

Details of the tenant who owns the policy. You can either provide name or the id of the tenant.

name

Name of the tenant who owns the policy. The supported values are as follows:

• <nameOfTenant>—Indicates that the policy is applicable to the specified tenant
• GLOBAL—Indicates that the policy is applicable to all agents
• PROVIDER—Indicates that the policy is applicable to the cloud service provider and also to the agents that do not have any tenants

enabled

Indicates whether the policy is enabled. The default value is true.

name

Name of the policy

type

Type of the policy. The supported types are as follows:

• blackout
• monitoring
• staging

description

Brief description about the policy

integrationService

Display name of the Integration Service(IS) that assists the Agent to communicate to the Infrastructure Management Server. This should be an existing IS/cluster. Ensure that the IS is created before calling the API.

integrationService: type

The type of the integration service. The values can be IS or cluster.

integrationService: name

Name of the IS or IS cluster.

enabled

Specifies whether the policy is enabled. The supported values are as follows:

• true
• false

The default value is true.

associatedUserGroup

Name of the user group with which you want to associate the policy