APIs to manage, protect, or recover MongoDB Ops Manager assets

This section contains information of MongoDB Ops Manager APIs.

The following sections are the part of this topic:

Add a MongoDB Ops Manager

Table: Add a MongoDB Ops Manager

API	Important variables and options
POST /netbackup/asset-service/queries GET /netbackup/asset-service/queries/{aqcId} GET /netbackup/asset-service/workloads /mongodb-ops-manager/assets	centralURL: The central URL is a fully qualified URL with the port number of the Ops Manager Application. credentialName: credentials associated with MongoDB Ops Manager. Note: Ensure that the credentials with credentialName exist.

MongoDB Ops Manager Discovery API

Table: Discover the MongoDB Ops Manager assets for given central URL of Ops Manager

API	Important variables and options
POST /netbackup/admin/discovery /workloads/mongodb-ops-manager/start POST /netbackup/admin/discovery/workloads /mongodb-ops-manager/stop GET /netbackup/admin/discovery/workloads /mongodb-ops-manager/status	serverName: central URL to initiate the discovery process.

API

Important variables and options

POST
/netbackup/admin/discovery
/workloads/mongodb-ops-manager/start
 
POST 
/netbackup/admin/discovery/workloads
/mongodb-ops-manager/stop
 
GET
/netbackup/admin/discovery/workloads
/mongodb-ops-manager/status

serverName: central URL to initiate the discovery process.

After discovery, you need to configure the preferred nodes for the replica sets in the cluster.

Preferred nodes of replica sets/shard in a cluster

Table: Select preferred nodes of replica sets/shard in a cluster

API	Important variables and options
POST /netbackup/asset-service/queries	assetType: is cluster. id: is the cluster ID for which the preferred node is to be configured. details: specify names along with their preferred nodes, with each value corresponding to a node name. For example: "details": {"rsId1": ["prefnode_hostname1:port1"], "rsId2": ["prefnode_hostname2:port2"] }

Once the preferred nodes of all replica sets/shard in the cluster are configured, the Protection Ready flag for the cluster will be displayed as Yes. Proceed to create the policies

Create a MongoDB Ops Manager Policy

Table: Create a MongoDB Ops Manager Policy

API	Important variables and options
POST /netbackup/config/policies	policyType: BigData. clients: Clients is a required parameter to have a hostname with a value corresponding to the cluster ID in MongoDB Ops Manager. backupSelections: Should have the following: Application_Type: mongodbopsmanager Cluster Information: Specify in the format: group/<group id>/clusters/<cluster id> ensuring that the cluster ID and group ID match those in Ops Manager. Backup_Host: Represents the hostname of the preferred nodes in the cluster, with an entry for each node. For example: "backupSelections": { "selections": ["Application_Type= mongodbopsmanager", "/group/<groupId>/clusters/<clusterId>", "Backup_Host=preferredNodeHostName" ] }

API

Important variables and options

POST 
/netbackup/config/policies

policyType: BigData.
clients: Clients is a required parameter to have a hostname with a value corresponding to the cluster ID in MongoDB Ops Manager.
backupSelections: Should have the following:
- Application_Type: mongodbopsmanager
- Cluster Information: Specify in the format: group/<group id>/clusters/<cluster id> ensuring that the cluster ID and group ID match those in Ops Manager.
- Backup_Host: Represents the hostname of the preferred nodes in the cluster, with an entry for each node.
  For example:
```
"backupSelections": {
  "selections": ["Application_Type=
mongodbopsmanager",
"/group/<groupId>/clusters/<clusterId>",
"Backup_Host=preferredNodeHostName"
  ]
}
```

Other processes, like scheduling within the policy or initiating the policy backup, remain unchanged.

MongoDB Ops Manager Recovery

Table: MongoDB Ops Manager Recovery

API	Important variables and options
POST /netbackup/recovery/workloads/ mongodb-ops-manager/scenarios/cluster /recover	sourceClusterAssetId: NetBackup asset id of the cluster whose backup is to be recovered. targetClusterAssetId: is NetBackup asset id of the cluster where the recovery will be performed. recoverPointInTime: this parameter is not mandatory, however you can specify as null when recovering databases to the current time. maxStreamsPerNode: is Maximum number of backup streams per node. Note: If the value for recoverPointInTime parameter is not provided, the recovery of the databases will happen to current time.

API

Important variables and options

POST
/netbackup/recovery/workloads/
mongodb-ops-manager/scenarios/cluster
/recover

sourceClusterAssetId: NetBackup asset id of the cluster whose backup is to be recovered.
targetClusterAssetId: is NetBackup asset id of the cluster where the recovery will be performed.
recoverPointInTime: this parameter is not mandatory, however you can specify as null when recovering databases to the current time.
maxStreamsPerNode: is Maximum number of backup streams per node.

Note:

If the value for recoverPointInTime parameter is not provided, the recovery of the databases will happen to current time.

APIs to manage, protect, or recover MongoDB Ops Manager assets

Feedback

Feedback