The SNMP Subagent Plugin provides the ability for the Data Governance Server to act as an SNMP AgentX sub-agent. It will expose a subset of monitor data.
↓Parent Component
↓Properties
↓dsconfig Usage
The SNMP Subagent Plugin component inherits from the Plugin
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ description | ↓ invoke-for-internal-operations |
| ↓ enabled | ↓ session-timeout |
| ↓ context-name | ↓ connect-retry-max-wait |
| ↓ agentx-address | ↓ ping-interval |
| ↓ agentx-port | |
| ↓ num-worker-threads |
| Description | A description for this Plugin |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Indicates whether the plug-in is enabled for use. |
| Default Value | None |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | The SNMP context name for this sub-agent. The context name must not be longer than 30 ASCII characters. Each server in a topology must have a unique SNMP context name. |
| Default Value | The context name is the same as the server instance name. |
| Allowed Values | An SNMP context name no more than 30 ASCII characters in length. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | The SNMP Subagent Plugin must be disabled and re-enabled for changes to this setting to take effect. In order for this modification to take effect, the component must be restarted, either by disabling and re-enabling it, or by restarting the server |
| Description | The hostname or IP address of the SNMP master agent. |
| Default Value | localhost |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | The SNMP Subagent Plugin must be disabled and re-enabled for changes to this setting to take effect. In order for this modification to take effect, the component must be restarted, either by disabling and re-enabling it, or by restarting the server |
| Description | The port number on which the SNMP master agent will be contacted. |
| Default Value | 705 |
| Allowed Values | An integer value. Lower limit is 1. Upper limit is 65535 . |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | The SNMP Subagent Plugin must be disabled and re-enabled for changes to this setting to take effect. In order for this modification to take effect, the component must be restarted, either by disabling and re-enabling it, or by restarting the server |
| Description | The number of worker threads to use to handle SNMP requests. |
| Default Value | 4 |
| Allowed Values | An integer value. Lower limit is 1. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | The SNMP Subagent Plugin must be disabled and re-enabled for changes to this setting to take effect. In order for this modification to take effect, the component must be restarted, either by disabling and re-enabling it, or by restarting the server |
invoke-for-internal-operations (Advanced Property)
| Description | Indicates whether the plug-in should be invoked for internal operations. Any plug-in that can be invoked for internal operations must ensure that it does not create any new internal operations that can cause the same plug-in to be re-invoked. |
| Default Value | true |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
session-timeout (Advanced Property)
| Description | Specifies the maximum amount of time to wait for a session to the master agent to be established. Also specifies the amount of time that the master agent should allow to elapse after dispatching a message on a session before it regards the sub-agent as not responding. |
| Default Value | 5 seconds |
| Allowed Values | A duration. Lower limit is 1 seconds. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
connect-retry-max-wait (Advanced Property)
| Description | The maximum amount of time to wait between attempts to establish a connection to the master agent. When a connection to the master agent cannot be established, or is lost, the connection is retried periodically. This property defines the maximum duration to wait between consecutive retry attempts. |
| Default Value | 10 s |
| Allowed Values | A duration. Lower limit is 1 milliseconds. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
ping-interval (Advanced Property)
| Description | The amount of time between consecutive pings sent by the sub-agent on its connection to the master agent. A value of zero disables the sending of pings by the sub-agent. |
| Default Value | 30 s |
| Allowed Values | A duration. Lower limit is 0 seconds. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
To list the configured Plugins:
dsconfig list-plugins
[--property {propertyName}] ...
To view the configuration for an existing Plugin:
dsconfig get-plugin-prop
--plugin-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing Plugin:
dsconfig set-plugin-prop
--plugin-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To create a new SNMP Subagent Plugin:
dsconfig create-plugin
--plugin-name {name}
--type snmp-subagent
--set enabled:{propertyValue}
[--set {propertyName}:{propertyValue}] ...
To delete an existing Plugin:
dsconfig delete-plugin
--plugin-name {name}