Database-MongoDB

Return All Connected Organizations — MongoDB Cloud Manager

Return All Connected Organizations¶

On this page

Required Roles
Resource
- Request Path Parameters
- Request Query Parameters
- Request Body Parameters
Response
- Response Document
- results Embedded Document
Example Request
Example Response

The federationSettings resource allows you to return all connected organizations for a federated authentication configuration.

Base URL: https://cloud.mongodb.com/api/public/v1.0

Required Roles¶

You must have the Organization Owner role for at least one connected organization in the federation configuration to call this endpoint.

Resource¶

GET /federationSettings/{FEDERATION-SETTINGS-ID}/connectedOrgConfigs/

Request Path Parameters¶

Name	Type	Description
`FEDERATION-SETTINGS-ID`	string	Unique 24-hexadecimal digit string that identifies the federated authentication configuration.

Request Query Parameters¶

The following query parameters are optional:

Name	Type	Necessity	Description	Default
pageNum	number	Optional	One-based integer that returns a subsection of results.	`1`
itemsPerPage	number	Optional	Number of items to return per page, up to a maximum of 500.	`100`
pretty	boolean	Optional	Flag that indicates whether the response body should be in a prettyprint format.	`false`
envelope	boolean	Optional	Flag that indicates whether or not to wrap the response in an envelope. Some API clients cannot access the HTTP response headers or status code. To remediate this, set `envelope : true` in the query. For endpoints that return a list of results, the `results` object is an envelope. Cloud Manager adds the `status` field to the response body.	`false`

Request Body Parameters¶

This endpoint does not use HTTP request body parameters.

Response¶

Response Document¶

The response JSON document includes an array of result objects, an array of link objects and a count of the total number of result objects retrieved.

Name	Type	Description
results	array of objects	One object for each item detailed in the results Embedded Document section.
links	array of objects	One or more links to sub-resources and/or related resources. All `links` arrays in responses include at least one link called `self` . The relationships between URL s are explained in the Web Linking Specification .
totalCount	integer	Count of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated.

results Embedded Document¶

Each document in the result array contains the federated authentication configuration for each connected organization.

Name	Type	Description
`domainAllowList`	array	List that contains the approved domains from which organization users can log in.
`domainRestrictionEnabled`	boolean	Flag that indicates whether domain restriction is enabled for the connected organization. Note `userConflicts` returns `null` when `"domainRestrictionEnabled": false` .
`identityProviderId`	string	Unique 20-hexadecimal digit string that identifies the identity provider associated with the connected organization.
`orgId`	string	Unique 24-hexadecimal digit string that identifies the connected organization.
`postAuthRoleGrants`	array	List that contains the default roles granted to users who authenticate through the IdP in a connected organization.
`roleMappings`	array	List that contains the role mappings configured in this organization.
`userConflicts`	array	List that contains the usernames that don’t match any domain on the allowed list. Note `userConflicts` returns `null` when `"domainRestrictionEnabled": false` .

Example Request¶

copy

     curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --include \
     --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/federationSettings/{FEDERATION-SETTINGS-ID}/connectedOrgConfigs"

    

Example Response¶

     {
 "links": [
     {
         "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/federationSettings/{FEDERATION-SETTINGS-ID}/connectedOrgConfigs?pageNum=1&itemsPerPage=100",
         "rel": "self"
     }
 ],
 "results": [
     {
         "domainAllowList": [],
         "domainRestrictionEnabled": false,
         "identityProviderId": null,
         "orgId": "5f86fb11e0079069c9ec3132",
         "postAuthRoleGrants": [],
         "roleMappings": [],
         "userConflicts": null
     }
 ],
 "totalCount": 1
}

    

Disks — MongoDB Cloud Manager

Disks¶

Retrieves the disks and disk partitions on which MongoDB runs.

Base URL: https://cloud.mongodb.com/api/public/v1.0

Endpoints¶

The following endpoints are available for hosts .

Method	Endpoint	Description
GET	/groups/{PROJECT-ID}/hosts/{HOST-ID}/disks	Retrieves all disk partitions on the specified host.
GET	/groups/{PROJECT-ID}/hosts/HOST-ID/disks/{PARTITION-NAME}	Retrieves a single disk parition.

Read article

Configure AWS Integration — MongoDB Cloud Manager

Configure AWS Integration¶

On this page

Considerations
Rolling Resync onto New EC2 Instances
Update a Replica Set’s Hostnames

Important

The ability to provision MongoDB servers in AWS using Cloud Manager was retired in October 2017.

Any existing clusters continue as they are.
This retirement impacts DNS entries in the following ways:
- Entries for existing servers continue to resolve to the same IP address to which they currently resolve until at least January 1, 2023.
- Servers that undergo a change of IP address due to maintenance or an instance stop/restart will no longer be resolvable via their mongodbdns.com hostname.
- All existing mongodbdns.com hostnames will stop working in May 2023.
Cloud Manager can manage hosts provisioned directly through AWS . See Provision Servers for Automation .
If you are interested in fully managed provisioning on AWS , evaluate MongoDB Atlas.

If you want to continue using Cloud Manager to manage these deployments, update the hostname for each host using one of the following methods for a replica set:

Rolling Resync onto New EC2 Instances
Update a Replica Set’s Hostnames

Considerations¶

These procedures involve stepping down the old primary and triggering at least one election for a new primary. All writes to the primary fail during the period starting when the rs.stepDown() method is received until either a new primary is elected, or if there are no electable secondaries, the original primary resumes normal operation. For MongoDB versions 4.0 and earlier, all client connections are closed.

Consider performing this procedure during a maintenance window during which applications stop all write operations to the cluster.

To learn more about elections, see rs.stepDown() behavior and Replica Set Elections .

Rolling Resync onto New EC2 Instances¶

Create a new EC2 instance for each member of the replica set.¶

Replace each non-primary replica set member with a new EC2 instance.¶

Add a new instance to the replica set using its EC2 hostname. To learn more, see Add Members to a Replica Set.
Wait for the initial sync to complete. To learn how to get the status of an initial sync, see the MongoDB manual.
Remove one old replica set member with a mongodbdns.com hostname. To learn more, see Remove Members from Replica Set.

Repeat for each non-primary replica set member.

Change your application connection string to use the AWS EC2 hostnames.¶

Replace the primary with a new EC2 instance.¶

Add the last new instance to the replica set using its EC2 hostname. To learn more, see Add Members to a Replica Set.
Wait for the initial sync to complete. To learn how to get the status of an initial sync, see the MongoDB manual.
Connect to the primary and step it down. To learn more, see rs.stepDown() .

Note

Stepping down the primary triggers at least one election for a new primary. To learn more about elections, see Replica Set Elections .
Remove the old primary with the mongodbdns.com hostname from the replica set. To learn more, see Remove Members from Replica Set.

Update a Replica Set’s Hostnames¶

Follow the Change Hostnames while Maintaining Replica Set Availability procedure in the MongoDB manual.

An overview of the linked procedure is as follows:

Connect to the primary.¶

Remove a secondary member from the replica set and re-add it using its EC2 hostname.¶

Repeat for each non-primary member of the replica set.

Change your application connection string to use the AWS EC2 hostnames.¶

Reconnect to the primary and step it down.¶

Note

Stepping down the primary triggers at least one election for a new primary. To learn more about elections, see Replica Set Elections .

Connect to the new primary.¶

Remove the old primary from the replica set and re-add it using its EC2 hostname.¶

Read article

Stop, Restart, or Terminate a Backup — MongoDB Cloud Manager

Stop, Restart, or Terminate a Backup¶

On this page

Stop Backup for a Deployment
Restart Backup for a Deployment
Terminate a Deployment’s Backups

When you stop backups for a replica set or sharded cluster Cloud Manager stops taking new snapshots but retains existing snapshots until their listed expiration date.

If you later restart backups for replica set or cluster, Cloud Manager might perform an initial sync , depending on how much time has elapsed.

If you terminate a backup, Cloud Manager immediately deletes all the backup’s snapshots.

Stop Backup for a Deployment¶

Click Continuous Backup , then the Overview tab.¶

On the line listing the process, click the ellipsis icon and click Stop .¶

Click the Stop button.¶

If prompted for an authentication code, enter the code and click Verify . Click Stop again.

Restart Backup for a Deployment¶

Click Continuous Backup , then the Overview tab.¶

On the line listing the process, click the ellipsis icon and click Restart .¶

Select a Sync source and click Restart. ¶

Terminate a Deployment’s Backups¶

Terminating a backup triggers a full backup

If you terminate a backup, Cloud Manager immediately deletes the backup’s snapshots. The next backup job runs as a full backup rather than an incremental backup.

Click Continuous Backup , then the Overview tab.¶

Click the ellipsis h icon next to the backup.¶

Click the Stop button.¶

If prompted for an authentication code, enter the code and click Verify . Click Stop again.

Once the backup has stopped, click the backup’s ellipsis icon and click Terminate .¶

Click the Terminate button.¶

Read article

Manage Alerts — MongoDB Cloud Manager

Manage Alerts¶

On this page

Overview
View Alerts
View All Activity
Retrieve the Activity Feed
Acknowledge an Alert
Unacknowledge an Alert
Disable Alerts for a Specific Process
Suspend Alerts by Adding a Maintenance Window

Overview¶

Cloud Manager issues alerts for the database and server conditions configured in your alert settings . When a condition triggers an alert, you receive the alert at regular intervals until the alert resolves or Cloud Manager cancels it. You should fix the immediate problem, implement a long-term solution, and view metrics to monitor your progress.

Organization Alerts
Project Alerts

View Alerts¶

Navigate to the Alerts page for your organization.¶

If it is not already displayed, select your desired organization from the office icon Organizations menu in the navigation bar.
Click Alerts in the sidebar.

If it is not already displayed, click the All Alerts tab.¶

View All Activity¶

Organization Activity
Project Activity

Navigate to the Activity Feed page for your organization.¶

If it is not already displayed, select your desired organization from the office icon Organizations menu in the navigation bar.
Click Activity Feed in the sidebar.

Filter the activity feed.¶

You can filter the organization activity feed by event type and time range. You can combine filtering methods together for greater control over the activity feed output.

Filter by event

Select the event categories or specific events you want to see from the activity feed. To exclude specific categories or events from the activity feed, click Select all categories and events , then deselect the categories and events you want to exclude.

You can filter events based on the following categories:

Category	Description
Access	Events related to Cloud Manager users.
Alerts	Events related to alert configuration and monitoring.
Billing	Events related to payments and payment methods.
Others	Miscellaneous events, including log retrieval and mLab events.
Organization	Events related to your Cloud Manager organization.
Projects	Events related to Cloud Manager projects.

Filter by time range: Select a Start Date and End Date to view events from within a specified time range. Once you have configured a time range, click Apply Dates to update the activity feed with the specified range.

Retrieve the Activity Feed¶

You can retrieve events for a specified organization or project using the Events API resource.

Acknowledge an Alert¶

When you acknowledge the alert, Cloud Manager sends no further notifications to the alert’s distribution list until the acknowledgment period has passed or until you resolve the alert. The distribution list receives no notification of the acknowledgment.

If the alert condition ends during the acknowledgment period, Cloud Manager sends a notification of the resolution.

If you configure an alert with PagerDuty, a third-party incident management service, you can only acknowledge the alert on your PagerDuty dashboard.

Navigate to the Alerts page for your organization.¶

If it is not already displayed, select your desired organization from the office icon Organizations menu in the navigation bar.
Click Alerts in the sidebar.

Acknowledge alerts¶

To acknowledge a single alert, on the line item for the alert, click Acknowledge .

To acknowledge multiple, but not all, alerts:

Check the checkbox to the left of each alert to acknowledge.
Click Mark Acknowledge above the table.

To acknowledge all alerts:

Select the checkbox in the table header to select every alert.
Click Mark Acknowledge above the table.

Select the time period for which to acknowledge the alert.¶

Click the time frame for which you no longer wish to receive alerts.

Cloud Manager sends no further alert messages for the period of time you select.

Optional: If all Alerts were checked, select All Visible or All Open Alerts .¶

If all alerts are checked, then another set of radio buttons appear:

Click Acknowledge all visible checked alerts to acknowledge all alerts that were loaded onto the page.
Click Acknowledge all open alerts to acknowledge all alerts: checked, unchecked, visible and not visible on the current page.

Click Acknowledge to confirm.¶

Unacknowledge an Alert¶

You can undo an acknowledgment and again receive notifications if the alert condition still applies.

Navigate to the Alerts page for your organization.¶

If it is not already displayed, select your desired organization from the office icon Organizations menu in the navigation bar.
Click Alerts in the sidebar.

On the line item for the alert, click Unacknowledge .¶

Click Confirm .¶

If the alert condition continues to exist, Cloud Manager resends the alerts.

Disable Alerts for a Specific Process¶

You can turn off alerts for a given process. This might be useful, for example, if you want to temporarily disable the process but do not want it hidden from monitoring. Use the following procedure both to turn alerts off or on.

Navigate to the Clusters view for your deployment.¶

If it is not already displayed, select the organization that contains your desired project from the office icon Organizations menu in the navigation bar.
If it is not already displayed, select your desired project from the Projects menu in the navigation bar.
If it is not already displayed, click Deployment in the sidebar.
Click the Clusters view.

On the line listing the process, click the ellipsis icon and select Monitoring Settings .¶

Select Alert Status and then modify the alert settings.¶

Suspend Alerts by Adding a Maintenance Window¶

Specify maintenance windows to temporarily turn off alert notifications for a given resource while you perform maintenance.

To view maintenance windows:

Navigate to the Alert Settings tab.¶

If it is not already displayed, select the organization that contains your desired project from the office icon Organizations menu in the navigation bar.
If it is not already displayed, select your desired project from the Projects menu in the navigation bar.
Click the bell icon Project Alerts icon in the navigation bar, or click Alerts in the sidebar.
Click the Alert Settings tab.

Click the Maintenance Windows filter.¶

Add or Edit a Maintenance Window¶

Navigate to the Alert Settings tab.¶

If it is not already displayed, select the organization that contains your desired project from the office icon Organizations menu in the navigation bar.
If it is not already displayed, select your desired project from the Projects menu in the navigation bar.
Click the bell icon Project Alerts icon in the navigation bar, or click Alerts in the sidebar.
Click the Alert Settings tab.

Add or edit a maintenance window.¶

To add a maintenance window: Click the Add button and select New Maintenance Window .
To edit a maintenance window: Click the Maintenance Windows filter, then click the ellipsis icon for a mainenance window and select Edit .

Select the target components for which to suspend alerts.¶

Note that selecting the Host target selects both HOST and HOST_METRIC alert configurations returned through the alertConfigs endpoint .

Select the time period for which to suspend alerts.¶

Enter an optional description for the maintenance window.¶

Click Save .¶

Delete a Maintenance Window¶

Navigate to the Alert Settings tab.¶

If it is not already displayed, select the organization that contains your desired project from the office icon Organizations menu in the navigation bar.
If it is not already displayed, select your desired project from the Projects menu in the navigation bar.
Click the bell icon Project Alerts icon in the navigation bar, or click Alerts in the sidebar.
Click the Alert Settings tab.

Click the Maintenance Windows filter.¶

For the window to delete, click the ellipsis icon and select Delete .¶

Click Confirm .¶

Read article

Install MongoDB Agent — MongoDB Cloud Manager

Install MongoDB Agent¶

Installation Instructions in Cloud Manager Interface

Cloud Manager displays the MongoDB Agent install instructions after you choose your MongoDB Agent download. You can copy all the necessary commands from the Cloud Manager.

Caution

Please review the MongoDB Agent Prerequisites before installing the MongoDB Agent.

There are two workflows to follow when using MongoDB Agents with MongoDB hosts:

Install the MongoDB Agent to Manage Deployments: Recommended: You have a project and want to install the MongoDB Agent to manage your MongoDB deployments. You can also monitor and back up your MongoDB deployments following this workflow.
Install the MongoDB Agent to Only Monitor or Backup Deployments: You have a project and want to install the MongoDB Agent to monitor and/or back up your MongoDB deployments. You are choosing not to manage your MongoDB deployments at this time.

Read article

Welcome to Knowledge Base!

KB at your finger tips

Database-MongoDB