The DataSync Agent supports accessing the Perspectium cloud based services and replication sources such as ServiceNow through a Proxy. Several organizations use such a proxy to provide a more secure or controlled method in which to access servers within the Internet.
Access to the Proxy can be configured to use either the HTTP or HTTPS protocol. The destination server, such as a ServiceNow instance, can also be configured to leverage either protocol. Furthermore, the DataSync Agent supports the ability to authenticate itself to the proxy using either the Basic Authentication or NTLM protocols. Additionally, you can configure authentication support for the destination server as well.
Prerequisites:
Instructions:
- Locate the agent's base directory and change it into the conf configuration folder where the agent.xml file is located.
- Edit agent.xml and save this file following the instructions below.
- Restart the agent.
Proxy enabled components
The following agent.xml directives can optionally be configured to access the defined URI via a proxy.
| Connection directive | Example |
|---|---|
| Message connection | <message_connection attributes>https://acme.perspectium.net</message_connection> |
| Reporting connection | <reporting_connection attributes>https://acme.perspectium.net</reporting_connection> |
| Management connection | <management_connection attributes>https://acme.perspectium.net</management_connection> |
The attributes which are available are outlined below.
| Attribute | Example | Required |
|---|---|---|
| proxy | proxy="http://ourproxy.acme.com" | Yes |
| user | user=“serviceNowUser” | No |
| password | password=“serviceNowUserPassword” | No |
| proxy_user | proxy_user=“proxyConfiguredUser” | No |
| proxy_password | proxy_password=“proxyConfiguredUserPassword” | No |
If you specify a user or proxy_user then you must also configure the password or proxy_password. In the examples below, when we say target we mean the true intended destination that we want to reach beyond the proxy.
| Proxy protocol, Authentication | Example |
|---|---|
| HTTP | <message_connection proxy=“http://proxy.acme.net”>https://acme.service-now.com</message_connection> |
| HTTPS | <message_connection proxy=“https://proxy.acme.net”>https://acme.service-now.</message_connection> |
| HTTP, proxy authentication | <message_connection proxy=“http://proxy.acme.net” proxy_user=“proxyUser” proxy_password=“”>https://acme.service-now.com</message_connection> |
| HTTPS, proxy authentication | <message_connection proxy=“https://proxy.acme.net” proxy_user=“proxyUser” proxy_password=“”>https://acme.service-now.com</message_connection> |
| HTTP, target authentication | <message_connection user=“mark” password=“” proxy=“http://proxy.acme.net”>https://acme.service-now.com</message_connection> |
| HTTPS, target authentication | <message_connection user=“mark” password=“” proxy=“https://proxy.acme.net”>https://acme.service-now.com</message_connection> |
| HTTP, proxy and target authentication | <message_connection user=“mark” password=“” proxy=“http://proxy.acme.net” proxy_user=“perspectium” proxy_password=“”>https://acme.service-now.com</message_connection> |
| HTTPS, proxy and target authentication | <message_connection user=“mark” password=“” proxy=“https://proxy.acme.net” proxy_user=“perspectium” proxy_password=“”>https://acme.service-now.com</message_connection> |
In most cases, the HTTP protocol is used when talking to the Proxy since that communication is taking place inside the firewall.