Lists container information based on specified search criteria.
container.list <"serviceName=<regexp>" | "serialNumber=<value>">
[, "serviceType=<device|test>"]
[, "memberListMethod=<auto|manual>"]
[, "severityMethod=<auto|manual>"]
[, "parentNames=none|<value1,value2,...>"]
[, "actionName=none|<value>"]
[, "departmentName=<value>"]
Use the optional parameters as search filters to narrow the listed containers. You can further filter the results by using other parameters. For example filter by ruleDeviceName
when serviceType=device
and memberListMethod=auto
.
The output includes all parameters from the container.update
command, with the exception of newServiceName
and memberList
.
Examples:
Search for a container by serial number:
container.list "serialNumber=90027"
OK 203 request accepted, records returned: 1
"serviceName=Critical Servers", "serialNumber=90027",
"serviceType=device", "memberListMethod=manual", "memberListCount=3",
"severityMethod=auto", "parentSerialNumber=", "actionName=none",
"comment=", "displayComment=false"
Search for test containers with a specific action profile:
container.list "serviceName=*", "serviceType=test", "actionName=Notify Admin"
OK 203 request accepted, records returned: 1
"serviceName=[VoIP] Infrastructure", "serialNumber=200019",
"serviceType=test", "memberListCount=26", "severityMethod=auto",
"parentSerialNumber=130168", "actionName=Notify Admin", "comment=",
"displayComment=false"
Search for containers by name/wildcard:
container.list "serviceName=*server*"
OK 203 request accepted, records returned: 3
"serviceName=Unix Servers", "serialNumber=90016", "serviceType=device",
"memberListMethod=auto", "ruleDeviceName=", "ruleDeviceType=*Unix*",
"ruleDeviceModel=", "ruleDeviceVendor=", "ruleDeviceTag1=",
"ruleDeviceTag2=", "ruleDeviceTag3=", "ruleDeviceTag4=",
"ruleDeviceTag5=", "memberListCount=1", "severityMethod=auto",
"parentSerialNumber=90027", "actionName=none", "comment=",
"displayComment=false"
"serviceName=Critical Servers", "serialNumber=90027",
"serviceType=device", "memberListMethod=manual", "memberListCount=3",
"severityMethod=auto", "parentSerialNumber=", "actionName=none",
"comment=", "displayComment=false"
"serviceName=Windows Servers", "serialNumber=420035",
"serviceType=device", "memberListMethod=manual", "memberListCount=5",
"severityMethod=auto", "parentSerialNumber=90027", "actionName=none",
"comment=", "displayComment=false"
Show all top level containers:
container.list "serviceName=*", "parentNames=none"
OK 203 request accepted, records returned: 1
"serviceName=All Devices", "serialNumber=300003", "serviceType=device",
"memberListMethod=manual", "memberListCount=1", "severityMethod=auto",
"parentSerialNumber=", "actionName=none", "comment=",
"displayComment=true"