3.1.1 Options configuration elements

This table describes the fields on the SDS Configuration Options page.

Table 3-1 Options Configuration Elements

Element Description Data Input Notes
Allow Connections If checked, incoming provisioning connections are allowed

Format: Check box

Range: Checked, Unchecked

Default: Checked

Max Transaction Size The maximum number of database manipulation commands per transaction

Format: Digits only

Range: 1–100

Default: 50

Log Provisioning Messages

If checked, all incoming and outgoing provisioning messages are logged in the command log.

Note: Command logs can be exported to a server other than the single remote server supported by APDE.

Format: Check box

Range: Checked, Unchecked

Default: Checked

Transaction Durability Timeout The number of seconds allowed between a transaction being committed and it becoming durable. If Transaction Durability Timeout lapses, DURABILITY_TIMEOUT (1024) response is sent to the originating client. The associated request should be resent to ensure the request was committed.

Format: Digits only; seconds

Range: 2–3600

Default: 5

Remote Import Enabled If checked, import files are imported from a remote host

Format: Check box

Range: Checked, Unchecked

Default: Unchecked

Remote Import Mode

If set to Non-Blocking, updates are allowed on all provisioning connections while the remote import operation is in progress.

If set to Blocking, updates are not allowed.

Format: list

Range: Non-Blocking, Blocking

Default: Non-Blocking

Remote Import Host IP Address The IP address of remote import host periodically queried for import files

Format: Alphanumeric

Range: 0–39 characters

Range: Either an IPv4 or an IPv6 IP address.

IPv4 addresses are 32 bits, represented in a dot-decimal notation like this: x.x.x.x where each x (called an octet) is a decimal value from 0 to 255. They are separated by periods. For example: 1.2.3.4 and 192.168.1.100 are valid IPv4 addresses.

IPv6 addresses are 128 bits, represented in a colon-hexadecimal notation like this: z:z:z:z:z:z:z:z where each z is a group of hexadecimal digits ranging from 0 to ffff. They are separated by colons. Leading zeros may be omitted in each group. "::" can be used (at most once) in an IPv6 address to represent a range of as many zero fields as needed to populate the address to eight fields. So the IPv6 address 2001:db8:c18:1:260:3eff:fe47:1530 can also be represented as 2001:0db8:0c18:0001:​0260:3eff:fe47:1530 and the IPv6 address ::1 is the same as 0000:0000:0000:0000:​0000:0000:0000:0001

Remote Import User The Username for remote import host user

Format: Alphanumeric

Range: 0–255 characters

Remote Import Password The password to exchange ssh keys with the remote import host. The password is cleared from this table after the keys have been exchanged.

Format: Alphanumeric

Range: 0–255 characters

Remote Import Directory The directory where import files exist on the remote import host

Format: Alphanumeric

Range: 0–255 characters

Export Mode

If set to Non-Blocking, updates are allowed on all provisioning connections while the export operation is in progress.

If set to Blocking, updates are not allowed.

Format: list

Range: Non-Blocking, Blocking

Default: Non-Blocking

Remote Export Transfers Enabled If checked, export files are copied to the remote export host

Format: Check box

Range: Checked, Unchecked

Default: Unchecked

Remote Export Host IP Address The IP address of the remote export host to where export files may be configured automatically transferred

Format: Alphanumeric

Range: 0–39 characters

Range: Either an IPv4 or an IPv6 IP address.

IPv4 addresses are 32 bits, represented in a dot-decimal notation like this: x.x.x.x where each x (called an octet) is a decimal value from 0 to 255. They are separated by periods. For example: 1.2.3.4 and 192.168.1.100 are valid IPv4 addresses.

IPv6 addresses are 128 bits, represented in a colon-hexadecimal notation like this: z:z:z:z:z:z:z:z where each z is a group of hexadecimal digits ranging from 0 to ffff. They are separated by colons. Leading zeros may be omitted in each group. "::" can be used (at most once) in an IPv6 address to represent a range of as many zero fields as needed to populate the address to eight fields. So the IPv6 address 2001:db8:c18:1:260:3eff:fe47:1530 can also be represented as 2001:0db8:0c18:0001:​0260:3eff:fe47:1530 and the IPv6 address ::1 is the same as 0000:0000:0000:0000:​​0000:0000:0000:0001

Remote Export User The username for remote export host user

Format: Alphanumeric

Range: 0–255 characters

Remote Export Password The Password to exchange ssh keys with the remote export host. The password is cleared from this table after the keys have been exchanged.

Format: Alphanumeric

Range: 0–255 characters

Remote Export Directory The directory in the Remote Export Host to which export files are transferred if configured

Format: Alphanumeric

Range: 0–255 characters

Remote Audit Receive Window Size The maximum number of retrieval messages that can be received and buffered by the Provisioning Database Application on the remote system. After this amount is reached, no more messages are sent until acknowledgments are received from the remote system.

Format: Digits only

Range: 5–2500

Default: 500

Remote Audit Send Message Rate The maximum rate of messages/second in which retrieval messages are sent to the Provisioning Database Application on the remote systems.

Format: Digits only

Range: 5–2500

Default: 500

Remote Audit Number Range Limit The maximum number of records that can be queried per request message

Format: Digits only

Range: 100–100000

Default: 1000

PDB Relay Enabled

Whether or not to relay successful incoming provisioning requests to a Provisioning Database Application on a remote system.

Note: This feature requires that the Log Provisioning Messages option is enabled.

Format: Check box

Range: Checked, Unchecked

Default: Unchecked

PDB Relay Primary Remote System VIP Address

The VIP address of the primary remote system of the Provisioning Database Application that is running.

Note: Changes to the VIP address listening port do not take affect until PDB Relay is restarted.

Format: Alphanumeric

Range: 0–39 characters

Range: Either an IPv4 or an IPv6 IP address.

IPv4 addresses are 32 bits, represented in a dot-decimal notation like this: x.x.x.x where each x (called an octet) is a decimal value from 0 to 255. They are separated by periods. For example: 1.2.3.4 and 192.168.1.100 are valid IPv4 addresses.

IPv6 addresses are 128 bits, represented in a colon-hexadecimal notation like this: z:z:z:z:z:z:z:z where each z is a group of hexadecimal digits ranging from 0 to ffff. They are separated by colons. Leading zeros may be omitted in each group. "::" can be used (at most once) in an IPv6 address to represent a range of as many zero fields as needed to populate the address to eight fields. So the IPv6 address 2001:db8:c18:1:260:3eff:fe47:1530 can also be represented as 2001:0db8:0c18:0001:​0260:3eff:fe47:1530 and the IPv6 address ::1 is the same as 0000:0000:0000:0000:​​0000:0000:0000:0001

PDB Relay Disaster Recovery Remote System VIP Address

The VIP address of the Disaster Recovery remote system on which the Provisioning Database Application is running.

Note: Changes to the VIP address do not take affect until PDB Relay is restarted.

Format: Alphanumeric

Range: 0–39 characters

IPv4 addresses are 32 bits, represented in a dot-decimal notation like this: x.x.x.x where each x (called an octet) is a decimal value from 0 to 255. They are separated by periods. For example: 1.2.3.4 and 192.168.1.100 are valid IPv4 addresses.

IPv6 addresses are 128 bits, represented in a colon-hexadecimal notation like this: z:z:z:z:z:z:z:z where each z is a group of hexadecimal digits ranging from 0 to ffff. They are separated by colons. Leading zeros may be omitted in each group. "::" can be used (at most once) in an IPv6 address to represent a range of as many zero fields as needed to populate the address to eight fields. So the IPv6 address 2001:db8:c18:1:260:3eff:fe47:1530 can also be represented as 2001:0db8:0c18:0001:​0260:3eff:fe47:1530 and the IPv6 address ::1 is the same as 0000:0000:0000:0000:​​0000:0000:0000:0001

PDB Relay Remote System Port

The TCP listening port of the Provisioning Database Application on the remote system.

Note: Changes to the TCP listening port do not take affect until PDB Relay is restarted.

Format: Digits only

Range: 0–65535

Default: 5873

PDB Relay Receive Window Size The maximum number of provisioning commands that can be received and buffered by the Provisioning Database Application on the remote system. After this amount is reached, no more commands are sent until acknowledgments are received from the remote system.

Format: Digits only

Range: 5–2500

Default: 1000

PDB Relay Send Command Rate The maximum rate (in commands/second) in which commands are relayed/sent to the Provisioning Database Application on remote system

Format: Digits only

Range: 5–2500

Default: 1000

PDB Relay Timestamp (read-only) The timestamp of the last provisioning message relayed to the Provisioning Database Application on the remote system Format: Read-only timestamp
XML Interface Port

XML interface TCP (unsecured) listening port.

To disable this port, set it to 0.

Note: Changes to the TCP listening port do not take effect until the xds process is restarted. You must also specify a different port other than the SOAP interface.

Format: Digits only

Range: 0–65535

Default: 5875

XML Interface Idle Timeout The maximum number of seconds an open connection remains active without a request being sent before the connection is dropped

Format: Digits only; seconds

Range: 1–86400

Default: 1200

Maximum XML Connections

The maximum number of simultaneous XML interface client connections.

Note: Changes to the Maximum XML Connections option do not take effect until the xds process is restarted.

Format: Digits only

Range: 1–120

Default: 120

SOAP Interface Port

The SOAP interface TCP listening port.

To disable this port, set it to 0.

Note: Changes to the TCP listening port do not take effect until the xds process is restarted. You must also specify a different port other than the XML interface.

Format: Digits only

Range: 0–65535

Default: 5876

SOAP Interface Idle Timeout The maximum time (in seconds) an open connection remains active without a request being sent, before the connection is dropped

Format: Digits only

Range = 1-86400

Default = 1200

Maximum SOAP Connections

The maximum number of simultaneous SOAP interface client connections.

Note: Changes to the Maximum SOAP Connections option do not take effect until the xds process is restarted.

Format: Digits only

Range: 1–120

Default: 120

SOAP Secure Mode

If set to Secure, the SOAP interface operates in secure mode (using TSL).

Note: Changes to the SOAP Secure Mode option do not take effect until the xds process is restarted.

Format: list

Range: Secure, Unsecure

Default: Unsecure

Maximum Transaction Lifetime

The maximum number of seconds a transaction remains open before automatically being rolled back if a commit or rollback is not performed.

To disable this timeout, set it to 0.

Format: Digits only; seconds

Range: 0–3600

Default: 60

Maintain Subscriber Timestamp (read-only)

Whether or not to maintain subscriber creation and last updated timestamp.

Note: Changes to this option do not take effect until the application processes are restarted.

Format: Check box

Range: Checked, Unchecked

Default: Unchecked