This chapter lists and describes the WebLogic Scripting Tool (WLST) commands and their options for Oracle Traffic Director in alphabetical order.
Description
Activates changes saved during the current editing session but not yet deployed. This command prints a message if a server restart is required for the changes that are being activated.
The activate command returns the latest ActivationTask
MBean which reflects the state of changes that a user is currently making or has made recently. You can then invoke methods to get information about the latest Configuration Manager activate task in progress or just completed. In the event of an error, the command returns a WLSTException
.
Use this command to deploy the configuration changes to the instances. Note that this command will deploy only the changes done after starting an edit session by executing the command startEdit
. Also, the effect of this command is not limited to Oracle Traffic Director. All the changes done after starting an edit session to the various other components and managed servers will also be deployed.
Syntax
activate([timeout], [block])
Argument | Definition |
---|---|
timeout
|
Optional. Time (in milliseconds) that WLST waits for the activation of configuration changes to complete before canceling the operation. A value of -1 indicates that the operation will not time out. This argument defaults to 300,000 ms (or 5 minutes). |
block
|
Optional. Boolean value specifying whether WLST should block user interaction until the command completes. This argument defaults to |
Example
The following example activates the changes made during the current edit session that have been saved to disk, but that have not yet been activated. WLST waits for 100,000 ms for the activation to complete, and 200,000 ms before the activation is stopped.
wls:/mydomain/edit !> activate(200000, block='true') Activating all your changes, this may take a while ... The edit lock associated with this edit session is released once the activation is completed. Action completed. wls:/mydomain/edit>
Description
Deletes a certificate or trusted certificate from the keystore using its alias.
Syntax
deleteKeyStoreEntry(appStripe='stripe', name='keystore', password='password', alias='alias', keypassword='keypassword')
Argument | Definition |
---|---|
svc
|
Specifies the service command object obtained through a call to getOpssService(). |
appStripe
|
Specifies the name of the stripe where the keystore resides. |
name
|
Specifies the name of the keystore. |
password
|
Specifies the keystore password. |
alias
|
Specifies the alias of the entry to be deleted. |
keypassword
|
Specifies the key password of the entry to be deleted. |
Example
This example deletes a keystore entry denoted by alias mycert
.
svc = getOpssService("KeyStoreService") svc.deleteKeyStoreEntry(appStripe='OTD', name='myconfig', password='', alias='mycert', keypassword='')
See Also
help, exportKeyStoreCertificateRequest, otd_listCertificates, importKeyStoreCertificate, getKeyStoreCertificates, generateKeyPair, Also see deleteKeyStoreEntry in Infrastructure Security WLST Command Reference.
Description
Use this command to view the contents of Oracle Traffic Director log files, the access log, tcp access log and error log. The access log records information about requests to and responses from the server.
The command returns a value only when the returnData option is set to true. By default it will not return any data. The return value depends on the option used.
Syntax
displayLogs([searchString,][options])
Argument | Definition |
---|---|
searchString |
An optional search string. Only messages that contain the given string (case-insensitive) will be returned. Note that the displayLogs command can read logs in multiple formats and it converts the messages to ODL format. The search will be performed in the native format, if possible. Otherwise, it may be performed in the message contents, and it may exclude mark-up. Therefore you should avoid using mark-up characters in the search string. |
target |
Optional. The name of a WebLogic Server instance, or a system component. For a system component, the syntax for the target is:
sc:component-name
In connected mode, the default target is the WebLogic domain. In disconnected mode, there is no default; the target option is required. |
oracleInstance |
Optional. Defines the path to the ORACLE_INSTANCE or WebLogic domain home. The command is executed in disconnected mode when you use this parameter. |
log |
Optional. A log file path. The command will read messages from the given log file. If the log file path is not given, the command will read all logs associated with the given target. |
last |
Optional. An integer value. Restricts the search to messages logged within the last minutes. The value can have a suffix |
tail |
Optional. An integer value. Restrict the search to the last n messages from each log file and limits the number of messages displayed to n. |
pattern |
Optional. A regular expression pattern. Only messages that contain the given pattern are returned. Using the pattern option is similar to using the searchString argument, except that you can use a regular expression. The regular expression pattern search is case sensitive (unless you explicitly turn on case-insensitive flags in the pattern). The pattern must follow java.util.regex syntax. |
ecid |
Optional. A string or string sequence containing one or more Execution Context ID (ECID) values to be used as a filter for log messages. |
component |
Optional. A string or string sequence containing one or more component ID values to be used as a filter for log messages. |
module |
Optional. A string or string sequence containing one or more module ID values to be used as a filter for log messages. |
type |
Optional. A string or string sequence containing one or more message type values to be used as a filter for log messages. |
app |
Optional. A string or string sequence containing one or more application values to be used as a filter for log messages. |
query |
Optional. A string that specifies an expression used to filter the contents of log messages. A simple expression has the form: field-name operator value where field-name is a log record field name and operator is an appropriate operator for the field type (for example, you can specify equals, startsWith, contains or matches for string fields). A field name is either one of the standard ODL attribute names (such as COMPONENT_ID, MSG_TYPE, MSG_TEXT, and SUPPL_DETAIL), or the name of a supplemental attribute (application specific), prefixed by SUPPL_ATTR. (For example, SUPPL_ATTR.myAttribute). A few common supplemental attributes can be used without the prefix. For example, you can use You can combine multiple simple expressions using the boolean operators See Administering Oracle Fusion Middleware for a detailed description of the query syntax. |
groupBy |
Optional. A string list. When the groupBy option is used, the output is a count of log messages, grouped by the attributes defined in the string list. |
orderBy |
Optional. A string list that defines the sort order for the result. The values are log message attribute names. The name may be extended with an optional suffix By default, the result is sorted by time. |
returnData |
Optional. A Jython boolean value (0 or 1). If the value is true the command will return data (for example, to be used in a script). The default value is false, which means that the command only displays the data but does not return any data. |
format |
Optional. A string defined the output format. Valid values are ODL-Text, ODL-XML, ODL-complete and simple. The default format is ODL-Text. |
exportFile |
Optional. The name of a file to where the command output is written. By default, the output is written to standard output. |
follow (f) |
Optional. Puts the command in "follow" mode so that it continues to read the logs and display messages as new messages are added to the logs (similar to the UNIX |
Example
displayLogs(target="sc:otd_test_varunam.in.example.com")
Description
This WLST command can be used to display runtime statistics about a server instance.
Syntax
displayMetricTables([metricTable_1] [, metricTable_2], [...] [, servers] [, variables])
Argument | Definition |
---|---|
metricTable_n
|
Optional. Specifies a list of metric tables. By default, this argument displays all available metrics. The metric table name can contain special characters for simple pattern matching. The character '?' matches any single character. The character '*' matches zero or more characters. You specify the metric table name. You can specify multiple metric table names in a comma-separated list. These are the same names output by the WLST command displayMetricTableNames. |
servers |
Optional. Specifies the servers from which to retrieve metrics. Valid values are a list of WebLogic Server instance names and system component names. To specify one server, use the following syntax: servers='servername' To specify multiple servers, use one of the following syntax options: servers=['servername1', 'servername2', ...] servers=('servername1', 'servername2', ...) If this argument is not specified, the command returns the list of metric tables for all WebLogic servers and system components. For system components, such as Oracle HTTP Server, use the following format: servers=['component_name], servertype='component_type') |
variables |
Optional. Defines the metric aggregation parameters. Valid values are a set of name-value pairs. It uses the following syntax: variables={name1:value1, name2:value2, ...} The specific name-value pairs depend on the aggregated metric tables. Each aggregated metric table has its specific set of variable names. |
Example
Note that at least a single Oracle Traffic Director instance needs to be running for the following examples to work correctly.
# View metrics for all OTD instances displayMetricTables('OTD_*') # View origin server metrics for all instances displayMetricTables('OTD_OriginServer') # Get list of metric tables for a specific instance displayMetricTableNames(servers='/OTD/otd_test_myserver.example.com') # View all metrics for a specific instance displayMetricTables(servers='/OTD/otd_test_myserver.example.com') # View instance metrics for a specific instance displayMetricTables('OTD_Instance', servers='/OTD/otd_test_myserver.example.com')
Description
Executing this command before activate
lets the activate
call overwrite the local configuration file modifications on instances with their corresponding server versions.
An activate
call would fail if there are any local configuration file modifications on the instance. In such a case, you would want to either discard the changes on the instance or pull the changes from the instance to the config store by executing pullComponentChanges
. In either case, you should execute the command enableOverwriteComponentChanges
before activate such that the activate call would not fail because of the local modifications on the instance.
Note:
This command can only be executed from an open edit session. See resync/resyncAll for overriding instance changes outside of an open edit session.
Syntax
enableOverwriteComponentChanges()
Example
props={'configuration': 'test', 'name': 'var_foo', 'value': 'bar'} otd_createVariable(props) activate() weblogic.management.provider.UpdateException: [Management:141191]The prepare phase of the configuration update failed with an exception. Caused by: weblogic.nodemanager.NMException: Received error message from Node Manager Server: [ChangeList validation failed for transaction '3033897627106602' with cause: OTD-67807 Validation failed for instance 'otd_test.example.com': The instance configuration has been locally modified. The following changes can either be discarded on the next activate using 'enableOverwriteComponentChanges' or pulled into the current configuration using 'pullComponentChanges'. Modified files: config/server.xml,config/test-obj.conf,config/obj.conf # Scenario 1: Pull the changes on instance to config store and call enableOverwriteComponentChanges and activate. showComponentChanges("otd_test.example.com") component otd_test.example.com changes on machine example.com: edit OTD/test/config/obj.conf 2014.12.01-16:20:50 1970.01.01-05:29:59 edit OTD/test/config/test-obj.conf 2014.12.01-16:20:50 1970.01.01-05:29:59 edit OTD/test/config/server.xml 2014.12.01-16:50:27 2014.12.01-16:49:44 pullComponentChanges("otd_test.example.com") pull component otd_test.example.com changes on machine in.example.com: edit OTD/test/config/obj.conf edit OTD/test/config/test-obj.conf edit OTD/test/config/server.xml enableOverwriteComponentChanges() activate() Activating all your changes, this may take a while ... The edit lock associated with this edit session is released once the activation is completed. Activation completed # Scenario 2: Discard the changes on the instance and override them with changes from the current edit session showComponentChanges("otd_test.example.com") component otd_test.example.com changes on machine example.com: edit OTD/test/config/obj.conf 2014.12.01-16:55:29 1970.01.01-05:29:59 edit OTD/test/config/test-obj.conf 2014.12.01-16:55:29 1970.01.01-05:29:59 edit OTD/test/config/server.xml 2014.12.01-16:55:29 2014.12.01-16:58:23 enableOverwriteComponentChanges() activate() Activating all your changes, this may take a while ... The edit lock associated with this edit session is released once the activation is completed. Activation completed
See Also
help, pullComponentChanges, resync/resyncAll, showComponentChanges, stopEdit, undo
Description
Exports a certificate, trusted certificate or certificate chain.
Syntax
exportKeyStoreCertificate(appStripe='stripe', name='keystore',password='password', alias='alias', keypassword='keypassword', type='entrytype',filepath='absolute_file_path')
Argument | Definition |
---|---|
svc
|
Specifies the service command object obtained through a call to getOpssService(). |
appStripe
|
Specifies the name of the stripe where the keystore resides. |
name
|
Specifies the name of the keystore. |
password
|
Specifies the keystore password. |
alias
|
Specifies the alias of the entry to be exported |
keypassword
|
Specifies the key password. |
type
|
Specifies the type of keystore entry to be exported. Valid values are 'Certificate', 'TrustedCertificate' or 'CertificateChain'. |
filepath
|
Specifies the absolute path of the file where certificate, trusted certificate or certificate chain is exported. |
Example
svc = getOpssService("KeyStoreService") svc.exportKeyStoreCertificate(appStripe='OTD', name='myconfig', password='', alias='mycert', keypassword='', type='Certificate', filepath='/scratch/cert.txt')
See Also
help, importKeyStoreCertificate, otd_listCertificates, deleteKeyStoreEntry, getKeyStoreCertificates, exportKeyStoreCertificate in Infrastructure Security WLST Command Reference.
Description
Generate a certificate signing request for a key pair and saves it to a file. This Base64-encoded certificate request can be submitted to a third-party Certificate Authority (CA) which will verify the sender, sign and return the signed certificate.
Syntax
exportKeyStoreCertificateRequest(appStripe='stripe', name='keystore', password='password', alias='alias', keypassword='keypassword', filepath='absolute_file_path')
Argument | Definition |
---|---|
svc
|
Specifies the service command object obtained through a call to getOpssService(). |
appStripe
|
Specifies the name of the stripe where the keystore resides. |
name
|
Specifies the name of the keystore. |
password
|
Specifies the keystore password. |
alias
|
Specifies the entry's alias name. |
keypassword
|
Specifies the key password. |
filepath
|
Specifies the absolute path of the file where certificate request is exported. |
Example
svc = getOpssService("KeyStoreService") # generate a key pair with the proper DN svc.generateKeyPair(appStripe='OTD', name='myconfig', password='', alias='mycert', keypassword='', dn='CN=test.example.com, OU=Webtier, O=\'Company Name\', ST=California, C=US', keysize='1024') # generate the CSR and put it in to a text file svc.exportKeyStoreCertificateRequest(appStripe='OTD', name='myconfig', password='', alias='mycert', keypassword='', filepath='/scratch/certreq.crt')
See Also
help, importKeyStoreCertificate, otd_listCertificates, deleteKeyStoreEntry, getKeyStoreCertificates, exportKeyStoreCertificateRequest in Infrastructure Security WLST Command Reference.
Description
Use this command to generate a key pair in a keystore and wrap it in a demo CA-signed certificate. This command is the equivalent of creating a self-signed certificate in Release 11g. You can use this key pair to generate a certificate signing request (CSR) using exportKeyStoreCertificateRequest
which you can submit to a third-party Certificate Authority (CA) for signing.
Syntax
generateKeyPair(appStripe='stripe', name='keystore', password='password', dn='distinguishedname', keysize='keysize', alias='alias', keypassword='keypassword')
Argument | Definition |
---|---|
svc
|
Specifies the service command object obtained through a call to getOpssService(). |
appStripe
|
Specifies the name of the stripe where the keystore resides. |
name
|
Specifies the name of the keystore. |
password
|
Specifies the keystore password. |
dn
|
Specifies the distinguished name of the certificate wrapping the key pair. |
keysize
|
Specifies the key size. |
alias
|
Specifies the alias of the key pair entry. |
keypassword
|
Specifies the key password. |
ext_san
|
subject alternate name extension |
Example
svc = getOpssService("KeyStoreService") svc.generateKeyPair(appStripe='OTD', name='myconfig', password='', alias='mycert', keypassword='', dn='CN=test.example.com, OU=Webtier, O=\'Company Name\', ST=California, C=US', keysize='1024',ext_san="DNS:www.b.com,DNS:www.c.com")
See Also
help, importKeyStoreCertificate, otd_listCertificates, deleteKeyStoreEntry, getKeyStoreCertificates, exportKeyStoreCertificateRequest, generateKeyPair in Infrastructure Security WLST Command Reference.
Description
Use this command to view the certificate properties including subject, issuer, issue date, and expiry date.
Syntax
getKeyStoreCertificates(appStripe='stripe', name='keystore', password='password', alias='alias', keypassword='keypassword')
Argument | Definition |
---|---|
svc
|
Specifies the service command object obtained through a call to getOpssService(). |
appStripe
|
Specifies the name of the stripe where the keystore resides. |
name
|
Specifies the name of the keystore. |
password
|
Specifies the keystore password. |
alias
|
Specifies the alias of the certificate, trusted certificate or certificate chain to be displayed. |
keypassword
|
Specifies the key password. |
Example
svc = getOpssService("KeyStoreService") svc.getKeyStoreCertificates(appStripe='OTD', name='myconfig', password='', alias='mycert')
See Also
help, importKeyStoreCertificate, deleteKeyStoreEntry, otd_listCertificates, generateKeyPair, exportKeyStoreCertificateRequest, getKeyStoreCertificates in Infrastructure Security WLST Command Reference.
Description
Lists all available Oracle Traffic Director custom WLST commands, or lists help for a particular command.
Syntax
To list all available Oracle Traffic Director custom WLST commands:
help('otd')
To list help for a particular command:
help('<otd_custom_command>')
Example
help('otd_createConfiguration')
Description
Imports a CA signed or trusted certificate into the keystore.
Once a CSR is submitted to a CA for signing, the CA signs the request and typically sends the certificate as a Base-64 encoded string. You should import this certificate as type CertificateChain
along with any Intermediate and Root CA certificates using the same alias as that of the key pair that was used to generate the certificate request.
Once you have downloaded your certificate from your CA, you can download any Intermediate and Root certificates from your CA's website, open a text editor and paste the entire body of each certificate into one text file in the following order: Primary Certificate > Intermediate Certificate > Root Certificate.
The file should appear as follows when finished:
-----BEGIN CERTIFICATE----- (Server SSL certificate) -----END CERTIFICATE----- -----BEGIN CERTIFICATE----- (Intermediate certificate) -----END CERTIFICATE----- -----BEGIN CERTIFICATE----- (Root certificate) -----END CERTIFICATE-----
Syntax
importKeyStoreCertificate(appStripe='stripe', name='keystore', password='password', alias='alias', keypassword='keypassword', type='entrytype',filepath='absolute_file_path')
Argument | Definition |
---|---|
svc
|
Specifies the service command object obtained through a call to getOpssService(). |
appStripe
|
Specifies the name of the stripe where the keystore resides. |
name
|
Specifies the name of the keystore. |
password
|
Specifies the keystore password. |
alias
|
Specifies the alias of the entry to be imported. |
keypassword
|
Specifies the key password of the newly imported entry. |
type
|
Specifies the type of keystore entry to be imported. Valid values are 'Certificate', 'TrustedCertificate' or 'CertificateChain'. |
filepath
|
Specifies the absolute path of the file from where certificate, trusted certificate or certificate chain is imported. |
Example
svc = getOpssService("KeyStoreService") # generate a key pair with the proper DN svc.generateKeyPair(appStripe='OTD', name='myconfig', password='', alias='mycert', keypassword='', dn='CN=test.example.com, OU=Webtier, O=\'Company Name\', ST=California, C=US', keysize='1024') # generate the CSR and put it in to a text file svc.exportKeyStoreCertificateRequest(appStripe='OTD', name='myconfig', password='', alias='mycert', keypassword='', filepath='/scratch/certreq.crt') # Submit the CSR to a CA who can sign the certificate and import signed cert into # the keystore using the same alias as the key pair. Note that the file being # imported should contain the CA cert along with the server cert and should be # imported as type 'CertificateChain' svc.importKeyStoreCertificate(appStripe='OTD', name='myconfig', password='', alias='mycert', keypassword='', type='CertificateChain', filepath='/scratch/certsign.pem') # Any CA cert can be imported into the keystore as a trusted cert svc.importKeyStoreCertificate(appStripe='OTD', name='myconfig', password='', alias='ca-cert', keypassword='', type='TrustedCertificate', filepath='/scratch/cacert.crt')
See Also
help, exportKeyStoreCertificateRequest, otd_listCertificates, deleteKeyStoreEntry, getKeyStoreCertificates, generateKeyPair, importKeyStoreCertificate in Infrastructure Security WLST Command Reference.
Description
List certificates expiring in a specified period.
Syntax
listExpiringCertificates(days='days', autorenew=true|false)
Argument | Definition |
---|---|
svc
|
Specifies the service command object obtained through a call to getOpssService(). |
days
|
Specifies that the list should only include certificates within this many days from expiration. |
autorenew
|
Specifies true for automatically renewing expiring certificates, false for only listing them. |
Example
svc = getOpssService("KeyStoreService") svc.listExpiringCertificates(days='365', autorenew=false)
See Also
help, importKeyStoreCertificate, otd_listCertificates, deleteKeyStoreEntry, getKeyStoreCertificates, exportKeyStoreCertificateRequest, listExpiringCertificates in Infrastructure Security WLST Command Reference.
Description
List all the keystores in a stripe. In the case of Oracle Traffic Director, a permission-protected keystore is created at the same time as the configuration and also has the same name as the configuration. Hence the keystore names returned by listKeyStores will typically match the configuration names.
Syntax
listKeyStores(appStripe='stripe')
Argument | Definition |
---|---|
svc
|
Specifies the service command object obtained through a call to getOpssService(). |
appStripe
|
Specifies the name of the stripe whose keystores are listed. |
Example
svc = getOpssService("KeyStoreService") svc.listKeyStores(appStripe='OTD')
See Also
help, importKeyStoreCertificate, otd_listCertificates, deleteKeyStoreEntry, getKeyStoreCertificates, exportKeyStoreCertificateRequest, listKeyStores in Infrastructure Security WLST Command Reference.
Description
List aliases in a keystore. Any certificate that is generated or imported into the keystore will be listed by its alias.
Syntax
listKeyStoreAliases(appStripe='stripe', name='keystore', password='password', type='entrytype')
Argument | Definition |
---|---|
svc
|
Specifies the service command object obtained through a call to getOpssService(). |
appStripe
|
Specifies the name of the stripe where the keystore resides. |
name
|
Specifies the name of the keystore. |
password
|
Specifies the keystore password. |
type
|
Specifies the type of entry for which aliases are listed. Valid values are 'Certificate', 'TrustedCertificate', 'SecretKey' or '*'. |
Example
svc = getOpssService("KeyStoreService") # List all certificates svc.listKeyStoreAliases(appStripe='OTD', name='myconfig', password='', type='*') # List all user certificates (both SSL server and client) svc.listKeyStoreAliases(appStripe='OTD', name='myconfig', password='', type='Certificate') # List only Trusted CA certificates svc.listKeyStoreAliases(appStripe='OTD', name='myconfig', password='', type='TrustedCertificate')
See Also
help, importKeyStoreCertificate, otd_listCertificates, deleteKeyStoreEntry, getKeyStoreCertificates, exportKeyStoreCertificateRequest, listKeyStoreAliases in Infrastructure Security WLST Command Reference.
Description
Use this command to add a failover instance. This command is valid only for active-active failover type. You can add a maximum of 254 instances in a failover group.
Syntax
otd_addFailoverInstance(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-ip |
Virtual IP that uniquely identifies the failure group. |
Mandatory. |
instance |
Name of the instance. |
Mandatory. |
nic |
A network interface, upon which the VIP must be managed. |
Mandatory. |
Example 2-1 Example
props = {} props['configuration'] = 'ha' props['virtual-ip'] = '10.128.67.44' props['instance'] = '1.example.com' props['nic'] = 'eth0' otd_addFailoverInstance(props)
See Also
Description
Use this command to block the generation and forwarding of a particular proxy parameter to the origin server. The information about the proxy parameters and headers is described in otd_forwardProxyInfo.
Note:
If the incoming request contains any of the headers corresponding to the proxy parameters, Oracle Traffic Director will pass-through the incoming request containing this header to the origin server.
Syntax
otd_blockProxyInfo(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server. |
Mandatory. |
route |
Name of the route. |
Mandatory. |
param |
Name of the proxy parameter to be blocked. Range of values: jroute, via, ip, cipher, proxy-agent, keysize, secret-keysize, ssl-id, issuer-dn, user-dn, auth-cert, xforwarded-for, cache-info, ssl. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' props['route'] = 'route-1' props['param'] = 'ssl' otd_blockProxyInfo(props)
See Also
Description
Use this command to create a copy of an existing configuration.
Syntax
otd_copyConfiguration(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
source-configuration |
Name of the configuration to be copied. |
Mandatory. |
dest-configuration |
Name of the new configuration. Name should not contain spaces, invalid characters or non-ASCII characters. |
Mandatory. |
Example
props = {} props['source-configuration'] = 'foo' props['dest-configuration'] = 'bar' otd_copyConfiguration(props)
Description
Use this command to create a copy of an existing virtual server.
Syntax
otd_copyVirtualServer(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
source-virtual-server |
Name of the virtual server to be copied. |
Mandatory. |
dest-virtual-server |
Name of the new virtual server. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['source-virtual-server'] = 'bar' props['dest-virtual-server'] = 'baz' otd_copyVirtualServer(props)
Description
Use this command to create a cache rule with a set of initial values.
Syntax
otd_createCacheRule(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server. |
Mandatory. |
cache-rule |
Name of the cache rule to be created. Only small letters are available. If the value contains capital letters, it will be changed to small letters without any notifications. |
Mandatory. |
condition |
A condition is an expression which if evaluates to true, will result in the rule being executed. Conditions are constructed from literals, variables, functions and operators. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' props['cache-rule'] = 'cache-rule-1' otd_createCacheRule(props)
Description
Use this command to create a compression rule with an initial set of values.
Syntax
otd_createCompressionRule(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server. |
Mandatory. |
compression-rule |
Name of the compression rule to be created. Only small letters are available. If the value contains capital letters, it will be changed to small letters without any notifications. |
Mandatory. |
condition |
A condition is an expression which if evaluates to true, will result in the rule being executed. Conditions are constructed from literals, variables, functions and operators. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' props['compression-rule'] = 'compression-rule-1' otd_createCompressionRule(props)
A configuration is a collection of metadata to instantiate Oracle Traffic Director. You can create a new configuration that listens to HTTP and TCP traffic on a given port and front-ends a set of HTTP and TCP origin servers.
Description
This command creates a default virtual server that handles HTTP traffic and a default TCP proxy that handles TCP traffic. In addition, it creates a default route and forwards all traffic to the origin server.
Syntax
otd_createConfiguration(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
name |
Name of the configuration to be created. Name should not contain spaces, invalid characters or non-ASCII characters. |
Mandatory. |
listener-port |
Listener port through which the server accepts requests. Range of values: port number should be an integer between 1 and 65535, both inclusive. |
Mandatory. |
server-name |
Valid only if |
|
ip |
The server will bind to this Internet Protocol (IP) address for the default listener. Only traffic sent to this IP address will be serviced. * indicates that the server will listen on all IP addresses. Range of values: *, a hostname, or an IPV4/IPV6 address |
|
origin-server-type |
Type of requests handled by the origin servers. Range of values: Default: |
|
origin-server |
A back-end server to which Oracle Traffic Director forwards requests that it receives from clients, and from which it receives responses to client requests. The origin servers could, for example, be application servers like Oracle WebLogic Server, web servers, LDAP servers, and so on. This should be specified as a comma separated list of origin servers of the format host:port. |
Multi-valued. |
Note:
You cannot invoke this command in offline mode until you have read a domain using readDomain
. Make sure to update the domain using updateDomain
after the command to apply the changes.
Example
Online:
# Online props = {} props['name'] = 'foo' props['listener-port'] = '12345' props['server-name'] = 'foo' props['origin-server'] = 'vault.example.com:80' otd_createConfiguration(props)
Offline:
# Offline readDomain('/export/domains/otd_domain') props = {} props['name'] = 'foo' props['listener-port'] = '12345' props['server-name'] = 'foo' props['origin-server'] = 'vault.example.com:80' otd_createConfiguration(props) updateDomain() closeDomain()
Description
Use this command to create a content rule.
Syntax
otd_createContentRule(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server for which the content rule is to be created. |
Mandatory. |
content-rule |
Name of the content rule to be created. Only small letters are available. If the value contains capital letters, it will be changed to small letters without any notifications. |
Mandatory. Name should be unique. |
uri-prefix |
URI prefix that has to be mapped to a directory. |
Mandatory. |
directory-path |
Absolute server path and a valid directory for storing documents. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' props['uri-prefix'] = '/baz' props['directory-path'] = '/qux' props['content-rule'] = 'content-rule-1' otd_createContentRule(props)
Description
Use this command to create an error page corresponding to the specified error code.
Syntax
otd_createErrorPage(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server. |
Mandatory. |
code |
Error code for which you want to create an error page. Range of values: 400 - 599. |
Mandatory. |
error-page |
Absolute path for which an error page is to be created. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' props['code'] = '408' props['error-page'] = '/documents/otd' otd_createErrorPage(props)
See Also
Description
Use this command to create an event.
Syntax
otd_createEvent(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration for which the event is to be created. |
Mandatory. |
event |
Name that uniquely identifies the event. Name can consist of one or more characters. Whitespace is not permitted. |
Mandatory. |
command |
The command that the event executes. Range of values: the value can be restart, reconfig, rotate-log, rotate-access-log, and update-crl, or any executable command. |
Mandatory. |
time |
Time, for example, 12:30, when this event is to be started. Range of values: the format of the time is |
|
month |
Month at which this event should occur. Range of values: 1-12. |
|
day-of-month |
Day of the month at which this event should occur. Range of values: 1-31. |
|
day-of-week |
Day of the week at which this event should occur. Range of values: Sun, Mon, Tue, Wed, Thu, Fri, or Sat. |
|
interval |
Time interval at which this event should occur. Range of values: an interval in seconds between 60 (1 minute) and 86400 (1 day), inclusive. |
|
enabled |
Whether the event is enabled at runtime. Range of values: true or false. Default: true. |
Example
props = {} props['configuration'] = 'foo' props['event'] = 'event-1' props['command'] = 'rotate-log' props['time'] = '12:00' otd_createEvent(props)
Description
Use this command to create an event subscription.
Syntax
otd_createEventSubscription(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration for which the event subscription is to be created. |
Mandatory. |
event-subscription |
User defined name for the event subscription. |
Mandatory. |
URL |
Specifies the subscription URL. If this is configured, Oracle Traffic Director publishes the notification to this URL. Range of values: A valid HTTP URL. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['event-subscription'] = 'bar' props['url'] = 'http://example.com:7777/subscriber' otd_createEventSubscription(props)
Description
Use this command to create a failover group consisting of two Oracle Traffic Director instances grouped by a unique virtual IP address (VIP), to provide high availability in active-passive mode. Requests are received at the specified VIP address and routed to the Oracle Traffic Director instance that is designated as the primary instance. If the primary instance is not reachable, requests are routed to the backup instance.
After creating the failover group, add the failover instance using the otd_addFailoverInstance
command.
There can be a maximum of 255 failover groups, across configurations.
When creating a failover group, if the administration node process is running as non-
root
on the node where the instances are located, then you must run otd_startFailover
on those nodes as a root
user. This is to manually start the failover. If this command is not executed, failover is not started and there will be no high availability.
For information about how failover works in Oracle Traffic Director, see Administering Oracle Traffic Director.
Syntax
otd_createFailoverGroup(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration for which the failover group is to be created. |
Mandatory. |
virtual-ip |
The VIP for which we are creating a failover for. The VIP should belong to the same subnet as that of the nodes in the failover group, and must be accessible to clients. Range of values: host name or an IPv4/IPv6 address. |
Mandatory. |
primary-instance |
An existing instance which is designated as the primary. |
Mandatory. |
backup-instance |
An existing instance which is designated as the backup. |
Mandatory. |
primary-nic |
A network interface, on the node where primary-instance is running, upon which the VIP must be managed. |
Mandatory. |
backup-nic |
A network interface, on the node where backup-instance is running, upon which the VIP must be managed. |
Mandatory. |
router-id |
A VRRP necessity, identifies the VRRP router group that are participating in failover for a VIP. The value should be unique across failover groups. If not specified, the default router-id will be a random number between 1 - 255. Range of values: positive integer, valid range is 1-255. Default: random number between 1 - 255 |
|
type |
Failover group type. Values: Active-passive, Active-active. Default value: Active-passive. Note: This property is valid on a Linux platform only. |
Example
Creating an active-passive failover group
props = {} props['configuration'] = 'ha' props['virtual-ip'] = '192.0.2.1' props['primary-instance'] = '1.example.com' props['backup-instance'] = '2.example.com' props['primary-nic'] = 'eth0' props['backup-nic'] = 'eth0' otd_createFailoverGroup(props)
Creating an active-active failover group
props = {} props['configuration'] = 'ha' props['virtual-ip'] = '192.0.2.1' props['failover-type'] = 'active-active' otd_createFailoverGroup(props)
Description
Use this command to create a new HTTP listener socket with a set of initial values. All virtual servers have an HTTP listener specified. When a new request comes in, Oracle Fusion Middleware determines which virtual server to send it to, based on the configured HTTP listener.
Syntax
otd_createHttpListener(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
http-listener |
Name that uniquely identifies the HTTP listener. Name can consist of one or more characters. Whitespace is not permitted. |
Mandatory. |
port |
Port on which to listen. Range of values: port number between 1 and 65535, inclusive. |
Mandatory. |
server-name |
Default server name. May include a scheme (for example, http://) prefix and port (for example, :80) suffix . Can be a hostname, fully qualified domain name, IP address, or a URL prefix that contains one. The URL prefix must not specify a path. |
Mandatory. |
default-virtual-server-name |
Name of the virtual server that processes requests that did not match a host. |
Mandatory. |
enabled |
Whether the listener is enabled at runtime. Range of values: true or false. Default: true. |
|
ip |
IP address on which to listen. Range of values: *, a hostname, or an IP address. |
|
acceptor-threads |
Number of threads dedicated to accepting connections received by this listener. Range of values: 1 - 128. Default: auto-tuned. |
|
blocking-io |
Whether the server uses blocking IO. Range of values: true or false. Default: false. |
|
blocking-accept |
Enables/Disables blocking of the server Listen Socket while retaining client end points as non blocking (useful when MaxProcs > 1). Range of values: true or false. Default: false. |
|
handle-protocol-mismatch |
Range of values: true or false. Default: true. |
|
family |
The socket family used to connect to the origin server. Range of values: default, inet, inet6, or inet-sdp Default: auto-tuned. |
|
listen-queue-size |
Maximum size of the operating system listen queue backlog. Range of values: 1 - 1048576. Default: 128. |
|
receive-buffer-size |
Size (in bytes) of the operating system socket receive buffer. Range of values: size in bytes between 0 and 2147483647, inclusive. |
|
send-buffer-size |
Size (in bytes) of the operating system socket send buffer. Range of values: size in bytes between 0 and 2147483647, inclusive. |
|
max-requests-per-connection |
Maximum number of keep-alive requests that will be handled per HTTP connection after which the keep-alive connection will be closed. 0 indicates no limit. Range of values: any positive Integer Default: 0. |
|
description |
Description of the HTTP listener for the administrator's reference. |
Example
props = {} props['configuration'] = 'foo' props['http-listener'] = 'http-listener-1' props['port'] = '23456' props['server-name'] = 'example.com' props['default-virtual-server-name'] = 'bar' otd_createHttpListener(props)
Description
Use this command to create an instance of this configuration on the specified machine. Instance refers to the environment of an Oracle Fusion Middleware daemon, including its configuration, log files, and other runtime artifacts such as lock databases, caches, and temporary files.
Syntax
otd_createInstance(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
machine-name |
Name specified while creating the machine in the Oracle WebLogic Server console corresponding to the host name of the machine on which the Oracle Traffic Director instance is running. |
Mandatory. |
Note:
When this command is executed in offline mode, the instance file artifacts are created only if the machine specified is on the same host as that of the admin server. Otherwise, the instance file artifacts will get created after the start of both admin server and node manager.
Example
# Online props = {} props['configuration'] = 'foo' props['machine-name'] = 'machine1' otd_createInstance(props) # Offline readDomain('/export/domains/otd_domain') props = {} props['configuration'] = 'foo' props['machine-name'] = 'machine1' otd_createInstance(props) updateDomain() closeDomain()
See Also
help, otd_deleteInstance, otd_listInstances, start, stop, softRestart
Description
Use this command to create a MIME type.
Syntax
otd_createMimeType(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
content-type |
The content type of the MIME types. |
Mandatory. |
extensions |
The file extension for the MIME value. |
Mandatory. To define multiple file extensions, separate them by a comma (,) |
Example
props = {} props['configuration'] = 'foo' props['content-type'] = 'bar' props['extensions'] = 'baz' otd_createMimeType(props)
See Also
Description
Use this command to create a origin pool server with a set of initial values to the existing origin server pool. The origin server defines a member of a server pool.
Syntax
otd_createOriginServer(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
origin-server-pool |
Name of the origin server pool. |
Mandatory. |
host |
IP address/Host name of this origin server. Range of values: hostname or IP address. |
Mandatory. |
port |
Port number of this origin server. Range of values: port number between 1 and 65535, inclusive. |
Mandatory. |
weight |
Load distribution weight for this origin server. Range of values: 1 - 1000. Default: 1 |
|
backup |
The parameter specifies if the origin server is a backup server. Range of values: true or false. Default: false. |
|
max-connections |
The maximum number of concurrent connections to a server. Range of values: 0 - 20480. Default: 0. |
|
ramp-up-time |
The time in seconds to ramp the sending rate up to the capacity of a newly up origin server. If the parameter is not specified, request rate accelerating will not be activated for the server. Range of values: an interval in seconds between 0.001 and 3600 (1 hour), inclusive. Default: 0.001. |
Example
props = {} props['configuration'] = 'foo' props['origin-server-pool'] = 'origin-server-pool-1' props['host'] = 'www.example.com' props['port'] = '12345' otd_createOriginServer(props)
Description
Use this command to create a origin-server pool. The origin-server pool configures a pool of origin servers that are used for load balancing requests.
Syntax
otd_createOriginServerPool(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
origin-server-pool |
Name by which this server pool is referenced. Name can consist of one or more characters, whitespace is not permitted. |
Mandatory. |
origin-server |
Represents an origin server that belongs to this server pool. Multiple comma separated values can be specified. |
Multi-valued. |
type |
Specifies the type of (requests handled by) every server in this server pool. Range of values: tcp, http, or https. Default: http. |
|
family |
The socket family used to connect to servers in this pool. Range of values: default, inet, inet6, or inet-sdp. Default: auto-tuned. |
|
load-distribution |
Algorithm that is used for load distribution of this server pool. Range of values: round-robin, least-connection-count, or least-response-time. Default: round-robin. |
|
proxy-server |
Name of the proxy-server in the form of host:port. |
Example
props = {} props['configuration'] = 'foo' props['origin-server-pool'] = 'origin-server-pool-1' props['origin-server'] = 'www.example.com:12345' otd_createOriginServerPool(props)
Description
Use this command to create a request limit rule with a set of initial values.
Syntax
otd_createRequestLimit(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server. |
Mandatory. |
request-limit |
Name of the request limit rule. Only small letters are available. If the value contains capital letters, it will be changed to small letters without any notifications. |
Mandatory. |
condition |
A condition is an expression which if evaluates to true, will result in the rule being executed. Conditions are constructed from literals, variables, functions and operators. |
|
max-rps |
Maximum number of requests that the virtual server can receive per second. |
|
max-connections |
Maximum number of concurrent matching connections. |
|
monitor-attribute |
Request attribute to monitor. |
Example
props = {}props['configuration'] = 'foo'props['virtual-server'] = 'bar'props['request-limit'] = 'request-limit-1' props['max-connections'] = '2048' otd_createRequestLimit(props)
Description
Use this command to create a route with a set of initial values. Based on the condition specified while creating a route, the load balancing requests are routed to the specified origin-server pool. A default route is created when a virtual-server is created.
Syntax
otd_createRoute(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server. |
Mandatory. |
route |
Name of the route to be created. Only small letters are available. If the value contains capital letters, it will be changed to small letters without any notifications. |
Mandatory. |
origin-server-pool |
Name of the origin server pool to which the load balancing requests must be routed. |
Mandatory. |
condition |
A condition is an expression which if evaluates to true, will result in the rule being executed. Conditions are constructed from literals, variables, functions and operators. |
|
uri-prefix |
A uri-prefix is a URI path with wildcard patterns. If a request URI matches with the uri-prefix then the rule will be executed. |
|
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' props['route'] = 'route-1' props['origin-server-pool'] = 'origin-server-pool-1' otd_createRoute(props)
Description
This command creates operating system service for the specified instance. This command should be executed as a privileged user on the machine on which the instance exists. By default, the name of the service would be the instance's name. If there exists a service already with the instance name, the service name will be suffixed with hash of instance-home. By default the service will be run as the user who owns the instance. The service can be run as a different user by modifying {SERVICE_USER} variable in /etc/init.d/<instance_name>
The service will not be created if an existing service is found for an instance.
Syntax
otd_createService(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
domain-home |
Path to the directory that contains Oracle Traffic Director domain |
Mandatory. |
instance |
Name of the Oracle Traffic Director instance. |
Mandatory. |
Example
props = {} props['domain-home'] = '/export/domains/otd_domain' props['instance'] = 'otd_foo_machine1' otd_createService(props)
By default the service will not be restarted on machine's restart. This can be changed by the user by executing the following command manually.
$ chkconfig <service-name> on <run levels>
See Also
Description
Use this command to create an Oracle Traffic Director standalone domain at the given location.
This command can only be run in offline mode.
Syntax
otd_createStandaloneDomain(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
domain-home |
Path to the domain directory which should contain the Oracle Traffic Director standalone domain. |
Mandatory. |
Example
props = {} props['domain-home'] = '/export/domains/otd_standalone' otd_createStandaloneDomain(props)
Description
Use this command to create an Oracle Traffic Director instance in an Oracle Traffic Director standalone domain.
This command can only be run in offline mode.
Syntax
otd_createStandaloneInstance(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
instance |
Name of the instance to be created. |
Mandatory. |
domain-home |
Path to the domain directory which should contain the Oracle Traffic Director standalone domain. |
Mandatory. |
listener-port |
Listener port through which the server accepts requests. Range of values: port number should be an integer between 1 and 65535, both inclusive. |
Mandatory. |
server-name |
Valid only if origin-server-type is http or https. The server name is used in any URLs that are generated automatically by the server and sent to the client. This server name should be the virtual host name or alias name if your server uses an alias. If a colon and port number are appended to the server name then that port is used in the generated URLs. |
|
ip |
The server will bind to this Internet Protocol (IP) address for the default listener. Only traffic sent to this IP address will be serviced. * indicates that the server will listen on all IP addresses. Range of values: *, a hostname, or an IPV4/IPV6 address. |
|
origin-server-type |
Type of requests handled by the origin servers. Range of values: http/https/tcp. Default: http. |
|
origin-server |
A back-end server to which Oracle Traffic Director forwards requests that it receives from clients, and from which it receives responses to client requests. The origin servers could, for example, be application servers like Oracle WebLogic Server, web servers, LDAP servers, and so on. Specified as a comma separated list of origin servers of the format host:port. |
Example
props = {} props['name'] = 'foo' props['domain-home'] = '/export/domains/otd_standalone' props['listener-port'] = '12345' props['server-name'] = 'foo.bar' otd_createStandaloneInstance(props)
Description
Use this command to create a new TCP listener with a set of initial values. When a new request comes in, Oracle Traffic Director determines which TCP proxy to send it to, based on the configured TCP listener.
Syntax
otd_createTcpListener(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
tcp-listener |
Name that uniquely identifies the listener. Name can consist of one or more characters. Whitespace is not permitted. |
Mandatory. |
port |
Port on which to listen. Range of values: port number between 1 and 65535, inclusive. |
Mandatory. |
tcp-proxy-name |
Name that identifies the exposed TCP service. |
Mandatory. |
enabled |
Whether the instance is enabled. Range of values: true or false. Default: true. |
|
ip |
IP address on which to listen. Range of values: hostname, or an IP address. |
|
acceptor-threads |
Acceptor threads for this listening end point. Range of values: 1 - 128. Default: auto-tuned. |
|
blocking-accept |
Enables/Disables blocking of the server Listen Socket while retaining client end points as non blocking (useful when Range of values: true or false. Default: false. |
|
description |
Description of the TCP listener for the administrator's reference. |
|
family |
Protocol family. Range of values: default, inet, inet6, or inet-sdp. Default: auto-tuned. |
|
listen-queue-size |
Maximum size of the operating system listen queue backlog. Range of values: 1 - 1048576. Default: 128. |
|
receive-buffer-size |
Size (in bytes) of the operating system socket receive buffer. Range of values: size in bytes between 0 and 2147483647, inclusive. |
|
send-buffer-size |
Size (in bytes) of the operating system socket send buffer. Range of values: size in bytes between 0 and 2147483647, inclusive. |
Example
props = {} props['configuration'] = 'foo' props['tcp-listener'] = 'tcp-listener-1' props['port'] = '34567' props['tcp-proxy-name'] = 'tcp-proxy-1' otd_createTcpListener(props)
Description
Use this command to create a new TCP proxy with a set of initial values. A TCP proxy handles TCP requests through TCP listeners for traffic tunnelling to the listed origin servers. A TCP proxy can have several TCP listeners associated with it.
You can enable FTP support for a TCP proxy. This will enable the TCP proxy along with the TCP listeners referring to it to be used to front-end an FTP server.
Syntax
otd_createTcpProxy(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
tcp-proxy |
Name that uniquely identifies the exposed TCP service. |
Mandatory. |
origin-server-pool |
Name of an existing server pool that provides the TCP service. |
Mandatory. |
enabled |
Whether the TCP service is enabled. Range of values: true or false. Default: true. |
|
session-idle-timeout |
Maximum timeout in seconds for load balancer to wait for receiving/sending data in the session. Range of values: an interval in seconds between 0.001 and 3600 (1 hour), inclusive. |
|
protocol |
If the protocol is 'ftp', the TCP proxy would have additional ftp properties that can be set/get using otd_setTcpProxyProperties/otd_getTcpProxyProperties. Range of values: *, ftp. Default value: *. |
When otd_createTcpProxy is executed with protocol as FTP, the FTP configuration is enabled for the TCP proxy with properties ssl-termination, origin-explicit-ftps and client-explicit-ftps as false, true and true respectively.
Example
props = {} props['configuration'] = 'foo' props['tcp-proxy'] = 'bar' props['protocol'] = 'ftp' props['origin-server-pool-name'] = 'tcp-origin-server-pool-1' otd_createTcpProxy(props)
Description
Use this command to define a variable for use in expressions, log formats, and obj.conf
parameters.
Syntax
otd_createConfigurationVariable(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
name |
Variable name consisting of letters, numbers, and underscores. Variable names must not begin with a number. |
Mandatory. |
value |
Value corresponding to a variable name. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['name'] = 'bar' props['value'] = 'baz' otd_createConfigurationVariable(props)
Description
Use this command to create a new virtual server with initial values defined.
Syntax
otd_createVirtualServer(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name that uniquely identifies the virtual server. Name can consist of one or more characters. Whitespace is not permitted. |
Mandatory. |
origin-server-pool |
Name of the origin server pool for which a virtual-server is to be created. |
Mandatory. |
canonical-server-name |
Canonical hostname of the virtual server (requests using a different hostname will be redirected to this hostname). Can be a Hostname, fully qualified domain name, IP address, or a URL prefix that contains one. The URL prefix must not specify a path. |
|
log-file |
Log file for the virtual server. |
|
http-listener |
Name of an HTTP listener associated with one or more of the virtual server's host hostnames. Multiple comma separated values can be specified. |
Multi-valued. |
host |
Hostname of the virtual server services. Multiple comma separated values can be specified where each value can be a wildcard pattern that matches one or more hostnames. |
Multi-valued. Mandatory if |
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' props['origin-server-pool'] = 'origin-server-pool-1' otd_createVirtualServer(props)
Description
Use this command to create a variable at the virtual server level. You can use the variable in expressions, log formats, and obj.conf
parameters.
Syntax
otd_createVirtualServerVariable(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server for which the variable is to be created. |
Mandatory. |
name |
Variable name consisting of letters, numbers, and underscores. Variable names must not begin with a number. |
Mandatory. |
value |
Value corresponding to the variable. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' props['name'] = 'baz' props['value'] = 'qux' otd_createVirtualServerVariable(props)
Description
Use this command to delete the cache rule with the specified name.
Syntax
otd_deleteCacheRule(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server. |
Mandatory. |
cache-rule |
Name of the cache rule to be deleted. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' props['cache-rule'] = 'cache-rule-1' otd_deleteCacheRule(props)
See Also
Description
Use this command to delete the compression rule with the specified name.
Syntax
otd_deleteCompressionRule(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server. |
Mandatory. |
compression-rule |
Name of the compression rule to be deleted. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' props['compression-rule'] = 'compression-rule-1' otd_deleteCompressionRule(props)
Description
Use this command to delete an existing configuration file.
Syntax
otd_deleteConfigFile(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
config-file |
Name of the configuration file to be deleted. This can be any existing configuration file except |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['config-file'] = 'bar.conf' otd_deleteConfigFile(props)
Description
Use this command to delete the configuration if it does not have any instances associated with it.
Syntax
otd_deleteConfiguration(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
name |
Name of the configuration to be deleted. |
Mandatory. |
domain-home |
Path to the directory which contains an Oracle Traffic Director domain. |
Mandatory for Offline, not valid for Online. |
Example
# Online props = {} props['name'] = 'foo' otd_deleteConfiguration(props) # Offline readDomain('/export/domains/otd_domain') props = {} props['name'] = 'foo' otd_deleteConfiguration(props) updateDomain() closeDomain()
Description
Use this command to delete a ruleset file for a web application firewall installed at the configuration level.
Syntax
otd_deleteConfigurationWebappFirewallRulesetFile(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
ruleset-file |
Name of the ruleset file that needs to be deleted. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['ruleset-file'] = 'bar.conf' otd_deleteConfigurationWebappFirewallRulesetFile(props)
Description
Use this command to delete a content rule.
Syntax
otd_deleteContentRule(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server. |
Mandatory. |
content-rule |
Name of the content rule to be deleted. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' props['content-rule'] = 'content-rule-1' otd_deleteContentRule(props)
Description
Use this command to delete a certificate revocation list (CRL).
Syntax
otd_deleteCrl(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
issuer |
Name of the CRL issuer. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['issuer'] = 'CN=GlobalSign ServerSign CA,OU=ServerSign CA,O=GlobalSign nv-sa,C=BE' otd_deleteCrl(props)
See Also
Description
Use this command to delete the error page corresponding to the specified error code.
Syntax
otd_deleteErrorPage(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server. |
Mandatory. |
code |
Error code for which the error page is to be deleted. Range of values: 400 - 599. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' props['code'] = '408' otd_deleteErrorPage(props)
See Also
Description
Use this command to delete a scheduled event.
Syntax
otd_deleteEvent(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
event |
Name that uniquely identifies the event. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['event'] = 'event-1' otd_deleteEvent(props)
Description
Use this command to delete an event subscription.
Syntax
otd_deleteEventSubscription(props)
The argument props is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
event-subscription |
User defined name for the event subscription. |
Mandatory. |
Example 2-2 Example
props = {} props['configuration'] = 'foo' props['event-subscription'] = 'bar' otd_deleteEventSubscription(props)
Description
Use this command to delete the specified failover group. To change the VIP or any property of a failover group, you should delete the failover group and create it afresh.
When deleting a failover group, if the administration node process is running as non-root
on the node where the instances are located and if at least one failover group is still available, then you must run otd_startFailover
on those nodes as a root
user. This is to manually restart the failover. On the other hand, after deleting a failover group, if no other failover groups are available for the corresponding instances, then otd_stopFailover
must be executed to stop the failover. If you do not execute either otd_startFailover or otd_stopFailover
, then the VIP associated with the deleted failover group will continue to be available.
Syntax
otd_deleteFailoverGroup(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-ip |
The VIP for the failover group to be deleted. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['virtual-ip'] = '10.128.10.10' otd_deleteFailoverGroup(props)
Description
Use this command to delete an HTTP listener socket with the specified name.
Syntax
otd_deleteHttpListener(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
http-listener |
Name of the HTTP listener to be deleted. |
Mandatory. |
force |
Enables the forced deletion of the HTTP listener. Default: false. |
Example
props = {} props['configuration'] = 'foo' props['http-listener'] = 'http-listener-1' otd_deleteHttpListener(props)
Description
Use this command to delete the specified instance.
Syntax
otd_deleteInstance(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration to which the instance belongs to. |
Mandatory. |
instance |
Name of the instance to be deleted. |
Mandatory. |
Note:
When this command is executed in offline mode, the instance file artifacts are deleted only if the machine specified is on the same host as that of the admin server. Otherwise, the instance file artifacts will get deleted after the start of both admin server and node manager.
Example
# Online props = {} props['configuration'] = 'foo' props['instance'] = 'otd_foo_machine1' otd_deleteInstance(props) # Offline readDomain('/export/.../domains/otd_domain') props = {} props['configuration'] = 'foo' props['instance'] = 'otd_foo_machine1' otd_deleteInstance(props) updateDomain() closeDomain()
See Also
help, otd_createInstance, otd_listInstances, start, stop, softRestart
Description
Use this command to delete a MIME type.
Syntax
otd_deleteMimeType(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
content-type |
The content type of the MIME types. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['content-type'] = 'bar' otd_deleteMimeType(props)
See Also
Description
Use this command to delete an origin server with the specified host and port.
Syntax
otd_deleteOriginServer(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
origin-server-pool |
Name of the origin server pool. |
Mandatory. |
host |
IP address/Host name of the origin server to be deleted. |
Mandatory. |
port |
Port number of the origin server to be deleted. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['origin-server-pool'] = 'origin-server-pool-1' props['host'] = 'www.example.com' props['port'] = '12345' otd_deleteOriginServer(props)
Description
Use this command to delete the origin-server pool with the specified name.
Syntax
otd_deleteOriginServerPool(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
origin-server-pool |
Name of the origin server pool to be deleted. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['origin-server-pool'] = 'origin-server-pool-1' otd_deleteOriginServerPool(props)
Description
Use this command to delete the request limit with the specified name.
Syntax
otd_deleteRequestLimit(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server. |
Mandatory. |
request-limit |
Name of the request limit rule. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' props['request-limit'] = 'request-limit-1' otd_deleteRequestLimit(props)
Description
Use this command to delete the route with the specified name.
Syntax
otd_deleteRoute(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server. |
Mandatory. |
route |
Name of the route to be deleted. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' props['route'] = 'route-1' otd_deleteRoute(props)
Description
This command removes the operating system service for the specified instance if it exists. This command should be executed as a privileged user on the machine on which the instance exists.
Syntax
otd_deleteService(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
domain-home |
Path to the directory that contains Oracle Traffic Director domain. |
Mandatory. |
instance |
Name of the Oracle Traffic Director instance. |
Mandatory. |
Example 2-3 Example Title
props = {} props['domain-home'] = '/export/domains/otd_domain' props['instance'] = 'otd_foo_machine1' otd_deleteService(props)
See Also
Description
Use this command to delete an Oracle Traffic Director instance with the specified name in an Oracle Traffic Director standalone domain.
This command can only be run in offline mode.
Syntax
otd_deleteStandaloneInstance(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
instance |
Name of the instance to be deleted. |
Mandatory. |
domain-home |
Path to the domain directory which should contain the Oracle Traffic Director standalone domain. |
Mandatory. |
Example
props = {} props['instance'] = 'foo' props['domain-home'] = '/export/domains/otd_standalone' otd_deleteStandaloneInstance(props)
Description
Use this command to delete the TCP listener with the specified name.
Syntax
otd_deleteTcpListener(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
tcp-listener |
Name of the TCP listener to be deleted. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['tcp-listener'] = 'tcp-listener-1' otd_deleteTcpListener(props)
Description
Use this command to delete the TCP proxy with the specified name.
Syntax
otd_deleteTcpProxy(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
tcp-proxy |
Name of the TCP proxy to be deleted. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['tcp-proxy'] = 'bar' otd_deleteTcpProxy(props)
Description
Use this command to delete a variable defined at the configuration level.
Syntax
otd_deleteConfigurationVariable(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
name |
Name of the variable to be deleted. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['name'] = 'bar' otd_deleteConfigurationVariable(props)
Description
Use this command to delete the virtual server with the specified name.
Syntax
otd_deleteVirtualServer(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server to be deleted. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' otd_deleteVirtualServer(props)
Description
Use this command to delete the variable with the specified name defined at the virtual server level.
Syntax
otd_deleteVirtualServerVariable(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server. |
Mandatory. |
name |
Name of the variable to be deleted. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' props['name'] = 'baz' otd_deleteVirtualServerVariable(props)
Description
Use this command to delete a ruleset file for a web application firewall installed at the virtual server level.
Syntax
otd_deleteVirtualServerWebappFirewallRulesetFile(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server. |
Mandatory. |
ruleset-filename |
Name of the ruleset file that needs to be deleted. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' props['ruleset-file'] = 'baz.conf' otd_deleteVirtualServerWebappFirewallRulesetFile(props)
Description
Use this command to disable maintenance for the origin server pool.
Syntax
otd_disableOriginServerPoolMaintenance(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
origin-server-pool |
Name of the origin server pool. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['origin-server-pool'] = 'origin-server-pool-1' otd_disableOriginServerPoolMaintenance(props)
Description
Use this command to disable access to perfdump
output through a URI.
Syntax
otd_disablePerfDump(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' otd_disablePerfDump(props)
See Also
Description
Use this command to disable events for a specific request limit.
Syntax
otd_disableRequestLimitEvents(props)
The argument 'props' is a dictionary that must contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server. |
Mandatory. |
request-limit |
Name of the request-limit to be disabled. |
Mandatory. |
Example 2-4 Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' props['request-limit'] = 'request-limit-1' otd_disableRequestLimitEvents(props)
Description
Use this command to disable the route authentication.
Syntax
otd_disableRouteAuth(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server. |
Mandatory. |
route |
Name of the route. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' props['route'] = 'route' otd_disableRouteAuth(props)
See Also
Description
Use this command to disable bandwidth limiting at the route level.
Syntax
otd_disableRouteBandwidthLimit(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server. |
Mandatory. |
route |
Name of the route. |
Mandatory. |
type |
Type of bandwidth limiting to be disabled. Range of values: |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' props['route'] = 'route-1' props['type'] = 'request' otd_disableRouteBandwidthLimit(props)
Description
Use this command to disable access to virtual server statistics in XML format through a URI.
Syntax
otd_disableStatsXml(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' otd_disableStatsXml(props)
Description
Use this command to disable Status Listener of an instance.
Syntax
otd_disableStatusListener(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
Example 2-5 Example
props = {} props['configuration'] = 'foo' otd_disableStatusListener(props)
Description
Use this command to disable the access log for a virtual server.
Syntax
otd_disableVirtualServerAccessLog(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' otd_disableVirtualServerAccessLog(props)
Description
Use this command to disable the web application firewall for the virtual server.
Syntax
otd_disableWebAppFirewall(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' otd_disableWebappFirewall(props)
Description
Use this command to disable request bandwidth limiting at the virtual server level.
Syntax
otd_disableVirtualServerRequestBandwidthLimit(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' otd_disableVirtualServerRequestBandwidthLimit(props)
Description
Use this command to disable response bandwidth limiting at the virtual server level.
Syntax
otd_disableVirtualServerResponseBandwidthLimit(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' otd_disableVirtualServerResponseBandwidthLimit(props)
Description
Use this command to enable the maintenance for an origin-server-pool.
Syntax
otd_enableOriginServerPoolMaintenance(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
origin-server-pool |
Name of the origin server pool. |
Mandatory. |
response-code |
Specifies the response code of the request when it lands on a maintenance enabled origin server pool. When this is not configured, its implicit value will be 200 if |
|
response-file |
Absolute path of an HTML file to send to the client when the request lands on a maintenance enabled origin server pool. |
Example
props = {} props['configuration'] = 'foo' props['origin-server-pool'] = 'origin-server-pool-1' props['response-code'] = '503' otd_enableOriginServerPoolMaintenance(props)
Description
Enables access to perfdump
output through a URI. The perfdump
utility collects the Oracle Traffic Director performance data and displays it in ASCII format. This utility allows you to monitor a greater variety of statistics. With perfdump
, the statistics are unified. Rather than monitoring a single process, statistics are multiplied by the number of processes. This gives you a more accurate view of the server performance.
Syntax
otd_enablePerfDump(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server. |
Mandatory. |
uri |
The URI at which the Default: /.perf. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' otd_enablePerfDump(props)
Description
Use this command to enable the route authentication.
Syntax
otd_enableRouteAuth(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server. |
Mandatory. |
route |
Name of the route. |
Mandatory. |
auth-user |
Specifies the authenticated user. |
Mandatory. |
auth-password |
Specifies the password for the user. |
Mandatory. |
auth-header |
Specifies the name of the authentication header. Default is Authorization. |
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' props['route'] = 'route-1' props['auth-user'] = 'baz' props['auth-password'] = 'qux' otd_enableRouteAuth(props)
See Also
Description
Use this command to enable bandwidth limiting at the route level.
Syntax
otd_enableRouteBandwidthLimit(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server for which bandwidth limit is to be enabled. |
Mandatory. |
route |
Name of the route for which bandwidth limit is to be enabled. |
Mandatory. |
type |
Type of bandwidth limiting is to be applied. Range of values: |
Mandatory. |
max-bps-per-monitor |
Value in bytes/sec for maximum request bandwidth for the entire bucket. Default: 0. |
Setting it to 0 means no bandwidth limiting is done. |
max-bps-per-connection |
Value in bytes/sec for maximum request bandwidth per connection. Default: 0. |
Setting it to 0 means no bandwidth limiting is done. |
timeout |
Value in second. Request is aborted when it had to wait in the queue for this much time. Default: 60. |
|
monitor |
Name of bucket to which the request belongs to. Default: $ip if type is "response". |
|
error-code |
HTTP error code that is returned when request is aborted. Range of value: 400-599. Default: 503. |
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' props['route'] = 'route-1' props['type'] = 'request' props['max-bps-per-monitor'] = '512' otd_enableRouteBandwidthLimit(props)
Description
Use this command to enable events for a specified request limit.
Syntax
otd_enableRequestLimitEvents(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server. |
Mandatory. |
request-limit |
Name of the request limit to be enabled. |
Mandatory. |
event-notification-interval |
Time interval (in seconds). A notification message will be sent to subscribers once every interval and will include information on all monitors that exceeded the request limit that was configured for them. Range: An interval in seconds between 1 and 32767, inclusive |
Mandatory. |
Example 2-6 Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' props['request-limit'] = 'request-limit-1' props['event-notification-interval'] = '60' otd_enableRequestLimitEvents(props)
Description
Use this command to enable access to virtual server statistics in XML format through a URI.
Syntax
otd_enableStatsXml(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server. |
Mandatory. |
uri |
The URI at which the statistics report in XML format should be available. Default: /stats-xml. |
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' otd_enableStatsXml(props)
Description
Use this command to enable listeners for status check requests. In addition, use this command to change the properties of an enabled Status Listener.
Syntax
otd_enableStatusListener(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
port |
Port on which to listen. Range of values: port number 1 and 65535, inclusive. |
Mandatory. |
ip |
IP address on which to listen. Range of values: hostname, or an IP address. |
|
family |
Protocol family. Range of values: default, inet, or inet6. Default: default |
Example 2-7 Example
props = {} props['configuration'] = 'foo' props['port'] = '12345' otd_enableStatusListener(props)
Description
Use this command to enable the web application firewall for a specific virtual server.
Syntax
otd_enableWebAppFirewall(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' otd_enableWebappFirewall(props)
Description
Use this command to enable the access log for a virtual server.
Syntax
otd_VirtualServerAccessLog(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server. |
Mandatory. |
log-file |
Path to the file where access logs for this configuration will be stored. Default: $DOMAIN_HOME/servers/$INSTANCE_NAME/logs/access.log |
|
format |
A format is a string that can be used to customize the format and the fields that are logged in the access log. Default: %Ses->client.ip% - %Req->vars.auth-user% %SYSDATE% "%Req->reqpb.clf-request%" %Req->srvhdrs.clf-status% %Req->srvhdrs.content-length% %Req->vars.ecid% %Req->vars.origin-server% |
|
log-ip |
Whether to log the IP of the client into the access log. Range of values: true or false. Default: false. |
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' props['log-file'] = 'logs/access.log' otd_enableVirtualServerAccessLog(props)
Description
Use this command to enable request bandwidth limiting at the virtual server level.
Syntax
otd_enableVirtualServerRequestBandwidthLimit(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server for which bandwidth limit is to be enabled. |
Mandatory. |
max-bps-per-monitor |
Value in bytes/sec for maximum request bandwidth for the entire bucket. Default: 0. |
Setting it to 0 means no bandwidth limiting is done. |
max-bps-per-connection |
Value in bytes/sec for maximum request bandwidth per connection. Default: 0. |
Setting it to 0 means no bandwidth limiting is done. |
timeout |
Value in second. Request is aborted when it had to wait in the queue for this much time. Default: 60. |
|
monitor |
Name of bucket to which the request belongs to. Default: $ip if type is "response". |
|
error-code |
HTTP error code that is returned when request is aborted. Range of value: 400-599. Default: 503. |
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' props['max-bps-per-monitor'] = '1024' otd_enableVirtualServerRequestBandwidthLimit(props)
Description
Use this command to enable response bandwidth limiting at the virtual server level.
Syntax
otd_enableVirtualServerResponseBandwidthLimit(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server for which bandwidth limit is to be enabled. |
Mandatory. |
max-bps-per-monitor |
Value in bytes/sec for maximum request bandwidth for the entire bucket. Default: 0. |
Setting it to 0 means no bandwidth limiting is done. |
max-bps-per-connection |
Value in bytes/sec for maximum request bandwidth per connection. Default: 0. |
Setting it to 0 means no bandwidth limiting is done. |
timeout |
Value in second. Request is aborted when it had to wait in the queue for this much time. Default: 60. |
|
monitor |
Name of bucket to which the request belongs to. Default: $ip if type is "response". |
|
error-code |
HTTP error code that is returned when request is aborted. Range of value: 400-599. Default: 503. |
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' props['max-bps-per-monitor'] = '1024' otd_enableVirtualServerResponseBandwidthLimit(props)
Description
Use this command to export all the certificates within a keystore into an Oracle wallet which will be placed in the config
directory of the configuration. If wallet password is set then the exported wallet is a password protected wallet (ewallet.p12), otherwise it is an auto login only wallet (cwallet.sso).
Syntax
otd_exportKeyStore(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' otd_exportKeyStore(props)
Description
Use this command to forward the proxy information. Information about a particular proxy parameter is generated and forwarded to the origin server using a HTTP header. Note that the HTTP header used by default is different depending on whether or not the origin server is Oracle WebLogic Server.
Parameter Name | Description | Default HTTP Header for WLS | Default HTTP Header for non-WLS |
---|---|---|---|
jroute |
Information about request routing used by the set-origin-server function and some Servlet containers to implement session stickiness. |
Proxy-jroute |
Proxy-jroute |
via |
Proxy servers and protocol versions that were involved in routing a request. |
Via |
Via |
ip |
Client's actual IP address. |
Wl-proxy-client-ip |
Client-ip |
xforwarded-for |
Used to keep track of the originating client IP connecting through a proxy. |
X-forwarded-for |
X-forwarded-for |
proxy-agent |
Proxy server product name and version. |
Proxy-agent |
Proxy-agent |
cache-info |
Client cache hits. |
Cache-info |
Cache-info |
ssl |
A value of true/false indicating whether the client connection was over SSL |
Wl-proxy-ssl |
Proxy-ssl |
cipher |
Client's SSL/TLS cipher suite. |
Proxy-cipher |
Proxy-cipher |
keysize |
Client's SSL/TLS key size. |
Wl-Proxy-client-keysize |
Proxy-keysize |
secret-keysize |
Size of the client's SSL/TLS secret key. |
Wl-proxy-client-secretkeysize |
Proxy-secret-keysize |
ssl-id |
Client's SSL/TLS session ID. |
Proxy-ssl-id |
Proxy-ssl-id |
auth-cert |
Client's SSL/TLS certificate in X.509 format. |
Wl-proxy-client-cert |
Proxy-auth-cert |
user-dn |
Distinguished name of the subject of the client's SSL/TLS certificate. |
Proxy-user-dn |
Proxy-user-dn |
issuer-dn |
Distinguished name of the issuer of the client's SSL/TLS certificate. |
Proxy-issuer-dn |
Proxy-issuer-dn |
Syntax
otd_forwardProxyInfo(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server. |
Mandatory. |
route |
Name of the route. |
Mandatory. |
param |
Name of the proxy parameter to be blocked. Range of values: jroute, via, ip, cipher, proxy-agent, keysize, secret-keysize, ssl-id, issuer-dn, user-dn, auth-cert, xforwarded-for, cache-info, ssl. |
Mandatory. |
header |
Name of the HTTP header used to send the proxy parameter to the origin server. Default: the default HTTP header corresponding to the specified proxy parameter. |
Mandatory. |
Note:
If an incoming request includes the specified header, Oracle Traffic Director will replace the header from the request that is forwarded to the origin server with the generated header.
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' props['route'] = 'route-1' props['param'] = 'via' otd_forwardProxyInfo(props)
See Also
Description
Use this command to view the access-log buffer properties. The properties that this command returns are described in otd_setAccessLogBufferProperties.
Syntax
otd_getAccessLogBufferProperties(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' otd_getAccessLogBufferProperties(props)
Description
Use this command to view the cache properties. The properties that this command returns are described in otd_setCacheProperties.
Syntax
otd_getCacheProperties(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' otd_getCacheProperties(props)
See Also
Description
Use this command to view the cache rule properties. The properties that this command returns are described in otd_setCacheRuleProperties.
Syntax
otd_getCacheRuleProperties(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server. |
Mandatory. |
cache-rule |
Name of the cache rule. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' props['cache-rule'] = 'cache-rule-1' otd_getCacheRuleProperties(props)
See Also
Description
Use this command to view compression rule properties. The properties that this command returns are described in otd_setCompressionRuleProperties.
Syntax
otd_getCompressionRuleProperties(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server. |
Mandatory. |
compression-rule |
Name of the compression rule. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' props['compression-rule'] = 'compression-rule-1' otd_getCompressionRuleProperties(props)
Description
Use this command to view the contents of a configuration file.
Syntax
otd_getConfigFile(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
config-file |
Name of the configuration file that needs to be fetched. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['config-file'] = 'foo-obj.conf' otd_getConfigFile(props)
Description
Use this command to view these access-log properties for a configuration:
Property | Description |
---|---|
file |
Path to the file where access logs for this configuration will be stored. Default: $DOMAIN_HOME/servers/$INSTANCE_NAME/logs/access.log |
format |
A format is a string that can be used to customize the format and the fields that are logged in the access log. Default: %Ses->client.ip% - %Req->vars.auth-user% %SYSDATE% "%Req->reqpb.clf-request%" %Req->srvhdrs.clf-status% %Req->srvhdrs.content-length% %Req->vars.ecid% %Req->vars.origin-server% |
default-access-log-format |
Default format for the access log entries: %Ses->client.ip% - %Req->vars.auth-user% %SYSDATE% "%Req->reqpb.clf-request%" %Req->srvhdrs.clf-status% %Req->srvhdrs.content-length% %Req->vars.ecid% %Req->vars.origin-server% |
Syntax
otd_getConfigurationAccessLogProperties(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' otd_getConfigurationAccessLogProperties(props)
Description
Use this command to view the certificate revocation list (CRL) properties. The properties that this command returns are described in otd_setConfigurationCrlProperties.
Syntax
otd_getConfigurationCrlProperties(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' otd_getConfigurationCrlProperties(props)
See Also
Description
Use this command to view the configuration properties. The properties that this command returns are described in otd_setConfigurationProperties.
Syntax
otd_getConfigurationProperties(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' otd_getConfigurationProperties(props)
See Also
Description
Use this command to view the content rule properties. The properties that this command returns are described in otd_setContentRuleProperties.
Syntax
otd_getContentRuleProperties(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server. |
Mandatory. |
content-rule |
Name of the content rule. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' props['content-rule'] = 'content-rule-1' otd_getContentRuleProperties(props)
See Also
Description
Use this command to view the Domain Name Server (DNS) cache properties. The properties that this command returns are described in otd_setDnsCacheProperties.
Syntax
otd_getDnsCacheProperties(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' otd_getDnsCacheProperties(props)
See Also
Description
Use this command to view the Domain Name Server (DNS) properties. DNS associates a standard IP address such as, 192.0.3.11, with host names such as, www.example.com. The properties that this command returns are described in otd_setDnsProperties.
Syntax
otd_getDnsProperties(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' otd_getDnsProperties(props)
See Also
Description
Use this command to get the event properties. The properties that this command returns are described in otd_setEventProperties.
Syntax
otd_getEventProperties(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
event |
Name of the event. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['event'] = 'bar' otd_getEventProperties(props)
See Also
help, otd_deleteEvent, otd_listEvents, otd_setEventProperties
Description
Use this command to get the event subscription properties.
Syntax
otd_getEventSubscriptionProperties(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
event-subscription |
User defined name of the event subscription. |
Mandatory. |
Example 2-8 Example
props = {} props['configuration'] = 'foo' props['event-subscription'] = 'bar' otd_getEventSubscriptionProperties(props)
Description
Use this command to view the file cache properties. The properties that this command returns are described in otd_setFileCacheProperties.
Syntax
otd_getFileCacheProperties(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' otd_getFileCacheProperties(props)
See Also
Description
Use this command to view the following properties of a failover group:
Property | Description | Comments |
---|---|---|
virtual-ip |
The VIP for which we are creating a failover for. The VIP should belong to the same subnet as that of the nodes in the failover group, and must be accessible to clients. Range of values: host name or an IPv4/IPv6 address. |
Mandatory. |
primary-instance |
An existing instance which is designated as the primary. |
Mandatory. |
backup-instance |
An existing instance which is designated as the backup. |
Mandatory. |
primary-nic |
A network interface, on the node where primary-instance is running, upon which the VIP must be managed. |
Mandatory. |
backup-nic |
A network interface, on the node where backup-instance is running, upon which the VIP must be managed. |
Mandatory. |
router-id |
A VRRP necessity, identifies the VRRP router group that are participating in failover for a VIP. The value should be unique across failover groups. Range of values: positive integer, valid range is 1-255. Default: random number between 1 - 255 |
This command lists the following additional property.
Property | Description | Comments |
---|---|---|
type |
Failover group type. |
Syntax
otd_getFailoverGroupProperties(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration for which the failover group is to be created. |
Mandatory. |
virtual-ip |
Virtual IP that uniquely identifies the failover group. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['virtual-ip'] = '192.0.2.1' otd_getFailoverGroupProperties(props)
Description
Use this command to view the health-check properties. The properties that this command returns are described in otd_setHealthCheckProperties.
Syntax
otd_getHealthCheckProperties(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
origin-server-pool |
Name of the origin server pool. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['origin-server-pool'] = 'origin-server-pool-1' otd_getHealthCheckProperties(props)
See Also
Description
Use this command to view the HTTP listener properties. The properties that this command returns are described in otd_setHttpListenerProperties.
Syntax
otd_getHttpListenerProperties(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
http-listener |
Name of the HTTP listener. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['http-listener'] = 'http-listener-1' otd_getHttpListenerProperties(props)
Description
Use this command to view the Secure Sockets Layer (SSL) properties for an HTTP listener. SSL is a software library establishing a secure connection between the client and server. SSL is used to implement HTTPS, the secure version of HTTP.
The properties that this command returns are described in otd_setHttpListenerSslProperties.
Syntax
otd_getHttpListenerSslProperties(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
http-listener |
Name of the HTTP listener. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['http-listener'] = 'http-listener-1' otd_getHttpListenerSslProperties(props)
See Also
Description
Use this command to view the HTTP properties. The properties that this command returns are described in otd_setHttpProperties.
Syntax
otd_getHttpProperties(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' otd_getHttpProperties(props)
See Also
Description
Use this command to view the thread-pool properties. You can use thread pools to allocate a certain number of threads to a specific service. By defining a pool with the maximum number of threads as 1, only one request is allowed to the specified service function. The properties that this command returns are described in otd_setHttpThreadPoolProperties.
Syntax
otd_getHttpThreadPoolProperties(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' otd_getHttpThreadPoolProperties(props)
See Also
Description
Use this command to view the keep-alive properties. The keep-alive or HTTP/1.1 persistent connection handling subsystem in Oracle Traffic Director is designed to be scalable. If the configuration does not conform as required, the performance can be less than optimal if the workload is not persistent (that is, HTTP/1.0 without the KeepAlive header), or for a lightly loaded system that is primarily servicing keep-alive connections. The properties that this command returns are described in otd_setKeepaliveProperties.
Syntax
otd_getKeepAliveProperties(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' otd_getKeepaliveProperties(props)
See Also
Description
Use this command to view the log properties. The properties that this command returns are described in otd_setLogProperties.
Syntax
otd_getLogProperties(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' otd_getLogProperties(props)
See Also
Description
Use this command to view the maintenance properties for the origin server pool. The properties that this command returns are described in otd_enableOriginServerPoolMaintenance.
Syntax
otd_getOriginServerPoolMaintenanceProperties(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
origin-server-pool |
Name of the origin server pool. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['origin-server-pool'] = 'origin-server-pool-1' otd_getOriginServerPoolMaintenanceProperties(props)
Description
Use this command to view the origin-server pool properties. The properties that this command returns are described in otd_setOriginServerPoolProperties.
Syntax
otd_getOriginServerPoolProperties(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
origin-server-pool |
Name of the origin server pool. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['origin-server-pool'] = 'origin-server-pool-1' otd_getOriginServerPoolProperties(props)
Description
Use this command to view origin server properties. The properties that this command returns are described in otd_setOriginServerPoolProperties.
Syntax
otd_getOriginServerProperties(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
origin-server-pool |
Name of the origin server pool. |
Mandatory. |
host |
IP address/host name of the origin server. |
Mandatory. |
port |
Port number of the origin server. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['origin-server-pool'] = 'origin-server-pool-1' props['host'] = 'www.example.com' props['port'] = '12345' otd_getOriginServerProperties(props)
Description
Use this command to view the SSL properties of the origin server. The properties that this command returns are described in otd_setOriginServerPoolSslProperties.
Syntax
otd_getOriginServerPoolSslProperties(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
origin-server-pool |
Name of the origin server pool. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['origin-server-pool'] = 'origin-server-pool-1' otd_getOriginServerPoolSslProperties(props)
See Also
Description
Use this command to view these access-log properties for a partition:
Property | Description |
---|---|
log-file |
Path to the file where access logs for the partition will be stored. Default: $DOMAIN_HOME/servers/$INSTANCE_NAME/logs/$PARTITION_NAME.log |
format |
A format is a string that can be used to customize the format and the fields that are logged in the partition access log. Default: %Ses->client.ip% - %Req->vars.auth-user% %SYSDATE% "%Req->reqpb.clf-request%" %Req->srvhdrs.clf-status% %Req->srvhdrs.content-length% %Req->vars.ecid% %Req->vars.origin-server% |
default-access-log-format |
Default format for the partition access log entries: %Ses->client.ip% - %Req->vars.auth-user% %SYSDATE% "%Req->reqpb.clf-request%" %Req->srvhdrs.clf-status% %Req->srvhdrs.content-length% %Req->vars.ecid% %Req->vars.origin-server% |
Syntax
otd_getPartitionAccessLogProperties(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. This must be the name of the configuration that is specified while registering the Oracle Traffic Director runtime with the Lifecycle Manager. |
Mandatory. |
partition |
Name of the partition. |
Mandatory. |
Example
props = {} props['configuration'] = 'mt' props['partition'] = 'WLSPartition' otd_getPartitionAccessLogProperties(props)
Description
Use this command to view the runtime statistics for various subsystems as a text report on the browser.
Syntax
otd_getPerfDump(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
instance-name |
Name of the instance. |
Mandatory. |
domain-home |
Path to the directory which contains the Oracle Traffic Director domain |
Mandatory for Offline, not valid for Online. |
Example
# Online props = {} props['instance-name'] = 'otd_abc123.example.com' otd_getPerfDump(props) # Offline props = {} props['domain-home'] = '/export/domains/otd_domain' props['instance-name'] = 'otd_abc123.example.com' otd_getPerfDump(props)
Description
Use this command to get the following perfdump
properties:
Property | Description | Comments |
---|---|---|
enabled |
Whether Default is false. |
Mandatory. |
uri |
The URI at which the Default: /.perf. |
Mandatory. |
Syntax
otd_getPerfDumpProperties(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' otd_getPerfDumpProperties(props)
See Also
help, otd_getPerfDump, otd_enablePerfDump, otd_disablePerfDump
Description
Use this command to view the request-limit properties. The properties that this command returns are described in otd_setRequestLimitProperties.
Syntax
otd_getRequestLimitProperties(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server. |
Mandatory. |
request-limit |
Name of the request limit rule. |
Mandatory. |
event-notification-interval |
Time interval (in seconds). A notification message will be sent to subscribers once every interval and will include information on all monitors that exceeded the request limit that was configured for them. |
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' props['request-limit'] = 'request-limit-1' otd_getRequestLimitProperties(props)
Description
Use this command to view the following route authentication properties:
Property | Description | Comments |
---|---|---|
auth-user |
Specifies the authenticated user. |
Mandatory. |
auth-header |
Specifies the name of the authentication header. Default is Authorization. |
Syntax
otd_getRouteAuthProperties(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server. |
Mandatory. |
route |
Name of the route. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' props['route'] = 'route-1' otd_getRouteAuthProperties(props)
Description
Use this command to get bandwidth limiting properties at the route level.
Syntax
otd_getRouteBandwidthLimitProperties(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server. |
Mandatory. |
route |
Name of the route. |
Mandatory. |
type |
Type of bandwidth limiting. Range of values: |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' props['route'] = 'route-1' props['type'] = 'request' otd_getRouteBandwidthLimitProperties(props)
Description
Use this command to view route properties. The properties that this command returns are described in otd_setRouteProperties.
Syntax
otd_getRouteProperties(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server. |
Mandatory. |
route |
Name of the route. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' props['route'] = 'route-1' otd_getRouteProperties(props)
Description
Use this command to view the Simple Network Management Protocol (SNMP) properties. The properties that this command returns are described in otd_setSnmpProperties.
Syntax
otd_getSnmpProperties(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' otd_getSnmpProperties(props)
Description
Use this command to view the properties that are currently defined for caching SSL session data. The properties that this command returns are described in otd_setSslSessionCacheProperties.
Syntax
otd_getSslSessionCacheProperties(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' otd_getSslSessionCacheProperties(props)
See Also
Description
Use this command to view properties of the statistics collection subsystem. The properties that this command returns are described in otd_setStatsProperties.
Syntax
otd_getStatsProperties(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' otd_getStatsProperties(props)
See Also
Description
Use this command to view runtime statistics for various subsystems in XML format.
Syntax
otd_getStatsXml(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
instance |
Name of the instance. |
Mandatory. |
domain-home |
Path to the directory which contains the Oracle Traffic Director domain. |
Mandatory for Offline, not valid for Online. |
Example
Online syntax:
props = {} props['instance'] = 'otd_foo_machine1' otd_getStatsXml(props)
Offline syntax:
props = {} props['domain-home'] = '/export/domains/otd_domain' props['instance'] = 'otd_foo_machine1' otd_getStatsXml(props)
Description
Use this command to view these properties defined for gathering and reporting statistical data in XML format:
Property | Description | Default |
---|---|---|
enabled |
Whether access to virtual-server statistics in XML format through a URI is enabled. |
false |
url |
The URI at which the statistics report in XML format should be available. |
/stats-xml |
Syntax
otd_getStatsXmlProperties(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' otd_getStatsXmlProperties(props)
See Also
Description
Use this command to view the Status Listener properties.
Syntax
otd_getStatusListenerProperties(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
Example 2-9 Example
props = {} props['configuration'] = 'foo' otd_getStatusListenerProperties(props)
Description
Use this command to view the SSL properties of a Status Listener.
Syntax
otd_getStatusListenerSslProperties(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
Example 2-10 Example
props = {} props['configuration'] = 'foo' otd_getStatusListenerSslProperties(props)
Description
Use this command to view these properties of the TCP access log. The properties that this command returns are described in otd_setTcpAccessLogProperties.
Property | Description |
---|---|
file |
Path to the file where the access log for this configuration will be stored. Default: $DOMAIN_HOME/servers/$INSTANCE_NAME/logs/tcp-access.log |
Syntax
otd_getTcpAccessLogProperties(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' otd_getTcpAccessLogProperties(props)
See Also
Description
Use this command to view the properties of the TCP listener. The properties that this command returns are described in otd_setTcpListenerProperties.
Syntax
otd_getTcpListenerProperties(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
tcp-listener |
Name of the TCP listener. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['tcp-listener'] = 'tcp-listener-1' otd_getTcpListenerProperties(props)
Description
Use this command to view the Secure Sockets Layer (SSL) properties for a TCP listener. SSL is a software library establishing a secure connection between the client and server. SSL is used to implement HTTPS, the secure version of HTTP.
The properties that this command returns are described in otd_setTcpListenerSslProperties.
Syntax
otd_getTcpListenerSslProperties(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
tcp-listener |
Name of the TCP listener. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['tcp-listener'] = 'tcp-listener-1' otd_getTcpListenerSslProperties(props)
See Also
Description
Use this command to view the properties of the TCP proxy.
Syntax
otd_getTcpProxyProperties(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
tcp-proxy |
Name that uniquely identifies the exposed TCP service. |
Mandatory. |
The properties that this command returns are described in otd_setTcpProxyProperties.
Example
props = {} props['configuration'] = 'foo' props['tcp-proxy'] = 'bar' otd_getTcpProxyProperties(props)
Description
Use this command to view the properties of the TCP thread pool. The properties that this command returns are described in otd_setTcpThreadPoolProperties.
Syntax
otd_getTcpThreadPoolProperties(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' otd_getTcpThreadPoolProperties(props)
See Also
Description
Use this command to view the following access-log properties:
Property | Description |
---|---|
enabled |
Whether the server writes to this access log. Range of values: true or false. Default: true. |
file |
Path to the file where access logs for this configuration will be stored. Default: $DOMAIN_HOME/servers/$INSTANCE_NAME/logs/access.log |
format |
A format is a string that can be used to customize the format and the fields that are logged in the access log. Default: %Ses->client.ip% - %Req->vars.auth-user% %SYSDATE% "%Req->reqpb.clf-request%" %Req->srvhdrs.clf-status% %Req->srvhdrs.content-length% %Req->vars.ecid% %Req->vars.origin-server% |
log-ip |
Whether to log the IP of the client into the access log. Range of values: true or false. Default: false. |
default-access-log-format |
Default format for the access log entries: %Ses->client.ip% - %Req->vars.auth-user% %SYSDATE% "%Req->reqpb.clf-request%" %Req->srvhdrs.clf-status% %Req->srvhdrs.content-length% %Req->vars.ecid% %Req->vars.origin-server% |
Syntax
otd_getVirtualServerAccessLogProperties(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' otd_getVirtualServerAccessLogProperties(props
Description
Use this command to get request bandwidth limiting properties at the virtual server level.
Syntax
otd_getVirtualServerRequestBandwidthLimitProperties(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' otd_getVirtualServerRequestBandwidthLimitProperties(props)
Description
Use this command to get response bandwidth limiting properties at the virtual server level.
Syntax
otd_getVirtualServerResponseBandwidthLimitProperties(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' otd_getVirtualServerBandwidthLimitProperties(props)
Description
Use this command to view the properties of a virtual server. The properties that this command returns are described in otd_setVirtualServerProperties.
Syntax
otd_getVirtualServerProperties(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' otd_getVirtualServerProperties(props)
Description
Use this command to get the SSL properties for a virtual server. The properties that this command returns are documented in otd_setVirtualServerSslProperties.
Syntax
otd_getVirtualServerSslProperties(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' otd_getVirtualServerSslProperties(props)
See Also
Description
Use this command to view the properties of a web application firewall. The properties that this command returns are described in otd_setWebappFirewallProperties.
Syntax
otd_getWebappFirewallProperties(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' otd_getWebappFirewallProperties(props)
Description
Use this command to upload a file containing Web Application Firewall (WAF) rules into the server configuration directory. These rules will apply server-wide across all virtual servers.
Syntax
otd_installConfigurationWebappFirewallRulesetFile(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
file-path |
The full path of the ruleset file to be installed. |
Mandatory. |
file-on-server |
Whether the file to be installed is available on the administration server host. Default is false. |
Example
props = {} props['configuration'] = 'foo' props['file-path'] = '/export/bar.conf' otd_installConfigurationWebappFirewallRulesetFile(props)
Description
Use this command to install a certificate revocation list (CRL) issued by a Certificate Authority (CA) into the server configuration directory. A CRL lists all certificates that either client or server users should no longer trust.
Syntax
otd_installCrl(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
file-path |
Specify the full path of the CRL file that you want to install. |
Mandatory. |
file-on-server |
If you specify this option, the CRL file is available on the administration server computer. If you do not specify this option, the CRL file is assumed to be available on the client machine and will be uploaded to the server. |
Example
props = {} props['configuration'] = 'foo' props['file-path'] = '/export/ServerSign.crl' otd_installCrl(props)
See Also
Description
Use this command to upload the web application firewall ruleset files into the server configuration directory. These rules will apply only to requests handled by the specified virtual server.
Syntax
otd_installVirtualServerWebappFirewallRulesetFile(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server. |
Mandatory. |
file-path |
The full path of the ruleset file to be installed. This file should be available on the administration server host. |
Mandatory. |
file-on-server |
Whether the file to be installed is available on the administration server host. Default is false. |
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' props['file-path'] = '/export/rulesets/baz.conf' otd_installVirtualServerWebappFirewallRulesetFile(props)
Description
Use this command to view a list of caching rules defined for the specified virtual server.
Syntax
otd_listCacheRules(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server. |
Mandatory. |
This command returns a list of strings each representing the name of a cache rule.
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' otd_listCacheRules(props)
Description
Use this command to list all the certificates of type 'Certificate' present in the keystore.
Syntax
otd_listCertificates(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
This command returns a list of maps, each map representing one certificate with properties alias
, subject
, issuer,
serial-number
and key-type
.
Example
props = {} props['configuration'] = 'foo' otd_listCertificates(props)
Description
Use this command to list compression rules defined for the specified virtual server.
Syntax
otd_listCompressionRules(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server. |
Mandatory. |
This command returns a list of strings each representing the name of a compression rule.
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' otd_listCompressionRules(props)
Description
Use this command to list configuration files pertaining to the specified configuration.
Syntax
otd_listConfigFiles(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
This command returns a list of strings each representing the name of a configuration file.
Example
props = {} props['configuration'] = 'foo' otd_listConfigFiles(props)
Description
Use this command to return a list of strings each representing the name of an existing configuration.
Syntax
otd_listConfigurations()
Example
# Online otd_listConfigurations() # Offline readDomain('/export/domains/otd_domain') otd_listConfigurations() closeDomain()
Description
Use this command to list all web application firewall rulesets defined for a configuration.
Syntax
otd_listConfigurationWebappFirewallRulesetFiles(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
This command returns a list of strings each representing the name of a web application ruleset file.
Example
props = {} props['configuration'] = 'foo' otd_listConfigurationWebappFirewallRulesetFiles(props)
Description
Use this command to list the content rules.
Syntax
otd_listContentRules(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' otd_listContentRules(props)
Description
Use this command to list all installed certificate revocation lists (CRLs).
Syntax
otd_listCrls(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' otd_listCrls(props)
See Also
Description
Use this command to list all the error pages and their corresponding error codes.
Syntax
otd_listErrorPages(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' otd_listErrorPages(props)
See Also
Description
Use this command to list all scheduled events for a configuration.
Syntax
otd_listEvents(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' otd_listEvents(props)
Description
Use this command to view a list of subscribed event subscriptions.
Syntax
otd_listEventSubscriptions(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Example 2-11 Example
props = {} props['configuration'] = 'foo' otd_listEventSubscriptions(props)
See Also
help,otd_createEventSubscription,otd_deleteEventSubscription,otd_getEventSubscriptionProperties,otd_listEventSubscriptionsDescription
Use this command to return a list of strings each representing the virtual-ip
of an existing failover group.
Syntax
otd_listFailoverGroups(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' otd_listFailoverGroups(props)
Description
Use this command to list all the instances present in an active-active failover group type. This command returns a list of maps, each map representing one instance with properties instance and NIC.
Syntax
otd_listFailoverInstances(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-ip |
Virtual IP that uniquely identifies the failure group. |
Mandatory. |
Example 2-12 Example
To list failover groups, see the following example with the below details.
Configuration: ha
Instance: 1.example.com
Virtual IP address: 10.128.67.44
props = {} props['configuration'] = 'ha' props['virtual-ip'] = '10.128.67.44' props['instance'] = '1.example.com' otd_listFailoverInstances(props)
Description
Use this command to list the names of the HTTP listeners defined for the configuration.
Syntax
otd_listHttpListeners(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
This command returns a list of strings each representing the name of an HTTP listener.
Example
props = {} props['configuration'] = 'foo' otd_listHttpListeners(props)
Description
Use this command to list all instances of this configuration.
Syntax
otd_listInstances(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
This command returns a list of strings each representing the name of an instance.
Example
#Online props = {} props['configuration'] = 'foo' otd_listInstances(props) #Offline readDomain('/export/domains/otd_domain') props = {} props['configuration'] = 'foo' otd_listInstances(props) closeDomain()
See Also
help, otd_createInstance, otd_deleteInstance, start, stop, softRestart
Description
Use this command to list MIME types.
Syntax
otd_listMimeTypes(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' otd_listMimeTypes(props)
See Also
Description
Use this command to view a list of origin-servers defined in a pool.
Syntax
otd_listOriginServers(props)
The argument props
is a dictionary that can contain the following properties, in addition to the properties described in otd_createOriginServer:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
origin-server-pool |
Name of the origin server pool. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['origin-server-pool'] = 'origin-server-pool-1' otd_listOriginServers(props)
Description
Use this command to list origin-server pools defined for a configuration.
Syntax
otd_listOriginServerPools(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
The command returns a list of strings each representing the name of an origin server pool.
Example
props = {} props['configuration'] = 'foo' otd_listOriginServerPools(props)
Description
Use this command to list all the Oracle Traffic Director partitions in a given configuration. The Oracle Traffic Director partition name should be same as the WLS partition name that it front-ends. In that case, it lists all the WLS partitions that are front-ended by Oracle Traffic Director.
Syntax
otd_listPartitions(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. This must be the name of the configuration that is specified while registering the Oracle Traffic Director runtime with the Lifecycle Manager. |
Mandatory. |
Example
props = {} props['configuration'] = 'mt' otd_listPartitions(props)
Description
Use this command to list the information about the proxy parameters configured for the route.
Syntax
otd_listProxyInfo(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server. |
Mandatory. |
route |
Name of the route. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' props['route'] = 'route-1' otd_listProxyInfo(props)
See Also
Description
Use this command to list the request limit conditions defined for a virtual server.
Syntax
otd_listRequestLimits(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server. |
Mandatory. |
This command returns a list of strings each representing the name of a request limit
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' otd_listRequestLimits(props)
Description
Provides information about all the resource-groups
that exist under a given partition. The resource-group
information contains the information about all the virtual-targets
that the resource-group
is targeted to. The virtual-target
information in turn includes the virtual-target
name and the corresponding Oracle Traffic Director artifacts information such as route
name, virtual-server
name and origin-server-pool
name.
Syntax
otd_listResourceGroups(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. This must be the name of the configuration that is specified while registering the Oracle Traffic Director runtime with the Lifecycle Manager. |
Mandatory. |
partition |
Name of the partition. |
Mandatory. |
Example
props = {} props['configuration'] = 'mt' props['partition'] = 'WLSPartition' otd_listResourceGroups(props)
Description
Use this command to list the rules defined for a virtual server.
Syntax
otd_listRoutes(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server. |
Mandatory. |
This command returns a list of strings each representing the name of a route.
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' otd_listRoutes(props)
Description
This command lists the operating system services corresponding to the Oracle Traffic Director instances that exist on the machine where the command is executed. The command returns a list of python dictionaries of name (string) - value (string) pairs where each dictionary contains the properties mentioned below.
Syntax
otd_listServices(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
domain-home |
Path to the directory that contains Oracle Traffic Director domain. |
Mandatory. |
Example 2-13 Example Title
props = {} props['domain-home'] = '/export/domains/otd_domain' otd_listServices(props)
See Also
Description
Use this command to list all the TCP listeners.
Syntax
otd_listTcpListeners(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
This command returns a list of strings each representing the name of a TCP listener.
Example
props = {} props['configuration'] = 'foo' otd_listTcpListeners(props)
Description
Use this command to list all the TCP proxies.
Syntax
otd_listTcpProxies(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
This command returns a list of strings each representing the name of a TCP proxy.
Example
props = {} props['configuration'] = 'foo' otd_listTcpProxies(props)
Description
Use this command to list all the variables defined at the configuration level.
Syntax
otd_listConfigurationVariables(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' otd_listConfigurationVariables(props)
Description
Use this command to list all virtual-servers defined for a configuration.
Syntax
otd_listVirtualServers(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
This command returns a list of strings each representing the name of a virtual server.
Example
props = {} props['configuration'] = 'foo' otd_listVirtualServers(props)
Description
Use this command to list all variables defined at the configuration level.
Syntax
otd_listVirtualServerVariables(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' otd_listVirtualServerVariables(props)
Description
Use this command to list all web application firewall rulesets defined for a virtual server.
Syntax
otd_listVirtualServerWebappFirewallRulesetFiles(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server. |
Mandatory. |
This command returns a list of strings each representing the name of a web application ruleset file.
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' otd_listVirtualServerWebappFirewallRulesetFiles(props)
Description
Use this command to remove a failover instance. This command is valid only for the active-active failover type.
Syntax
otd_removeFailoverInstance(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-ip |
Virtual IP that uniquely identifies the failure group. |
Mandatory. |
instance |
An instance which is part of this failover group. |
Mandatory. |
Example 2-14 Example
Configuration: ha
Instance: 1.example.com
Virtual IP address: 10.128.67.44
props = {} props['configuration'] = 'ha' props['virtual-ip'] = '10.128.67.44' props['instance'] = '1.example.com' otd_removeFailoverInstance(props)
See Also
help, otd_addFailoverInstance,otd_setFailoverInstanceOrderDescription
Use this command to rotate the server log and access log files. The server saves the old log files and marks the saved files with a name that includes the date and time when they were saved.
Note:
Ensure that you are connected to the Administration Server while running this command.Syntax
otd_rotateLog(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
instance-name |
Name of the node whose logs are to be rotated. |
Mandatory. |
Example
props = {} props['instance-name'] = 'otd_foo_machine1' otd_rotateLog(props)
See Also
Description
Use this command to upload changes to an existing configuration file or create a new one.
Syntax
otd_saveConfigFile(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
file-path |
Absolute path to the local file to be uploaded to the configuration directory. |
Mandatory. |
config-file |
Name of the configuration file. |
Example
props = {} props['configuration'] = 'foo' props['file-path'] = '/export/config_files/foo-obj.conf' otd_saveConfigFile(props)
Description
Use this command to set the following properties of the access-log buffer.
Property | Description |
---|---|
enabled |
Whether the system buffers access log updates. Range of values: true or false. Default: true. |
buffer-size |
Size (in bytes) of individual access log buffers. Range of values: 4096 - 1048576. Default: 8192. |
direct-io |
Indicates whether the file system should cache access-log writes. Range of values: true or false. The default value, false, indicates that the file system should cache access log writes. Setting the value to true indicates that the file system should not cache access log writes. The setting is purely advisory; either the server or the operating system may choose to ignore it. |
max-buffers |
Maximum number of access log buffers per server. Range of values: 1 - 65536. Default: 1000. |
max-buffers-per-file |
Maximum number of access log buffers per access log file. Range of values: 1 - 128. Default: auto-tuned. |
max-age |
Maximum amount of time to buffer a given access log entry. Range of values: an interval in seconds between 0.001 and 3600 (1 hour), inclusive. Default: 1. |
Syntax
otd_setAccessLogBufferProperties(props)
The argument props
is a dictionary that can contain the following properties in addition to the properties that can be set (as described above):
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['max-buffers'] = '2000' otd_setAccessLogBufferProperties(props)
Description
Use this command to define or change the following caching properties for a configuration:
Property | Description |
---|---|
enabled |
Defines if caching is enabled or not. Range of values: true or false. Default: true. |
max-entries |
Maximum number of objects for which to cache content. Range of values: 1 - 1073741824. Default: 1024. |
replacement |
Cache entry replacement algorithm. Range of values: lru, lfu, or false. Default: lru. |
max-heap-object-size |
Maximum size of response (single entry) (in bytes) to cache on the heap. If HTTP response object is bigger than max-heap-object-size, it will not be cached. Range of values: maximum size in bytes between 0 and 2147483647, inclusive. -1 indicates that there is no maximum size. Default: 524288. |
max-heap-size |
Maximum amount (in bytes) of heap to use for caching response objects. It should not be more than available memory or process address space. Range of values: maximum amount of address space in bytes between 0 and 1099511627776, inclusive. Default: 10485760. |
Syntax
otd_setCacheProperties(props)
The argument props
is a dictionary that can contain the following properties in addition to the properties that can be set (as described above):
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['max-heap-space'] = '20971520' otd_setCacheProperties(props)
See Also
Description
Use this command to set the following cache rule properties:
Property | Description | Comments |
---|---|---|
condition |
A condition is an expression which if evaluates to true, will result in the rule being executed. Conditions are constructed from literals, variables, functions and operators. |
|
enabled |
Specifies whether the caching rule is enabled. |
|
max-reload-interval |
Specifies the maximum time (in seconds) allowed between consecutive up-to-date checks. Range of values: any positive Integer. Default: 3600. |
|
min-reload-time |
Specifies the minimum time (in seconds) allowed between consecutive up-to-date checks of a cached document. Range of values: any positive Integer. Default: 0. |
|
last-modified-factor |
Represents the factor used in estimating the expiry time, which defines how long a document will be up-to-date based on time it was last modified. This property is used only when the explicit age of the document is not available. Range of values: any positive Integer. Default: 0. |
|
min-object-size |
The maximum size, in bytes, of any document to be cached. This setting enables users to limit the maximum size of cached documents, so that no single document can take too much space. This value cannot exceed the value of Range of values: any positive Integer. Default: 0. |
|
max-object-size |
Specifies the minimum size (in bytes) of any document to be cached. Range of values: any positive Integer. |
|
query-maxlen |
Specifies the number of characters in the query string. If this property is set to 0, URIs with query strings are not cached. Range of values: any positive Integer. Default: 0. |
|
compression |
If this property value is set to true, the document is compressed before storing in the cache Range of values: true or false. Default: false. |
|
cache-https-response |
If this property value is set to true, responses from the HTTPS servers are also cached. Range of values: true or false. Default: false. |
Syntax
otd_setCacheRuleProperties(props)
The argument props
is a dictionary that can contain the following properties in addition to the properties that can be set:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server. |
Mandatory. |
cache-rule |
Name of the cache rule. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' props['cache-rule'] = 'cache-rule-1' props['min-object-size'] = '512' otd_setCacheRuleProperties(props)
See Also
Description
Use this command to set or change the following properties of a compression rule for a virtual server:
Property | Description | Comments |
---|---|---|
condition |
A condition is an expression which if evaluates to true, will result in the rule being executed. Conditions are constructed from literals, variables, functions and operators. |
|
insert-vary-header |
Select to insert a vary:Accept-encoding header. Range of values: true or false. Default: true. |
|
compression-level |
Specifies the compression level for the virtual server. Specifying 1 yields better speed and specifying 9 yields best compression. Range of values: 1 - 9. Default: auto-tuned. |
|
fragment-size |
Specifies the memory fragment size (in bytes) that is used by the compression library to control the compression rate. Range of values: any positive Integer. Default: 8192. |
Syntax
otd_setCompressionRuleProperties(props)
The argument props
is a dictionary that can contain the following properties in addition to the properties that can be set:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server. |
Mandatory. |
compression-rule |
Name of the compression rule. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' props['compression-rule'] = 'compression-rule-1' props['compression-level'] = '8' otd_setCompressionRuleProperties(props)
Description
Use this command to set access-log properties for a configuration.
Syntax
otd_setConfigurationAccessLogProperties
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
log-file |
Path to the file where access log for this configuration will be stored. Default: $DOMAIN_HOME/servers/$INSTANCE_NAME/logs/access.log. |
|
format |
A format is a string that can be used to customize the format and the fields that are logged in the access log. Default: %Ses->client.ip% - %Req->vars.auth-user% %SYSDATE% "%Req->reqpb.clf-request%" %Req->srvhdrs.clf-status% %Req->srvhdrs.content-length% %Req->vars.ecid% %Req->vars.origin-server% |
Example
props = {} props['configuration'] = 'foo' props['log-file'] = 'logs/access.log' otd_setConfigurationAccessLogProperties(props)
Description
Use this command to define or change the following certificate revocation list (CRL) properties for a configuration:
Property | Description |
---|---|
enabled |
Specifies whether the properties are enabled. Range of values: true or false. Default: true. |
crl-cache-size |
Size of CRL cache. Range of values: size in bytes between 0 and 2147483647, inclusive. Default: 52428800. |
crl-path |
Directory that contains dynamically updated CRL files. Range of values: pathname. Default: crl. |
Syntax
otd_setConfigurationCrlProperties(props)
The argument props
is a dictionary that can contain the following properties in addition to the properties that can be set:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['crl-cache-size'] = '104857600' otd_setConfigurationCrlProperties(props)
See Also
Description
Use this command to set the following configuration properties.
Property | Description | Comments |
---|---|---|
temp-path |
Any valid directory where the server stores its temporary files. |
not supported on windows |
webapp-firewall-ruleset |
Wildcard pattern that matches one or more path names or a path to a file containing Web Application Firewall(WAF) rules/configurations. Multiple values (separated by commas) can also be specified. |
Multi-valued. |
default-language |
An IANA language tag specifying the default language for messages displayed to administrators and content served to clients. |
|
negotiate-client-language |
Whether the server attempts to use the Accept-language HTTP header to negotiate the content language with clients. Range of values: true or false. Default: false. |
|
fips |
Turns on FIPS-140 mode of operation for security library. Range of values: true or false. Default: false. |
|
max-fd |
Sets the maximum value of file descriptor availability. Default: 2097152. |
Syntax
otd_setConfigurationProperties(props)
The argument props
is a dictionary that can contain the following properties in addition to the properties that can be set:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['webapp-firewall-ruleset'] = 'rulesets' otd_setConfigurationProperties(props)
See Also
Description
Use this command to set content rule properties.
Syntax
otd_setContentRuleProperties(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server. |
Mandatory. |
content-rule |
Name of the content rule. |
Mandatory. |
uri-prefix |
URI prefix that has to be mapped to a directory. |
|
directory-path |
Absolute server path and a valid directory for storing documents. |
|
index-files |
Index files are a list of welcome files or startup pages. Default: index.html,index.htm. |
|
default-content-type |
The type of the default content that you want to edit. Default: text/plain. |
|
allow-directory-listing |
Enable directory listing for a directory that does not have a welcome page. Range of values: true or false. Default: false. |
Example
props['configuration'] = 'foo' props['virtual-server'] = 'bar' props['content-rule'] = 'content-rule-1' props['index-files'] = 'home.htm' otd_setContentRuleProperties(props)
Description
Use this command to set the following Domain Name Server (DNS) cache properties:
Property | Description |
---|---|
enabled |
Defines whether the server caches DNS lookup results. Range of values: true or false. Default: true. |
max-age |
Maximum amount of time (in seconds) to cache a DNS lookup result. Range of values: an interval in seconds between 0.001 (1 millisecond) and 604800 (1 week), inclusive. Default: 120. |
max-entries |
Maximum number of DNS lookup results to cache. Range of values: 1 - 1048576. Default: 1024. |
Syntax
otd_setDnsCacheProperties(props)
The argument props
is a dictionary that can contain the following properties in addition to the properties that can be set:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['max-age'] = '240' otd_setDnsCacheProperties(props)
See Also
Description
Use this command to set the following Domain Name Server (DNS) lookup properties for a configuration:
Property | Description |
---|---|
enabled |
Defines whether the server does DNS lookups. Range of values: true or false. Default: true. |
async |
Whether the server uses its own asynchronous DNS resolver instead of the operating system's synchronous resolver. Range of values: true or false. Default: false. |
timeout |
Timeout (in seconds) for asynchronous DNS lookups. Range of values: an interval in seconds between 0.001 and 3600 (1 hour), inclusive. Default: 12. |
Syntax
otd_setDnsProperties(props)
The argument props
is a dictionary that can contain the following properties in addition to the properties that can be set:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['async'] = 'true' props['timeout'] = '24' otd_setDnsProperties(props)
Description
Use this command to set the event properties.
Property | Description | Comments |
---|---|---|
command |
The command that the event executes. Range of values: the value can be restart, reconfig, rotate-log, rotate-access-log, and update-crl, or any executable command. |
|
day-of-month |
Day of the month at which this event should occur. Range of values: 1-31. |
|
day-of-week |
Day of the week at which this event should occur. Range of values: Sun, Mon, Tue, Wed, Thu, Fri, or Sat. |
|
enabled |
Whether the event is enabled at runtime. Range of values: true or false. Default: true. |
|
interval |
Time interval at which this event should occur. Range of values: an interval in seconds between 60 (1 minute) and 86400 (1 day), inclusive. |
|
month |
Month at which this event should occur. Range of values: 1-12. |
|
time |
Time, for example, 12:30, when this event is to be started. Range of values: the format of the time is |
Syntax
otd_setEventProperties(props)
The argument props
is a dictionary that can contain the following properties in addition to the properties that can be set:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
event |
Name of the event. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['event'] = 'bar' props['time'] = '10:24' otd_setEventProperties(props)
See Also
help, otd_deleteEvent, otd_listEvents, otd_getEventProperties
Description
Use this command to set the event subscription properties.
Syntax
otd_setEventSubscriptionProperties(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
event-subscription |
User defined name of the event subscription. |
Mandatory. |
enabled |
Indicates whether the even-subscription is enabled/disabled. Range of values: true or false |
|
url |
Specifies the subscription URL. If this is configured, Oracle Traffic Director publishes the notifications to this URL. Range: A Valid HTTP URL. |
Example 2-15 Example
props = {} props['configuration'] = 'foo' props['event-subscription'] = 'bar' props['enabled'] = 'false' otd_setEventSubscriptionProperties(props)
See Also
help,otd_createEventSubscription,otd_deleteEventSubscription,otd_getEventSubscriptionProperties,otd_listEventSubscriptionsDescription
Use this command to change the failover instance order. This command is valid only for the active-active failover type.
Syntax
otd_setFailoverInstanceOrder(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-ip |
Virtual IP that uniquely identifies the failure group. |
Mandatory. |
instances |
List of instances in the order in which failover must happen. |
Mandatory. |
Example 2-16 Example
props = {} props['configuration'] = 'ha' props['virtual-ip'] = '10.128.67.44' props['instances'] = '1.example.com,2.example.com' otd_setFailoverInstanceOrder(props)
See Also
otd_addFailoverInstance,otd_removeFailoverInstance,otd_listFailoverInstancesDescription
Sets file cache properties.
Syntax
otd_setFileCacheProperties(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description |
---|---|
configuration |
Name of the configuration. |
enabled |
Indicates whether the server caches the file content and meta information. Default: true |
max-age |
The maximum amount of time (in seconds) to cache the file content and/or meta information. Range of values: the range of values is 0.001-3600. Default: 30. |
max-entries |
The maximum number of paths for which the file content and/or meta information should be cached. Range of values: 1 - 1073741824 Default: 1024. |
max-open-files |
The maximum number of file descriptors the file cache will keep open. Range of values: 1 - 1073741824. |
sendfile |
Indicates whether the server will attempt to use the operating system's The default value is true on Windows and false on other platforms. |
copy-files |
Indicates whether the server copies the cached files to a temporary directory. The default value is true on Windows and false on other platforms. |
copy-path |
The name of the temporary directory that the server uses when copy-files is true. |
replacement |
The cache entry replacement algorithm. The values can be false,lru, or lfu. Default: lru. |
cache-content |
Indicates whether the server caches the file content. Default: true |
max-heap-file-size |
The maximum size (in bytes) of files to cache on the heap. Range of values: 0-2147483647. Default: 524288. |
max-heap-space |
The maximum amount (in bytes) of heap to use for caching files. Range of values: 0-9223372036854775807. Default: 10485760. |
max-mmap-file-size |
The maximum size (in bytes) of files to mmap. Range of values: 0-2147483647. Default: 0. |
max-mmap-space |
The maximum amount (in bytes) of mmap address space to use for caching files. Range of values: 0-9223372036854775807. Default: 0. |
buffer-size |
Size of the input/output buffer used on cache misses. Range of values: 512-1048576. Default: 8192. |
sendfile-size |
A hint to send the file in chunks of at most this value Range of values: 0-2147483647. Default: 0. |
Example
props = {} props['configuration'] = 'foo' props['max-age'] = '1200' otd_setFileCacheProperties(props)
See Also
Description
Use this command to set the following health-check properties for an origin server pool:
Property | Description |
---|---|
protocol |
Health check mechanism. Range of values: http, tcp or command Default: origin server pool type |
interval |
The time interval in seconds between two health check pings. Range of values: an interval in seconds between 0.001 and 3600 (1 hour), inclusive. Default: 30 |
timeout |
The timeout value in seconds for a ping request or connection. Range of values: an interval in seconds between 0.001 and 3600 (1 hour), inclusive. Default: 5 |
failover-threshold |
The number of consecutive failures for marking a server down. Range of values: 1 - 256 Default: 3 |
request-method |
The method used in HTTP ping requests. Range of values: OPTIONS or GET Default: OPTIONS |
request-uri |
The URI to use for HTTP health check request. Range of values: URI (virtual directory) that begins with /. Default: / |
response-code-match |
A modified regular expression to specify what response status codes are acceptable for a healthy origin server. The expression is a union of 3-character patterns that contain only digits or 'x', where 'x' stands for any digit. For example, the following 3 expressions are valid: 200, 2xx or 304, 1xx or 2xx or 3xx or 4xx. If the parameter is not specified, all codes except 5xx server errors are considered acceptable. |
response-body-match |
A regular expression used to match the HTTP response body in order to determine if the server is healthy. The origin server will be marked UP if the ping response matches the regular expression (if this parameter is specified) and the response status code is not a 5xx server error (if this parameter is not specified). If response body match is enabled, request method should be set to GET. |
response-body-match-size |
The maximum length of response body to be matched. Range of values: size in bytes between 0 and 2147483647, inclusive. Default: 2048. |
dynamic-server-discovery |
Indicates whether the server caches the file content. Range of values: true or false. Default: false. |
command |
The full path of the external health check executable. |
use-object-file |
Indicates whether object file processing is done for health-check-requests. Range of values: true or false. Default: true. |
Syntax
otd_setHealthCheckProperties(props)
The argument props
is a dictionary that can contain the following properties in addition to the properties that can be set:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
origin-server-pool |
Name of the origin server pool. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['origin-server-pool'] = 'origin-server-pool-1' props['response-body-match-size'] = '4096' otd_setHealthCheckProperties(props)
See Also
Description
Use this command to set the following HTTP listener properties:
Property | Description | Comments |
---|---|---|
enabled |
Whether the listener is enabled at runtime. Range of values: true or false. Default: true. |
|
ip |
IP address on which to listen. Range of values: *, a hostname, or an IP address. |
|
port |
Port on which to listen. Range of values: port number between 1 and 65535, inclusive. |
|
acceptor-threads |
Number of threads dedicated to accepting connections received by this listener. Range of values: 1 - 128. Default: auto-tuned. |
|
server-name |
Default server name. May include a scheme (for example, http://) prefix and port (for example, :80) suffix . Can be a hostname, fully qualified domain name, IP address, or a URL prefix that contains one. The URL prefix must not specify a path. |
|
blocking-io |
Whether the server uses blocking IO. Range of values: true or false. Default: false. |
|
blocking-accept |
Enables/Disables blocking of the server Listen Socket while retaining client end points as non blocking (useful when MaxProcs > 1). Range of values: true or false. Default: false. |
|
handle-protocol-mismatch |
Range of values: true or false. Default: true. |
|
family |
The socket family used to connect to the origin server. Range of values: default, inet, inet6, or inet-sdp Default: auto-tuned. |
|
listen-queue-size |
Maximum size of the operating system listen queue backlog. Range of values: 1 - 1048576. Default: 128. |
|
receive-buffer-size |
Size (in bytes) of the operating system socket receive buffer. Range of values: size in bytes between 0 and 2147483647, inclusive. |
|
send-buffer-size |
Size (in bytes) of the operating system socket send buffer. Range of values: size in bytes between 0 and 2147483647, inclusive. |
|
max-requests-per-connection |
Maximum number of keep-alive requests that will be handled per HTTP connection after which the keep-alive connection will be closed. -1 indicates no limit. Range of values: 1-, any positive Integer Default: -1. |
|
default-virtual-server-name |
Name of the virtual server that processes requests that did not match a host. |
|
description |
Description of the HTTP listener for the administrator's reference. |
Syntax
otd_setHttpListenerProperties(props)
The argument props
is a dictionary that can contain the following properties (in addition to the properties that can be set as described above):
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory |
http-listener |
Name that uniquely identifies the HTTP listener. |
Mandatory |
Example
props = {} props['configuration'] = 'foo' props['http-listener'] = 'http-listener-1' props['max-requests-per-connection'] = '1024' otd_setHttpListenerProperties(props)
Description
Use this command to set the following HTTP properties for a configuration:
Property | Description |
---|---|
server-header |
Specifies the server header information such as server software and version. Default: Oracle-Traffic-Director/<version> |
etag |
Indicates if the server includes an Etag header field in its responses. Range of values: true or false. Default: true. |
request-header-buffer-size |
Size (in bytes) of buffer used to read HTTP request header. Range of values: size in bytes between 0 and 2147483647, inclusive. Default: 8192. |
strict-request-headers |
Whether the server rejects certain malformed HTTP request headers Range of values: true or false. Default: false. |
websocket-strict-upgrade |
Enables/Disables the strict RFC 6455 adherence during the WebSocket upgrade request. Range of values: true or false. Default: false. |
discard-misquoted-cookies |
Whether to discard misquoted cookies. Range of values: true or false. Default: true. |
max-request-headers |
Maximum number of header fields to allow in an HTTP request header. Range of values: 1 - 512. Default: 64. |
body-buffer-size |
Defines the maximum size of the request body content that OTD will expose via the Range of values: size in bytes between 0 and 2147483647, inclusive Default: 1024. |
output-buffer-size |
Size (in bytes) of buffer used to buffer HTTP responses. Range of values: size in bytes between 0 and 2147483647, inclusive Default: 8192. |
max-unchunk-size |
Maximum size (in bytes) of a chunked HTTP request body the server will unchunk. Range of values: size in bytes between 0 and 2147483647, inclusive Default: 8192. |
unchunk-timeout |
Maximum time (in seconds) the server will spend waiting for a chunked HTTP request body to arrive. Range of values: an interval in seconds between 0 and 3600 (1 hour), inclusive. -1 indicates no timeout. Default: 60. |
io-timeout |
Maximum time (in seconds) server will wait for an individual packet. Range of values: an interval in seconds between 0.001 and 3600 (1 hour), inclusive. Default: 30. |
request-body-timeout |
Maximum time (in seconds) server will wait for the complete HTTP request body. Range of values: an interval in seconds between 0 and 604800 (1 week), inclusive. -1 indicates no timeout. Default: -1. |
request-header-timeout |
Maximum time (in seconds) server will wait for the complete HTTP request header. Range of values: an interval in seconds between 0 and 3600 (1 hour), inclusive. -1 indicates no timeout. Default: 30. |
favicon |
Whether the server replies to requests for favicon.ico with its own built in icon file. Range of values: true or false. Default: true. |
ecid |
Whether the server generates/propagates Execution Context and logs it with its error log. Range of values: true or false. Default: true. |
Syntax
otd_setHttpProperties(props)
The argument props
is a dictionary that can contain the following properties (in addition to the properties that can be set as described above):
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Example
props = {} props['configuration'] = 'foo' props['unchunk-timeout'] = '120' otd_setHttpProperties(props)
See Also
Description
Use this command to set the SSL properties for a listener. SSL is a software library establishing a secure connection between the client and server. SSL is used to implement HTTPS, the secure version of HTTP. You can set the following properties:
Property | Description |
---|---|
enabled |
Whether SSL/TLS is enabled at runtime. Range of values: true or false. Default: true. |
client-auth |
Client certificate authentication method. Range of values: one of required, optional, or false. Default: false. |
client-auth-timeout |
Timeout (in seconds) after which client authentication handshake fails. Range of values: an interval in seconds between 0.001 and 3600 (1 hour), inclusive. Default: 60. |
max-client-auth-data |
Maximum amount of application-level data to buffer during a client authentication handshake. Range of values: size in bytes between 0 and 2147483647, inclusive. Default: 1048576. |
tls10 |
Whether TLS 1.0 connections are accepted. Range of values: true or false. Default: false. |
tls11 |
Whether TLS 1.1 connections are accepted. Range of values: true or false. Default: true. |
tls12 |
Whether TLS 1.2 connections are accepted. Range of values: true or false. Default: true. |
ciphers |
Comma separated list of ciphers that must be enabled. Range of values: one (or) more ciphers that are supported. For a list of supported ciphers, see Ciphers. Default: all supported ciphers are enabled by default. |
override-cipher-order |
Whether cipher order should be overridden. Setting this flag to true will make OTD select the cipher suites in the order specified in server.xml instead of the order specified in the client's ClientHello message. Range of values: true or false. Default: false. |
supported-ciphers |
List of supported ciphers. This is a read-only property. Range of values: for a list of supported ciphers, see Ciphers. Default: N.A. |
server-cert-alias |
Comma separated list of server certificate aliases present in the keystore. Maximum of one RSA server certificate alias and one EC server certificate alias. |
Note:
The command otd_setHttpListenerSslProperties
will enable ssl implicitly if server-cert-alias
is set for the first time. It will enable ssl, even though ssl=enabled is not explicitly set.
Syntax
otd_setHttpListenerSslProperties(props)
The argument props
is a dictionary that can contain the following properties (in addition to the properties that can be set):
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory |
http-listener |
Name of the HTTP listener. |
Mandatory |
Example
props = {} props['configuration'] = 'foo' props['http-listener'] = 'http-listener-1' props['tls10'] = 'false' otd_setHttpListenerSslProperties(props)
See Also
Description
Use this command to set the thread-pool properties for a configuration. The min-threads
and max-threads
properties configure the threads used to process HTTP requests. You can use thread pools to allocate a certain number of threads to a specific service. By defining a pool with the maximum number of threads as 1, only one request is allowed to the specified service function.
You can set the following properties:
Property | Description |
---|---|
enabled |
Whether the thread pool is enabled or not. Range of values: true or false. Default: true. |
queue-size |
Maximum number of concurrent HTTP connections that can be queued waiting for processing. Range of values: 1 - 1048576. Default: auto-tuned. |
min-threads |
Minimum number of HTTP request processing threads. Range of values: 1 - 20480. Default: auto-tuned. |
max-threads |
Maximum number of HTTP request processing threads. Range of values: 1 - 20480. Default: auto-tuned. |
stack-size |
Stack size (in bytes) for HTTP request processing threads. Range of values: stack size in bytes between 8192 and 268435456, inclusive. 0 indicates that the platform-specific default stack size should be used. Default: 262144. |
Syntax
otd_setHttpThreadPoolProperties(props)
The argument props
is a dictionary that can contain the following properties (in addition to the properties that can be set):
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory |
Example
props = {} props['configuration'] = 'foo' props['stack-size'] = '8192' otd_setHttpThreadPoolProperties(props)
See Also
Description
Sets the following keep-alive subsystem properties:
Property | Description |
---|---|
enabled |
Whether the server supports keep-alive connections. Range of values: true or false. Default: true. |
threads |
Number of keep-alive subsystem threads. Range of values: 1 - 256. Default: auto-tuned. |
max-connections |
Maximum number of concurrent keep-alive connections the server will support. Range of values: 1 - 1048576. Default: auto-tuned. |
timeout |
Timeout (in seconds) after which inactive keep-alive connection may be closed. Range of values: an interval in seconds between 0.001 (1 millisecond) and 3600 (1 hour), inclusive. -1 indicates no timeout. Default: 30. |
poll-interval |
Interval (in seconds) between polls. Range of values: an interval in seconds between 0.001 and 1, inclusive. Default: 0.001. |
Syntax
otd_setKeepaliveProperties(props)
The argument props
is a dictionary that can contain the following properties (in addition to the properties that can be set):
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory |
Example
props = {} props['configuration'] = 'foo' props['threads'] = '128' otd_setKeepaliveProperties(props)
See Also
Description
Use this command to set the following log properties:
Property | Description |
---|---|
log-stdout |
Whether the server logs data that applications write to stdout. Range of values: true or false. Default: true. |
log-stderr |
Whether the server logs data that applications write to stderr. Range of values: true or false. Default: true. |
log-virtual-server-name |
Whether the server includes the virtual server name in log messages. Range of values: true or false. Default: false. |
create-console |
(Windows only) Whether the server creates a console window. Range of values: true or false. Default: false. |
log-to-console |
Whether the server writes log messages to the console. Range of values: true or false. Default: true. |
log-to-syslog |
Whether the server writes log messages to syslog (Unix) or the Event Viewer (Windows). Range of values: true or false. Default: false. |
archive-command |
Command executed after the server rotates a log file. The file name of the log file, after rotation, is passed as an argument to the archive command. |
log-level |
Log verbosity for the server as a whole. Range of values: valid log levels are INCIDENT_ERROR:1, ERROR:1, ERROR:16, ERROR:32, WARNING:1, NOTIFICATION:1, TRACE:1, TRACE:16, and TRACE:32. TRACE:32 (finest) is the most verbose while INCIDENT_ERROR:1 (catastrophe) is the least verbose. Default: NOTIFICATION:1. |
log-file |
Log file for the server as a whole. Default: $DOMAIN_HOME/servers/$INSTANCE_NAME/logs/server.log. |
Syntax
otd_setLogProperties(props)
The argument props
is a dictionary that can contain the following properties (in addition to the properties that can be set):
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory |
Example
props = {} props['configuration'] = 'foo' props['log-level'] = 'TRACE:32' otd_setLogProperties(props)
See Also
Description
Use this command to set the SSL properties of the origin server pool.
Property | Description |
---|---|
enabled |
Whether SSL/TLS is enabled at runtime. Range of values: true or false. Default: true. |
tls10 |
Whether TLS 1.0 connections are accepted. Range of values: true or false. Default: false. |
tls11 |
Whether TLS 1.1 connections are accepted. Range of values: true or false. Default: true. |
tls12 |
Whether TLS 1.2 connections are accepted. Range of values: true or false. Default: true. |
validate-server-cert |
Only applies to outgoing connections. Validate SSL certificate hostname on/off flag. Range of values: true or false. Default: true. |
ciphers |
Comma separated list of ciphers that must be enabled. Range of values: one (or) more ciphers that are supported. For a list of supported ciphers, see Ciphers. Default: all supported ciphers are enabled by default. |
supported-ciphers |
List of supported ciphers. This is a read-only property. Range of values: for a list of supported ciphers, see Ciphers. Default: n/a |
client-cert-alias |
A valid client certificate alias present in the keystore. Maximum of one RSA server certificate alias and one EC server certificate alias. |
Syntax
otd_setOriginServerPoolSslProperties(props)
The argument props
is a dictionary that can contain the following properties (in addition to the properties that can be set):
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory |
origin-server-pool |
Name of the origin server pool. |
Mandatory |
Example
props = {} props['configuration'] = 'foo' props['origin-server-pool'] = 'origin-server-pool-1' props['tls10'] = 'false' otd_setOriginServerPoolSslProperties(props)
See Also
Description
Use this command to set the following origin-server pool properties:
Property | Description | Comments |
---|---|---|
family |
The socket family used to connect to servers in this pool. Range of values: default, inet, inet6, or inet-sdp. Default: auto-tuned. |
|
load-distribution |
Algorithm that is used for load distribution of this server pool. Range of values: round-robin, least-connection-count, or least-response-time. Default: least-connection-count. |
|
queue-timeout |
Timeout (in seconds) for which the request waits in the queue for a connection to an origin-server. After the timeout, request is rejected. Range of values: 0.001 - 3600. Default: 30. |
|
proxy-server |
Name of the proxy-server in the form of host:port. |
Syntax
otd_setOriginServerPoolProperties(props)
The argument props
is a dictionary that can contain the following properties in addition to the properties that can be set (as described above):
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
origin-server-pool |
Name of the origin server pool. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['origin-server-pool'] = 'origin-server-pool-1' props['load-distribution'] = 'least-connection-count' otd_setOriginServerPoolProperties(props)
Description
Use this command to set the following properties of an origin-server:
Property | Description |
---|---|
mode |
Mode.of this origin server. Range of values: enabled, disabled, draining. Default: enabled. |
weight |
Load distribution weight for this origin server. Range of values: 1 - 1000. Default: 1. |
backup |
The parameter specifies if the origin server is a backup server. Range of values: true or false. Default: false. |
max-connections |
The maximum number of concurrent connections to a server. -1 indicates that there is no maximum. Range of values: -1, 1 - 1048576. Default: -1. |
ramp-up-time |
The time in seconds to ramp the sending rate up to the capacity of a newly up origin server. If the parameter is not specified, request rate accelerating will not be activated for the server. Range of values: an interval in seconds between 0.001 and 3600 (1 hour), inclusive. Default: 0.001. |
max-requests-per-connection |
Maximum limit on times a connection to origin server can be reused for different requests. -1 indicates there is no limit. Range of values: -1, 1 - 2147483647. Default: -1. |
max-request-bps |
Total bandwidth limit in byte/second enforced on request. Range of values: 0 - 1099511627776. Default: 0. |
max-response-bps |
Total bandwidth limit in byte/second enforced on response. Range of values: 0 - 1099511627776. Default: 0. |
bandwidth-queue-timeout |
Request is aborted when it had to wait in the queue for bandwidth for this much time in second. Range of values: 0 - 86400. Default: 60. |
Syntax
otd_setOriginServerProperties(props)
The argument props
is a dictionary that can contain the following properties (in addition to the properties that can be set):
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory |
origin-server-pool |
Name of the origin server pool. |
Mandatory |
host |
IP address/Host name of the origin server. |
Mandatory |
port |
Port number of the origin server. |
Mandatory |
Example
props = {} props['configuration'] = 'foo' props['origin-server-pool'] = 'origin-server-pool-1' props['host'] = 'www.example.com' props['port'] = '12345' props['ramp-up-time'] = '1200' otd_setOriginServerProperties(props)
Description
Use this command to set the access-log properties for a partition.
Property | Description |
---|---|
log-file |
Path to the file where access logs for this partition will be stored. Default: $DOMAIN_HOME/servers/$INSTANCE_NAME/logs/$PARTITION_NAME.log |
format |
A format is a string that can be used to customize the format and the fields that are logged in the partition access log. Default: %Ses->client.ip% - %Req->vars.auth-user% %SYSDATE% "%Req->reqpb.clf-request%" %Req->srvhdrs.clf-status% %Req->srvhdrs.content-length% %Req->vars.ecid% %Req->vars.origin-server% |
Syntax
otd_setPartitionAccessLogProperties (props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. This must be the name of the configuration that is specified while registering the Oracle Traffic Director runtime with the Lifecycle Manager. |
Mandatory. |
partition |
Name of the partition. |
Mandatory. |
Example
props = {} props['configuration'] = 'mt' props['partition'] = 'WLSPartition' props['log-file'] = 'logs/WLSPartition.log' otd_setPartitionAccessLogProperties(props)
Description
Use this command to set the following request limit properties for a virtual server:
Property | Description | Comments |
---|---|---|
condition |
A condition is an expression which if evaluates to true, will result in the rule being executed. Conditions are constructed from literals, variables, functions and operators. |
|
max-rps |
Maximum number of requests that the virtual server can receive per second. Range of values: any positive Integer. |
|
max-connections |
Maximum number of concurrent matching connections. Range of values: any positive Integer. |
|
queue-size |
Maximum number of requests to be queued in the bucket. Range of values: any positive Integer. Default: 0. |
|
timeout |
Request is aborted when it had to wait in the queue for this much time in second. Range of values: 1 - 86400. Default: 60. |
|
error-code |
HTTP status code to return for blocked requests. Range of values: 400 - 599. Default: 503. |
|
monitor-attribute |
Request attribute to monitor. |
Syntax
otd_setRequestLimitProperties(props)
The argument props
is a dictionary that can contain the following properties in addition to the properties that can be set (as described above):
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server. |
Mandatory. |
request-limit |
Name of the request limit rule. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' props['request-limit'] = 'request-limit-1' props['max-connections'] = '1024' otd_setRequestLimitProperties(props)
Description
Use this command to set the following route properties for a virtual server.
Property | Description | Comments |
---|---|---|
condition |
A condition is an expression which if evaluates to true, will result in the rule being executed. Conditions are constructed from literals, variables, functions and operators. |
|
uri-prefix |
A uri-prefix is a URI path with wildcard patterns. If a request URI matches with the uri-prefix then the rule will be executed. |
|
origin-server-pool |
Name of the origin server pool for this route. |
|
offline-check-interval |
Specifies the offline check interval. |
|
server |
Specifies the server name. |
|
sticky-cookie |
Name of the cookie that causes subsequent requests to stick to a particular origin server. Default: JSESSIONID. |
|
sticky-param |
Name of a URI parameter to inspect for route information. When the URI parameter is present in a request URI and its value contains a colon :, followed by a route ID, the request will 'stick' to the origin server identified by that route ID. Default: jsessionid. |
|
route-header |
Name of the HTTP request header that is used to communicate route IDs to the origin servers. Default: Proxy-jroute. |
|
route-cookie |
Name of the cookie generated by the server when it encounters a sticky-cookie cookie in a response. The route-cookie parameter stores the route ID that enables the server to direct subsequent requests back to the same origin server. Default: ORA_OTD_JROUTE. |
|
rewrite-headers |
List of HTTP request headers separated by commas. |
|
use-keep-alive |
Whether the HTTP client can use existing persistent connections for all types of requests. Range of values: true of false. Default: true. |
|
keep-alive-timeout |
Maximum number (in seconds) to retain persistent connectivity. Range of values: any positive Integer. Default: 29. |
|
timeout |
Maximum number (in seconds) that a connection can be in a idle state. Range of values: any positive Integer. Default: 300. |
|
always-use-keep-alive |
Whether the HTTP client can reuse existing connections for all types of requests. Range of values: true of false. Default: false. |
|
protocol |
Specifies the HTTP protocol version. |
|
proxy-agent |
Whether the proxy server product name and version has to be forwarded to the origin servers. |
|
from |
URI prefix to map. The prefix must not contain trailing slashes. |
|
to |
URL prefix to which the request should be mapped. The prefix must not contain trailing slashes. |
|
log-headers |
If true, the HTTP request and response headers for all connections with origin servers will be logged in the server log file. Range of values: true or false. Default: false. |
|
websocket-upgrade-enabled |
Specifies whether standard HTTP(S) connections should be upgraded to bi-directional, full-duplex WebSocket connections. Range of values: true or false. Default: true. |
|
websocket-idle-timeout |
The maximum number of seconds a connection can be idle. If no value is specified, then the timeout from the TCP connection thread pool (300 seconds) is used. Range of values: -1 or 0 - 3600. |
|
buffer-size |
The size of the buffer that is used by the server to store data before it is sent to the client. Range of values: any positive Integer. Default: 16384. |
|
priority |
The priority of the request. Range of values: high, normal, low. Default: normal. |
Syntax
otd_setRouteProperties(props)
The argument props
is a dictionary that can contain the following properties in addition to the properties that can be set (as described above):
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server. |
Mandatory. |
route |
Name of the route. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' props['route'] = 'route-1' props['websocket-idle-timeout'] = '1200' otd_setRouteProperties(props)
Description
Use this command to enable and define these settings for the SNMP subagents.
Property | Description |
---|---|
enabled |
Whether SNMP is enabled. Range of values: true or false. Default: true. |
description |
Description of the server, or unknown. |
organization |
Organization responsible for the server, or unknown. |
location |
Location of the server, or unknown. |
contact |
Contact information of the person responsible for the server, or unknown. |
Syntax
otd_setSnmpProperties(props)
The argument props
is a dictionary that can contain the following properties in addition to the properties that can be set (as described above):
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['organization'] = 'bar' otd_setSnmpProperties(props)
Description
Use this command to set the SSL session cache properties.
Property | Description |
---|---|
enabled |
Whether the server caches SSL/TLS sessions. Range of values: true or false. Default: true. |
max-entries |
Maximum number of SSL/TLS sessions the server will cache. Range of values: 1 - 524288. Default: 10000. |
max-ssl3-tls-session-age |
Maximum amount of time to cache an TLS session. Range of values: 1 - 86400. Default: 86400. |
Syntax
otd_setSslSessionCacheProperties(props)
The argument props
is a dictionary that can contain the following properties in addition to the properties that can be set (as described above):
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['max-entries'] = '20000' otd_setSslSessionCacheProperties(props)
See Also
Description
Use this command to set these properties of the statistics collection subsystem.
Property | Description |
---|---|
enabled |
Whether the server collects statistics at runtime. Range of values: true or false. Default: true. |
interval |
Interval (in seconds) at which statistics are updated. Range of values: an interval in seconds between 0.001 and 3600 (1 hour), inclusive. Default: 5. |
profiling |
Whether performance buckets, used to track NSAPI function execution time, are enabled. Range of values: true or false. Default: true. |
Syntax
otd_setStatsProperties(props)
The argument props
is a dictionary that can contain the following properties in addition to the properties that can be set:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['interval'] = '10' otd_setStatsProperties(props)
See Also
Description
Use this command to change the SSL properties of the Status Listener.
Syntax
otd_setStatusListenerSslProperties(props)
The argument props
is a dictionary that can contain the following properties in addition to the properties that can be set:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
enabled |
Specifies if SSL is enabled for status listener. Values: True or false. Default: True |
Example 2-17 Example
props = {} props['configuration'] = 'foo' props['enabled'] = 'false' otd_setStatusListenerSslProperties(props)
See Also
otd_enableStatusListener, otd_disableStatusListener, otd_getStatusListenerProperties, otd_getStatusListenerSslPropertiesDescription
Use this command to set the properties of the TCP access log.
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
log-file |
Path to the file where the TCP access log for this configuration will be stored. Default: $DOMAIN_HOME/servers/$INSTANCE_NAME/logs/tcp-access.log |
|
Syntax
otd_setTcpAccessLogProperties(props)
The argument props
is a dictionary that can contain the following properties in addition to the properties that can be set:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['log-file'] = 'logs/tcp-access.log' otd_setTcpAccessLogProperties(props)
See Also
Description
Use this command to set the TCP listener properties.
Property | Description |
---|---|
port |
Port on which to listen. Range of values: port number between 1 and 65535, inclusive. |
ip |
IP address on which to listen. Range of values: *, a hostname, or an IP address. Default: *. |
acceptor-threads |
Acceptor threads for this listening end point. Range of values: 1 - 128. Default: auto-tuned. |
enabled |
Whether the instance is enabled. Range of values: true or false. Default: true. |
description |
Description of the TCP listener for the administrator's reference. |
family |
Protocol family. Range of values: default, inet, inet6, or inet-sdp. Default: auto-tuned. |
listen-queue-size |
Maximum size of the operating system listen queue backlog. Range of values: 1 - 1048576. Default: 128. |
receive-buffer-size |
Size (in bytes) of the operating system socket receive buffer. Range of values: size in bytes between 0 and 2147483647, inclusive. |
send-buffer-size |
Size (in bytes) of the operating system socket send buffer. Range of values: size in bytes between 0 and 2147483647, inclusive. |
blocking-accept |
Enables/Disables blocking of the server Listen Socket while retaining client end points as non blocking (useful when Range of values: true or false. Default: false. |
tcp-proxy |
Name that identifies the exposed TCP service. Name can consist of one or more characters, whitespace is not permitted. |
Syntax
otd_setTcpListenerProperties(props)
The argument props
is a dictionary that can contain the following properties in addition to the properties that can be set:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
tcp-listener |
Name of the TCP listener. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['tcp-listener'] = 'tcp-listener-1' props['listen-queue-size'] = '256' otd_setTcpListenerProperties(props)
Description
Use this command to set the Secure Sockets Layer (SSL) properties for a TCP listener:
Property | Description |
---|---|
enabled |
Whether SSL/TLS is enabled at runtime. Range of values: true or false. Default: true. |
client-auth |
Client certificate authentication method. Range of values: one of required, optional, or false. Default: false. |
client-auth-timeout |
Timeout (in seconds) after which client authentication handshake fails. Range of values: an interval in seconds between 0.001 and 3600 (1 hour), inclusive. Default: 60. |
max-client-auth-data |
Maximum amount of application-level data to buffer during a client authentication handshake. Range of values: size in bytes between 0 and 2147483647, inclusive. Default: 1048576. |
tls11 |
Whether TLS 1.1 connections are accepted. Range of values: true or false. Default: true. |
tls12 |
Whether TLS 1.2 connections are accepted. Range of values: true or false. Default: true. |
ciphers |
Comma separated list of ciphers that must be enabled. Range of values: one (or) more ciphers that are supported. For a list of supported ciphers, see Ciphers. Default: all supported ciphers are enabled by default. |
override-cipher-order |
Whether cipher order should be overridden. Setting this flag to true will make OTD select the cipher suites in the order specified in server.xml instead of the order specified in the client's ClientHello message. Range of values: true or false. Default: false. |
supported-ciphers |
List of supported ciphers. This is a read-only property. Range of values: for a list of supported ciphers, see Ciphers. Default: N.A. |
server-cert-alias |
Comma separated list of server certificate aliases present in the keystore. Maximum of one RSA server certificate alias and one EC server certificate alias. |
Syntax
otd_setTcpListenerProperties(props)
The argument props
is a dictionary that can contain the following properties in addition to the properties that can be set:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
tcp-listener |
Name of the TCP listener. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['tcp-listener'] = 'tcp-listener-1' props['tls10'] = 'false' otd_setTcpListenerSslProperties(props)
See Also
Description
Use this command to set the following properties of the TCP proxy for a configuration:
In addition, use this command to set FTP configuration properties on the TCP proxy in addition to the existing TCP properties if the TCP proxy is created with the property protocol as FTP.
Syntax
otd_setTcpProxyProperties(props)
The argument props
is a dictionary that can contain the following properties in addition to the properties that can be set (as described above):
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
tcp-proxy |
Name that uniquely identifies the exposed TCP service. |
Mandatory. |
enabled |
Indicates whether the TCP service is enabled. Range of values: true or false. |
|
session-idle-timeout |
Maximum timeout in seconds for load balancer to wait for receiving/sending data in the session. Range of values: an interval in seconds between 0.001 and 3600 (1 hour), inclusive. |
|
origin-server-pool |
Name of an existing server pool that provides the TCP service. |
|
protocol |
If the protocol is FTP, the FTP configuration properties can be set/get on the TCP proxy. Default value: * |
This is a read-only property. |
client-explicit-ftps |
Specifies if client-side SSL should be explicitly enabled. Default value: true |
Valid only if |
origin-explicit-ftps |
Specifies if server-side SSL should be explicitly enabled. Default value: true |
Valid only if |
ssl-termination |
Specifies if SSL should terminate at Oracle® Fusion Middleware. Default value: false |
Valid only if |
passive-port-min |
Specifies the lower limit of port range for FTP passive connections. Default value: 1025 |
Valid only if |
passive-port-max |
Specifies the upper limit of port range for FTP passive connections. Default value: 65535 |
Valid only if |
active-port-min |
Specifies the lower limit of port range for FTP active connections. Default value: 1025 |
Valid only if |
active-port-max |
Specifies the upper limit of port range for FTP active connections. Default value: 65535 |
Valid only if |
Example
Whenprotocol
property is not FTP-enabled.
props = {} props['configuration'] = 'foo' props['tcp-proxy'] = 'bar' props['session-idle-timeout'] = '1200' otd_setTcpProxyProperties(props)
When protocol
property is ftp
for a TCP proxy and client-side SSL
is enabled explicitly.
props = {} props['configuration'] = 'foo' props['tcp-proxy'] = 'bar' props['client-explicit-ftps'] = 'true' otd_setTcpProxyProperties(props)
Description
Use this command to set the thread-pool properties of a configuration. The properties configure the threads used to proxy data for upgraded WebSocket connections and generic TCP connections. You can use TCP thread pools to allocate a certain number of threads to a specific service.
You can set the following properties:
Property | Description |
---|---|
enabled |
Whether the pool is enabled or not. Range of values: true or false. Default: true. |
threads |
Number of threads in the proxy thread-pool. Range of values: 1 - 512. Default: auto-tuned. |
max-connections |
Maximum number of connection pairs the server will support. Range of values: 1 - 1048576. Default: auto-tuned. |
timeout |
Idle timeout (in seconds) after which connection pairs will be closed. Value will be overridden by the TCP or WebSocket subsystem. Range of values: an interval in seconds between 0.001 (1 millisecond) and 3600 (1 hour), inclusive. -1 indicates no timeout. Default: 300. |
poll-interval |
Interval (in seconds) between polls. Range of values: an interval in seconds between 0.001 and 1, inclusive. Default: 0.01. |
buffer-size |
Size of the buffer in bytes used for transferring data. Range of values: 512 - 1048576. Default: 16384. |
stack-size |
Stack size in bytes for each thread. Range of values: stack size in bytes between 8192 and 268435456, inclusive. 0 indicates that the platform-specific default stack size should be used. Default: 32768. |
Syntax
otd_setTcpThreadPoolProperties(props)
The argument props
is a dictionary that can contain the following properties in addition to the properties that can be set:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['stack-size'] = '8192' otd_setTcpThreadPoolProperties(props)
See Also
Description
Use this command to set the properties of a virtual-server.
Property | Description |
---|---|
enabled |
Whether the virtual server is enabled at runtime. Range of values: true or false. Default: true. |
canonical-server-name |
Canonical hostname of the virtual server (requests using a different hostname will be redirected to this hostname). Can be a Hostname, fully qualified domain name, ip address, or a url prefix that contains one. the url prefix must not specify a path. |
log-file |
Log file for the virtual server. |
http-listener-name |
Name of an HTTP listener associated with one or more of the virtual server's host hostnames. Multiple comma separated values can be specified. |
host |
Hostname the virtual server services. Multiple comma separated values can be specified where each value can be a wildcard pattern that matches one or more hostnames. |
default-language |
An IANA language tag specifying the default language for messages displayed to administrators and content served to clients. |
negotiate-client-language |
Whether the server attempts to use the Accept-language HTTP header to negotiate the content language with clients. Range of values: true or false. Default: false. |
Syntax
otd_setVirtualServerProperties(props)
The argument props
is a dictionary that can contain the following properties in addition to the properties that can be set:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' props['http-listener-name'] = 'http-listener-1' otd_setVirtualServerProperties(props)
Description
Use this command to set the SSL properties for a virtual server.
Property | Description |
---|---|
enabled |
Whether SSL/TLS is enabled at runtime. Range of values: true or false. Default: true. |
client-auth |
Client certificate authentication method. Range of values: one of required, optional, or false. Default: false. |
client-auth-timeout |
Timeout (in seconds) after which client authentication handshake fails. Range of values: an interval in seconds between 0.001 and 3600 (1 hour), inclusive. Default: 60. |
max-client-auth-data |
Maximum amount of application-level data to buffer during a client authentication handshake. Range of values: size in bytes between 0 and 2147483647, inclusive. Default: 1048576. |
tls10 |
Whether TLS 1.0 connections are accepted. Range of values: true or false. Default: false. |
tls11 |
Whether TLS 1.1 connections are accepted. Range of values: true or false. Default: true. |
tls12 |
Whether TLS 1.2 connections are accepted. Range of values: true or false. Default: true. |
ciphers |
Comma separated list of ciphers that must be enabled. Range of values: one (or) more ciphers that are supported. For a list of supported ciphers, see Ciphers. Default: all supported ciphers are enabled by default. |
override-cipher-order |
Whether cipher order should be overridden. Setting this flag to true will make OTD select the cipher suites in the order specified in server.xml instead of the order specified in the client's ClientHello message. Range of values: true or false. Default: false. |
supported-ciphers |
List of supported ciphers. This is a read-only property. Range of values: for a list of supported ciphers, see Ciphers. Default: N.A. |
server-cert-alias |
Comma separated list of server certificate aliases present in the keystore. Maximum of one RSA server certificate alias and one EC server certificate alias. |
Syntax
otd_setVirtualServerSslProperties(props)
The argument props
is a dictionary that can contain the following properties in addition to those properties that can be set:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' props['tls10'] = 'false' otd_setVirtualServerSslProperties(props)
See Also
Description
Sets the password on a wallet.
Syntax
otd_setWalletPassword(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
password |
Password consisting of a minimum length of 8 characters and contain alphabetic characters combined with numbers or special characters. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['password'] = 'barBazqux#' otd_setWalletPassword(props)
Description
Use this command to set the following properties of a web application firewall:
Property | Description | Comments |
---|---|---|
ruleset |
Path to a file containing Web Application Firewall (WAF) rules/configuration |
Multi-valued. |
Syntax
otd_setWebappFirewallProperties(props)
The argument props
is a dictionary that must contain the following keys in addition to the properties that can be set:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-server |
Name of the virtual server. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['virtual-server'] = 'bar' props['ruleset'] = 'rulesets' otd_setWebappFirewallProperties(props)
Description
Use this command to start the failover daemon on the local machine. Since the failover daemon needs to run as root, you should execute this command should with sudo
privileges on the host on which the primary/backup instance of the failover group is running to start the failover on the instance.
This command can only be run in offline mode.
Syntax
otd_startFailover(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
domain-home |
Path to the directory that contains the Oracle Traffic Director domain. |
Mandatory. |
instance-name |
Name of the primary/backup Oracle Traffic Director instance which is part of the failover group. |
Mandatory. |
log-verbose |
Whether keepalived should be started in verbose log level mode. Default: false. |
Example
props = {} props['domain-home'] = '/export/domains/otd_domain' props['instance-name'] = 'otd_abc123.example.com' otd_startFailover(props)
Description
Use this command to start the Oracle Traffic Director Simple Network Management Protocol (SNMP) sub-agent on the specified machine.
Syntax
otd_startSnmpSubAgent(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
machine-name |
Name specified while creating the machine in the Oracle WebLogic Server console, corresponding to the host name of the machine on which the Oracle Traffic Director instance is running. |
Mandatory for Online, not valid for Offline. |
domain-home |
Path to the directory that contains the Oracle Traffic Director domain. |
Mandatory for Offline, not valid for Online. |
Example
# Online props = {} props['machine-name'] = 'abc123.example.com' otd_startSnmpSubAgent(props) # Offline props = {} props['domain-home'] = '/export/domains/otd_domain' otd_startSnmpSubAgent(props)
Description
Use this command to stop the failover daemon on the local machine. Since the failover daemon needs to run as root, execute this command with sudo
privileges on the host on which the primary/backup instance of the failover group is running to stop the failover on the instance.
This command can only be run in offline mode.
Syntax
otd_stopFailover(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
domain-home |
Path to the directory that contains the Oracle Traffic Director domain. |
Mandatory. |
instance |
Name of the primary/backup Oracle Traffic Director instance which is part of the failover group. |
Mandatory. |
Example
props = {} props['domain-home'] = '/export/otd_domain' props['instance'] = 'otd_abc123.example.com' otd_stopFailover(props)
Description
Use this command to stop the Simple Network Management Protocol (SNMP) sub-agent on the specified machine.
Syntax
otd_stopSnmpSubAgent(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
machine-name |
Name specified while creating the machine in the Oracle WebLogic Server console, corresponding to the host name of the machine on which the Oracle Traffic Director instance is running. |
Mandatory for Online, not valid for Offline. |
domain-home |
Path to the directory that contains the Oracle Traffic Director domain. |
Mandatory for Offline, not valid for Online. |
Example
# Online props = {} props['machine-name'] = 'host.example.com' otd_stopSnmpSubAgent(props) # Offline props = {} props['domain-home'] = '/export/domains/otd_domain' otd_stopSnmpSubAgent(props)
Description
Use this command to toggle the primary and backup instances in a failover group. This command is valid only when failover type is active-passive
. If the failover is running already, you should execute the stopFailover and startfailover scripts on the hosts where the instances are running. This is to manually toggle the nodes. If this command is not executed, the instances will not be toggled. Also, when you execute otd_getFailoverGroupProperties, the result will show the configured primary and the backup instances, which will not be the same as the runtime primary and backup instances.
Syntax
otd_toggleFailoverGroupPrimary(props)
The argument props
is a dictionary that can contain the following properties:
Property | Description | Comments |
---|---|---|
configuration |
Name of the configuration. |
Mandatory. |
virtual-ip |
Virtual IP that uniquely identifies the failover group. |
Mandatory. |
Example
props = {} props['configuration'] = 'foo' props['virtual-ip'] = '192.0.2.1' otd_toggleFailoverGroupPrimary(props)
Description
Pulls configuration files from a particular instance of the configuration to the config store in the admin server. The pulled configuration files overwrite their corresponding server versions and any pending changes (conflicting with the pulled configuration files) on the admin server are lost.
After executing this command, you must execute the command enableOverwriteComponentChanges
before activate
. Otherwise, activate
will fail because of the local modifications on the instance.
Note:
This command can only be executed from an open edit session. You must execute the command activate
for the pulled configuration changes to be deployed across all the instances of the configuration.
Syntax
pullComponentChanges(<instance_name>)
The argument <instance_name>
is the name of the instance and is mandatory.
Example
startEdit() pullComponentChanges('otd_test.example.com') pull component otd_test.example.com changes on machine example.com: add OTD/test/config/foo.conf edit OTD/test/config/server.xml edit OTD/test/config/test-obj.conf remove OTD/test/config/obj.conf activate()
Description
Over writes the modifications on an instance or all instances with their corresponding server versions from the admin server.
Syntax
resync(<instance_name>) / resyncAll()
The argument <instance_name>
is the name of the instance and is mandatory.
Note:
This command cannot be executed from an open edit session. See enableOverwriteComponentChanges and activate for overriding instance changes within an open edit session.
Example
# resync showComponentChanges('otd_test.example.com') add OTD/test/config/bar.conf 1970.01.01-05:30:00 2014.11.07-17:35:15 edit OTD/test/config/proxyvs.obj.conf 2014.11.07-17:36:49 1970.01.01-05:29:59 edit OTD/test/config/server.xml 2014.11.07-17:36:49 2014.11.07-17:37:22 remove OTD/test/config/test-obj.conf 2014.11.07-17:36:49 1970.01.01-05:30:00 resync('otd_test.example.com') showComponentChanges('otd_test.example.com') component otd_test.example.com changes on machine example.com: no change found. # resyncAll showComponentChanges() component otd_test.example.com changes on machine example.com: add OTD/test/config/baz.conf 1970.01.01-05:30:00 2014.11.07-17:42:57 component otd_origin-server-1.example.com changes on machine example.com: add OTD/origin-server-1/config/bar.conf 1970.01.01-05:30:00 2014.11.07-17:43:34 resyncAll() showComponentChanges() component otd_test.example.com changes on machine example.com: no change found. component otd_origin-server-1.example.com changes on machine example.com: no change found.
Description
Lists all the configuration file modifications on instances.
Syntax
showComponentChanges(<instance_name>)
The argument <instance_name>
is the name of the instance and is optional. If not specified, the command will display the modifications across all the instances.
Note:
Configuration changes in Oracle Traffic Director sometimes requires changes to multiple files such as server.xml
, obj.conf
, and magnus.conf
. Hence configuration changes in Oracle Traffic Director should either be overridden or pulled with these files treated as a unit in order to avoid inconsistencies. As a result, even if one of these files is modified, all of them will be shown as modified since they are treated as a file unit.
Example
showComponentChanges() component otd_test.example.com changes on machine example.com: no change found. component otd_origin-server-1.example.com changes on machine example.com: no change found. component otd_origin-server-2.example.com changes on machine example.com: no change found. component otd_origin-server-3.example.com changes on machine example.com: no change found. showComponentChanges('otd_test.example.com') add OTD/test/config/foo.conf 1970.01.01-05:30:00 2014.11.07-17:06:30 edit OTD/test/config/server.xml 2014.11.06-19:48:15 2014.11.07-17:06:08 edit OTD/test/config/test-obj.conf 2014.11.06-16:59:32 1970.01.01-05:29:59 remove OTD/test/config/obj.conf 2014.11.06-19:48:15 1970.01.01-05:30:00
Description
Use this WLST command to restart or reconfigure the instance
Reconfigure dynamically applies configuration changes on instances without a server restart. Only dynamically reconfigurable changes in the configuration take effect. Changes in the user
, temp-path
, log
, thread-pool
, pkcs11
, stats
, dns
, dns-cache
, ssl-session-cache
, and access-log-buffer
settings remain the same after a reconfiguration procedure is completed. A Restart-required exception will be thrown if there are any such changes that require restart when a reconfiguration is done.
Note:
Ensure that you are connected to the Administration Server while running this command.Syntax
softRestart(name, [block], [properties])
Argument | Definition |
---|---|
name
|
Name of the system component to restart. |
block
|
Optional. Boolean value specifying whether WLST should block user interaction until the server is restarted. |
properties
|
Optional. Properties value specifying properties to pass to the system component. |
Example
Reconfiguring the instance:
props = java.util.Properties() props.setProperty("MODE", "RECONFIG") cmo.softRestart(props)
Restarting the instance:
cmo.softRestart(java.util.Properties())
See Also
help, otd_deleteInstance, otd_listInstances, start, stop, otd_createInstance
Description
Starts an instance.
Note:
Ensure that you are connected to the Administration Server while running this command.Syntax
start(name, [type])
Argument | Definition |
---|---|
name
|
Name of the system component to start. |
type
|
Optional. Type, |
Example
start('otd_foo_machine1')
See Also
help, otd_deleteInstance, otd_listInstances, otd_createInstance, stop, softRestart
Description
Returns the state of an instance.
Note:
Ensure that you are connected to the Administration Server while running this command.Syntax
state(name, [type])
Argument | Definition |
---|---|
name
|
Name of the server, cluster, or system component for which you want to retrieve the current state. |
type
|
Optional. Type is |
Example
state('otd_test.in.example.com')
See Also
Description
Stops an instance.
Note:
Ensure that you are connected to the Administration Server while running this command.Syntax
stop(name, [type])
Example
stop('host.example.com', 'SystemComponent')
See Also
help, otd_deleteInstance, otd_listInstances, otd_createInstance, stop, softRestart
Description
Stops the edit session, discards unsaved changes and releases the edit lock.
Syntax
stopEdit([defaultAnswer])
Argument | Definition |
---|---|
defaultAnswer
|
Optional. Default response, if you would prefer not to be prompted at the command line. Valid values are |
Example
The following example stops the current editing session. WLST prompts for verification before canceling.
wls:/mydomain/edit !> stopEdit() Sure you would like to stop your edit session? (y/n) y Edit session has been stopped successfully. wls:/mydomain/edit>
Description
This command reverts all unsaved (undo()
) or unactivated (undo('true')
) edits. This command does not release the edit session. The effect of this command is not limited to Oracle Traffic Director. All the changes done after starting an edit session to the various other components and managed servers will also be reverted.
Syntax
undo([unactivatedChanges], [defaultAnswer])
Argument | Definition |
---|---|
unactivatedChanges
|
Optional. Boolean value specifying whether to undo all unactivated changes, including edits that have been saved to disk. This argument defaults to false, indicating that all edits since the last |
defaultAnswer
|
Optional. Default response, if you would prefer not to be prompted at the command line. Valid values are |
Example
The following example reverts all changes since the last save operation. WLST prompts for verification before reverting.
wls:/mydomain/edit !> undo() Sure you would like to undo your changes? (y/n) y Discarded your in-memory changes successfully. wls:/mydomain/edit>
The following example reverts all unactivated changes. WLST prompts for verification before reverting.
wls:/mydomain/edit !> undo('true') Sure you would like to undo your changes? (y/n) y Discarded all your changes successfully. wls:/mydomain/edit>