Searching the Help
To search for information in the Help, type a word or phrase in the Search box. When you enter a group of words, OR is inferred. You can use Boolean operators to refine your search.
Results returned are case insensitive. However, results ranking takes case into account and assigns higher scores to case matches. Therefore, a search for "cats" followed by a search for "Cats" would return the same number of Help topics, but the order in which the topics are listed would be different.
Search for | Example | Results |
---|---|---|
A single word | cat
|
Topics that contain the word "cat". You will also find its grammatical variations, such as "cats". |
A phrase. You can specify that the search results contain a specific phrase. |
"cat food" (quotation marks) |
Topics that contain the literal phrase "cat food" and all its grammatical variations. Without the quotation marks, the query is equivalent to specifying an OR operator, which finds topics with one of the individual words instead of the phrase. |
Search for | Operator | Example |
---|---|---|
Two or more words in the same topic |
|
|
Either word in a topic |
|
|
Topics that do not contain a specific word or phrase |
|
|
Topics that contain one string and do not contain another | ^ (caret) |
cat ^ mouse
|
A combination of search types | ( ) parentheses |
|
Domain and Probe Data Methods
Returns the domain type.
Input
Parameter | Comment |
---|---|
cmdbContext | For details, see CmdbContextCmdbContext |
domainName | The name of the domain. |
Output
Parameter | Comment |
---|---|
domainType | The domain type. |
Returns the names of the current domains.
See Code Samples.
Input
Parameter | Comment |
---|---|
cmdbContext | For details, see CmdbContextCmdbContext |
Output
Parameter | Comment |
---|---|
domainNames | The list of domain names. |
Returns the IP addresses of the specified probe.
Input
Parameter | Comment |
---|---|
cmdbContext | For details, see CmdbContextCmdbContext |
domainName | The domain to check. |
probeName | The name of the probe used on that domain. |
Output
Parameter | Comment |
---|---|
probeIPs | The IPList of the addresses in the probe. |
Returns the names of the probes in the specified domain.
See Code Samples.
Input
Parameter | Comment |
---|---|
cmdbContext | For details, see CmdbContextCmdbContext |
domainName | The domain to check. |
Output
Parameter | Comment |
---|---|
probesName | The list of probes on the domain. |
Returns the scope definition of the specified probe.
Input
Parameter | Comment |
---|---|
cmdbContext | For details, see CmdbContextCmdbContext |
domainName | The domain to check. |
probeName | The name of the probe. |
Output
Parameter | Comment |
---|---|
probeScope | The Scope of the probe. |
Checks whether the specified probe is connected.
See Code Samples.
Input
Parameter | Comment |
---|---|
cmdbContext | For details, see CmdbContextCmdbContext |
domainName | The domain to check. |
probeName | The probe to check |
Output
Parameter | Comment |
---|---|
isConnected | True if the probe is connected. |
Sets the scope of the specified probe, overriding the existing scope.
Input
Parameter | Comment |
---|---|
cmdbContext | For details, see CmdbContextCmdbContext |
domainName | The domain. |
probeName | The probe to update. |
newScope | The Scope to set for the probe. |