Develop > Command-Line Interfaces > Policy Management CLI workflows

Policy Management CLI workflows

You can use the CLIs opr-template, opr-config-tool, and opr-assign for CLI-based end-to-end policy management:

  • opr-template: to edit policies

    Download and upload policies, check the syntax (policy data and parameters), and list/delete policies.

  • opr-config-tool: to update aspects and management templates

    Show impacted aspects and management templates after having created a new policy version, and update aspects and management templates to use the latest policy version.

  • opr-assign: to update assignments

    Enable or disable an (auto-)assignment rule, update an (auto-)assignment rule, and change parameter values.

ClosedExample: deploy a specific aspect to a CI

To deploy a specific aspect to a CI, do the following:

  1. Get the ID for a specific CI:

    opr-ci-list -node_list example.company.net

    Output:

    Type: nt
    ID: 4559693cfb527b06a5444f0d0f106750
    Label: example

  2. Get the list of aspects and their versions:

    opr-config-tool -list -type aspect

    Output:

    8261d0cf-3e13-94a7-bc36-59a10c7d9dd7 “MyMonitoringAspect” 1.5

  3. Assign and deploy the aspect MyMonitoringAspect to the new CI:

    opr-assign -create_assignment_by_aspect_version -ci_id 4559693cfb527b06a5444f0d0f106750 -id 8261d0cf-3e13-94a7-bc36-59a10c7d9dd7 -parameter_value Param1=Value1

    Output:

    AspectAssignment:8261d0cf-3e13-94a7-bc36-59a10c7d9dd7: 4559693cfb527b06a5444f0d0f106750

  4. Change the policy parameter of the created assignment:

    opr-assign -update_assignment -id AspectAssignment:8261d0cf-3e13-94a7-bc36-59a10c7d9dd7:4559693cfb527b06a5444f0d0f106750 –parameter_value Param1=NewValue

ClosedExample: change the name of an existing policy (using sed) and reupload the policy with a new name

To change the name of an existing policy and reupload it, do the following:

  1. Download a policy (MyEventPolicy) for modification:

    opr-template -download -name MyEventPolicy –object_version 1.0 -output /tmp/mypolicy

    Output:

    92cd640e-289e-4043-ad23-df94baff03e6 "OprEvent" 1.0

  2. Use sed to modify the content of the files:

    sed ‘s/MyPolicyName/MyNewPolicyName/g’ /tmp/mypolicy/*

  3. Upload the modified policy from /tmp/mypolicy:

    opr-template –upload –input /tmp/mypolicy

ClosedExample: deploy an updated policy template to a specific CI

To deploy an updated policy template to a specific CI, do the following:

  1. Download a policy (MyEventPolicy) for modification:

    opr-template -download -name MyEventPolicy –object_version 1.0 -output C:\temp

    Output:

    92cd640e-289e-4043-ad23-df94baff03e6 " MyEventPolicy" 1.0

  2. Do the necessary changes in the policy body file, for example C:\temp\92cd640e-289e-4043-ad23-df94baff03e6_data

  3. Check that the syntax of the modified policy is still correct:

    opr-template –check –input C:\temp

    Output:

    INFO: Syntax check for 'OprEvent' is OK.
    Checked version 1.0 with id 92cd640e-289e-4043-ad23-df94baff03e6.

    INFO: syntax-check summary: total=1, ok=1, failed=0, ignoredStubs=0

  4. Upload the modified policy:

    opr-template -upload -input C:\temp

    Output:

    48a94f9e-35b7-4661-a9ea-1dad3497dcdf "OprEvent" 1.1

    INFO: upload summary: total=1, ok=1, failed=0, skpped=0, ignoredStubs=0

  5. Get the CI ID for a specific CI:

    opr-ci-list -node_list example.company.net

    Output:

    Type: nt
    ID: 4559693cfb527b06a5444f0d0f106750
    Label: example

  6. Assign and deploy the imported policy to example.company.net:

    opr-assign -create_assignment_by_template_version -ci_id 4559693cfb527b06a5444f0d0f106750 48a94f9e-35b7-4661-a9ea-1dad3497dcdf

    Output:

    TemplateAssignment:48a94f9e-35b7-4661-a9ea-1dad3497dcdf:4e4695241cba263baa8c8c3cff389882

ClosedExample: add policy from template group to an aspect and deploy the aspect version to a specific CI

To add a policy from a template group to an aspect and deploy the created aspect version to a specific CI, do the following:

  1. Get a list of the OSMonitoring template group's policy templates:

    opr-template –list –type tg –name OSMonitoring

    Output:

    “MyProcessMonitoring” 1.0 65b8bc83-b995-5d53-ca08-5490ec29c890

  2. Add the MyProcessMonitoring policy template to the existing aspect MyMonitoringAspect:

    opr-config-tool -create_containment -type t -name MyProcessMonitor -parent_type a -parent_name MyMonitoringAspect

    Output:

    36ad02d0-4a67-4738-a9bb-d450f72d9849 “MyMonitoringAspect” 1.1

  3. Get the node's CI ID:

    opr-ci-list -node_list example.company.net

    Output:

    Type: nt
    ID: 4559693cfb527b06a5444f0d0f106750
    Label: example

  4. Assign and deploy the new aspect version to the CI:

    opr-assign –create_assignment_by_aspect_version -ci_id 4559693cfb527b06a5444f0d0f106750 36ad02d0-4a67-4738-a9bb-d450f72d9849 –parameter_value Param1=Value1

Send Help Center feedback