Resources | system | admin
 adminBasic configuration (name, location, etc) for the system. |
Configuration
| Parameter | Presence | Type | Default | Description | |
|---|---|---|---|---|---|
  | name | M | string | Name of the system. | |
| actualSystemName | O | string | System Name given by user as user/metadata | |
| haMode | O | enumeration | Management mode of the system (haMode1to1 or haModeNto1) | |
| clusterId | O | string | clusterID instance given in userdata | |
| location | O | string | Unknown | Physical location of the system. |
| contact | O | string | Unknown | Contact information of the system. |
| localAuthenticationEnabled | O | boolean | true | The confd cli user information stored locally can be used for authentication. |
| externalAuthenticationEnabled | O | boolean | false | The type of external authentication to use |
| externalAuthenticationType | O | enumeration | radius | The confd cli user information stored on remote Radius server used for authentication. |
| defaultAccountLocalOnly | O | boolean | false | Default confd cli user admin can only have local authentication. |
| commonCriteriaModeEnabled | O | boolean | false | Value of true will enable common criteria validation mode. |
| utilMonitorStatsInterval | O | uint32 | 15 | The time interval for system resource monitoring statistics. |
| utilMonitorStatsNumOfPastInterval | O | uint32 | 4 | The number of past intervals saved for system resource monitoring statistics. |
| auditLogState | O | enumeration | enabled | This enables/disable the management audit log. |
| dspMismatchAction | O | enumeration | preserveRedundancy | Action to be taken if the DSP mismatch is detected between active and standby. |
| cliSetWarningSupport | O | enumeration | enabled | Setting to enable/disable warning prompts configured for the set command. This setting does not modify warnings generated with the request command. |
| verifyAutoIndex | O | boolean | false | If true, verify that the autoIndex assigned to a new row is not already used in the confd database |
| sshPublicKeyAuthenticationEnabled | O | boolean | false | Enable/Disable state of SSH public key authentication through CLI for all users. |
| sshMaxAuthTries | O | int32 | 6 | Maximum authentication tries |
 | rest | O | |||
| vnfr | O | |||
| linkDetection | O | System wide settings associated with link detection. | ||
| passwordRules | O | The rules implementing Conf-D user password policy. | ||
| passwordRulesForAdmin | O | The rules implementing user password policy for Administrator users. | ||
| passwordDictionary | O | Password management dictionary related configuration | ||
| accountManagement | O | Account and password management related configuration | ||
| gratuitousArp | O | System wide settings associated with gratuitousArp . | ||
| intrusionDetection | O | Configuration for intrusion detection system (AIDE). | ||
| banner | O | Configuration parameters for displaying a Banner. | ||
| fips-140-2 | O | FIPS-140-2 related configuration and commands. | ||
| dod | O | |||
| ema | O | EMA modules enable/disable related configurations. | ||
| kernelParams | O | Modifying kernel parameters for SBC. | ||
| license | O | System-level License configuration. |
Operational Data
| Parameter | Description | |
|---|---|---|
| sftpUserPassword | Save the sftp password for the user. |
| savedConfigurations | Lists saved configurations available on OAM |
Operations
| Operation Name | Description |
|---|---|
| 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. |
| reenableOsAccount | Re-enable OS Account |
| removeInstanceFromGroup | Removes the specified instance from Redundancy Group. |
| saveAndActivate | Save and Activate the Configuration |
| viewConfigurationChanges | View changes for the specified revision or the candidate changes. |
| restoreRevision | Restores configuration to an earlier revision |
| discardCandidateConfiguration | Deletes 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} |
Overview
Content Tools