MarkLogic 12 EA 1 Product Documentationadmin functions (cluster)
For the complete list of functions and categories in this namespace, refer to the main admin functions page.
99 functions
| Function name | Description |
|---|---|
| admin.clusterGetAuditLogEncryption | This function returns the encryption setting at cluster level for the audit log file. |
| admin.clusterGetConfigEncryption | This function returns the encryption setting at cluster level for configuration files. |
| admin.clusterGetConfigEncryptionKeyId | This function returns the active encryption key ID used for encryption of configuration files. |
| admin.clusterGetDataEncryption | This function returns the encryption setting at cluster level for user data. |
| admin.clusterGetDataEncryptionKeyId | This function returns the active encryption key ID used for encryption of data. |
| admin.clusterGetEffectiveVersion | This function returns the effective software version of this cluster. |
| admin.clusterGetExternalConfigEncryptionKeyId | This function returns the encryption key ID in the external KMS to use for encryption of configuration files. |
| admin.clusterGetExternalDataEncryptionKeyId | This function returns the encryption key ID in the external KMS to use for encryption of data. |
| admin.clusterGetExternalLogsEncryptionKeyId | This function returns the encryption key ID in the external KMS to use for encryption of log files. |
| admin.clusterGetForeignClusterId | This function returns the id of the specified foreign cluster. |
| admin.clusterGetForeignClusterIds | This function returns the ids of the foreign clusters. |
| admin.clusterGetForeignMasterDatabase | This function is executed on a replica cluster to return the replication configuration for the specified local database from the specified foreign master cluster. |
| admin.clusterGetForeignReplicaDatabases | This function is executed on the master cluster to return the replication configuration for the specified local database to the specified foreign replica cluster. |
| admin.clusterGetId | This function returns the id of this cluster. |
| admin.clusterGetInternalConfigEncryptionKeyId | This function returns the encryption key ID in the internal KMS to use for encryption of configuration files. |
| admin.clusterGetInternalDataEncryptionKeyId | This function returns the encryption key ID in the internal KMS to use for encryption of data. |
| admin.clusterGetInternalLogsEncryptionKeyId | This function returns the encryption key ID in the internal KMS to use for encryption of log files. |
| admin.clusterGetKeystoreBackupOption | This function is used to get the backup option for the embedded PKCS#11 wallet. |
| admin.clusterGetKeystoreHostName | This function returns the first host name for the Keystore Management System. |
| admin.clusterGetKeystoreHostNames | This function returns all configured KMS host names. |
| admin.clusterGetKeystoreKmipCAPath | This function returns the path to the PEM encoded KMIP Certificate Authority (CA) used for authentication with the KMS |
| admin.clusterGetKeystoreKmipCertificatePath | This function returns the path to PEM encoded KMIP certificate. |
| admin.clusterGetKeystoreKmipKeyPath | This function returns the path to the PEM encoded private key |
| admin.clusterGetKeystoreKmsType | This function returns the encryption setting at cluster level for log files |
| admin.clusterGetKeystorePort | This function returns the first port number to connect to the Keystore Management System. |
| admin.clusterGetKeystorePorts | This function returns all the configured KMS ports. |
| admin.clusterGetKeystoreWalletLocation | This function returns the PKCS#11 wallet location if it has been set by cluster-set-keystore-wallet-location. |
| admin.clusterGetLanguageBaseline | This function returns the language baseline of this cluster. |
| admin.clusterGetLogsEncryption | This function returns the encryption setting at cluster level for log files. |
| admin.clusterGetLogsEncryptionKeyId | This function returns the active encryption key ID used for encryption of log files. |
| admin.clusterGetName | This function returns the name of this cluster. |
| admin.clusterGetSslFipsEnabled | This function returns true when OpenSSL FIPS 140-2 mode is enabled in the cluster configuration. |
| admin.clusterGetXdqpBootstrapHosts | This function returns the ids of the bootstrap hosts configured for this cluster. |
| admin.clusterGetXdqpSslCertificate | This function returns the SSL certificate used to establish secure communication between this cluster and foreign clusters. |
| admin.clusterGetXdqpSslPrivateKey | This function returns the private key for secure communication between this cluster and foreign clusters. |
| admin.clusterRotateConfigEncryptionKeyId | This function rotates the encryption key ID to use for encryption of configuration files when MarkLogic is configured with internal KMS |
| admin.clusterRotateDataEncryptionKeyId | This function rotates the encryption key ID to use for encryption of data when MarkLogic is configured with internal KMS |
| admin.clusterRotateLogsEncryptionKeyId | This function rotates the encryption key ID to use for encryption of log files when MarkLogic is configured with internal KMS |
| admin.clusterSetAuditLogEncryption | This function sets the encryption setting at cluster level for the audit log file. |
| admin.clusterSetConfigEncryption | This function sets the encryption setting at cluster level for configuration files. |
| admin.clusterSetConfigEncryptionKeyId | This function sets the encryption key ID to use for encryption of configuration files |
| admin.clusterSetDataEncryption | This function sets the encryption setting at cluster level for user data. |
| admin.clusterSetDataEncryptionKeyId | This function sets the encryption key ID to use for encryption of data. |
| admin.clusterSetExternalConfigEncryptionKeyId | This function sets the encryption key ID to use for encryption of configuration files when the kms-type is external. |
| admin.clusterSetExternalDataEncryptionKeyId | This function sets the encryption key ID to use for encryption of data when the kms-type is external. |
| admin.clusterSetExternalLogsEncryptionKeyId | This function sets the encryption key ID to use for encryption of log files when kms-type is external. |
| admin.clusterSetKeystoreBackupOption | This function is used to set the backup option for the embedded PKCS#11 wallet. |
| admin.clusterSetKeystoreHostName | This function sets the host name for the Keystore Management System. |
| admin.clusterSetKeystoreHostNames | This function sets the host name(s) for the Keystore Management System. |
| admin.clusterSetKeystoreKmipCAPath | This function updates the path to the PEM encoded Certificate Authority (CA) used for authentication with the KMS. |
| admin.clusterSetKeystoreKmipCertificatePath | This function updates the path for the PEM encoded KMIP certificate for this host |
| admin.clusterSetKeystoreKmipKeyPath | This function updates the path to the PEM encoded private key. |
| admin.clusterSetKeystoreKmsType | This function sets the type of Keystore Management System (KMS) to be used. |
| admin.clusterSetKeystoreLogsEncryptionPassphrase | MarkLogic supports encrypting the logs with a secondary encryption passphrase, this function can be used to set the passphrase. |
| admin.clusterSetKeystorePassphrase | This function resets the MarkLogic PKCS#11 wallet protection passphrase |
| admin.clusterSetKeystorePort | This function sets the port number to connect to the Keystore Management System. |
| admin.clusterSetKeystorePorts | This function sets the port number(s) to connect to the Keystore Management System. |
| admin.clusterSetKeystoreWalletLocation | This function is used to set the PKCS#11 wallet location. |
| admin.clusterSetLanguageBaseline | This function sets the language baseline for this cluster. |
| admin.clusterSetLogsEncryption | This function sets the encryption setting at cluster level for log files. |
| admin.clusterSetLogsEncryptionKeyId | This function sets the encryption key ID to use for encryption of log files. |
| admin.clusterSetName | This function sets the name for this cluster. |
| admin.clusterSetSslFipsEnabled | This function enables or disables OpenSSL FIPS 140-2 mode for the cluster. |
| admin.clusterSetXdqpBootstrapHosts | This function sets the bootstrap hosts for the domestic cluster. |
| admin.clusterSetXdqpSslCertificate | This function sets the SSL certificate used to establish secure communication between this cluster and foreign clusters. |
| admin.clusterSetXdqpSslPrivateKey | This function sets the SSL private key for secure communication between this cluster and foreign clusters. |
| admin.databaseGetBackupEncryption | This function returns the backup encryption key used for encryption of backup for the database identified by the database-id. |
| admin.databaseGetEncryptionKeyId | This function returns the encryption key ID used for encryption of data for the database identified by the database-id. |
| admin.databaseSetBackupEncryptionKey | This function sets which key encryption key to use for encryption of backup for the database identified by database-id. |
| admin.databaseSetEncryptionKeyId | This function sets the encryption key ID to use for encryption of data for the database identified by database-id. |
| admin.foreignClusterCreate | This function creates a complete configuration for a foreign cluster. |
| admin.foreignClusterDelete | This function deletes the configuration for the specified foreign cluster. |
| admin.foreignClusterGetBootstrapHosts | This function returns one or more configuration elements that identify the bootstrap hosts on the specified foreign cluster. |
| admin.foreignClusterGetHostTimeout | This function returns the timeout period (in seconds) for communication between domestic hosts and hosts in the specified foreign cluster. |
| admin.foreignClusterGetName | This function returns the name of the foreign cluster. |
| admin.foreignClusterGetSslCertificate | This function returns the SSL certificate used to communicate with hosts in the foreign cluster. |
| admin.foreignClusterGetXdqpSslAllowSslv3 | This function is deprecated and will be removed in a future release. |
| admin.foreignClusterGetXdqpSslAllowTls | This function returns true if the TLS protocol is enabled for the foreign cluster. |
| admin.foreignClusterGetXdqpSslCiphers | This function returns the SSL ciphers set for the specified foreign cluster. |
| admin.foreignClusterGetXdqpSslEnabled | This function returns true if SSL is enabled for the foreign cluster. |
| admin.foreignClusterGetXdqpTimeout | This function returns the timeout setting (in seconds) for XDQP communication between data nodes and evaluator nodes in the domestic cluster and their counterparts in the foreign cluster. |
| admin.foreignClusterReplace | This function replaces a configuration for a foreign cluster with a new configuration. |
| admin.foreignClusterSetBootstrapHosts | This function identifies the foreign host to be used to bootstrap communication with the foreign cluster. |
| admin.foreignClusterSetHostTimeout | This function sets the timeout period (in seconds) for communication between domestic hosts and hosts in the specified foreign cluster. |
| admin.foreignClusterSetName | This function sets the name of a foreign cluster. |
| admin.foreignClusterSetSslCertificate | This function sets the specified SSL certificate for secure communication with hosts in a foreign cluster. |
| admin.foreignClusterSetXdqpSslAllowSslv3 | This function is deprecated and will be removed in a future release. |
| admin.foreignClusterSetXdqpSslAllowTls | This function enables or disables the TLS protocol for the specified foreign cluster. |
| admin.foreignClusterSetXdqpSslCiphers | This function sets SSL ciphers for the specified foreign cluster. |
| admin.foreignClusterSetXdqpSslEnabled | This function enables or disables SSL for the foreign cluster. |
| admin.foreignClusterSetXdqpTimeout | This function sets the timeout (in seconds) for XDQP communication between data nodes and evaluator nodes in the domestic cluster and their counterparts in the foreign cluster. |
| admin.foreignHost | This function configures a foreign host to be set by the admin.foreignClusterSetBootstrapHosts function as the bootstrap host for the foreign cluster. |
| admin.foreignHostGetConnectPort | This function returns the number of the port configured for the foreign bootstrap host. |
| admin.foreignHostGetId | This function returns the id of the foreign bootstrap host. |
| admin.foreignHostGetName | This function returns the name of the foreign bootstrap host. |
| admin.hostGetForeignPort | This function returns the port used by the specified host to listen for communications from foreign hosts. |
| admin.hostSetForeignPort | This function configures the specified domestic host to listen for communications from foreign hosts over the specified port. |
| admin.uiGetBanner | This function returns the UI banner setting. |
| admin.uiSetBanner | This function sets the banner that will appear on the qconsole page and the admin GUI page. |