You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

Resources | system | admin

admin

Basic configuration (name, location, etc) for the system.

Configuration

ParameterPresenceTypeDefaultDescription
nameMstring Name of the system.
actualSystemNameOstring System Name given by user as user/metadata
haModeOenumeration Management mode of the system (haMode1to1 or haModeNto1)
clusterIdOstring clusterID instance given in userdata
locationOstringUnknown Physical location of the system.
contactOstringUnknown Contact information of the system.
localAuthenticationEnabledObooleantrue The confd cli user information stored locally can be used for authentication.
externalAuthenticationEnabledObooleanfalse The confd cli user information stored on remote Radius server used for authentication.
defaultAccountLocalOnlyObooleanfalse Default confd cli user admin can only have local authentication.
utilMonitorStatsIntervalOuint3215 The time interval for system resource monitoring statistics.
utilMonitorStatsNumOfPastIntervalOuint324 The number of past intervals saved for system resource monitoring statistics.
auditLogStateOenumerationenabled This enables/disable the management audit log.
dspMismatchActionOenumerationpreserveRedundancy Action to be taken if the DSP mismatch is detected between active and standby.
cliSetWarningSupportOenumerationenabled Setting to enable/disable warning prompts configured for the set command. This setting does not modify warnings generated with the request command.
verifyAutoIndexObooleanfalse If true, verify that the autoIndex assigned to a new row is not already used in the confd database
sshPublicKeyAuthenticationEnabledObooleanfalse Enable/Disable state of SSH public key authentication through CLI for all users.
sshMaxAuthTriesOint326 Maximum authentication tries
restO
linkDetectionO System wide settings associated with link detection.
passwordRulesO The rules implementing Conf-D user password policy.
passwordRulesForAdminO The rules implementing user password policy for Administrator users.
passwordDictionaryOPassword management dictionary related configuration
accountManagementOAccount and password management related configuration
intrusionDetectionO Configuration for intrusion detection system (AIDE).
bannerO Configuration parameters for displaying a Banner.
fips-140-2O FIPS-140-2 related configuration and commands.
dodO
licenseO System-level License configuration.

Operational Data

ParameterDescription
sftpUserPassword Save the sftp password for the user.
savedConfigurationsLists saved configurations available on OAM

Operations

Operation NameDescription
reKeyConfdEncryptionKeys Re-key confd DES and AES encryption keys.
zeroizePersistenKeys Zeroize persistently stored keys.
reGenerateSshKeys Re-key RSA and ECDSA ssh public/private keys.
restart Restart System (all the CEs)
softReset Restart application on the system without rebooting the server(s).
switchover Switchover the management applications and restart application on current active server.
saveConfig Save the current configuration.
loadConfig Load saved configuration and restart the system without rebooting the server(s).
removeSavedConfig Removes a previously saved configuration from the server.
adManualSync Sync with AD Server to fetch subscriber data.
searchAdData Searches the AD database.
verifyDatabaseIntegrity Verifies config policy databases integrity.
saveConfigStoreFile Save the current configuration to an external cloud object store service.
retrieveConfigStoreFile Retrieve a configuration file from an external cloud object store service to the active configuration.
deleteConfigStoreFile Delete a configuration file on an external cloud object store service.
setConfigStoreParameters Set the parameters used to access an external cloud object store service.
resetSoftwareUpgradeState Resets software upgrade state and cleans up staging directory, previous versions, etc.
setHaConfig Set the HA port redundancy configuration.
reenableOsAccountRe-enable OS Account
removeInstanceFromGroup Removes the specified instance from Redundancy Group.
saveAndActivateSave and Activate the Configuration
viewConfigurationChangesView changes for the specified revision or the candidate changes.
restoreRevisionRestores configuration to an earlier revision
discardCandidateConfigurationDeletes configuration commits that have not been saveAndActivated
REST API: GET Example

curl -kisu 'admin:secret' -X GET https://{SBX-SERVER}/api/config/system/admin/{name}

  • No labels