MarkLogic Server 11.0 Product Documentationadmin functions (group)
For the complete list of functions and categories in this namespace, refer to the main admin functions page.
170 functions
| Function name | Description |
|---|---|
| admin.getGroupIds | This function returns all the group IDs from the configuration. |
| admin.groupAddModuleLocation | Add one or more module namespace to location mappings to a Group configuration. |
| admin.groupAddNamespace | Add one or more namespaces to a Group configuration, which will predefine the namespace(s) for all requests evaluated against any App Server in the Group. |
| admin.groupAddSchema | This function adds a schema binding definition to the existing schema binding definitions in the configuration for the specified Group. |
| admin.groupAddTraceEvent | This function adds trace events to the configuration. |
| admin.groupAddUsingNamespace | Add one or more "using" namespaces to a Group configuration, which add the namespaces to the namespace path for all requests evaluated against any App Server in the Group. |
| admin.groupCopy | This function creates a new group specification with the same settings as the group with the specified ID. |
| admin.groupCreate | This function creates a new group with the specified name in the configuration. |
| admin.groupDelete | This function deletes one or more groups in the configuration. |
| admin.groupDeleteModuleLocation | Delete one or more module location bindings from a Group configuration. |
| admin.groupDeleteNamespace | This function deletes the specified namespaces from the configuration for the specified group. |
| admin.groupDeleteScheduledTaskById | This function deletes the scheduled tasks for a group using the group ID. |
| admin.groupDeleteSchema | This function deletes a schema binding definition to the existing schema binding definitions in the configuration for the specified Group. |
| admin.groupDeleteTraceEvent | This function deletes the specified trace events from the configuration. |
| admin.groupDeleteUsingNamespace | Delete one or more "using" namespaces from a Group configuration. |
| admin.groupDisableAuditEventType | This function changes the audit event type(s) enabled setting for the audit configuration. |
| admin.groupEnableAuditEventType | This function changes the audit event type(s) enabled setting for the audit configuration. |
| admin.groupExists | This function determines whether or not the specified Group exists. |
| admin.groupGetAppserverIds | This function returns the IDs of all appservers belonging to the group. |
| admin.groupGetAuditEnabled | This function returns the value for the audit enabled setting from the specified group. |
| admin.groupGetAuditEventTypeEnabled | This function returns the audit event type's enabled setting for the audit configuration. |
| admin.groupGetAuditExcludedRoles | This function returns the roles excluded from auditing. |
| admin.groupGetAuditExcludedUris | This function returns the uris excluded from auditing. |
| admin.groupGetAuditExcludedUsers | This function returns the users excluded from auditing. |
| admin.groupGetAuditIncludedRoles | This function returns the roles included from auditing. |
| admin.groupGetAuditIncludedUris | This function returns the uris included from auditing. |
| admin.groupGetAuditIncludedUsers | This function returns the users included from auditing. |
| admin.groupGetAuditOutcomeRestriction | This function returns whether auditing events are restricted by a success or failure outcome. |
| admin.groupGetAzureStorageProxy | This function returns the URL of the proxy server used by the group to access Azure blob storage. |
| admin.groupGetBackgroundIoLimit | This function gets the value for the I/O background limit that controls the I/O resources that I/O tasks (for example, merges) will consume. |
| admin.groupGetCompressedTreeCachePartitions | This function returns the value for the compressed tree cache partitions setting from the specified group. |
| admin.groupGetCompressedTreeCacheSize | This function returns the value for the compressed tree cache size setting from the specified group. |
| admin.groupGetCompressedTreeReadSize | This function returns the value for the compressed tree read size (in kilobytes) setting from the specified group. |
| admin.groupGetExpandedTreeCachePartitions | This function returns the value for the expanded tree cache partitions setting from the specified group. |
| admin.groupGetExpandedTreeCacheSize | This function returns the value for the expanded tree cache size setting from the specified group. |
| admin.groupGetFailoverEnable | This function returns the value for the failover enable setting from the specified group. |
| admin.groupGetFileLogLevel | This function returns the value for the file log level setting from the specified group. |
| admin.groupGetHostIds | This function returns the IDs of all hosts belonging to the group. |
| admin.groupGetHostInitialTimeout | This function returns the value for the host initial timeout setting from the specified group. |
| admin.groupGetHostTimeout | This function returns the value for the host timeout setting from the specified group. |
| admin.groupGetHttpserverIds | This function returns the IDs of all httpservers belonging to the group. |
| admin.groupGetHttpTimeout | This function returns the value for the http timeout setting from the specified group. |
| admin.groupGetHttpUserAgent | This function returns the value for the http user agent setting from the specified group. |
| admin.groupGetId | This function returns the ID of the group. |
| admin.groupGetKeepAuditFiles | This function returns the value for the keep audit files setting from the specified group. |
| admin.groupGetKeepLogFiles | This function returns the value for the keep log files setting from the specified group. |
| admin.groupGetListCachePartitions | This function returns the value for the list cache partitions setting from the specified group. |
| admin.groupGetListCacheSize | This function returns the value for the list cache size setting from the specified group. |
| admin.groupGetMeteringEnabled | This function returns the value of the metering-enabled group setting. |
| admin.groupGetMetersDatabase | This function returns the ID of the meters-database configured for the specified group. |
| admin.groupGetModuleCacheTimeout | This function returns the number of seconds a module can be unused before being flushed from caches. |
| admin.groupGetModuleLocations | This function returns the value of any module locations predefined for the specified Group. |
| admin.groupGetName | This function returns the name of the specified group. |
| admin.groupGetNamespaces | This function returns the value of any namespace definitions predefined for the specified group. |
| admin.groupGetOdbcserverIds | This function returns the ids of all of the ODBC App Servers in the specified group. |
| admin.groupGetOptimizedPlanCacheTimeout | This function returns the optimized plan cache timeout in seconds. |
| admin.groupGetPerformanceMeteringEnabled | This function returns the value of the performance-metering-enabled group setting. |
| admin.groupGetPerformanceMeteringPeriod | This function returns the value of the performance-metering-period group setting. |
| admin.groupGetPerformanceMeteringRetainDaily | This function returns the value of the performance-metering-retain-daily group setting. |
| admin.groupGetPerformanceMeteringRetainHourly | This function returns the value of the performance-metering-retain-hourly group setting. |
| admin.groupGetPerformanceMeteringRetainRaw | This function returns the value of the performance-metering-retain-raw group setting. |
| admin.groupGetRetryTimeout | This function returns the value for the number of seconds a request will retry before timing out. |
| admin.groupGetRotateAuditFiles | This function returns the value for the rotate audit files setting from the specified group. |
| admin.groupGetRotateLogFiles | This function returns the value for the rotate log files setting from the specified group. |
| admin.groupGetS3Domain | This function gets the simple storage service internet domain name for hosts in the group. |
| admin.groupGetS3Protocol | This function gets the simple storage service protocol for hosts in the group. |
| admin.groupGetS3Proxy | This function returns the URL of the proxy server used by the group to access AWS S3 storage. |
| admin.groupGetS3ServerSideEncryption | This function gets the method of server side encryption for data at rest on the simple storage service. |
| admin.groupGetS3ServerSideEncryptionKmsKey | This function gets the KMS key that is used by server side encryption for data at rest on the simple storage service. |
| admin.groupGetSchemas | This function returns the value of any schemas definitions predefined for the specified group. |
| admin.groupGetSecurityDatabase | This function returns the ID of the security database for the specified group from the configuration. |
| admin.groupGetSmtpRelay | This function returns the value for the smtp relay setting from the specified group. |
| admin.groupGetSmtpTimeout | This function returns the value for the smtp timeout setting from the specified group. |
| admin.groupGetSystemLogLevel | This function returns the value for the system log level setting from the specified group. |
| admin.groupGetTaskserverId | This function returns the ID of of the taskserver belonging to the group. |
| admin.groupGetTelemetryConfig | This function returns the currently set frequency for sending configuration file changes to telemetry. |
| admin.groupGetTelemetryLogLevel | This function returns the current configured telemetry log level. |
| admin.groupGetTelemetryMetering | This function returns the configured detail level for collecting metering data sent to telemetry. |
| admin.groupGetTelemetryProxy | This function returns the proxy server URL used by telemetry |
| admin.groupGetTelemetrySessionEndpoint | This function returns the initial default telemetry endpoint. |
| admin.groupGetTelemetryUsage | This function returns the Telemetry Usage enable setting for the specific group. |
| admin.groupGetTemporaryDirectory | This function returns the temporary directory used by MarkLogic Server. |
| admin.groupGetTraceEvents | This function returns the value of any trace events activated for the specified group. |
| admin.groupGetTraceEventsActivated | This function returns the value for the trace events activated setting from the specified group. |
| admin.groupGetTripleCachePartitions | This function returns the number of triple cache partitions configured for the group. |
| admin.groupGetTripleCacheSize | This function returns the value of the triple cache size for the group. |
| admin.groupGetTripleCacheTimeout | This function gets the timeout value for the triple cache. |
| admin.groupGetTripleValueCachePartitions | This function returns the number of triple value cache partitions configured for the group. |
| admin.groupGetTripleValueCacheSize | This function returns the size of triple value cache configured for the group. |
| admin.groupGetTripleValueCacheTimeout | This function gets the timeout value for the triple value cache. |
| admin.groupGetUsingNamespaces | This function returns the value of any "using" namespaces predefined for the specified Group. |
| admin.groupGetWebdavserverIds | This function returns the IDs of all webdavservers belonging to the group. |
| admin.groupGetXdbcserverIds | This function returns the IDs of all xdbcservers belonging to the group. |
| admin.groupGetXdqpSslAllowSslv3 | This function is deprecated and will be removed in a future release. |
| admin.groupGetXdqpSslAllowTls | This function returns true if the TLS protocol is enabled for the group. |
| admin.groupGetXdqpSslCiphers | This function returns the SSL ciphers set for the group. |
| admin.groupGetXdqpSslDisabledProtocols | This function returns the disabled protocols for the group. |
| admin.groupGetXdqpSslEnabled | This function returns true if SSL is enabled for the group. |
| admin.groupGetXdqpTimeout | This function returns the value for the xdqp timeout setting from the specified group. |
| admin.groupModuleLocation | This function constructs a module namespace element with the specified namespace URI and location. |
| admin.groupNamespace | This function constructs a namespace element with the specified prefix and URI. |
| admin.groupScheduledTaskGetEnabled | This function returns true or false to indicate whether a scheduled task for a group is enabled. |
| admin.groupScheduledTaskSetEnabled | This function enables one or more scheduled tasks for a group based on the group ID and task ID. |
| admin.groupSchema | This function constructs a schema element with the specified prefix and URI. |
| admin.groupSetAuditEnabled | This function changes the audit enabled setting for the group in the configuration. |
| admin.groupSetAuditOutcomeRestriction | This function restricts the audit configuration by auditing events only if they are "success" or "failure" events. |
| admin.groupSetAuditRoleRestriction | This function restricts the audit configuration by excluding or including by role. |
| admin.groupSetAuditUriRestriction | This function restricts the audit configuration by excluding or including by document uri(s). |
| admin.groupSetAuditUserRestriction | This function restricts the audit configuration by excluding or including by user. |
| admin.groupSetAzureStorageProxy | This function sets the URL of the proxy server used by the group to access Azure blob storage. |
| admin.groupSetBackgroundIoLimit | This function sets a limit on the amount of I/O that background tasks (for example, merges) will consume. |
| admin.groupSetCompressedTreeCachePartitions | This function changes the compressed tree cache partitions setting of the group with the specified ID to the specified value. |
| admin.groupSetCompressedTreeCacheSize | This function changes the compressed tree cache size setting of the group with the specified ID to the specified value. |
| admin.groupSetCompressedTreeReadSize | This function changes the compressed tree read size setting of the group with the specified ID to the specified value. |
| admin.groupSetExpandedTreeCachePartitions | This function changes the expanded tree cache partitions setting of the group with the specified ID to the specified value. |
| admin.groupSetExpandedTreeCacheSize | This function changes the expanded tree cache size setting of the group with the specified ID to the specified value. |
| admin.groupSetFailoverEnable | This function changes the failover enable setting for the group in the configuration. |
| admin.groupSetFileLogLevel | This function changes the host file log level setting for the group in the configuration. |
| admin.groupSetHostInitialTimeout | This function changes the host initial timeout setting (the time the cluster will wait for a host to come online during cluster startup) for the group in the configuration. |
| admin.groupSetHostTimeout | This function changes the host timeout setting (the timeout for communication between hosts) for the group in the configuration. |
| admin.groupSetHttpTimeout | This function changes the HTTP timeout setting for the group in the configuration. |
| admin.groupSetHttpUserAgent | This function changes the HTTP User-Agent setting for the group in the configuration. |
| admin.groupSetKeepAuditFiles | This function changes the keep audit files setting for the group in the configuration. |
| admin.groupSetKeepLogFiles | This function changes the keep log files setting for the group in the configuration. |
| admin.groupSetListCachePartitions | This function changes the list cache partitions setting of the group with the specified ID to the specified value. |
| admin.groupSetListCacheSize | This function changes the list cache size setting of the group with the specified ID to the specified value. |
| admin.groupSetMeteringEnabled | This function enables or disables usage metering for all hosts in the specified group. |
| admin.groupSetMetersDatabase | This function specifies the database to be used to store metering data. |
| admin.groupSetModuleCacheTimeout | This function sets the number of seconds a module can be unused before being flushed from caches. |
| admin.groupSetName | This function changes the name of the group with the specified ID to the specified name. |
| admin.groupSetOptimizedPlanCacheTimeout | This function changes the optimized plan cache timeout. |
| admin.groupSetPerformanceMeteringEnabled | This function enables or disables performance metering for all hosts in the specified group. |
| admin.groupSetPerformanceMeteringPeriod | This function sets the period (in number of seconds) between when performance data is gathered. |
| admin.groupSetPerformanceMeteringRetainDaily | This function sets the number of days of performance metering data to retain. |
| admin.groupSetPerformanceMeteringRetainHourly | This function sets the number of days to retain hourly performance data. |
| admin.groupSetPerformanceMeteringRetainRaw | This function sets the number of days of raw performance data to retain. |
| admin.groupSetRetryTimeout | This function changes the number of seconds a request will retry before timing out. |
| admin.groupSetRotateAuditFiles | This function changes the rotate audit files setting for the group in the configuration. |
| admin.groupSetRotateLogFiles | This function changes the rotate log files setting for the group in the configuration. |
| admin.groupSetS3Domain | This function sets the simple storage service internet domain name for hosts in the group. |
| admin.groupSetS3Protocol | This function sets the simple storage service protocol for hosts in the group. |
| admin.groupSetS3Proxy | This function sets the URL of the proxy server used by the group to access AWS S3 storage. |
| admin.groupSetS3ServerSideEncryption | This function gets the method of server side encryption for data at rest on the simple storage service. |
| admin.groupSetS3ServerSideEncryptionKmsKey | This function sets the KMS key that is used by server side encryption for data at rest on the simple storage service. |
| admin.groupSetSecurityDatabase | This function sets the security database for a group to the specified database in the configuration. |
| admin.groupSetSmtpRelay | This function changes the SMTP relay setting for the group in the configuration. |
| admin.groupSetSmtpTimeout | This function changes the SMTP timeout setting for the group in the configuration. |
| admin.groupSetSystemLogLevel | This function changes the host system log level setting for the group in the configuration. |
| admin.groupSetTelemetryConfig | This function sets the update frequency for configuration changes sent to telemetry, would also be the maximum frequency at which updates will be sent. |
| admin.groupSetTelemetryLogLevel | This function sets the initial log level for telemetry, which is also the maximum (finest) log level that will be sent. |
| admin.groupSetTelemetryMetering | This function sets the level of metering data sent to telemetry. |
| admin.groupSetTelemetryProxy | This function sets the proxy server URL used by telemetry |
| admin.groupSetTelemetrySessionEndpoint | This function sets the initial session endpoint for telemetry. |
| admin.groupSetTelemetryUsage | This function enables or disables usage data sent to telemetry. |
| admin.groupSetTemporaryDirectory | This function changes the MarkLogic Server temporary directory (default data-directory/Temp) |
| admin.groupSetTraceEventsActivated | This function changes the value for trace events in the group configuration. |
| admin.groupSetTripleCachePartitions | This function sets the number of partitions to allocate for the triple index cache. |
| admin.groupSetTripleCacheSize | This function sets the number of triple cache partitions to allocate. |
| admin.groupSetTripleCacheTimeout | This function sets the timeout value for the triple cache. |
| admin.groupSetTripleValueCachePartitions | This function sets the number of partitions to allocate for the triple value index cache. |
| admin.groupSetTripleValueCacheSize | This function sets the size of the value cache for the triple index. |
| admin.groupSetTripleValueCacheTimeout | This function sets the timeout value for the triple value cache. |
| admin.groupSetXdqpSslAllowSslv3 | This function is deprecated and will be removed in a future release. |
| admin.groupSetXdqpSslAllowTls | This function enables or disables the TLS protocol for the specified group. |
| admin.groupSetXdqpSslCiphers | This function sets SSL ciphers for the specified group. |
| admin.groupSetXdqpSslDisabledProtocols | This function sets the disabled protocols for the specified group. |
| admin.groupSetXdqpSslEnabled | This function enables or disables SSL for the group. |
| admin.groupSetXdqpTimeout | This function changes the XDQP timeout setting (the timeout for communication between data nodes and evaluator nodes) for the group in the configuration. |
| admin.groupTraceEvent | This function constructs an event element for the specified event name. |
| admin.groupUsingNamespace | This function constructs a using namespace element with the specified URI. |