Usage
opcli - CLI interface
opcli [-h]
{getalerts,postalerts,webhookalerts,getincidents,syncincidentfromdatasource,getresources,importresources,addpropasmetriclabel,exportservicemaps,importservicemaps,cloneservicemaps,transformsvcmap,getservicemaps,getchildsvcgroups,getservicegroup,exportcustattrfile,importcustattrfile,getcustomattrs,importfromdatasource,customattrmetriclabel,getdiscoprofile,getalertesc,migratealertesc,getdevmgtpol,gettemplates,clonetemplates,metricsql,setbaselinethreshold,getintegrations,importintegrations,addazurearmintegration,addazureasmintegration,addkubernetesintegration}
...
opcli options
opcli getalerts
Search for and take action on alerts
opcli getalerts [-h] [--env ENV] [--envfile ENVFILE] [--url URL] [--client_id KEY] [--client_secret SCRT] [--tenant TENANT] [--partner PARTNER] [--secure SECURE]
[--loglevel {DEBUG,INFO,WARNING,ERROR,CRITICAL}] [--query QUERY] [--brief] [--descr] [--count] [--filter FILTER] [--action ACTION] [--heal]
opcli getalerts options
--queryQUERY- Query String to filter alerts as per https://develop.opsramp.com/resource-management/tenants-tenantid-resources-search (default:startDate:2026-03-20T13:44:30 0000)--brief- Include only key fields in output--descr- Include the description field in results (runs much slower as it requires a separate api call per alert)--count- Only show the count of matching alerts--filterFILTER- Post-query filter on alerts. Python expression that will evaluate to True or False such as alert["resource"]["name"].startswith("prod")--actionACTION- Perform an action on matching alerts (Heal, acknowledge, suppress, close, unsuppress, unAcknowledge)--heal- Heal the matching alerts (i.e. send a matching Ok)
opcli getalerts Specify credentials via YAML file
opcli getalerts Specify credentials via command line
--urlURL- OpsRamp API URL--client_idKEY- OpsRamp API Key--client_secretSCRT- OpsRamp API Secret--tenantTENANT- OpsRamp tenant ID--partnerPARTNER- OpsRamp partner ID (usually unnecessary - only needed for partner-level API calls)
opcli getalerts Other common options
--secureSECURE- Whether or not to verify SSL cert (default:True)--loglevelLOGLEVEL- Set the logging level (default:INFO)
opcli postalerts
Post alerts using the Alerts API
opcli postalerts [-h] [--env ENV] [--envfile ENVFILE] [--url URL] [--client_id KEY] [--client_secret SCRT] [--tenant TENANT] [--partner PARTNER] [--secure SECURE]
[--loglevel {DEBUG,INFO,WARNING,ERROR,CRITICAL}] [--infile INFILE] [--range RANGE] [--subject SUBJECT] [--state {Critical,Warning,Info,Ok}] [--metric METRIC]
[--resource RESOURCE] [--comp COMP] [--desc DESC] [--source SOURCE] [--prob PROB] [--client CLIENT] [--custom NAME VALUE]
opcli postalerts options
opcli postalerts Specify credentials via YAML file
opcli postalerts Specify credentials via command line
--urlURL- OpsRamp API URL--client_idKEY- OpsRamp API Key--client_secretSCRT- OpsRamp API Secret--tenantTENANT- OpsRamp tenant ID--partnerPARTNER- OpsRamp partner ID (usually unnecessary - only needed for partner-level API calls)
opcli postalerts Other common options
--secureSECURE- Whether or not to verify SSL cert (default:True)--loglevelLOGLEVEL- Set the logging level (default:INFO)
opcli postalerts Post alerts using alert content from a json file
opcli postalerts Post an alert using alert content from the command line
--subjectSUBJECT- Alert Subject--stateSTATE- Alert Current State--metricMETRIC- Alert metric--resourceRESOURCE- Alert Resource name--compCOMP- Alert Component name--descDESC- Alert Description--sourceSOURCE- Alert Source name--probPROB- Alert Problem Area--clientCLIENT- Alert Client ID (only required if posting with a partner-level tenant--customNAME VALUE- Alert custom attribute name and value (can repeat this option for multiple custom attributes)
opcli webhookalerts
Post alerts to a Webhook integration
opcli webhookalerts [-h] [--url URL] [--tenant TENANT] [--vtoken VTOKEN] --infile INFILE [--range RANGE] [--secure SECURE]
opcli webhookalerts options
--urlURL- OpsRamp API URL--tenantTENANT- OpsRamp tenant ID--vtokenVTOKEN- OpsRamp integration webhook token--infileINFILE- File containing an array of json alert payloads--rangeRANGE- An integer or range identifying which alert in the file to send (default:all)--secureSECURE- Whether or not to verify SSL cert (default:True)
opcli getincidents
Search and take action on Incidents
opcli getincidents [-h] [--env ENV] [--envfile ENVFILE] [--url URL] [--client_id KEY] [--client_secret SCRT] [--tenant TENANT] [--partner PARTNER] [--secure SECURE]
[--loglevel {DEBUG,INFO,WARNING,ERROR,CRITICAL}] --query QUERY [--brief] [--details] [--count] [--filter FILTER] [--resolve]
opcli getincidents options
--queryQUERY- Query String to filter incidents--brief- Include only key fields in output--details- Get the full details for all matched incidents - this will include custom field values--count- Only show the count of matching incidents--filterFILTER- Post-query filter on incidents. Python expression that will evaluate to True or False such as incident["resource"]["name"].startswith("prod")--resolve- Resolve the matching incidents
opcli getincidents Specify credentials via YAML file
opcli getincidents Specify credentials via command line
--urlURL- OpsRamp API URL--client_idKEY- OpsRamp API Key--client_secretSCRT- OpsRamp API Secret--tenantTENANT- OpsRamp tenant ID--partnerPARTNER- OpsRamp partner ID (usually unnecessary - only needed for partner-level API calls)
opcli getincidents Other common options
--secureSECURE- Whether or not to verify SSL cert (default:True)--loglevelLOGLEVEL- Set the logging level (default:INFO)
opcli syncincidentfromdatasource
Sync incident status from a data source.
opcli syncincidentfromdatasource [-h] [--env ENV] [--envfile ENVFILE] [--url URL] [--client_id KEY] [--client_secret SCRT] [--tenant TENANT] [--partner PARTNER] [--secure SECURE]
[--loglevel {DEBUG,INFO,WARNING,ERROR,CRITICAL}] --job JOB
opcli syncincidentfromdatasource options
opcli syncincidentfromdatasource Specify credentials via YAML file
opcli syncincidentfromdatasource Specify credentials via command line
--urlURL- OpsRamp API URL--client_idKEY- OpsRamp API Key--client_secretSCRT- OpsRamp API Secret--tenantTENANT- OpsRamp tenant ID--partnerPARTNER- OpsRamp partner ID (usually unnecessary - only needed for partner-level API calls)
opcli syncincidentfromdatasource Other common options
--secureSECURE- Whether or not to verify SSL cert (default:True)--loglevelLOGLEVEL- Set the logging level (default:INFO)
opcli getresources
Search for and take action on resources/devices
opcli getresources [-h] [--env ENV] [--envfile ENVFILE] [--url URL] [--client_id KEY] [--client_secret SCRT] [--tenant TENANT] [--partner PARTNER] [--secure SECURE]
[--loglevel {DEBUG,INFO,WARNING,ERROR,CRITICAL}] [--query QUERY] [--search SEARCH] [--count] [--delete] [--manage] [--filter FILTER]
opcli getresources options
--queryQUERY- Query String to filter resources as per https://develop.opsramp.com/resource-management/tenants-tenantid-resources-search--searchSEARCH- Search String to filter resources as it would be entered under Resources -> Search--count- Only show the count of matching resources--delete- Delete the matching resources--manage- Manage the matching resources--filterFILTER- Post-query filter on resources. Python expression that will evaluate to True or False such as alert["resource"]["name"].startswith("prod")
opcli getresources Specify credentials via YAML file
opcli getresources Specify credentials via command line
--urlURL- OpsRamp API URL--client_idKEY- OpsRamp API Key--client_secretSCRT- OpsRamp API Secret--tenantTENANT- OpsRamp tenant ID--partnerPARTNER- OpsRamp partner ID (usually unnecessary - only needed for partner-level API calls)
opcli getresources Other common options
--secureSECURE- Whether or not to verify SSL cert (default:True)--loglevelLOGLEVEL- Set the logging level (default:INFO)
opcli importresources
Import resources from a spreadsheet. Custom attr field names should be prefixed with “tag.” and the custom attribute names should be created in advance via the UI. Any resource with an Action Processing column value of Delete will be deleted.
opcli importresources [-h] [--env ENV] [--envfile ENVFILE] [--url URL] [--client_id KEY] [--client_secret SCRT] [--tenant TENANT] [--partner PARTNER] [--secure SECURE]
[--loglevel {DEBUG,INFO,WARNING,ERROR,CRITICAL}] [--commit] [--addnames] [--addvalues] [--writeblanks] [--filename FILENAME] [--nocreate]
opcli importresources options
--commit- Make the actual updates on the platform. If not specified, only error checking and import simulation will occur.--addnames- If new tag/custattr names are found in the data source, add the definitions on the fly. Otherwise new tag names will be considered an error.--addvalues- If new values are found in the spreadsheet, add the value definitions on the fly. Otherwise new values will be considered an error.--writeblanks- When no value is provided in the spreadsheet for a resource, remove any existing value for that resource on the platform. If not specified then no action is taken for empty values.--filenameFILENAME- Name of excel file to import (.xlsx extension will be added if not specified.)--nocreate- Don’t create new resources.
opcli importresources Specify credentials via YAML file
opcli importresources Specify credentials via command line
--urlURL- OpsRamp API URL--client_idKEY- OpsRamp API Key--client_secretSCRT- OpsRamp API Secret--tenantTENANT- OpsRamp tenant ID--partnerPARTNER- OpsRamp partner ID (usually unnecessary - only needed for partner-level API calls)
opcli importresources Other common options
--secureSECURE- Whether or not to verify SSL cert (default:True)--loglevelLOGLEVEL- Set the logging level (default:INFO)
opcli addpropasmetriclabel
Add a resource property as a custom attribute value of the matched resources, with metric label option selected
opcli addpropasmetriclabel [-h] [--env ENV] [--envfile ENVFILE] [--url URL] [--client_id KEY] [--client_secret SCRT] [--tenant TENANT] [--partner PARTNER] [--secure SECURE]
[--loglevel {DEBUG,INFO,WARNING,ERROR,CRITICAL}] [--query QUERY] [--property PROPERTY] --custattrname CUSTATTRNAME
opcli addpropasmetriclabel options
--queryQUERY- Query String to filter resources as per https://develop.opsramp.com/resource-management/tenants-tenantid-resources-search--propertyPROPERTY- Resource property in dot notation to be with values to be added as a custattr values, for example attributes.accountName (Must be in content returned by getresources)--custattrnameCUSTATTRNAME- Custom attribute name - must already be existing (i.e. defined via UI.). This command only adds new values to it if needed.
opcli addpropasmetriclabel Specify credentials via YAML file
opcli addpropasmetriclabel Specify credentials via command line
--urlURL- OpsRamp API URL--client_idKEY- OpsRamp API Key--client_secretSCRT- OpsRamp API Secret--tenantTENANT- OpsRamp tenant ID--partnerPARTNER- OpsRamp partner ID (usually unnecessary - only needed for partner-level API calls)
opcli addpropasmetriclabel Other common options
--secureSECURE- Whether or not to verify SSL cert (default:True)--loglevelLOGLEVEL- Set the logging level (default:INFO)
opcli exportservicemaps
Export one or more full Service Map definitions to a file which can be manipulated and re-imported
opcli exportservicemaps [-h] [--env ENV] [--envfile ENVFILE] [--url URL] [--client_id KEY] [--client_secret SCRT] [--tenant TENANT] [--partner PARTNER] [--secure SECURE]
[--loglevel {DEBUG,INFO,WARNING,ERROR,CRITICAL}] [--name NAME] [--outdir OUTDIR] [--clobber] [--timestamp]
opcli exportservicemaps options
--nameNAME- Name of the root level Service Map/Group (export all if not specified)--outdirOUTDIR- Directory path where export will be saved (default:.)--clobber- Remove/overwrite prior exports of same maps--timestamp- Include a timestamp in the Service Map dir name
opcli exportservicemaps Specify credentials via YAML file
opcli exportservicemaps Specify credentials via command line
--urlURL- OpsRamp API URL--client_idKEY- OpsRamp API Key--client_secretSCRT- OpsRamp API Secret--tenantTENANT- OpsRamp tenant ID--partnerPARTNER- OpsRamp partner ID (usually unnecessary - only needed for partner-level API calls)
opcli exportservicemaps Other common options
--secureSECURE- Whether or not to verify SSL cert (default:True)--loglevelLOGLEVEL- Set the logging level (default:INFO)
opcli importservicemaps
Import (and optionally transform while doing so) from a Service Map export file
opcli importservicemaps [-h] [--env ENV] [--envfile ENVFILE] [--url URL] [--client_id KEY] [--client_secret SCRT] [--tenant TENANT] [--partner PARTNER] [--secure SECURE]
[--loglevel {DEBUG,INFO,WARNING,ERROR,CRITICAL}] --src SRC [--replace REGEX REPLACEWITH] [--parentlink] [--clobber]
opcli importservicemaps options
--srcSRC- Source: Path to the export file of a Service Map--replaceREGEX REPLACEWITH- Transforming regex pattern and replacement string (option can be repeated)--parentlink- If root Service has a link to a parent, link the imported Service Map--clobber- Overwrite Service Map (i.e. with same name) if it already exists
opcli importservicemaps Specify credentials via YAML file
opcli importservicemaps Specify credentials via command line
--urlURL- OpsRamp API URL--client_idKEY- OpsRamp API Key--client_secretSCRT- OpsRamp API Secret--tenantTENANT- OpsRamp tenant ID--partnerPARTNER- OpsRamp partner ID (usually unnecessary - only needed for partner-level API calls)
opcli importservicemaps Other common options
--secureSECURE- Whether or not to verify SSL cert (default:True)--loglevelLOGLEVEL- Set the logging level (default:INFO)
opcli cloneservicemaps
Copy an existing Service Map, with transformations/replacements (useful when you have a template Service Map to re-use)
opcli cloneservicemaps [-h] [--env ENV] [--envfile ENVFILE] [--url URL] [--client_id KEY] [--client_secret SCRT] [--tenant TENANT] [--partner PARTNER] [--secure SECURE]
[--loglevel {DEBUG,INFO,WARNING,ERROR,CRITICAL}] --name NAME --replace REGEX REPLACEWITH [--parentlink] [--clobber]
opcli cloneservicemaps options
--nameNAME- Name of Service Map to transform and clone--replaceREGEX REPLACEWITH- Transforming regex pattern and replacement string (option can be repeated)--parentlink- If root Service has a link to a parent, link the imported Service Map--clobber- Overwrite Service Map (i.e. with same name) if it already exists
opcli cloneservicemaps Specify credentials via YAML file
opcli cloneservicemaps Specify credentials via command line
--urlURL- OpsRamp API URL--client_idKEY- OpsRamp API Key--client_secretSCRT- OpsRamp API Secret--tenantTENANT- OpsRamp tenant ID--partnerPARTNER- OpsRamp partner ID (usually unnecessary - only needed for partner-level API calls)
opcli cloneservicemaps Other common options
--secureSECURE- Whether or not to verify SSL cert (default:True)--loglevelLOGLEVEL- Set the logging level (default:INFO)
opcli transformsvcmap
Apply regex replacements to an exported Service Map and create a new transformed export file with the changes
opcli transformsvcmap [-h] --replace REGEX REPLACEWITH [--clobber] src dest
opcli transformsvcmap positional arguments
opcli transformsvcmap options
opcli getservicemaps
Get Service Map definitions
opcli getservicemaps [-h] [--env ENV] [--envfile ENVFILE] [--url URL] [--client_id KEY] [--client_secret SCRT] [--tenant TENANT] [--partner PARTNER] [--secure SECURE]
[--loglevel {DEBUG,INFO,WARNING,ERROR,CRITICAL}]
opcli getservicemaps options
opcli getservicemaps Specify credentials via YAML file
opcli getservicemaps Specify credentials via command line
--urlURL- OpsRamp API URL--client_idKEY- OpsRamp API Key--client_secretSCRT- OpsRamp API Secret--tenantTENANT- OpsRamp tenant ID--partnerPARTNER- OpsRamp partner ID (usually unnecessary - only needed for partner-level API calls)
opcli getservicemaps Other common options
--secureSECURE- Whether or not to verify SSL cert (default:True)--loglevelLOGLEVEL- Set the logging level (default:INFO)
opcli getchildsvcgroups
Get child Service Groups of a parent Service
opcli getchildsvcgroups [-h] [--env ENV] [--envfile ENVFILE] [--url URL] [--client_id KEY] [--client_secret SCRT] [--tenant TENANT] [--partner PARTNER] [--secure SECURE]
[--loglevel {DEBUG,INFO,WARNING,ERROR,CRITICAL}] --parent PARENT
opcli getchildsvcgroups options
opcli getchildsvcgroups Specify credentials via YAML file
opcli getchildsvcgroups Specify credentials via command line
--urlURL- OpsRamp API URL--client_idKEY- OpsRamp API Key--client_secretSCRT- OpsRamp API Secret--tenantTENANT- OpsRamp tenant ID--partnerPARTNER- OpsRamp partner ID (usually unnecessary - only needed for partner-level API calls)
opcli getchildsvcgroups Other common options
--secureSECURE- Whether or not to verify SSL cert (default:True)--loglevelLOGLEVEL- Set the logging level (default:INFO)
opcli getservicegroup
Get the full definition of a Service Group
opcli getservicegroup [-h] [--env ENV] [--envfile ENVFILE] [--url URL] [--client_id KEY] [--client_secret SCRT] [--tenant TENANT] [--partner PARTNER] [--secure SECURE]
[--loglevel {DEBUG,INFO,WARNING,ERROR,CRITICAL}] --id ID
opcli getservicegroup options
opcli getservicegroup Specify credentials via YAML file
opcli getservicegroup Specify credentials via command line
--urlURL- OpsRamp API URL--client_idKEY- OpsRamp API Key--client_secretSCRT- OpsRamp API Secret--tenantTENANT- OpsRamp tenant ID--partnerPARTNER- OpsRamp partner ID (usually unnecessary - only needed for partner-level API calls)
opcli getservicegroup Other common options
--secureSECURE- Whether or not to verify SSL cert (default:True)--loglevelLOGLEVEL- Set the logging level (default:INFO)
opcli exportcustattrfile
Generate an Excel or csv file from existing custom attribute values
opcli exportcustattrfile [-h] [--env ENV] [--envfile ENVFILE] [--url URL] [--client_id KEY] [--client_secret SCRT] [--tenant TENANT] [--partner PARTNER] [--secure SECURE]
[--loglevel {DEBUG,INFO,WARNING,ERROR,CRITICAL}] [--query QUERY] [--search SEARCH] [--filter FILTER] [--filename FILENAME] [--attrs ATTRS] [--props PROPS]
opcli exportcustattrfile options
--queryQUERY- Query String to filter resources as per https://develop.opsramp.com/resource-management/tenants-tenantid-resources-search--searchSEARCH- Search String to filter resources as it would be entered under Resources -> Search--filterFILTER- Post-query filter on resources. Python expression that will evaluate to True or False such as alert["resource"]["name"].startswith("prod")--filenameFILENAME- Name of excel file to generate (.xlsx extension will be added)--attrsATTRS- Comma separated list of Custom Attribute names to include (no custom attrs will be exported if not specified)--propsPROPS- Comma separated list of Resource Properties to include (Use dot-walk notation based on getresources json payload)
opcli exportcustattrfile Specify credentials via YAML file
opcli exportcustattrfile Specify credentials via command line
--urlURL- OpsRamp API URL--client_idKEY- OpsRamp API Key--client_secretSCRT- OpsRamp API Secret--tenantTENANT- OpsRamp tenant ID--partnerPARTNER- OpsRamp partner ID (usually unnecessary - only needed for partner-level API calls)
opcli exportcustattrfile Other common options
--secureSECURE- Whether or not to verify SSL cert (default:True)--loglevelLOGLEVEL- Set the logging level (default:INFO)
opcli importcustattrfile
Import an Excel file containing custom attribute values
opcli importcustattrfile [-h] [--env ENV] [--envfile ENVFILE] [--url URL] [--client_id KEY] [--client_secret SCRT] [--tenant TENANT] [--partner PARTNER] [--secure SECURE]
[--loglevel {DEBUG,INFO,WARNING,ERROR,CRITICAL}] [--commit] [--addnames] [--addvalues] [--writeblanks] [--filename FILENAME]
opcli importcustattrfile options
--commit- Make the actual updates on the platform. If not specified, only error checking and import simulation will occur.--addnames- If new tag/custattr names are found in the data source, add the definitions on the fly. Otherwise new tag names will be considered an error.--addvalues- If new values are found in the spreadsheet, add the value definitions on the fly. Otherwise new values will be considered an error.--writeblanks- When no value is provided in the spreadsheet for a resource, remove any existing value for that resource on the platform. If not specified then no action is taken for empty values.--filenameFILENAME- Name of excel file to import (.xlsx extension will be added if not specified.)
opcli importcustattrfile Specify credentials via YAML file
opcli importcustattrfile Specify credentials via command line
--urlURL- OpsRamp API URL--client_idKEY- OpsRamp API Key--client_secretSCRT- OpsRamp API Secret--tenantTENANT- OpsRamp tenant ID--partnerPARTNER- OpsRamp partner ID (usually unnecessary - only needed for partner-level API calls)
opcli importcustattrfile Other common options
--secureSECURE- Whether or not to verify SSL cert (default:True)--loglevelLOGLEVEL- Set the logging level (default:INFO)
opcli getcustomattrs
Get custom attribute definitions
opcli getcustomattrs [-h] [--env ENV] [--envfile ENVFILE] [--url URL] [--client_id KEY] [--client_secret SCRT] [--tenant TENANT] [--partner PARTNER] [--secure SECURE]
[--loglevel {DEBUG,INFO,WARNING,ERROR,CRITICAL}]
opcli getcustomattrs options
opcli getcustomattrs Specify credentials via YAML file
opcli getcustomattrs Specify credentials via command line
--urlURL- OpsRamp API URL--client_idKEY- OpsRamp API Key--client_secretSCRT- OpsRamp API Secret--tenantTENANT- OpsRamp tenant ID--partnerPARTNER- OpsRamp partner ID (usually unnecessary - only needed for partner-level API calls)
opcli getcustomattrs Other common options
--secureSECURE- Whether or not to verify SSL cert (default:True)--loglevelLOGLEVEL- Set the logging level (default:INFO)
opcli importfromdatasource
Import Resources & Custom Attributes from a data source.
opcli importfromdatasource [-h] [--env ENV] [--envfile ENVFILE] [--url URL] [--client_id KEY] [--client_secret SCRT] [--tenant TENANT] [--partner PARTNER] [--secure SECURE]
[--loglevel {DEBUG,INFO,WARNING,ERROR,CRITICAL}] --job JOB [--commit] [--addnames] [--addvalues] [--writeblanks] [--alertonmisssing {INFO,WARNING,CRITICAL}]
opcli importfromdatasource options
--jobJOB- Name of yaml job definition file--commit- Make the actual updates on the platform. If not specified, only error checking and import simulation will occur.--addnames- If new tag/custattr names are found in the data source, add the definitions on the fly. Otherwise new tag names will be considered an error.--addvalues- If new values are found in the data source, add the value definitions on the fly. Otherwise new values will be considered an error.--writeblanks- When no value is provided in the data source record for a resource, remove any existing value for that resource on the platform. If not specified then no action is taken for empty values.--alertonmisssingALERTONMISSSING- Post alerts for resources that are in the data source but not in OpsRamp
opcli importfromdatasource Specify credentials via YAML file
opcli importfromdatasource Specify credentials via command line
--urlURL- OpsRamp API URL--client_idKEY- OpsRamp API Key--client_secretSCRT- OpsRamp API Secret--tenantTENANT- OpsRamp tenant ID--partnerPARTNER- OpsRamp partner ID (usually unnecessary - only needed for partner-level API calls)
opcli importfromdatasource Other common options
--secureSECURE- Whether or not to verify SSL cert (default:True)--loglevelLOGLEVEL- Set the logging level (default:INFO)
opcli customattrmetriclabel
Make all values of an existing custom attribute a metric label or not a metric label
opcli customattrmetriclabel [-h] [--env ENV] [--envfile ENVFILE] [--url URL] [--client_id KEY] [--client_secret SCRT] [--tenant TENANT] [--partner PARTNER] [--secure SECURE]
[--loglevel {DEBUG,INFO,WARNING,ERROR,CRITICAL}] --attrname ATTRNAME --ismetriclabel {YES,NO}
opcli customattrmetriclabel options
--attrnameATTRNAME- Custom attribute name--ismetriclabelISMETRICLABEL- YES makes it a metric label, NO makes it not a metric label
opcli customattrmetriclabel Specify credentials via YAML file
opcli customattrmetriclabel Specify credentials via command line
--urlURL- OpsRamp API URL--client_idKEY- OpsRamp API Key--client_secretSCRT- OpsRamp API Secret--tenantTENANT- OpsRamp tenant ID--partnerPARTNER- OpsRamp partner ID (usually unnecessary - only needed for partner-level API calls)
opcli customattrmetriclabel Other common options
--secureSECURE- Whether or not to verify SSL cert (default:True)--loglevelLOGLEVEL- Set the logging level (default:INFO)
opcli getdiscoprofile
Get discovery profile definition
opcli getdiscoprofile [-h] [--env ENV] [--envfile ENVFILE] [--url URL] [--client_id KEY] [--client_secret SCRT] [--tenant TENANT] [--partner PARTNER] [--secure SECURE]
[--loglevel {DEBUG,INFO,WARNING,ERROR,CRITICAL}] --id ID --tenantId TENANTID
opcli getdiscoprofile options
--idID- Discovery profile ID--tenantIdTENANTID- Client ID or MSP ID of the tenant
opcli getdiscoprofile Specify credentials via YAML file
opcli getdiscoprofile Specify credentials via command line
--urlURL- OpsRamp API URL--client_idKEY- OpsRamp API Key--client_secretSCRT- OpsRamp API Secret--tenantTENANT- OpsRamp tenant ID--partnerPARTNER- OpsRamp partner ID (usually unnecessary - only needed for partner-level API calls)
opcli getdiscoprofile Other common options
--secureSECURE- Whether or not to verify SSL cert (default:True)--loglevelLOGLEVEL- Set the logging level (default:INFO)
opcli getalertesc
Search and get Escalation Policy definitions
opcli getalertesc [-h] [--env ENV] [--envfile ENVFILE] [--url URL] [--client_id KEY] [--client_secret SCRT] [--tenant TENANT] [--partner PARTNER] [--secure SECURE]
[--loglevel {DEBUG,INFO,WARNING,ERROR,CRITICAL}] [--query QUERY] [--details] [--count] [--filter FILTER]
opcli getalertesc options
--queryQUERY- Query String to filter alerts--details- Get the full details for all matched policies--count- Only show the count of matching alerts--filterFILTER- Post-query filter on alerts. Python expression that will evaluate to True or False such as alert["resource"]["name"].startswith("prod")
opcli getalertesc Specify credentials via YAML file
opcli getalertesc Specify credentials via command line
--urlURL- OpsRamp API URL--client_idKEY- OpsRamp API Key--client_secretSCRT- OpsRamp API Secret--tenantTENANT- OpsRamp tenant ID--partnerPARTNER- OpsRamp partner ID (usually unnecessary - only needed for partner-level API calls)
opcli getalertesc Other common options
--secureSECURE- Whether or not to verify SSL cert (default:True)--loglevelLOGLEVEL- Set the logging level (default:INFO)
opcli migratealertesc
Migrate/copy Escalation Policies within same tenant or from one tenant to another
opcli migratealertesc [-h] [--env ENV] [--envfile ENVFILE] [--url URL] [--client_id KEY] [--client_secret SCRT] [--tenant TENANT] [--partner PARTNER] [--secure SECURE]
[--loglevel {DEBUG,INFO,WARNING,ERROR,CRITICAL}] [--query QUERY] [--filter FILTER] [--preexec PREEXEC] [--postexec POSTEXEC] --to_env TO_ENV [--test] [--update]
[--setactive SETACTIVE]
opcli migratealertesc options
--queryQUERY- Query string to filter policies from source/from instance--filterFILTER- Filter for which policies to migrate. Python expression that will evaluate to True or False such as alert["resource"]["name"].startswith("prod")--preexecPREEXEC- Pre-mapped exec command--postexecPOSTEXEC- Post-mapped exec command--to_envTO_ENV- Target environment to which policy definitions will be migrated. (–env option defines the source/from environment)--test- Test run only. Will check object mappings for missing items and not actually change the target instance.--update- Used for bulk updates, will only work if –env and –to_env are the same. Try to update existing policies instead of creating new ones.--setactiveSETACTIVE- Specify ON or OFF. Will force all policies created on the target to be ON or OFF. Otherwise will be set the same as the source.
opcli migratealertesc Specify credentials via YAML file
opcli migratealertesc Specify credentials via command line
--urlURL- OpsRamp API URL--client_idKEY- OpsRamp API Key--client_secretSCRT- OpsRamp API Secret--tenantTENANT- OpsRamp tenant ID--partnerPARTNER- OpsRamp partner ID (usually unnecessary - only needed for partner-level API calls)
opcli migratealertesc Other common options
--secureSECURE- Whether or not to verify SSL cert (default:True)--loglevelLOGLEVEL- Set the logging level (default:INFO)
opcli getdevmgtpol
Search and get Escalation Policy definitions
opcli getdevmgtpol [-h] [--env ENV] [--envfile ENVFILE] [--url URL] [--client_id KEY] [--client_secret SCRT] [--tenant TENANT] [--partner PARTNER] [--secure SECURE]
[--loglevel {DEBUG,INFO,WARNING,ERROR,CRITICAL}] [--query QUERY] [--details] [--count] [--filter FILTER]
opcli getdevmgtpol options
--queryQUERY- Query String to filter alerts--details- Get the full details for all matched policies--count- Only show the count of matching alerts--filterFILTER- Post-query filter on alerts. Python expression that will evaluate to True or False such as alert["resource"]["name"].startswith("prod")
opcli getdevmgtpol Specify credentials via YAML file
opcli getdevmgtpol Specify credentials via command line
--urlURL- OpsRamp API URL--client_idKEY- OpsRamp API Key--client_secretSCRT- OpsRamp API Secret--tenantTENANT- OpsRamp tenant ID--partnerPARTNER- OpsRamp partner ID (usually unnecessary - only needed for partner-level API calls)
opcli getdevmgtpol Other common options
--secureSECURE- Whether or not to verify SSL cert (default:True)--loglevelLOGLEVEL- Set the logging level (default:INFO)
opcli gettemplates
Clone monitoring templates
opcli gettemplates [-h] [--env ENV] [--envfile ENVFILE] [--url URL] [--client_id KEY] [--client_secret SCRT] [--tenant TENANT] [--partner PARTNER] [--secure SECURE]
[--loglevel {DEBUG,INFO,WARNING,ERROR,CRITICAL}] [--query QUERY] [--brief]
opcli gettemplates options
opcli gettemplates Specify credentials via YAML file
opcli gettemplates Specify credentials via command line
--urlURL- OpsRamp API URL--client_idKEY- OpsRamp API Key--client_secretSCRT- OpsRamp API Secret--tenantTENANT- OpsRamp tenant ID--partnerPARTNER- OpsRamp partner ID (usually unnecessary - only needed for partner-level API calls)
opcli gettemplates Other common options
--secureSECURE- Whether or not to verify SSL cert (default:True)--loglevelLOGLEVEL- Set the logging level (default:INFO)
opcli clonetemplates
Clone monitoring templates
opcli clonetemplates [-h] [--env ENV] [--envfile ENVFILE] [--url URL] [--client_id KEY] [--client_secret SCRT] [--tenant TENANT] [--partner PARTNER] [--secure SECURE]
[--loglevel {DEBUG,INFO,WARNING,ERROR,CRITICAL}] (--name NAME | --infile INFILE) (--prefix PREFIX | --copyname COPYNAME)
opcli clonetemplates options
--nameNAME- Name of the Monitoring Template to clone--infileINFILE- File containing list of templates to clone (requires use of –prefix option)--prefixPREFIX- New template name will be same as original name but with this text prepended--copynameCOPYNAME- New template will have this as its name
opcli clonetemplates Specify credentials via YAML file
opcli clonetemplates Specify credentials via command line
--urlURL- OpsRamp API URL--client_idKEY- OpsRamp API Key--client_secretSCRT- OpsRamp API Secret--tenantTENANT- OpsRamp tenant ID--partnerPARTNER- OpsRamp partner ID (usually unnecessary - only needed for partner-level API calls)
opcli clonetemplates Other common options
--secureSECURE- Whether or not to verify SSL cert (default:True)--loglevelLOGLEVEL- Set the logging level (default:INFO)
opcli metricsql
Run a MetricsQL/PromQL query
opcli metricsql [-h] [--env ENV] [--envfile ENVFILE] [--url URL] [--client_id KEY] [--client_secret SCRT] [--tenant TENANT] [--partner PARTNER] [--secure SECURE]
[--loglevel {DEBUG,INFO,WARNING,ERROR,CRITICAL}] [--instant_query INSTANT_QUERY]
opcli metricsql options
--instant_queryINSTANT_QUERY- MetricsQL/PromQL Query
opcli metricsql Specify credentials via YAML file
opcli metricsql Specify credentials via command line
--urlURL- OpsRamp API URL--client_idKEY- OpsRamp API Key--client_secretSCRT- OpsRamp API Secret--tenantTENANT- OpsRamp tenant ID--partnerPARTNER- OpsRamp partner ID (usually unnecessary - only needed for partner-level API calls)
opcli metricsql Other common options
--secureSECURE- Whether or not to verify SSL cert (default:True)--loglevelLOGLEVEL- Set the logging level (default:INFO)
opcli setbaselinethreshold
Set a new override threshold for a resource/component that matches a given MetricQL query
opcli setbaselinethreshold [-h] [--env ENV] [--envfile ENVFILE] [--url URL] [--client_id KEY] [--client_secret SCRT] [--tenant TENANT] [--partner PARTNER] [--secure SECURE]
[--loglevel {DEBUG,INFO,WARNING,ERROR,CRITICAL}] --template TEMPLATE --metric METRIC --instant_query INSTANT_QUERY
[--warnop {NONE,LESS_THAN,LESS_THAN_EQUAL,EQUAL,GREATER_THAN_EQUAL,GREATER_THAN}] [--critop {NONE,LESS_THAN,LESS_THAN_EQUAL,EQUAL,GREATER_THAN_EQUAL,GREATER_THAN}]
[--warnthresh WARNTHRESH] [--critthresh CRITTHRESH] [--warnrepeat WARNREPEAT] [--critrepeat CRITREPEAT] --raisealert {on,off} [--availability]
opcli setbaselinethreshold options
--templateTEMPLATE- Name of template that metric is assigned from--metricMETRIC- Technical metric name as listed in the template definition--instant_queryINSTANT_QUERY- PromQL instant query returning a vector result (i.e. must aggregate over time)--warnopWARNOP- Comparison operator for Warning--critopCRITOP- Comparison operator for Warning--warnthreshWARNTHRESH- Warning threshold value--critthreshCRITTHRESH- Critical threshold value--warnrepeatWARNREPEAT- Warning repeat count (default:1)--critrepeatCRITREPEAT- Critical repeat count (default:1)--raisealertRAISEALERT- Whether to raise an alert or not--availability- Make the metric an availability metric
opcli setbaselinethreshold Specify credentials via YAML file
opcli setbaselinethreshold Specify credentials via command line
--urlURL- OpsRamp API URL--client_idKEY- OpsRamp API Key--client_secretSCRT- OpsRamp API Secret--tenantTENANT- OpsRamp tenant ID--partnerPARTNER- OpsRamp partner ID (usually unnecessary - only needed for partner-level API calls)
opcli setbaselinethreshold Other common options
--secureSECURE- Whether or not to verify SSL cert (default:True)--loglevelLOGLEVEL- Set the logging level (default:INFO)
opcli getintegrations
Get installed Integration definitions
opcli getintegrations [-h] [--env ENV] [--envfile ENVFILE] [--url URL] [--client_id KEY] [--client_secret SCRT] [--tenant TENANT] [--partner PARTNER] [--secure SECURE]
[--loglevel {DEBUG,INFO,WARNING,ERROR,CRITICAL}] [--query QUERY] [--filter FILTER]
opcli getintegrations options
opcli getintegrations Specify credentials via YAML file
opcli getintegrations Specify credentials via command line
--urlURL- OpsRamp API URL--client_idKEY- OpsRamp API Key--client_secretSCRT- OpsRamp API Secret--tenantTENANT- OpsRamp tenant ID--partnerPARTNER- OpsRamp partner ID (usually unnecessary - only needed for partner-level API calls)
opcli getintegrations Other common options
--secureSECURE- Whether or not to verify SSL cert (default:True)--loglevelLOGLEVEL- Set the logging level (default:INFO)
opcli importintegrations
Import integration definitions from a json file
opcli importintegrations [-h] [--env ENV] [--envfile ENVFILE] [--url URL] [--client_id KEY] [--client_secret SCRT] [--tenant TENANT] [--partner PARTNER] [--secure SECURE]
[--loglevel {DEBUG,INFO,WARNING,ERROR,CRITICAL}] --file FILE
opcli importintegrations options
opcli importintegrations Specify credentials via YAML file
opcli importintegrations Specify credentials via command line
--urlURL- OpsRamp API URL--client_idKEY- OpsRamp API Key--client_secretSCRT- OpsRamp API Secret--tenantTENANT- OpsRamp tenant ID--partnerPARTNER- OpsRamp partner ID (usually unnecessary - only needed for partner-level API calls)
opcli importintegrations Other common options
--secureSECURE- Whether or not to verify SSL cert (default:True)--loglevelLOGLEVEL- Set the logging level (default:INFO)
opcli addazurearmintegration
Install a new Azure ARM integration
opcli addazurearmintegration [-h] [--env ENV] [--envfile ENVFILE] [--url URL] [--client_id KEY] [--client_secret SCRT] [--tenant TENANT] [--partner PARTNER] [--secure SECURE]
[--loglevel {DEBUG,INFO,WARNING,ERROR,CRITICAL}] [--recurrence {WEEKLY,DAILY,NONE}] [--daysofweek DAYSOFWEEK] [--starthour STARTHOUR] [--rules RULES] --azname
AZNAME --azsub AZSUB --aztenant AZTENANT --azclient AZCLIENT --azsecret AZSECRET
opcli addazurearmintegration options
--aznameAZNAME- displayName for the integration--azsubAZSUB- Azure Subscription ID--aztenantAZTENANT- Azure Tenant ID--azclientAZCLIENT- Azure Client ID--azsecretAZSECRET- Azure Secret Key
opcli addazurearmintegration Specify credentials via YAML file
opcli addazurearmintegration Specify credentials via command line
--urlURL- OpsRamp API URL--client_idKEY- OpsRamp API Key--client_secretSCRT- OpsRamp API Secret--tenantTENANT- OpsRamp tenant ID--partnerPARTNER- OpsRamp partner ID (usually unnecessary - only needed for partner-level API calls)
opcli addazurearmintegration Other common options
--secureSECURE- Whether or not to verify SSL cert (default:True)--loglevelLOGLEVEL- Set the logging level (default:INFO)
opcli addazurearmintegration Specify discovery schedule
--recurrenceRECURRENCE- Recurrence type for discovery schedule (default:WEEKLY)--daysofweekDAYSOFWEEK- Comma-separated list of days of week used for WEEKLY recurrence (default:sunday,)--starthourSTARTHOUR- Hour of day to start discovery (default:2)--rulesRULES- Comma-delimited list of rules to filter what object types are discovered and managed (default:ANY_CLOUD_RESOURCE)
opcli addazureasmintegration
Install a new Azure ASM integration
opcli addazureasmintegration [-h] [--env ENV] [--envfile ENVFILE] [--url URL] [--client_id KEY] [--client_secret SCRT] [--tenant TENANT] [--partner PARTNER] [--secure SECURE]
[--loglevel {DEBUG,INFO,WARNING,ERROR,CRITICAL}] [--recurrence {WEEKLY,DAILY,NONE}] [--daysofweek DAYSOFWEEK] [--starthour STARTHOUR] [--rules RULES] --azname
AZNAME --azsub AZSUB --azcert AZCERT --azkspw AZKSPW
opcli addazureasmintegration options
opcli addazureasmintegration Specify credentials via YAML file
opcli addazureasmintegration Specify credentials via command line
--urlURL- OpsRamp API URL--client_idKEY- OpsRamp API Key--client_secretSCRT- OpsRamp API Secret--tenantTENANT- OpsRamp tenant ID--partnerPARTNER- OpsRamp partner ID (usually unnecessary - only needed for partner-level API calls)
opcli addazureasmintegration Other common options
--secureSECURE- Whether or not to verify SSL cert (default:True)--loglevelLOGLEVEL- Set the logging level (default:INFO)
opcli addazureasmintegration Specify discovery schedule
--recurrenceRECURRENCE- Recurrence type for discovery schedule (default:WEEKLY)--daysofweekDAYSOFWEEK- Comma-separated list of days of week used for WEEKLY recurrence (default:sunday,)--starthourSTARTHOUR- Hour of day to start discovery (default:2)--rulesRULES- Comma-delimited list of rules to filter what object types are discovered and managed (default:ANY_CLOUD_RESOURCE)
opcli addkubernetesintegration
Install a new Kubernetes integration
opcli addkubernetesintegration [-h] [--env ENV] [--envfile ENVFILE] [--url URL] [--client_id KEY] [--client_secret SCRT] [--tenant TENANT] [--partner PARTNER] [--secure SECURE]
[--loglevel {DEBUG,INFO,WARNING,ERROR,CRITICAL}] --name NAME --type {cloud,onPrem} --engine {Docker,ContainerD,CRI-O}
opcli addkubernetesintegration options
opcli addkubernetesintegration Specify credentials via YAML file
opcli addkubernetesintegration Specify credentials via command line
--urlURL- OpsRamp API URL--client_idKEY- OpsRamp API Key--client_secretSCRT- OpsRamp API Secret--tenantTENANT- OpsRamp tenant ID--partnerPARTNER- OpsRamp partner ID (usually unnecessary - only needed for partner-level API calls)
opcli addkubernetesintegration Other common options
--secureSECURE- Whether or not to verify SSL cert (default:True)--loglevelLOGLEVEL- Set the logging level (default:INFO)