Skip to Content
Information
Unsupported content This version of the product has reached end of support. The documentation is available for your convenience. However, you must be logged in to access it. You will not be able to leave comments.

policy

add

Use policy-add from the command line to create a service health policy.

Command-line syntax
clm policy-add [-h] [--waitfor TIME_OUT_SECONDS] --policytype NAME --tagsourcename NAME --taggroupname NAME

Use policy_add in the API to create a service health policy. This command returns a Policy  API object with the same attributes and relationships.

API syntax
obj = policy_add(gcac, policyType=None, tagSourceName=None, tagGroupName=None)

obj.tagsource # returns the tag source for the policy
obj.taggroup # returns the tag group for the policy
obj.match # returns the match for the policy

Command-line argument

API parameter

Description

Required?

--policytype
policyType

Name of the service health policy to create.

Yes

--tagsourcename
tagSourceName

Name of the tag source of the policy.

Yes

--taggroupname
tagGroupName

Name of the group of the policy.

Yes

--waitfor

 

Time in seconds to wait for a response from the server, otherwise return running task details.

 

 

gcac

GenericCloudAPIClient instance/user authentication.

 

delete

Use policy-delete from the command line to delete the specified service health policy.

Command-line syntax
clm policy-delete [-h] [--waitfor TIME_OUT_SECONDS] --policytype NAME --tagsourcename NAME --taggroupname NAME

Use policy_delete in the API to delete the specified service health policy. This command returns a Policy  API object with the same attributes and relationships.

API syntax
obj = policy_delete(gcac, policyType=None, tagSourceName=None, tagGroupName=None)

obj.tagsource # returns the tag source for the policy
obj.taggroup # returns the tag group for the policy
obj.match # returns the match for the policy

Command-line argument

API parameter

Description

Required?

--policytype
policyType

Name of the service health policy to delete.

Yes

--tagsourcename
tagSourceName

Name of the tag source of the policy.

Yes

--taggroupname
tagGroupName

Name of the group of the policy.

Yes

--waitfor

 

Time in seconds to wait for a response from the server, otherwise return running task details.

 

 

gcac

GenericCloudAPIClient instance/user authentication.

 

list

Use policy-list from the command line to list available service health policies with their tag sources and tag groups.

Command-line syntax
clm policy-list [-h] --policytype NAME

Use policy_list in the API to list available service health policies with their tag sources and tag groups. This command returns a list of Policy API objects with the same attributes and relationships.

API syntax
obj = policy_list(gcac, policyType=None)

obj.tagsource # returns the tag source for the policy
obj.taggroup # returns the tag group for the policy
obj.match # returns the match for the policy

Command-line argument

API parameter

Description

Required?

--policytype
policyType

Name of the policy type to list.

Yes

 

gcac

GenericCloudAPIClient instance/user authentication.

 

update

Use policy-update from the command line to enable or disable the specified service health policy rule.

Command-line syntax
clm policy-update [-h] [--waitfor TIME_OUT_SECONDS] --policytype NAME [--tagsourcename NAME]
[--taggroupname NAME] [--newtaggroupname NAME] [--match NAME]

Use policy_update in the API to enable or disable the specified service health policy rule. This command returns a Policy  API object with the same attributes and relationships.

API syntax
obj = policy_update(gcac, policyType=None, tagSourceName=None, tagGroupName=None, newTagGroupName=None,
matchValue=None)

obj.tagsource # returns the tag source for the policy
obj.taggroup # returns the tag group for the policy
obj.match # returns the match for the policy

Command-line argument

API parameter

Description

Required?

--policytype
policyType

Name of the policy type to update.

Yes

--tagsourcename
tagSourceName

Name of the tag source of the policy.

 

--taggroupname
tagGroupName

Name of the group of the policy.

 

--newtaggroupname
newTagGroupName

Name of the new group for the policy.

 

--match
matchValue

Criteria for applying the update. Use all to match all policies. Use any to match any one policy.

 

--waitfor

 

Time in seconds to wait for a response from the server, otherwise return running task details.

 

 

gcac

GenericCloudAPIClient instance/user authentication.

 

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*

BMC Cloud Lifecycle Management 4.5