The Gateways section under [Manage→DevicesManage→Topology] provides access to the set of gateways monitored and managed by DPOD.
| Warning |
|---|
This step changes or adds some of the monitored gateway objects. Please review the list of changes before you continue to perform these actions. |
Gateways
This screen displays This screen displays filters (see Filters for a complete list of filters) and a table containing information on all the monitored gateways connected to DPOD's console, and lets an administrator perform several configuration tasks, at a gateway , or domain or service level.
Each row in the table contains the following details about a single gateway (this information relates to the information entered when Adding Monitored Devices):. For more information, see Adding Monitored Gateways.
Column | Description |
|---|---|
Name | The gateway name in DPOD |
. | |
Host | The IP |
address or host used to access the gateway. | |
SOMA port | The SOMA port configured on this gateway |
IP Address of the gateway's log target source.
This should be the IP address of the ethernet interface of the gateway from which Syslog records should be sent to DPOD.
Usually, this IP address is the same as the IP address used for the Host field mentioned above.
If link aggregation interface is configured in the gateway, you may define its IP address as the log target source address to take advantage of the link aggregation benefits when sending Syslog records to DPOD.
...
. | |
Form Factor | The gateway’s form factor - virtual, physical or a container. |
Firmware Level | The gateway’s firmware level. |
Added By | Whether the gateway was added to DPOD by the user or by the Cloud Agent. |
Cloud Agent | The name of the Cloud Agent that is monitoring this gateway. (FFU) |
Info button | Click on the Info button for more information, such as the firmware level, device type, serial number, features, etc. |
Adding a Gateway
...
The following steps let an administrator perform gateway-level configuration tasks:
...
gateways
...
Domain Level Configuration
The following steps let an administrator perform domain-level configuration tasks:
- Click on one of the monitored gateways in the Monitored Gateways table.
The system displays the gateway details, and a list of all the domains on that gateway. - Click on one of the domains to select it.
The system displays the domain's details and a list of all services running on the selected domain. - Click the Setup link (found at the top of the table, next to the label ‘Services’)
The system displays a list of administrator tasks available for this domain. Consult the tables at the end of this page to find details about the available tasks.
Service Level Configuration
The following steps let an administrator perform service-level configuration tasks:
- Click on one of the monitored gateways in the Monitored Gateways table.
The system displays the gateway details, and a list of all the domains on that gateway. - Click on one of the domains to select it.
The system displays the domain's details and a list of all services running on the selected domain. - Click on one of the services.
The system displays the service's details and a list of all endpoints in the service - Click the Setup link (found at the top of the table, next to the label ‘Endpoints’)
The system displays a list of administrator tasks available for this service. Consult the tables at the end of this page to find details about the available tasks.
| Warning |
|---|
This step changes or adds some of your monitored gateway objects. Please review the list of changes before you continue too perform this actions. |
Available Tasks (Operations)
Gateway Level Operation Details
The following tasks are available for gateway setup.
If you wish to monitor transactions in the default domain, please follow the instructions in this page.
...
Setup Syslog for device
...
Sets up the necessary configuration for the gateway to send gateway-level Syslog records to the selected agent.
This configuration should be executed once after installing the system or when you need to redirect the gateway-level Syslog messages to a different agent.
To setup the Syslog for a gateway, select a Syslog Agent from the drop-down list, and click the Setup Syslog button.
You can disable/enable this Syslog target by clicking on the "Device Syslog Status" Enabled/Disabled buttons.
Limitation: DPOD does not support transactions in the default domain. See /wiki/spaces/MS/pages/9306256.
Note: This action changes your gateway configuration - please review changes .
...
Setup Syslog for all domains
...
Sets up the necessary configuration for all the domains to send domain-level Syslog records to the selected agent.
This configuration should be executed once after installing the system, when a new domain is created or when you need to redirect the gateway-level Syslog messages to a different agent.
To setup the log targets for all domains, select a Syslog Agent from the drop-down list, select analysis level from the drop-down list, and click the Setup Syslog button.
You can disable/enable all log targets by clicking on the "Domains Syslog Status" Enabled/Disabled buttons.
Limitation: DPOD does not support more than 125 domains per gateway. See /wiki/spaces/MS/pages/9306256 .
Trying to run this action on more than 125 domains can be unpredictable.
If you have more than 125 domains, you MUST run "Setup Syslog" using the Domain Level procedure below.
Note: This action changes your gateway configuration - please review changes .
...
This feature will automatically detect and setup new domains created on the monitored gateway, this is especially useful for dynamically created API Connect domains.
Choose a Syslog agent and a WS-M agent that the domains should report to, select analysis level from the drop-down list, enter the domain pattern (use asterisk as wildcard) and click save.
DPOD will scan the monitored gateway every 2 minutes and will setup the new domain (you can change the interval from the system parameters page. A UI service
restart is required after changing this interval)
...
Setup WS-M for all domains
...
Sets up the necessary configuration for all the domains to send payload data to the selected agent
This configuration should be executed once after installing the system, when a new domain is created or when you need to redirect the payloads to a different agent
Clicking the "Record Payload" link will take you to the Payload Capture page, where you can start a WS-M subscription.
Note: This action changes your gateway configuration - please review changes .
Note: This action does not enable the WS-M Agent on IDG. For security reasons, this can only be done from IDG.
...
Setup Certificate Monitor for gateway
...
The Certificate Monitor is used to provide alerts before certificate expiration. Each gateway must be configured (at the gateway level) to enable certificate expiry alerts.
This configuration should be executed once after installing the system.
Note: This action changes your gateway configuration - please review changes .
...
Note: This action changes your gateway configuration - please review changes .
| Warning |
|---|
This step changes some of your monitored device objects. Please review the list of changes before you continue with this action. |
Domain Level Operation Details
The following tasks are available for domains setup.
...
Sets up the necessary configuration for this domain to send domain-level Syslog records to the selected agent.
This configuration should be executed once after installing the system, or when the domain-level Syslog messages need to be redirected to a different agent.
To setup the Syslog for a domain, select a Syslog Agent from the drop-down list, and click the Setup Syslog button.
You can disable/enable this Syslog target by clicking on the "Domain Syslog Status" Enabled/Disabled buttons.
Note: This action changes your device configuration - please review changes .
...
Setup WS-M
...
Sets up the necessary configuration for all the domains to send payload data to the selected agent.
This configuration should be executed once after installing the system, when a new domain is created or when the payloads need to be redirected to a different agent.
Clicking the "Record Payload" link will take you to the Payload Capture page, where you can start a WS-M subscription.
Note: This action changes your device configuration - please review changes .
Note: This action does not enable the WS-M Agent on IDG. This can be done only from IDG for security reasons.
...
Setup Extended Transactions for all services
...
This configuration should be executed once after installing the system (either at a service or a domain level), or when you need to add extended transaction support for services in the domain. If extended transactions were previously enabled for some of the services in this domain, executing this will add the new step to new services only - the previously configured services will be unaffected.
Note: This action is intrusive and changes your service configuration and may require manual rollback - please review changes .
| Warning |
|---|
This step changes some of your monitored gateway objects. Please review the list of changes before you continue with this action. |
Service Level Operation Details
The following task is available for services setup.
...
This configuration should be executed once after installing the system (either at a service or a domain level), or when you need to add extended transaction support for services in the domain. Executing this again for a service that has already been enabled for extended transactions will not change its state.
...
table widget contains the New… button at the top. Click this button to add a new gateway to be monitored and managed by DPOD.
To add a gateway, see Adding Monitored Devices.
Configuring a Gateway
Each monitored gateway needs to be configured to send information to DPOD after added to DPOD. To configure a gateway, see Configuring Monitored Devices.
Click on the name of the gateway to configure it.