CtsDataStoreProperties
Global Operations
An object of property key-value pairs
Resource path:
/global-config/servers/{serverName}/properties/cts
Resource version: 1.0
read
Usage
am> read CtsDataStoreProperties --global --serverName serverName
Parameters
- --serverName
-
An object of property key-value pairs
update
Usage
am> update CtsDataStoreProperties --global --serverName serverName --body body
Parameters
- --serverName
-
An object of property key-value pairs
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "type" : "object", "properties" : { "amconfig.org.forgerock.services.cts.store.common.section" : { "title" : "CTS Token Store", "type" : "object", "propertyOrder" : 0, "properties" : { "org.forgerock.services.cts.store.location" : { "title" : "Store Mode", "type" : "object", "propertyOrder" : 0, "description" : "", "properties" : { "value" : { "enum" : [ "default", "external" ], "options" : { "enum_titles" : [ "Default Token Store", "External Token Store" ] }, "type" : "string", "required" : false }, "inherited" : { "type" : "boolean", "required" : true } } }, "org.forgerock.services.cts.store.root.suffix" : { "title" : "Root Suffix", "type" : "object", "propertyOrder" : 1, "description" : "", "properties" : { "value" : { "type" : "string", "required" : false }, "inherited" : { "type" : "boolean", "required" : true } } }, "org.forgerock.services.cts.store.max.connections" : { "title" : "Max Connections", "type" : "object", "propertyOrder" : 2, "description" : "", "properties" : { "value" : { "type" : "string", "required" : false }, "inherited" : { "type" : "boolean", "required" : true } } }, "org.forgerock.services.cts.store.page.size" : { "title" : "Page Size", "type" : "object", "propertyOrder" : 3, "description" : "The number of results per page returned from the underlying datastore. If the result set is smaller than the page size, the number of results will never be paginated. If larger, the number of pages returned will be <code>result set size / page size</code>. Larger values will result in fewer round trips to the datastore when retrieving large result sets. Leave as <code>0</code> to not enable pagination, and return all results in a single page.", "properties" : { "value" : { "type" : "integer", "required" : false }, "inherited" : { "type" : "boolean", "required" : true } } }, "org.forgerock.services.cts.store.vlv.page.size" : { "title" : "VLV Page Size", "type" : "object", "propertyOrder" : 4, "description" : "The number of results per page returned from the underlying datastore when using VLVs. Larger values will result in fewer round trips to the datastore when retrieving large result sets.", "properties" : { "value" : { "type" : "integer", "required" : false }, "inherited" : { "type" : "boolean", "required" : true } } } } }, "amconfig.org.forgerock.services.cts.store.external.section" : { "title" : "External Store Configuration", "type" : "object", "propertyOrder" : 1, "properties" : { "org.forgerock.services.cts.store.ssl.enabled" : { "title" : "SSL/TLS Enabled", "type" : "object", "propertyOrder" : 0, "description" : "", "properties" : { "value" : { "type" : "boolean", "required" : false }, "inherited" : { "type" : "boolean", "required" : true } } }, "org.forgerock.services.cts.store.starttls.enabled" : { "title" : "Start TLS", "type" : "object", "propertyOrder" : 1, "description" : "Specifies whether to use StartTLS for the connection.", "properties" : { "value" : { "type" : "boolean", "required" : false }, "inherited" : { "type" : "boolean", "required" : true } } }, "org.forgerock.services.cts.store.directory.name" : { "title" : "Connection String(s)", "type" : "object", "propertyOrder" : 2, "description" : "An ordered list of connection strings for LDAP directories. Each connection string is composed as follows: <code>HOST:PORT[|SERVERID[|SITEID]]</code>, where server and site IDs are optional parameters that will prioritize that connection to use from the specified nodes. Multiple connection strings should be comma-separated, e.g. <code>host1:389,host2:50389|server1|site1,host3:50389</code>.", "properties" : { "value" : { "type" : "string", "required" : false }, "inherited" : { "type" : "boolean", "required" : true } } }, "org.forgerock.services.cts.store.loginid" : { "title" : "Login Id", "type" : "object", "propertyOrder" : 3, "description" : "", "properties" : { "value" : { "type" : "string", "required" : false }, "inherited" : { "type" : "boolean", "required" : true } } }, "org.forgerock.services.cts.store.password" : { "title" : "Password", "type" : "object", "propertyOrder" : 4, "description" : "", "properties" : { "value" : { "type" : "string", "required" : false, "format" : "password" }, "inherited" : { "type" : "boolean", "required" : true } } }, "org.forgerock.services.cts.store.heartbeat" : { "title" : "Heartbeat", "type" : "object", "propertyOrder" : 5, "description" : "", "properties" : { "value" : { "type" : "integer", "required" : false }, "inherited" : { "type" : "boolean", "required" : true } } }, "org.forgerock.services.cts.store.affinity.enabled" : { "title" : "Affinity Enabled", "type" : "object", "propertyOrder" : 6, "description" : "Enables affinity based request load balancing when accessing the CTS servers. It is imperative that the connection string setting is set to the same value for all OpenAM servers in the deployment when this feature is enabled.", "properties" : { "value" : { "type" : "boolean", "required" : false }, "inherited" : { "type" : "boolean", "required" : true } } } } } } }