Administration

Edit online

Introduction
Some administrative tasks can be completed by using the Manager REST API.
Backup system
Back up the manager database by using the settings set with the systemBackupSettings API.
Edit license key
This method allows you to add or remove a license key to the IBM Cloud Object Storage Manager.
Configure Accesser API
Change the default Accesser protocol type, or change it on a per-device basis.
Log collection settings
Manager log collection configuration settings that include the destination location and automatic collection details.
Collect logs now
Run log collection for one or more devices in the system. Logs within the time range are selected.
Configure provisioning API
Configure the ability for users to use the Provisioning API against IBM Cloud Object Storage Accesser® devices.
Configure system backup settings
Configures Manager system backup settings, including protocol and scheduling automatic backups. If automatic backup is not configured, a backup can be generated after these settings are saved by using the systemBackupNow API.
Configure system event suppression
Enable or disable the ability to configure event suppression on a per-device basis.
Edit certificate authority
Add, edit, or remove a certificate authority (CA) to authenticate against devices or users.
Edit preference configuration
Edit several system-wide preferences.
Edit system alert forward configuration
Enable alert forwarding on each device, which forward system alerts to an SNMP trap server or a Syslog server.
Edit system device level API configuration
Enable or disable an API on each device, which allows access to state information outside of the Manager. Two APIs are available: statistics and health.
Configure external agent
Create, edit, and delete external agents.
Edit system LDAP configuration
Allows the Manager to the ability to authenticate with an external LDAP / AD server. The Manager Administration Guide has detailed information, including troubleshooting.
Edit system keystone authentication settings
Configure the Keystone authentication settings for the system. An external Keystone server can be used to authenticate users. When configured, you can create accounts or groups in the system and tie them to users, groups, and projects in the external Keystone server. Keystone users can then authenticate against Accesser devices by using their Keystone credentials.
Edit the system root organization configuration
Edit the information and details that relate to the main organization in the system. This information is used throughout the application for identification and reporting.
Edit the system SMTP configuration
Configure the email capability of the system.
Edit the system SNMP configuration
Configure the SNMP v2c settings for the system. SNMP can be enabled on each of IBM Cloud Object Storage Manager™, IBM Cloud Object Storage Accesser®, and IBM Cloud Object Storage Slicestor® devices. When enabled, SNMP polling is enabled with a community string and limited by the set of IP addresses.
Edit the system Network Transport Layer configuration
TLS provides three features: confidentiality, authentication, and integrity.
OIDC configuration
System login banner configuration
Change the login banner for the system.
View system
This method combines the (View System Status) and (View System Configuration) method output.
View system configuration
Configuration parameters of devices, storage pools, and vaults are visible from this API.
View system status
Capacity and usage of devices, storage pools, and vaults are visible from this API.
External agent deployment configuration
Configure deployments for an external agent on the system.
System NTP configuration
Change the set of NTP servers to which the Manager and the other devices sync.
Enable container mode
Converts the vaults deployed to an access pool to container vaults.
Configure container mode
Edit Container Mode settings for the system.
Configure extended COS APIs settings
Enable the Resource Configuration API globally or on specific access pools so that you can configure IBM Cloud Object Storage resources.
Call Home configuration API
Set the call home configuration settings.
Add Notification Service
Configure add Notification Service API.
Edit Notification Service
Configure edit Notification Service API.
Delete Notification Service
Configure delete Notification Service API.
Edit storage pool Notification Service
Edit storage pool vault Notification Service
Edit default maximum Accesser devices offline percentage
Set the default target percentage of Accesser devices that may be offline across all Access Pools and Sites within the system.
Edit maximum Accesser devices offline percentage
Set the target percentage of Accesser devices that may be offline for the specified Access Pools and Sites within the system.
Edit System Optimistic Status Reporting Configuration
Enable or disable Optimistic Status Reporting on all devices. Optimistic Status Reporting extends the period in which devices report to the manager to 5 minutes.
Configure vault protection
Configure vault protection API.
Recover failed conversion
Recover from a failed vault to container mode conversion.
Restore settings
Perform Manager database restore.
Edit container mode settings
Edit Container Mode settings for the system.
Root organization configuration
Update the information relating to the main organization in the Manager.
System level privacy algorithm configuration
Configure default Privacy algorithm at system level.
System properties configuration
Edit System Properties Configuration settings for the system.
Edit Software Signature Verification configuration
Edit Software Signature Verification Configuration settings for the system.

Parent topic: Manager API Development