Skip to content

appd get-collector

Retrieve collector

Description

Returns collector if ID is provided. Else, returns all collectors

Synopsis

appd get-collector
    [--site <site>]
    [--cluster <cluster>]
    [<id>]

Arguments

site - (string)

     Site where this command will be executed
     Example: --site "site-1"
     Default: input.site      Attributes: optional

cluster - (string)

     Name of elastic search cluster
     Example: --cluster "appdynamics-default"
     Default: appdynamics-default      Attributes: optional

id - (int)

     configuration-id(s) for retrieving the collector(s)
     Example: 562
     Default: _None_      Attributes: optional

Examples

Input: 

x = ! appd get-collector 562
Output: 
{
  "performanceState": null,
  "collectorStatus": "ERROR",
  "eventSummary": null,
  "configId": 562,
  "nodeId": 932032,
  "config": {
    "id": 562,
    "version": 0,
    "name": "test",
    "nameUnique": true,
    "builtIn": false,
    "createdBy": null,
    "createdOn": 1664451680000,
    "modifiedBy": null,
    "modifiedOn": 1664451680000,
    "type": "MONGO",
    "hostname": "",
    "useWindowsAuth": false,
    "username": "master",
    "password": "",
    "port": 0,
    "loggingEnabled": false,
    "enabled": true,
    "excludedSchemas": null,
    "jdbcConnectionProperties": [],
    "databaseName": "",
    "failoverPartner": null,
    "connectAsSysdba": false,
    "useServiceName": false,
    "sid": "",
    "customConnectionString": "mongodb://localhost:27017",
    "enterpriseDB": false,
    "useSSL": false,
    "enableOSMonitor": false,
    "hostOS": null,
    "useLocalWMI": false,
    "hostDomain": null,
    "hostUsername": null,
    "hostPassword": null,
    "dbInstanceIdentifier": null,
    "region": null,
    "certificateAuth": false,
    "removeLiterals": true,
    "sshPort": 0,
    "agentName": "Default Database Agent",
    "dbCyberArkEnabled": false,
    "dbCyberArkApplication": null,
    "dbCyberArkSafe": null,
    "dbCyberArkFolder": null,
    "dbCyberArkObject": null,
    "hwCyberArkEnabled": false,
    "hwCyberArkApplication": null,
    "hwCyberArkSafe": null,
    "hwCyberArkFolder": null,
    "hwCyberArkObject": null,
    "orapkiSslEnabled": false,
    "orasslClientAuthEnabled": false,
    "orasslTruststoreLoc": null,
    "orasslTruststoreType": null,
    "orasslTruststorePassword": null,
    "orasslKeystoreLoc": null,
    "orasslKeystoreType": null,
    "orasslKeystorePassword": null,
    "ldapEnabled": false,
    "customMetrics": null,
    "subConfigs": [],
    "jmxPort": 0,
    "backendIds": [],
    "extraProperties": []
  },
  "licensesUsed": -1
}
Input: 
! appd get-collector
Output: 
ID  VERSION NAME                TYPE    HOSTNAME    USERNAME    PORT    DATABASE NAME 
562       0 test                MONGO               master         0                    
564       0 s                   MONGO               null         0                  
565       0 b                   MONGO               null         0                  
571       0 sample collector    MONGO               null           0
Input: 
! appd get-collector 562
Output: 
ID  VERSION NAME                TYPE    HOSTNAME    USERNAME    PASSWORD    PORT    DATABASE NAME 
562       0 test                MONGO               master                     0

Access Control

To use this command, you need access to the following:

Field Value
Action "read"
Service Type "appd"
Service Instance cluster
Namespace
Object Type "collector"
Object ID id

Please see Access Control for details.