From cb4568110bffc703c5f46d32f3ee1ea32b601763 Mon Sep 17 00:00:00 2001 From: andreaangiolillo Date: Wed, 18 Dec 2024 16:22:35 +0000 Subject: [PATCH 1/3] CLOUDP-285950: add support for flex clusters to `atlas backup snaphots download` --- .../atlas-backups-snapshots-download.txt | 0 docs/command/atlas-backups-snapshots-list.txt | 115 --------- .../command/atlas-backups-snapshots-watch.txt | 108 --------- docs/command/atlas-backups-snapshots.txt | 67 ------ docs/command/atlas-backups.txt | 67 ------ ...oudProviders-accessRoles-aws-authorize.txt | 96 -------- ...-cloudProviders-accessRoles-aws-create.txt | 80 ------- ...dProviders-accessRoles-aws-deauthorize.txt | 94 -------- .../atlas-cloudProviders-accessRoles-aws.txt | 63 ----- .../atlas-cloudProviders-accessRoles-list.txt | 68 ------ .../atlas-cloudProviders-accessRoles.txt | 61 ----- docs/command/atlas-cloudProviders.txt | 59 ----- ...las-clusters-advancedSettings-describe.txt | 91 ------- ...atlas-clusters-advancedSettings-update.txt | 175 -------------- .../atlas-clusters-advancedSettings.txt | 61 ----- .../atlas-clusters-availableRegions-list.txt | 89 ------- .../atlas-clusters-availableRegions.txt | 59 ----- ...as-clusters-connectionStrings-describe.txt | 96 -------- .../atlas-clusters-connectionStrings.txt | 59 ----- docs/command/atlas-clusters-create.txt | 222 ------------------ docs/command/atlas-clusters-delete.txt | 120 ---------- docs/command/atlas-clusters-describe.txt | 103 -------- docs/command/atlas-clusters-failover.txt | 102 -------- .../command/atlas-clusters-indexes-create.txt | 135 ----------- docs/command/atlas-clusters-indexes.txt | 59 ----- docs/command/atlas-clusters-list.txt | 103 -------- .../atlas-clusters-onlineArchives-create.txt | 139 ----------- .../atlas-clusters-onlineArchives-delete.txt | 106 --------- ...atlas-clusters-onlineArchives-describe.txt | 107 --------- .../atlas-clusters-onlineArchives-list.txt | 103 -------- .../atlas-clusters-onlineArchives-pause.txt | 106 --------- .../atlas-clusters-onlineArchives-start.txt | 98 -------- .../atlas-clusters-onlineArchives-update.txt | 124 ---------- .../atlas-clusters-onlineArchives-watch.txt | 107 --------- .../command/atlas-clusters-onlineArchives.txt | 73 ------ docs/command/atlas-clusters-pause.txt | 103 -------- .../atlas-clusters-sampleData-describe.txt | 103 -------- .../atlas-clusters-sampleData-load.txt | 102 -------- .../atlas-clusters-sampleData-watch.txt | 103 -------- docs/command/atlas-clusters-sampleData.txt | 65 ----- .../atlas-clusters-search-indexes-create.txt | 110 --------- .../atlas-clusters-search-indexes-delete.txt | 106 --------- ...atlas-clusters-search-indexes-describe.txt | 107 --------- .../atlas-clusters-search-indexes-list.txt | 99 -------- .../atlas-clusters-search-indexes-update.txt | 110 --------- .../command/atlas-clusters-search-indexes.txt | 67 ------ .../atlas-clusters-search-nodes-create.txt | 102 -------- .../atlas-clusters-search-nodes-delete.txt | 92 -------- .../atlas-clusters-search-nodes-list.txt | 91 ------- .../atlas-clusters-search-nodes-update.txt | 102 -------- docs/command/atlas-clusters-search-nodes.txt | 65 ----- docs/command/atlas-clusters-search.txt | 61 ----- docs/command/atlas-clusters-start.txt | 103 -------- docs/command/atlas-clusters-update.txt | 184 --------------- docs/command/atlas-clusters-upgrade.txt | 146 ------------ docs/command/atlas-clusters-watch.txt | 104 -------- docs/command/atlas-clusters.txt | 93 -------- docs/command/atlas-completion-bash.txt | 76 ------ docs/command/atlas-completion-fish.txt | 75 ------ docs/command/atlas-completion-powershell.txt | 72 ------ docs/command/atlas-completion-zsh.txt | 86 ------- docs/command/atlas-completion.txt | 69 ------ docs/command/atlas-config-delete.txt | 103 -------- docs/command/atlas-config-describe.txt | 78 ------ docs/command/atlas-config-edit.txt | 74 ------ docs/command/atlas-config-init.txt | 77 ------ docs/command/atlas-config-list.txt | 71 ------ docs/command/atlas-config-rename.txt | 86 ------- docs/command/atlas-config-set.txt | 87 ------- docs/command/atlas-config.txt | 78 ------ docs/command/atlas-customDbRoles-create.txt | 131 ----------- docs/command/atlas-customDbRoles-delete.txt | 94 -------- docs/command/atlas-customDbRoles-describe.txt | 84 ------- docs/command/atlas-customDbRoles-list.txt | 68 ------ docs/command/atlas-customDbRoles-update.txt | 106 --------- docs/command/atlas-customDbRoles.txt | 67 ------ docs/command/atlas-customDns-aws-describe.txt | 87 ------- docs/command/atlas-customDns-aws-disable.txt | 86 ------- docs/command/atlas-customDns-aws-enable.txt | 86 ------- docs/command/atlas-customDns-aws.txt | 63 ----- docs/command/atlas-customDns.txt | 59 ----- docs/command/atlas-dataFederation-create.txt | 126 ---------- docs/command/atlas-dataFederation-delete.txt | 103 -------- .../command/atlas-dataFederation-describe.txt | 93 -------- docs/command/atlas-dataFederation-list.txt | 81 ------- docs/command/atlas-dataFederation-logs.txt | 105 --------- ...dataFederation-privateEndpoints-create.txt | 106 --------- ...dataFederation-privateEndpoints-delete.txt | 103 -------- ...taFederation-privateEndpoints-describe.txt | 93 -------- ...s-dataFederation-privateEndpoints-list.txt | 77 ------ .../atlas-dataFederation-privateEndpoints.txt | 65 ----- ...tlas-dataFederation-queryLimits-create.txt | 114 --------- ...tlas-dataFederation-queryLimits-delete.txt | 107 --------- ...as-dataFederation-queryLimits-describe.txt | 97 -------- .../atlas-dataFederation-queryLimits-list.txt | 81 ------- .../atlas-dataFederation-queryLimits.txt | 65 ----- docs/command/atlas-dataFederation-update.txt | 126 ---------- docs/command/atlas-dataFederation.txt | 73 ------ docs/command/atlas-dbusers-certs-create.txt | 94 -------- docs/command/atlas-dbusers-certs-list.txt | 94 -------- docs/command/atlas-dbusers-certs.txt | 61 ----- docs/command/atlas-dbusers-create.txt | 178 -------------- docs/command/atlas-dbusers-delete.txt | 120 ---------- docs/command/atlas-dbusers-describe.txt | 121 ---------- docs/command/atlas-dbusers-list.txt | 92 -------- docs/command/atlas-dbusers-update.txt | 137 ----------- docs/command/atlas-dbusers.txt | 73 ------ docs/command/atlas-deployments-connect.txt | 98 -------- docs/command/atlas-deployments-delete.txt | 133 ----------- docs/command/atlas-deployments-list.txt | 73 ------ docs/command/atlas-deployments-logs.txt | 94 -------- docs/command/atlas-deployments-pause.txt | 92 -------- ...tlas-deployments-search-indexes-create.txt | 120 ---------- ...tlas-deployments-search-indexes-delete.txt | 111 --------- ...as-deployments-search-indexes-describe.txt | 109 --------- .../atlas-deployments-search-indexes-list.txt | 101 -------- .../atlas-deployments-search-indexes.txt | 65 ----- docs/command/atlas-deployments-search.txt | 59 ----- docs/command/atlas-deployments-setup.txt | 154 ------------ docs/command/atlas-deployments-start.txt | 95 -------- docs/command/atlas-deployments.txt | 73 ------ .../atlas-events-organizations-list.txt | 105 --------- docs/command/atlas-events-organizations.txt | 61 ----- docs/command/atlas-events-projects-list.txt | 105 --------- docs/command/atlas-events-projects.txt | 61 ----- docs/command/atlas-events.txt | 61 ----- ...onSettings-connectedOrgConfigs-connect.txt | 93 -------- ...ionSettings-connectedOrgConfigs-delete.txt | 89 ------- ...nSettings-connectedOrgConfigs-describe.txt | 85 ------- ...ettings-connectedOrgConfigs-disconnect.txt | 102 -------- ...ationSettings-connectedOrgConfigs-list.txt | 87 ------- ...ionSettings-connectedOrgConfigs-update.txt | 83 ------- ...federationSettings-connectedOrgConfigs.txt | 69 ------ ...entication-federationSettings-describe.txt | 87 ------- ...nSettings-identityProvider-create-oidc.txt | 141 ----------- ...rationSettings-identityProvider-create.txt | 59 ----- ...rationSettings-identityProvider-delete.txt | 107 --------- ...tionSettings-identityProvider-describe.txt | 104 -------- ...derationSettings-identityProvider-list.txt | 104 -------- ...ionSettings-identityProvider-revokeJwk.txt | 93 -------- ...nSettings-identityProvider-update-oidc.txt | 141 ----------- ...rationSettings-identityProvider-update.txt | 59 ----- ...on-federationSettings-identityProvider.txt | 69 ------ ...ratedAuthentication-federationSettings.txt | 63 ----- .../command/atlas-federatedAuthentication.txt | 59 ----- .../atlas-integrations-create-DATADOG.txt | 100 -------- .../atlas-integrations-create-OPS_GENIE.txt | 96 -------- .../atlas-integrations-create-PAGER_DUTY.txt | 92 -------- .../atlas-integrations-create-VICTOR_OPS.txt | 98 -------- .../atlas-integrations-create-WEBHOOK.txt | 96 -------- docs/command/atlas-integrations-create.txt | 67 ------ docs/command/atlas-integrations-delete.txt | 104 -------- docs/command/atlas-integrations-describe.txt | 92 -------- docs/command/atlas-integrations-list.txt | 87 ------- docs/command/atlas-integrations.txt | 65 ----- .../command/atlas-kubernetes-config-apply.txt | 117 --------- .../atlas-kubernetes-config-generate.txt | 142 ----------- docs/command/atlas-kubernetes-config.txt | 63 ----- .../atlas-kubernetes-operator-install.txt | 164 ------------- docs/command/atlas-kubernetes-operator.txt | 61 ----- docs/command/atlas-kubernetes.txt | 63 ----- docs/command/atlas-liveMigrations-create.txt | 126 ---------- docs/command/atlas-liveMigrations-cutover.txt | 82 ------- .../command/atlas-liveMigrations-describe.txt | 62 ----- .../atlas-liveMigrations-link-create.txt | 82 ------- .../atlas-liveMigrations-link-delete.txt | 76 ------ docs/command/atlas-liveMigrations-link.txt | 61 ----- ...atlas-liveMigrations-validation-create.txt | 126 ---------- ...las-liveMigrations-validation-describe.txt | 80 ------- .../atlas-liveMigrations-validation.txt | 61 ----- docs/command/atlas-liveMigrations.txt | 67 ------ docs/command/atlas-logs-download.txt | 126 ---------- docs/command/atlas-logs.txt | 59 ----- .../atlas-maintenanceWindows-clear.txt | 92 -------- .../atlas-maintenanceWindows-defer.txt | 88 ------- .../atlas-maintenanceWindows-describe.txt | 89 ------- .../atlas-maintenanceWindows-update.txt | 100 -------- docs/command/atlas-maintenanceWindows.txt | 65 ----- .../atlas-metrics-databases-describe.txt | 131 ----------- docs/command/atlas-metrics-databases-list.txt | 118 ---------- docs/command/atlas-metrics-databases.txt | 61 ----- docs/command/atlas-metrics-disks-describe.txt | 133 ----------- docs/command/atlas-metrics-disks-list.txt | 118 ---------- docs/command/atlas-metrics-disks.txt | 61 ----- docs/command/atlas-metrics-processes.txt | 129 ---------- docs/command/atlas-metrics.txt | 63 ----- .../atlas-networking-containers-delete.txt | 102 -------- .../atlas-networking-containers-list.txt | 92 -------- docs/command/atlas-networking-containers.txt | 61 ----- .../atlas-networking-peering-create-aws.txt | 110 --------- .../atlas-networking-peering-create-azure.txt | 116 --------- .../atlas-networking-peering-create-gcp.txt | 106 --------- .../atlas-networking-peering-create.txt | 63 ----- .../atlas-networking-peering-delete.txt | 102 -------- .../command/atlas-networking-peering-list.txt | 92 -------- .../atlas-networking-peering-watch.txt | 108 --------- docs/command/atlas-networking-peering.txt | 65 ----- docs/command/atlas-networking.txt | 61 ----- ...ganizations-apiKeys-accessLists-create.txt | 104 -------- ...ganizations-apiKeys-accessLists-delete.txt | 106 --------- ...organizations-apiKeys-accessLists-list.txt | 106 --------- ...tlas-organizations-apiKeys-accessLists.txt | 63 ----- .../atlas-organizations-apiKeys-assign.txt | 114 --------- .../atlas-organizations-apiKeys-create.txt | 98 -------- .../atlas-organizations-apiKeys-delete.txt | 104 -------- .../atlas-organizations-apiKeys-describe.txt | 105 --------- .../atlas-organizations-apiKeys-list.txt | 92 -------- docs/command/atlas-organizations-apiKeys.txt | 69 ------ docs/command/atlas-organizations-create.txt | 104 -------- docs/command/atlas-organizations-delete.txt | 100 -------- docs/command/atlas-organizations-describe.txt | 99 -------- ...atlas-organizations-invitations-delete.txt | 102 -------- ...las-organizations-invitations-describe.txt | 92 -------- ...atlas-organizations-invitations-invite.txt | 120 ---------- .../atlas-organizations-invitations-list.txt | 80 ------- ...atlas-organizations-invitations-update.txt | 119 ---------- .../atlas-organizations-invitations.txt | 69 ------ docs/command/atlas-organizations-list.txt | 110 --------- .../atlas-organizations-users-list.txt | 99 -------- docs/command/atlas-organizations-users.txt | 59 ----- docs/command/atlas-organizations.txt | 73 ------ ...las-performanceAdvisor-namespaces-list.txt | 92 -------- .../atlas-performanceAdvisor-namespaces.txt | 59 ----- ...Advisor-slowOperationThreshold-disable.txt | 76 ------ ...eAdvisor-slowOperationThreshold-enable.txt | 76 ------ ...formanceAdvisor-slowOperationThreshold.txt | 61 ----- ...-performanceAdvisor-slowQueryLogs-list.txt | 100 -------- ...atlas-performanceAdvisor-slowQueryLogs.txt | 59 ----- ...rformanceAdvisor-suggestedIndexes-list.txt | 102 -------- ...as-performanceAdvisor-suggestedIndexes.txt | 59 ----- docs/command/atlas-performanceAdvisor.txt | 65 ----- docs/command/atlas-plugin-install.txt | 99 -------- docs/command/atlas-plugin-list.txt | 58 ----- docs/command/atlas-plugin-uninstall.txt | 87 ------- docs/command/atlas-plugin-update.txt | 99 -------- docs/command/atlas-plugin.txt | 65 ----- .../atlas-privateEndpoints-aws-create.txt | 92 -------- .../atlas-privateEndpoints-aws-delete.txt | 102 -------- .../atlas-privateEndpoints-aws-describe.txt | 103 -------- ...privateEndpoints-aws-interfaces-create.txt | 108 --------- ...privateEndpoints-aws-interfaces-delete.txt | 106 --------- ...ivateEndpoints-aws-interfaces-describe.txt | 109 --------- .../atlas-privateEndpoints-aws-interfaces.txt | 63 ----- .../atlas-privateEndpoints-aws-list.txt | 76 ------ .../atlas-privateEndpoints-aws-watch.txt | 104 -------- docs/command/atlas-privateEndpoints-aws.txt | 69 ------ .../atlas-privateEndpoints-azure-create.txt | 92 -------- .../atlas-privateEndpoints-azure-delete.txt | 102 -------- .../atlas-privateEndpoints-azure-describe.txt | 103 -------- ...ivateEndpoints-azure-interfaces-create.txt | 113 --------- ...ivateEndpoints-azure-interfaces-delete.txt | 106 --------- ...ateEndpoints-azure-interfaces-describe.txt | 107 --------- ...tlas-privateEndpoints-azure-interfaces.txt | 63 ----- .../atlas-privateEndpoints-azure-list.txt | 76 ------ .../atlas-privateEndpoints-azure-watch.txt | 104 -------- docs/command/atlas-privateEndpoints-azure.txt | 69 ------ .../atlas-privateEndpoints-gcp-create.txt | 89 ------- .../atlas-privateEndpoints-gcp-delete.txt | 101 -------- .../atlas-privateEndpoints-gcp-describe.txt | 91 ------- ...privateEndpoints-gcp-interfaces-create.txt | 116 --------- ...privateEndpoints-gcp-interfaces-delete.txt | 106 --------- ...ivateEndpoints-gcp-interfaces-describe.txt | 107 --------- .../atlas-privateEndpoints-gcp-interfaces.txt | 63 ----- .../atlas-privateEndpoints-gcp-list.txt | 75 ------ .../atlas-privateEndpoints-gcp-watch.txt | 103 -------- docs/command/atlas-privateEndpoints-gcp.txt | 69 ------ ...rivateEndpoints-regionalModes-describe.txt | 89 ------- ...privateEndpoints-regionalModes-disable.txt | 88 ------- ...-privateEndpoints-regionalModes-enable.txt | 88 ------- .../atlas-privateEndpoints-regionalModes.txt | 63 ----- docs/command/atlas-privateEndpoints.txt | 65 ----- docs/command/atlas-processes-describe.txt | 101 -------- docs/command/atlas-processes-list.txt | 92 -------- docs/command/atlas-processes.txt | 61 ----- .../command/atlas-projects-apiKeys-assign.txt | 108 --------- .../command/atlas-projects-apiKeys-create.txt | 98 -------- .../command/atlas-projects-apiKeys-delete.txt | 106 --------- docs/command/atlas-projects-apiKeys-list.txt | 92 -------- docs/command/atlas-projects-apiKeys.txt | 65 ----- docs/command/atlas-projects-create.txt | 120 ---------- docs/command/atlas-projects-delete.txt | 98 -------- docs/command/atlas-projects-describe.txt | 99 -------- docs/command/atlas-projects-list.txt | 99 -------- .../atlas-projects-settings-describe.txt | 85 ------- .../atlas-projects-settings-update.txt | 144 ------------ docs/command/atlas-projects-settings.txt | 63 ----- docs/command/atlas-projects-teams-add.txt | 108 --------- docs/command/atlas-projects-teams-delete.txt | 104 -------- docs/command/atlas-projects-teams-list.txt | 99 -------- docs/command/atlas-projects-teams-update.txt | 106 --------- docs/command/atlas-projects-teams.txt | 65 ----- docs/command/atlas-projects-update.txt | 102 -------- docs/command/atlas-projects-users-delete.txt | 104 -------- docs/command/atlas-projects-users-list.txt | 92 -------- docs/command/atlas-projects-users.txt | 61 ----- docs/command/atlas-projects.txt | 77 ------ .../atlas-security-customerCerts-create.txt | 92 -------- .../atlas-security-customerCerts-describe.txt | 76 ------ .../atlas-security-customerCerts-disable.txt | 84 ------- docs/command/atlas-security-customerCerts.txt | 63 ----- docs/command/atlas-security-ldap-delete.txt | 86 ------- docs/command/atlas-security-ldap-get.txt | 87 ------- docs/command/atlas-security-ldap-save.txt | 138 ----------- ...tlas-security-ldap-verify-status-watch.txt | 103 -------- .../atlas-security-ldap-verify-status.txt | 106 --------- docs/command/atlas-security-ldap-verify.txt | 123 ---------- docs/command/atlas-security-ldap.txt | 65 ----- docs/command/atlas-security.txt | 61 ----- ...las-serverless-backups-restores-create.txt | 138 ----------- ...s-serverless-backups-restores-describe.txt | 84 ------- ...atlas-serverless-backups-restores-list.txt | 104 -------- ...tlas-serverless-backups-restores-watch.txt | 99 -------- .../atlas-serverless-backups-restores.txt | 65 ----- ...-serverless-backups-snapshots-describe.txt | 95 -------- ...tlas-serverless-backups-snapshots-list.txt | 104 -------- ...las-serverless-backups-snapshots-watch.txt | 95 -------- .../atlas-serverless-backups-snapshots.txt | 63 ----- docs/command/atlas-serverless-backups.txt | 61 ----- docs/command/atlas-serverless-create.txt | 114 --------- docs/command/atlas-serverless-delete.txt | 108 --------- docs/command/atlas-serverless-describe.txt | 103 -------- docs/command/atlas-serverless-list.txt | 99 -------- docs/command/atlas-serverless-update.txt | 122 ---------- docs/command/atlas-serverless-watch.txt | 103 -------- docs/command/atlas-serverless.txt | 73 ------ docs/command/atlas-setup.txt | 142 ----------- .../atlas-streams-connections-create.txt | 118 ---------- .../atlas-streams-connections-delete.txt | 116 --------- .../atlas-streams-connections-describe.txt | 97 -------- .../atlas-streams-connections-list.txt | 81 ------- .../atlas-streams-connections-update.txt | 111 --------- docs/command/atlas-streams-connections.txt | 69 ------ .../atlas-streams-instances-create.txt | 114 --------- .../atlas-streams-instances-delete.txt | 112 --------- .../atlas-streams-instances-describe.txt | 109 --------- .../atlas-streams-instances-download.txt | 114 --------- docs/command/atlas-streams-instances-list.txt | 95 -------- .../atlas-streams-instances-update.txt | 111 --------- docs/command/atlas-streams-instances.txt | 71 ------ docs/command/atlas-streams.txt | 63 ----- docs/command/atlas-teams-create.txt | 106 --------- docs/command/atlas-teams-delete.txt | 102 -------- docs/command/atlas-teams-describe.txt | 104 -------- docs/command/atlas-teams-list.txt | 92 -------- docs/command/atlas-teams-rename.txt | 106 --------- docs/command/atlas-teams-users-add.txt | 108 --------- docs/command/atlas-teams-users-delete.txt | 106 --------- docs/command/atlas-teams-users-list.txt | 84 ------- docs/command/atlas-teams-users.txt | 65 ----- docs/command/atlas-teams.txt | 71 ------ docs/command/atlas-users-describe.txt | 104 -------- docs/command/atlas-users-invite.txt | 126 ---------- docs/command/atlas-users.txt | 63 ----- docs/command/atlas.txt | 130 ---------- internal/cli/backup/snapshots/download.go | 157 +++++++++++++ .../cli/backup/snapshots/download_test.go | 51 ++++ internal/cli/backup/snapshots/snapshots.go | 1 + internal/store/cloud_provider_backup.go | 3 +- internal/usage/usage.go | 1 + 359 files changed, 211 insertions(+), 32865 deletions(-) create mode 100644 docs/command/atlas-backups-snapshots-download.txt delete mode 100644 docs/command/atlas-backups-snapshots-list.txt delete mode 100644 docs/command/atlas-backups-snapshots-watch.txt delete mode 100644 docs/command/atlas-backups-snapshots.txt delete mode 100644 docs/command/atlas-backups.txt delete mode 100644 docs/command/atlas-cloudProviders-accessRoles-aws-authorize.txt delete mode 100644 docs/command/atlas-cloudProviders-accessRoles-aws-create.txt delete mode 100644 docs/command/atlas-cloudProviders-accessRoles-aws-deauthorize.txt delete mode 100644 docs/command/atlas-cloudProviders-accessRoles-aws.txt delete mode 100644 docs/command/atlas-cloudProviders-accessRoles-list.txt delete mode 100644 docs/command/atlas-cloudProviders-accessRoles.txt delete mode 100644 docs/command/atlas-cloudProviders.txt delete mode 100644 docs/command/atlas-clusters-advancedSettings-describe.txt delete mode 100644 docs/command/atlas-clusters-advancedSettings-update.txt delete mode 100644 docs/command/atlas-clusters-advancedSettings.txt delete mode 100644 docs/command/atlas-clusters-availableRegions-list.txt delete mode 100644 docs/command/atlas-clusters-availableRegions.txt delete mode 100644 docs/command/atlas-clusters-connectionStrings-describe.txt delete mode 100644 docs/command/atlas-clusters-connectionStrings.txt delete mode 100644 docs/command/atlas-clusters-create.txt delete mode 100644 docs/command/atlas-clusters-delete.txt delete mode 100644 docs/command/atlas-clusters-describe.txt delete mode 100644 docs/command/atlas-clusters-failover.txt delete mode 100644 docs/command/atlas-clusters-indexes-create.txt delete mode 100644 docs/command/atlas-clusters-indexes.txt delete mode 100644 docs/command/atlas-clusters-list.txt delete mode 100644 docs/command/atlas-clusters-onlineArchives-create.txt delete mode 100644 docs/command/atlas-clusters-onlineArchives-delete.txt delete mode 100644 docs/command/atlas-clusters-onlineArchives-describe.txt delete mode 100644 docs/command/atlas-clusters-onlineArchives-list.txt delete mode 100644 docs/command/atlas-clusters-onlineArchives-pause.txt delete mode 100644 docs/command/atlas-clusters-onlineArchives-start.txt delete mode 100644 docs/command/atlas-clusters-onlineArchives-update.txt delete mode 100644 docs/command/atlas-clusters-onlineArchives-watch.txt delete mode 100644 docs/command/atlas-clusters-onlineArchives.txt delete mode 100644 docs/command/atlas-clusters-pause.txt delete mode 100644 docs/command/atlas-clusters-sampleData-describe.txt delete mode 100644 docs/command/atlas-clusters-sampleData-load.txt delete mode 100644 docs/command/atlas-clusters-sampleData-watch.txt delete mode 100644 docs/command/atlas-clusters-sampleData.txt delete mode 100644 docs/command/atlas-clusters-search-indexes-create.txt delete mode 100644 docs/command/atlas-clusters-search-indexes-delete.txt delete mode 100644 docs/command/atlas-clusters-search-indexes-describe.txt delete mode 100644 docs/command/atlas-clusters-search-indexes-list.txt delete mode 100644 docs/command/atlas-clusters-search-indexes-update.txt delete mode 100644 docs/command/atlas-clusters-search-indexes.txt delete mode 100644 docs/command/atlas-clusters-search-nodes-create.txt delete mode 100644 docs/command/atlas-clusters-search-nodes-delete.txt delete mode 100644 docs/command/atlas-clusters-search-nodes-list.txt delete mode 100644 docs/command/atlas-clusters-search-nodes-update.txt delete mode 100644 docs/command/atlas-clusters-search-nodes.txt delete mode 100644 docs/command/atlas-clusters-search.txt delete mode 100644 docs/command/atlas-clusters-start.txt delete mode 100644 docs/command/atlas-clusters-update.txt delete mode 100644 docs/command/atlas-clusters-upgrade.txt delete mode 100644 docs/command/atlas-clusters-watch.txt delete mode 100644 docs/command/atlas-clusters.txt delete mode 100644 docs/command/atlas-completion-bash.txt delete mode 100644 docs/command/atlas-completion-fish.txt delete mode 100644 docs/command/atlas-completion-powershell.txt delete mode 100644 docs/command/atlas-completion-zsh.txt delete mode 100644 docs/command/atlas-completion.txt delete mode 100644 docs/command/atlas-config-delete.txt delete mode 100644 docs/command/atlas-config-describe.txt delete mode 100644 docs/command/atlas-config-edit.txt delete mode 100644 docs/command/atlas-config-init.txt delete mode 100644 docs/command/atlas-config-list.txt delete mode 100644 docs/command/atlas-config-rename.txt delete mode 100644 docs/command/atlas-config-set.txt delete mode 100644 docs/command/atlas-config.txt delete mode 100644 docs/command/atlas-customDbRoles-create.txt delete mode 100644 docs/command/atlas-customDbRoles-delete.txt delete mode 100644 docs/command/atlas-customDbRoles-describe.txt delete mode 100644 docs/command/atlas-customDbRoles-list.txt delete mode 100644 docs/command/atlas-customDbRoles-update.txt delete mode 100644 docs/command/atlas-customDbRoles.txt delete mode 100644 docs/command/atlas-customDns-aws-describe.txt delete mode 100644 docs/command/atlas-customDns-aws-disable.txt delete mode 100644 docs/command/atlas-customDns-aws-enable.txt delete mode 100644 docs/command/atlas-customDns-aws.txt delete mode 100644 docs/command/atlas-customDns.txt delete mode 100644 docs/command/atlas-dataFederation-create.txt delete mode 100644 docs/command/atlas-dataFederation-delete.txt delete mode 100644 docs/command/atlas-dataFederation-describe.txt delete mode 100644 docs/command/atlas-dataFederation-list.txt delete mode 100644 docs/command/atlas-dataFederation-logs.txt delete mode 100644 docs/command/atlas-dataFederation-privateEndpoints-create.txt delete mode 100644 docs/command/atlas-dataFederation-privateEndpoints-delete.txt delete mode 100644 docs/command/atlas-dataFederation-privateEndpoints-describe.txt delete mode 100644 docs/command/atlas-dataFederation-privateEndpoints-list.txt delete mode 100644 docs/command/atlas-dataFederation-privateEndpoints.txt delete mode 100644 docs/command/atlas-dataFederation-queryLimits-create.txt delete mode 100644 docs/command/atlas-dataFederation-queryLimits-delete.txt delete mode 100644 docs/command/atlas-dataFederation-queryLimits-describe.txt delete mode 100644 docs/command/atlas-dataFederation-queryLimits-list.txt delete mode 100644 docs/command/atlas-dataFederation-queryLimits.txt delete mode 100644 docs/command/atlas-dataFederation-update.txt delete mode 100644 docs/command/atlas-dataFederation.txt delete mode 100644 docs/command/atlas-dbusers-certs-create.txt delete mode 100644 docs/command/atlas-dbusers-certs-list.txt delete mode 100644 docs/command/atlas-dbusers-certs.txt delete mode 100644 docs/command/atlas-dbusers-create.txt delete mode 100644 docs/command/atlas-dbusers-delete.txt delete mode 100644 docs/command/atlas-dbusers-describe.txt delete mode 100644 docs/command/atlas-dbusers-list.txt delete mode 100644 docs/command/atlas-dbusers-update.txt delete mode 100644 docs/command/atlas-dbusers.txt delete mode 100644 docs/command/atlas-deployments-connect.txt delete mode 100644 docs/command/atlas-deployments-delete.txt delete mode 100644 docs/command/atlas-deployments-list.txt delete mode 100644 docs/command/atlas-deployments-logs.txt delete mode 100644 docs/command/atlas-deployments-pause.txt delete mode 100644 docs/command/atlas-deployments-search-indexes-create.txt delete mode 100644 docs/command/atlas-deployments-search-indexes-delete.txt delete mode 100644 docs/command/atlas-deployments-search-indexes-describe.txt delete mode 100644 docs/command/atlas-deployments-search-indexes-list.txt delete mode 100644 docs/command/atlas-deployments-search-indexes.txt delete mode 100644 docs/command/atlas-deployments-search.txt delete mode 100644 docs/command/atlas-deployments-setup.txt delete mode 100644 docs/command/atlas-deployments-start.txt delete mode 100644 docs/command/atlas-deployments.txt delete mode 100644 docs/command/atlas-events-organizations-list.txt delete mode 100644 docs/command/atlas-events-organizations.txt delete mode 100644 docs/command/atlas-events-projects-list.txt delete mode 100644 docs/command/atlas-events-projects.txt delete mode 100644 docs/command/atlas-events.txt delete mode 100644 docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-connect.txt delete mode 100644 docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-delete.txt delete mode 100644 docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-describe.txt delete mode 100644 docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-disconnect.txt delete mode 100644 docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-list.txt delete mode 100644 docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-update.txt delete mode 100644 docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs.txt delete mode 100644 docs/command/atlas-federatedAuthentication-federationSettings-describe.txt delete mode 100644 docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-create-oidc.txt delete mode 100644 docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-create.txt delete mode 100644 docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-delete.txt delete mode 100644 docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-describe.txt delete mode 100644 docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-list.txt delete mode 100644 docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-revokeJwk.txt delete mode 100644 docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-update-oidc.txt delete mode 100644 docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-update.txt delete mode 100644 docs/command/atlas-federatedAuthentication-federationSettings-identityProvider.txt delete mode 100644 docs/command/atlas-federatedAuthentication-federationSettings.txt delete mode 100644 docs/command/atlas-federatedAuthentication.txt delete mode 100644 docs/command/atlas-integrations-create-DATADOG.txt delete mode 100644 docs/command/atlas-integrations-create-OPS_GENIE.txt delete mode 100644 docs/command/atlas-integrations-create-PAGER_DUTY.txt delete mode 100644 docs/command/atlas-integrations-create-VICTOR_OPS.txt delete mode 100644 docs/command/atlas-integrations-create-WEBHOOK.txt delete mode 100644 docs/command/atlas-integrations-create.txt delete mode 100644 docs/command/atlas-integrations-delete.txt delete mode 100644 docs/command/atlas-integrations-describe.txt delete mode 100644 docs/command/atlas-integrations-list.txt delete mode 100644 docs/command/atlas-integrations.txt delete mode 100644 docs/command/atlas-kubernetes-config-apply.txt delete mode 100644 docs/command/atlas-kubernetes-config-generate.txt delete mode 100644 docs/command/atlas-kubernetes-config.txt delete mode 100644 docs/command/atlas-kubernetes-operator-install.txt delete mode 100644 docs/command/atlas-kubernetes-operator.txt delete mode 100644 docs/command/atlas-kubernetes.txt delete mode 100644 docs/command/atlas-liveMigrations-create.txt delete mode 100644 docs/command/atlas-liveMigrations-cutover.txt delete mode 100644 docs/command/atlas-liveMigrations-describe.txt delete mode 100644 docs/command/atlas-liveMigrations-link-create.txt delete mode 100644 docs/command/atlas-liveMigrations-link-delete.txt delete mode 100644 docs/command/atlas-liveMigrations-link.txt delete mode 100644 docs/command/atlas-liveMigrations-validation-create.txt delete mode 100644 docs/command/atlas-liveMigrations-validation-describe.txt delete mode 100644 docs/command/atlas-liveMigrations-validation.txt delete mode 100644 docs/command/atlas-liveMigrations.txt delete mode 100644 docs/command/atlas-logs-download.txt delete mode 100644 docs/command/atlas-logs.txt delete mode 100644 docs/command/atlas-maintenanceWindows-clear.txt delete mode 100644 docs/command/atlas-maintenanceWindows-defer.txt delete mode 100644 docs/command/atlas-maintenanceWindows-describe.txt delete mode 100644 docs/command/atlas-maintenanceWindows-update.txt delete mode 100644 docs/command/atlas-maintenanceWindows.txt delete mode 100644 docs/command/atlas-metrics-databases-describe.txt delete mode 100644 docs/command/atlas-metrics-databases-list.txt delete mode 100644 docs/command/atlas-metrics-databases.txt delete mode 100644 docs/command/atlas-metrics-disks-describe.txt delete mode 100644 docs/command/atlas-metrics-disks-list.txt delete mode 100644 docs/command/atlas-metrics-disks.txt delete mode 100644 docs/command/atlas-metrics-processes.txt delete mode 100644 docs/command/atlas-metrics.txt delete mode 100644 docs/command/atlas-networking-containers-delete.txt delete mode 100644 docs/command/atlas-networking-containers-list.txt delete mode 100644 docs/command/atlas-networking-containers.txt delete mode 100644 docs/command/atlas-networking-peering-create-aws.txt delete mode 100644 docs/command/atlas-networking-peering-create-azure.txt delete mode 100644 docs/command/atlas-networking-peering-create-gcp.txt delete mode 100644 docs/command/atlas-networking-peering-create.txt delete mode 100644 docs/command/atlas-networking-peering-delete.txt delete mode 100644 docs/command/atlas-networking-peering-list.txt delete mode 100644 docs/command/atlas-networking-peering-watch.txt delete mode 100644 docs/command/atlas-networking-peering.txt delete mode 100644 docs/command/atlas-networking.txt delete mode 100644 docs/command/atlas-organizations-apiKeys-accessLists-create.txt delete mode 100644 docs/command/atlas-organizations-apiKeys-accessLists-delete.txt delete mode 100644 docs/command/atlas-organizations-apiKeys-accessLists-list.txt delete mode 100644 docs/command/atlas-organizations-apiKeys-accessLists.txt delete mode 100644 docs/command/atlas-organizations-apiKeys-assign.txt delete mode 100644 docs/command/atlas-organizations-apiKeys-create.txt delete mode 100644 docs/command/atlas-organizations-apiKeys-delete.txt delete mode 100644 docs/command/atlas-organizations-apiKeys-describe.txt delete mode 100644 docs/command/atlas-organizations-apiKeys-list.txt delete mode 100644 docs/command/atlas-organizations-apiKeys.txt delete mode 100644 docs/command/atlas-organizations-create.txt delete mode 100644 docs/command/atlas-organizations-delete.txt delete mode 100644 docs/command/atlas-organizations-describe.txt delete mode 100644 docs/command/atlas-organizations-invitations-delete.txt delete mode 100644 docs/command/atlas-organizations-invitations-describe.txt delete mode 100644 docs/command/atlas-organizations-invitations-invite.txt delete mode 100644 docs/command/atlas-organizations-invitations-list.txt delete mode 100644 docs/command/atlas-organizations-invitations-update.txt delete mode 100644 docs/command/atlas-organizations-invitations.txt delete mode 100644 docs/command/atlas-organizations-list.txt delete mode 100644 docs/command/atlas-organizations-users-list.txt delete mode 100644 docs/command/atlas-organizations-users.txt delete mode 100644 docs/command/atlas-organizations.txt delete mode 100644 docs/command/atlas-performanceAdvisor-namespaces-list.txt delete mode 100644 docs/command/atlas-performanceAdvisor-namespaces.txt delete mode 100644 docs/command/atlas-performanceAdvisor-slowOperationThreshold-disable.txt delete mode 100644 docs/command/atlas-performanceAdvisor-slowOperationThreshold-enable.txt delete mode 100644 docs/command/atlas-performanceAdvisor-slowOperationThreshold.txt delete mode 100644 docs/command/atlas-performanceAdvisor-slowQueryLogs-list.txt delete mode 100644 docs/command/atlas-performanceAdvisor-slowQueryLogs.txt delete mode 100644 docs/command/atlas-performanceAdvisor-suggestedIndexes-list.txt delete mode 100644 docs/command/atlas-performanceAdvisor-suggestedIndexes.txt delete mode 100644 docs/command/atlas-performanceAdvisor.txt delete mode 100644 docs/command/atlas-plugin-install.txt delete mode 100644 docs/command/atlas-plugin-list.txt delete mode 100644 docs/command/atlas-plugin-uninstall.txt delete mode 100644 docs/command/atlas-plugin-update.txt delete mode 100644 docs/command/atlas-plugin.txt delete mode 100644 docs/command/atlas-privateEndpoints-aws-create.txt delete mode 100644 docs/command/atlas-privateEndpoints-aws-delete.txt delete mode 100644 docs/command/atlas-privateEndpoints-aws-describe.txt delete mode 100644 docs/command/atlas-privateEndpoints-aws-interfaces-create.txt delete mode 100644 docs/command/atlas-privateEndpoints-aws-interfaces-delete.txt delete mode 100644 docs/command/atlas-privateEndpoints-aws-interfaces-describe.txt delete mode 100644 docs/command/atlas-privateEndpoints-aws-interfaces.txt delete mode 100644 docs/command/atlas-privateEndpoints-aws-list.txt delete mode 100644 docs/command/atlas-privateEndpoints-aws-watch.txt delete mode 100644 docs/command/atlas-privateEndpoints-aws.txt delete mode 100644 docs/command/atlas-privateEndpoints-azure-create.txt delete mode 100644 docs/command/atlas-privateEndpoints-azure-delete.txt delete mode 100644 docs/command/atlas-privateEndpoints-azure-describe.txt delete mode 100644 docs/command/atlas-privateEndpoints-azure-interfaces-create.txt delete mode 100644 docs/command/atlas-privateEndpoints-azure-interfaces-delete.txt delete mode 100644 docs/command/atlas-privateEndpoints-azure-interfaces-describe.txt delete mode 100644 docs/command/atlas-privateEndpoints-azure-interfaces.txt delete mode 100644 docs/command/atlas-privateEndpoints-azure-list.txt delete mode 100644 docs/command/atlas-privateEndpoints-azure-watch.txt delete mode 100644 docs/command/atlas-privateEndpoints-azure.txt delete mode 100644 docs/command/atlas-privateEndpoints-gcp-create.txt delete mode 100644 docs/command/atlas-privateEndpoints-gcp-delete.txt delete mode 100644 docs/command/atlas-privateEndpoints-gcp-describe.txt delete mode 100644 docs/command/atlas-privateEndpoints-gcp-interfaces-create.txt delete mode 100644 docs/command/atlas-privateEndpoints-gcp-interfaces-delete.txt delete mode 100644 docs/command/atlas-privateEndpoints-gcp-interfaces-describe.txt delete mode 100644 docs/command/atlas-privateEndpoints-gcp-interfaces.txt delete mode 100644 docs/command/atlas-privateEndpoints-gcp-list.txt delete mode 100644 docs/command/atlas-privateEndpoints-gcp-watch.txt delete mode 100644 docs/command/atlas-privateEndpoints-gcp.txt delete mode 100644 docs/command/atlas-privateEndpoints-regionalModes-describe.txt delete mode 100644 docs/command/atlas-privateEndpoints-regionalModes-disable.txt delete mode 100644 docs/command/atlas-privateEndpoints-regionalModes-enable.txt delete mode 100644 docs/command/atlas-privateEndpoints-regionalModes.txt delete mode 100644 docs/command/atlas-privateEndpoints.txt delete mode 100644 docs/command/atlas-processes-describe.txt delete mode 100644 docs/command/atlas-processes-list.txt delete mode 100644 docs/command/atlas-processes.txt delete mode 100644 docs/command/atlas-projects-apiKeys-assign.txt delete mode 100644 docs/command/atlas-projects-apiKeys-create.txt delete mode 100644 docs/command/atlas-projects-apiKeys-delete.txt delete mode 100644 docs/command/atlas-projects-apiKeys-list.txt delete mode 100644 docs/command/atlas-projects-apiKeys.txt delete mode 100644 docs/command/atlas-projects-create.txt delete mode 100644 docs/command/atlas-projects-delete.txt delete mode 100644 docs/command/atlas-projects-describe.txt delete mode 100644 docs/command/atlas-projects-list.txt delete mode 100644 docs/command/atlas-projects-settings-describe.txt delete mode 100644 docs/command/atlas-projects-settings-update.txt delete mode 100644 docs/command/atlas-projects-settings.txt delete mode 100644 docs/command/atlas-projects-teams-add.txt delete mode 100644 docs/command/atlas-projects-teams-delete.txt delete mode 100644 docs/command/atlas-projects-teams-list.txt delete mode 100644 docs/command/atlas-projects-teams-update.txt delete mode 100644 docs/command/atlas-projects-teams.txt delete mode 100644 docs/command/atlas-projects-update.txt delete mode 100644 docs/command/atlas-projects-users-delete.txt delete mode 100644 docs/command/atlas-projects-users-list.txt delete mode 100644 docs/command/atlas-projects-users.txt delete mode 100644 docs/command/atlas-projects.txt delete mode 100644 docs/command/atlas-security-customerCerts-create.txt delete mode 100644 docs/command/atlas-security-customerCerts-describe.txt delete mode 100644 docs/command/atlas-security-customerCerts-disable.txt delete mode 100644 docs/command/atlas-security-customerCerts.txt delete mode 100644 docs/command/atlas-security-ldap-delete.txt delete mode 100644 docs/command/atlas-security-ldap-get.txt delete mode 100644 docs/command/atlas-security-ldap-save.txt delete mode 100644 docs/command/atlas-security-ldap-verify-status-watch.txt delete mode 100644 docs/command/atlas-security-ldap-verify-status.txt delete mode 100644 docs/command/atlas-security-ldap-verify.txt delete mode 100644 docs/command/atlas-security-ldap.txt delete mode 100644 docs/command/atlas-security.txt delete mode 100644 docs/command/atlas-serverless-backups-restores-create.txt delete mode 100644 docs/command/atlas-serverless-backups-restores-describe.txt delete mode 100644 docs/command/atlas-serverless-backups-restores-list.txt delete mode 100644 docs/command/atlas-serverless-backups-restores-watch.txt delete mode 100644 docs/command/atlas-serverless-backups-restores.txt delete mode 100644 docs/command/atlas-serverless-backups-snapshots-describe.txt delete mode 100644 docs/command/atlas-serverless-backups-snapshots-list.txt delete mode 100644 docs/command/atlas-serverless-backups-snapshots-watch.txt delete mode 100644 docs/command/atlas-serverless-backups-snapshots.txt delete mode 100644 docs/command/atlas-serverless-backups.txt delete mode 100644 docs/command/atlas-serverless-create.txt delete mode 100644 docs/command/atlas-serverless-delete.txt delete mode 100644 docs/command/atlas-serverless-describe.txt delete mode 100644 docs/command/atlas-serverless-list.txt delete mode 100644 docs/command/atlas-serverless-update.txt delete mode 100644 docs/command/atlas-serverless-watch.txt delete mode 100644 docs/command/atlas-serverless.txt delete mode 100644 docs/command/atlas-setup.txt delete mode 100644 docs/command/atlas-streams-connections-create.txt delete mode 100644 docs/command/atlas-streams-connections-delete.txt delete mode 100644 docs/command/atlas-streams-connections-describe.txt delete mode 100644 docs/command/atlas-streams-connections-list.txt delete mode 100644 docs/command/atlas-streams-connections-update.txt delete mode 100644 docs/command/atlas-streams-connections.txt delete mode 100644 docs/command/atlas-streams-instances-create.txt delete mode 100644 docs/command/atlas-streams-instances-delete.txt delete mode 100644 docs/command/atlas-streams-instances-describe.txt delete mode 100644 docs/command/atlas-streams-instances-download.txt delete mode 100644 docs/command/atlas-streams-instances-list.txt delete mode 100644 docs/command/atlas-streams-instances-update.txt delete mode 100644 docs/command/atlas-streams-instances.txt delete mode 100644 docs/command/atlas-streams.txt delete mode 100644 docs/command/atlas-teams-create.txt delete mode 100644 docs/command/atlas-teams-delete.txt delete mode 100644 docs/command/atlas-teams-describe.txt delete mode 100644 docs/command/atlas-teams-list.txt delete mode 100644 docs/command/atlas-teams-rename.txt delete mode 100644 docs/command/atlas-teams-users-add.txt delete mode 100644 docs/command/atlas-teams-users-delete.txt delete mode 100644 docs/command/atlas-teams-users-list.txt delete mode 100644 docs/command/atlas-teams-users.txt delete mode 100644 docs/command/atlas-teams.txt delete mode 100644 docs/command/atlas-users-describe.txt delete mode 100644 docs/command/atlas-users-invite.txt delete mode 100644 docs/command/atlas-users.txt delete mode 100644 docs/command/atlas.txt create mode 100644 internal/cli/backup/snapshots/download.go create mode 100644 internal/cli/backup/snapshots/download_test.go diff --git a/docs/command/atlas-backups-snapshots-download.txt b/docs/command/atlas-backups-snapshots-download.txt new file mode 100644 index 0000000000..e69de29bb2 diff --git a/docs/command/atlas-backups-snapshots-list.txt b/docs/command/atlas-backups-snapshots-list.txt deleted file mode 100644 index 4fee8008ea..0000000000 --- a/docs/command/atlas-backups-snapshots-list.txt +++ /dev/null @@ -1,115 +0,0 @@ -.. _atlas-backups-snapshots-list: - -============================ -atlas backups snapshots list -============================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return all cloud backup snapshots for your project and cluster. - -To use this command, you must authenticate with a user account or an API key with the Project Read Only role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas backups snapshots list [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - clusterName - - string - - true - - Name of the Atlas cluster that contains the snapshots you want to retrieve. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for list - * - --limit - - int - - false - - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. - * - --omitCount - - - - false - - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --page - - int - - false - - Page number that specifies a page of results. This value defaults to 1. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - ID TYPE STATUS CREATED AT EXPIRES AT - - - -Examples --------- - -.. code-block:: - :copyable: false - - # Return a JSON-formatted list of snapshots for the cluster named myDemo - atlas backups snapshots list myDemo --output json diff --git a/docs/command/atlas-backups-snapshots-watch.txt b/docs/command/atlas-backups-snapshots-watch.txt deleted file mode 100644 index f17ed235fc..0000000000 --- a/docs/command/atlas-backups-snapshots-watch.txt +++ /dev/null @@ -1,108 +0,0 @@ -.. _atlas-backups-snapshots-watch: - -============================= -atlas backups snapshots watch -============================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Watch the specified snapshot in your project until it becomes available. - -This command checks the snapshot's status periodically until it reaches a completed or failed status. -Once the snapshot reaches the expected status, the command prints "Snapshot changes completed." -If you run the command in the terminal, it blocks the terminal session until the resource status completes or fails. -You can interrupt the command's polling at any time with CTRL-C. - -To use this command, you must authenticate with a user account or an API key with the Project Read Only role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas backups snapshots watch [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - snapshotId - - string - - true - - Unique identifier of the snapshot you want to watch. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --clusterName - - string - - true - - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. - * - -h, --help - - - - false - - help for watch - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - - Snapshot changes completed. - - -Examples --------- - -.. code-block:: - :copyable: false - - # Watch the backup snapshot with the ID 5f4007f327a3bd7b6f4103c5 in the cluster named myDemo until it becomes available: - atlas backups snapshots watch 5f4007f327a3bd7b6f4103c5 --clusterName myDemo diff --git a/docs/command/atlas-backups-snapshots.txt b/docs/command/atlas-backups-snapshots.txt deleted file mode 100644 index 42a3f27f1b..0000000000 --- a/docs/command/atlas-backups-snapshots.txt +++ /dev/null @@ -1,67 +0,0 @@ -.. _atlas-backups-snapshots: - -======================= -atlas backups snapshots -======================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage cloud backup snapshots for your project. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for snapshots - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-backups-snapshots-create` - Create a backup snapshot for your project and cluster. -* :ref:`atlas-backups-snapshots-delete` - Remove the specified backup snapshot. -* :ref:`atlas-backups-snapshots-describe` - Return the details for the specified snapshot for your project. -* :ref:`atlas-backups-snapshots-list` - Return all cloud backup snapshots for your project and cluster. -* :ref:`atlas-backups-snapshots-watch` - Watch the specified snapshot in your project until it becomes available. - - -.. toctree:: - :titlesonly: - - create - delete - describe - list - watch - diff --git a/docs/command/atlas-backups.txt b/docs/command/atlas-backups.txt deleted file mode 100644 index c04fe26d41..0000000000 --- a/docs/command/atlas-backups.txt +++ /dev/null @@ -1,67 +0,0 @@ -.. _atlas-backups: - -============= -atlas backups -============= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage cloud backups for your project. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for backups - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-backups-compliancePolicy` - Manage cloud backup compliance policy for your project. Use "atlas backups compliancepolicy setup" to enable backup compliance policy with a full configuration. Use "atlas backups compliancepolicy enable" to enable backup compliance policy without any configuration. -* :ref:`atlas-backups-exports` - Manage cloud backup export jobs for your project. -* :ref:`atlas-backups-restores` - Manage cloud backup restore jobs for your project. -* :ref:`atlas-backups-schedule` - Return a cloud backup schedule for the cluster you specify. -* :ref:`atlas-backups-snapshots` - Manage cloud backup snapshots for your project. - - -.. toctree:: - :titlesonly: - - compliancePolicy - exports - restores - schedule - snapshots - diff --git a/docs/command/atlas-cloudProviders-accessRoles-aws-authorize.txt b/docs/command/atlas-cloudProviders-accessRoles-aws-authorize.txt deleted file mode 100644 index 63807f8d41..0000000000 --- a/docs/command/atlas-cloudProviders-accessRoles-aws-authorize.txt +++ /dev/null @@ -1,96 +0,0 @@ -.. _atlas-cloudProviders-accessRoles-aws-authorize: - -============================================== -atlas cloudProviders accessRoles aws authorize -============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Authorize an AWS IAM role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas cloudProviders accessRoles aws authorize [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - roleId - - string - - true - - Unique ID of the role to authorize. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for authorize - * - --iamAssumedRoleArn - - string - - false - - Role ARN that Atlas assumes to access your AWS account. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - AWS IAM role ' successfully authorized. - - diff --git a/docs/command/atlas-cloudProviders-accessRoles-aws-create.txt b/docs/command/atlas-cloudProviders-accessRoles-aws-create.txt deleted file mode 100644 index d9d9cc95a5..0000000000 --- a/docs/command/atlas-cloudProviders-accessRoles-aws-create.txt +++ /dev/null @@ -1,80 +0,0 @@ -.. _atlas-cloudProviders-accessRoles-aws-create: - -=========================================== -atlas cloudProviders accessRoles aws create -=========================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create an AWS IAM role. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas cloudProviders accessRoles aws create [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for create - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - AWS IAM role '' successfully created. - Atlas AWS Account ARN: - Unique External ID: - - diff --git a/docs/command/atlas-cloudProviders-accessRoles-aws-deauthorize.txt b/docs/command/atlas-cloudProviders-accessRoles-aws-deauthorize.txt deleted file mode 100644 index cdb6f3e25b..0000000000 --- a/docs/command/atlas-cloudProviders-accessRoles-aws-deauthorize.txt +++ /dev/null @@ -1,94 +0,0 @@ -.. _atlas-cloudProviders-accessRoles-aws-deauthorize: - -================================================ -atlas cloudProviders accessRoles aws deauthorize -================================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Deauthorize an AWS IAM role. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas cloudProviders accessRoles aws deauthorize [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - roleId - - string - - true - - Unique ID of the role to authorize. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --force - - - - false - - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. - * - -h, --help - - - - false - - help for deauthorize - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - AWS IAM role successfully deauthorized. - - diff --git a/docs/command/atlas-cloudProviders-accessRoles-aws.txt b/docs/command/atlas-cloudProviders-accessRoles-aws.txt deleted file mode 100644 index 87be4ff42e..0000000000 --- a/docs/command/atlas-cloudProviders-accessRoles-aws.txt +++ /dev/null @@ -1,63 +0,0 @@ -.. _atlas-cloudProviders-accessRoles-aws: - -==================================== -atlas cloudProviders accessRoles aws -==================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage AWS IAM role access in Atlas. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for aws - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-cloudProviders-accessRoles-aws-authorize` - Authorize an AWS IAM role. -* :ref:`atlas-cloudProviders-accessRoles-aws-create` - Create an AWS IAM role. -* :ref:`atlas-cloudProviders-accessRoles-aws-deauthorize` - Deauthorize an AWS IAM role. - - -.. toctree:: - :titlesonly: - - authorize - create - deauthorize - diff --git a/docs/command/atlas-cloudProviders-accessRoles-list.txt b/docs/command/atlas-cloudProviders-accessRoles-list.txt deleted file mode 100644 index f547b542a0..0000000000 --- a/docs/command/atlas-cloudProviders-accessRoles-list.txt +++ /dev/null @@ -1,68 +0,0 @@ -.. _atlas-cloudProviders-accessRoles-list: - -===================================== -atlas cloudProviders accessRoles list -===================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -List AWS IAM role access in Atlas. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas cloudProviders accessRoles list [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for list - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - diff --git a/docs/command/atlas-cloudProviders-accessRoles.txt b/docs/command/atlas-cloudProviders-accessRoles.txt deleted file mode 100644 index a0d5c04fa9..0000000000 --- a/docs/command/atlas-cloudProviders-accessRoles.txt +++ /dev/null @@ -1,61 +0,0 @@ -.. _atlas-cloudProviders-accessRoles: - -================================ -atlas cloudProviders accessRoles -================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage AWS IAM role access in Atlas. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for accessRoles - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-cloudProviders-accessRoles-aws` - Manage AWS IAM role access in Atlas. -* :ref:`atlas-cloudProviders-accessRoles-list` - List AWS IAM role access in Atlas. - - -.. toctree:: - :titlesonly: - - aws - list - diff --git a/docs/command/atlas-cloudProviders.txt b/docs/command/atlas-cloudProviders.txt deleted file mode 100644 index 397bdf243d..0000000000 --- a/docs/command/atlas-cloudProviders.txt +++ /dev/null @@ -1,59 +0,0 @@ -.. _atlas-cloudProviders: - -==================== -atlas cloudProviders -==================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage cloud provider access in Atlas using AWS IAM roles. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for cloudProviders - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-cloudProviders-accessRoles` - Manage AWS IAM role access in Atlas. - - -.. toctree:: - :titlesonly: - - accessRoles - diff --git a/docs/command/atlas-clusters-advancedSettings-describe.txt b/docs/command/atlas-clusters-advancedSettings-describe.txt deleted file mode 100644 index da40aab20e..0000000000 --- a/docs/command/atlas-clusters-advancedSettings-describe.txt +++ /dev/null @@ -1,91 +0,0 @@ -.. _atlas-clusters-advancedSettings-describe: - -======================================== -atlas clusters advancedSettings describe -======================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Retrieve advanced configuration settings for one cluster. - -To use this command, you must authenticate with a user account or an API key with the Project Read Only role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas clusters advancedSettings describe [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - clusterName - - string - - true - - Name of the Atlas cluster for which you want to retrieve configuration settings. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for describe - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - atlas clusters advancedSettings describe Cluster0 diff --git a/docs/command/atlas-clusters-advancedSettings-update.txt b/docs/command/atlas-clusters-advancedSettings-update.txt deleted file mode 100644 index 5017e010ae..0000000000 --- a/docs/command/atlas-clusters-advancedSettings-update.txt +++ /dev/null @@ -1,175 +0,0 @@ -.. _atlas-clusters-advancedSettings-update: - -====================================== -atlas clusters advancedSettings update -====================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Update advanced configuration settings for one cluster. - -Updates the advanced configuration details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. Advanced configuration details include the read/write concern, index and oplog limits, and other database settings. -Atlas supports this command only for M10+ clusters. - - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas clusters advancedSettings update [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - clusterName - - string - - true - - Name of the cluster to update. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --disableFailIndexKeyTooLong - - - - false - - Flag that disables writing documents that exceed 1024 bytes without indexing. - - Mutually exclusive with --enableFailIndexKeyTooLong. - * - --disableJavascript - - - - false - - Flag that disables the execution of operations that perform server-side executions of JavaScript. - - Mutually exclusive with --enableJavascript. - * - --disableTableScan - - - - false - - Flag that disables executing any query that requires a collection scan to return results. - - Mutually exclusive with --enableTableScan. - * - --enableFailIndexKeyTooLong - - - - false - - Flag that enables writing documents that exceed 1024 bytes without indexing. - - Mutually exclusive with --disableFailIndexKeyTooLong. - * - --enableJavascript - - - - false - - Flag that enables the execution of operations that perform server-side executions of JavaScript. - - Mutually exclusive with --disableJavascript. - * - --enableTableScan - - - - false - - Flag that enables executing any query that requires a collection scan to return results. - - Mutually exclusive with --disableTableScan. - * - -h, --help - - - - false - - help for update - * - --oplogMinRetentionHours - - float - - false - - Minimum retention window for cluster's oplog expressed in hours. - * - --oplogSizeMB - - int - - false - - Storage limit of cluster's oplog expressed in megabytes. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --readConcern - - string - - false - - Default level of acknowledgment requested from MongoDB for read operations set for this cluster. - * - --sampleRefreshIntervalBIConnector - - int - - false - - Interval in seconds at which the mongosqld process re-samples data to create its relational schema. This value defaults to -1. - * - --sampleSizeBIConnector - - int - - false - - Number of documents per database to sample when gathering schema information. This value defaults to -1. - * - --tlsProtocol - - string - - false - - Minimum Transport Layer Security (TLS) version that the cluster accepts for incoming connections. - * - --writeConcern - - string - - false - - Default level of acknowledgment requested from MongoDB for write operations set for this cluster. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Updating advanced configuration settings of your cluster'. - - -Examples --------- - -.. code-block:: - :copyable: false - - # Update the minimum oplog size for a cluster: - atlas cluster advancedSettings update --projectId --oplogSizeMB 1000 - - -.. code-block:: - :copyable: false - - # Update the minimum TLS protocol version for a cluster: - atlas cluster advancedSettings update --projectId --minimumEnabledTLSProtocol "TLS1_2" diff --git a/docs/command/atlas-clusters-advancedSettings.txt b/docs/command/atlas-clusters-advancedSettings.txt deleted file mode 100644 index 206c7620db..0000000000 --- a/docs/command/atlas-clusters-advancedSettings.txt +++ /dev/null @@ -1,61 +0,0 @@ -.. _atlas-clusters-advancedSettings: - -=============================== -atlas clusters advancedSettings -=============================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage advanced configuration settings for your cluster. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for advancedSettings - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-clusters-advancedSettings-describe` - Retrieve advanced configuration settings for one cluster. -* :ref:`atlas-clusters-advancedSettings-update` - Update advanced configuration settings for one cluster. - - -.. toctree:: - :titlesonly: - - describe - update - diff --git a/docs/command/atlas-clusters-availableRegions-list.txt b/docs/command/atlas-clusters-availableRegions-list.txt deleted file mode 100644 index e0adf92e91..0000000000 --- a/docs/command/atlas-clusters-availableRegions-list.txt +++ /dev/null @@ -1,89 +0,0 @@ -.. _atlas-clusters-availableRegions-list: - -==================================== -atlas clusters availableRegions list -==================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -List available regions that Atlas supports for new deployments. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas clusters availableRegions list [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for list - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --provider - - string - - false - - Name of your cloud service provider. Valid values are AWS, AZURE, or GCP. - * - --tier - - string - - false - - Tier for each data-bearing server in the cluster. To learn more about cluster tiers, see https://dochub.mongodb.org/core/cluster-tier-atlas. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - # List available regions for a given cloud provider and tier: - atlas cluster availableRegions list --provider AWS --tier M50 - - -.. code-block:: - :copyable: false - - # List available regions by tier for a given provider: - atlas cluster availableRegions list --provider GCP diff --git a/docs/command/atlas-clusters-availableRegions.txt b/docs/command/atlas-clusters-availableRegions.txt deleted file mode 100644 index 56a43e7f4a..0000000000 --- a/docs/command/atlas-clusters-availableRegions.txt +++ /dev/null @@ -1,59 +0,0 @@ -.. _atlas-clusters-availableRegions: - -=============================== -atlas clusters availableRegions -=============================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage available regions for your project. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for availableRegions - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-clusters-availableRegions-list` - List available regions that Atlas supports for new deployments. - - -.. toctree:: - :titlesonly: - - list - diff --git a/docs/command/atlas-clusters-connectionStrings-describe.txt b/docs/command/atlas-clusters-connectionStrings-describe.txt deleted file mode 100644 index 92b25f762c..0000000000 --- a/docs/command/atlas-clusters-connectionStrings-describe.txt +++ /dev/null @@ -1,96 +0,0 @@ -.. _atlas-clusters-connectionStrings-describe: - -========================================= -atlas clusters connectionStrings describe -========================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return the SRV connection string for the cluster you specify. - -To use this command, you must authenticate with a user account or an API key with the Project Read Only role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas clusters connectionStrings describe [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - clusterName - - string - - true - - Name of the Atlas cluster for which you want to retrieve connection strings. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for describe - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --type - - string - - false - - Type of connection string. If you specify 'private', this option retrieves the connection string for the network peering endpoint. If you specify 'privateEndpoint', this option retrieves the shard optimized connection strings for the private endpoints. This value defaults to "standard". - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - # Return the JSON-formatted connection strings for the cluster named myCluster: - atlas clusters connectionStrings describe myCluster --output json diff --git a/docs/command/atlas-clusters-connectionStrings.txt b/docs/command/atlas-clusters-connectionStrings.txt deleted file mode 100644 index 0b206d8b56..0000000000 --- a/docs/command/atlas-clusters-connectionStrings.txt +++ /dev/null @@ -1,59 +0,0 @@ -.. _atlas-clusters-connectionStrings: - -================================ -atlas clusters connectionStrings -================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage MongoDB cluster connection string. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for connectionStrings - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-clusters-connectionStrings-describe` - Return the SRV connection string for the cluster you specify. - - -.. toctree:: - :titlesonly: - - describe - diff --git a/docs/command/atlas-clusters-create.txt b/docs/command/atlas-clusters-create.txt deleted file mode 100644 index 8058282bb3..0000000000 --- a/docs/command/atlas-clusters-create.txt +++ /dev/null @@ -1,222 +0,0 @@ -.. _atlas-clusters-create: - -===================== -atlas clusters create -===================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create a cluster for your project. - -To get started quickly, specify a name for your cluster, a cloud provider, and a region to deploy a three-member replica set with the latest MongoDB server version. -For full control of your deployment, or to create multi-cloud clusters, provide a JSON configuration file with the --file flag. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas clusters create [name] [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - name - - string - - false - - Name of the cluster. The cluster name cannot be changed after the cluster is created. Cluster name can contain ASCII letters, numbers, and hyphens. You must specify the cluster name argument if you don't use the --file option. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --backup - - - - false - - Flag that enables Continuous Cloud Backup for your deployment. This option is unavailable for clusters smaller than M10. - * - --biConnector - - - - false - - Flag that enables BI Connector for Atlas on the deployment. - - Mutually exclusive with --file. - * - --diskSizeGB - - float - - false - - Capacity, in gigabytes, of the host's root volume. - - Mutually exclusive with --file. This value defaults to 2. - * - --enableTerminationProtection - - - - false - - Enables termination protection for your cluster. You can't delete a cluster with termination protection enabled. - * - -f, --file - - string - - false - - Path to an optional JSON configuration file that defines cluster settings. To learn more about cluster configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/cluster-config-file-atlascli. - - Mutually exclusive with --tier, --provider, --members, --region, --diskSizeGB, --mdbVersion, --biConnector, --type, --shards, --tag. - * - -h, --help - - - - false - - help for create - * - --mdbVersion - - string - - false - - Major MongoDB version of the cluster. - - Mutually exclusive with --file. This value defaults to "8.0". - * - -m, --members - - int - - false - - Number of members in the replica set. - - Mutually exclusive with --file. This value defaults to 3. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --provider - - string - - false - - Name of your cloud service provider. Valid values are AWS, AZURE, or GCP. You must specify the provider option if you don't use the --file option. - - Mutually exclusive with --file. - * - -r, --region - - string - - false - - Physical location of your MongoDB cluster. You must specify the region option if you don't use the --file option. For a complete list of supported AWS regions, see: https://dochub.mongodb.org/core/aws-atlas. For a complete list of supported Azure regions, see: https://dochub.mongodb.org/core/azure-atlas. For a complete list of supported GCP regions, see: https://dochub.mongodb.org/core/gcp-atlas. - - Mutually exclusive with --file. - * - -s, --shards - - int - - false - - Number of shards in the cluster. - - Mutually exclusive with --file. This value defaults to 1. - * - --tag - - key=value - - false - - List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. - - Mutually exclusive with --file. - * - --tier - - string - - false - - Tier for each data-bearing server in the cluster. To learn more about cluster tiers, see https://dochub.mongodb.org/core/cluster-tier-atlas. - - Mutually exclusive with --file. This value defaults to "M2". - * - --type - - string - - false - - Type of the cluster that you want to create. Valid values are REPLICASET or SHARDED. - - Mutually exclusive with --file. This value defaults to "REPLICASET". - * - -w, --watch - - - - false - - Flag that indicates whether to watch the command until it completes its execution or the watch times out. To set the time that the watch times out, use the --watchTimeout option. - * - --watchTimeout - - int - - false - - Time in seconds until a watch times out. After a watch times out, the CLI no longer watches the command. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Cluster '' is being created. - - -Examples --------- - -.. code-block:: - :copyable: false - - # Deploy a free cluster named myCluster for the project with the ID 5e2211c17a3e5a48f5497de3: - atlas cluster create myCluster --projectId 5e2211c17a3e5a48f5497de3 --provider AWS --region US_EAST_1 --tier M0 - - -.. code-block:: - :copyable: false - - # Deploy a free cluster named myCluster for the project with the ID 5e2211c17a3e5a48f5497de3 and tag "env=dev": - atlas cluster create myCluster --projectId 5e2211c17a3e5a48f5497de3 --provider AWS --region US_EAST_1 --tier M0 --tag env=dev - - -.. code-block:: - :copyable: false - - # Deploy a three-member replica set named myRS in AWS for the project with the ID 5e2211c17a3e5a48f5497de3: - atlas cluster create myRS --projectId 5e2211c17a3e5a48f5497de3 --provider AWS --region US_EAST_1 --members 3 --tier M10 --mdbVersion 5.0 --diskSizeGB 10 - - -.. code-block:: - :copyable: false - - # Deploy a three-member replica set named myRS in AZURE for the project with the ID 5e2211c17a3e5a48f5497de3: - atlas cluster create myRS --projectId 5e2211c17a3e5a48f5497de3 --provider AZURE --region US_EAST_2 --members 3 --tier M10 --mdbVersion 5.0 --diskSizeGB 10 - - -.. code-block:: - :copyable: false - - # Deploy a three-member replica set named myRS in GCP for the project with the ID 5e2211c17a3e5a48f5497de3: - atlas cluster create myRS --projectId 5e2211c17a3e5a48f5497de3 --provider GCP --region EASTERN_US --members 3 --tier M10 --mdbVersion 5.0 --diskSizeGB 10 - - -.. code-block:: - :copyable: false - - # Deploy a cluster or a multi-cloud cluster from a JSON configuration file named myfile.json for the project with the ID 5e2211c17a3e5a48f5497de3: - atlas cluster create --projectId --file myfile.json diff --git a/docs/command/atlas-clusters-delete.txt b/docs/command/atlas-clusters-delete.txt deleted file mode 100644 index cf9404e96d..0000000000 --- a/docs/command/atlas-clusters-delete.txt +++ /dev/null @@ -1,120 +0,0 @@ -.. _atlas-clusters-delete: - -===================== -atlas clusters delete -===================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Remove the specified cluster from your project. - -The command prompts you to confirm the operation when you run the command without the --force option. - -Deleting a cluster also deletes any backup snapshots for that cluster. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas clusters delete [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - clusterName - - string - - true - - Name of the cluster to delete. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --force - - - - false - - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. - * - -h, --help - - - - false - - help for delete - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - -w, --watch - - - - false - - Flag that indicates whether to watch the command until it completes its execution or the watch times out. To set the time that the watch times out, use the --watchTimeout option. - * - --watchTimeout - - int - - false - - Time in seconds until a watch times out. After a watch times out, the CLI no longer watches the command. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Deleting cluster '' - -Examples --------- - -.. code-block:: - :copyable: false - - # Remove a cluster named myCluster after prompting for a confirmation: - atlas clusters delete myCluster - - -.. code-block:: - :copyable: false - - # Remove a cluster named myCluster without requiring confirmation: - atlas clusters delete myCluster --force diff --git a/docs/command/atlas-clusters-describe.txt b/docs/command/atlas-clusters-describe.txt deleted file mode 100644 index 859d243f87..0000000000 --- a/docs/command/atlas-clusters-describe.txt +++ /dev/null @@ -1,103 +0,0 @@ -.. _atlas-clusters-describe: - -======================= -atlas clusters describe -======================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return the details for the specified cluster for your project. - -To use this command, you must authenticate with a user account or an API key with the Project Read Only role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas clusters describe [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - clusterName - - string - - true - - Name of the cluster to retrieve. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for describe - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - ID NAME MDB VER STATE - - - -Examples --------- - -.. code-block:: - :copyable: false - - # Return the JSON-formatted details for the cluster named myCluster: - atlas clusters describe myCluster --output json diff --git a/docs/command/atlas-clusters-failover.txt b/docs/command/atlas-clusters-failover.txt deleted file mode 100644 index 8d96a5dee8..0000000000 --- a/docs/command/atlas-clusters-failover.txt +++ /dev/null @@ -1,102 +0,0 @@ -.. _atlas-clusters-failover: - -======================= -atlas clusters failover -======================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Starts a failover test for the specified cluster in the specified project. - -Clusters contain a group of hosts that maintain the same data set. A failover test checks how MongoDB Cloud handles the failure of the cluster's primary node. During the test, MongoDB Cloud shuts down the primary node and elects a new primary. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas clusters failover [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - clusterName - - string - - true - - Human-readable label that identifies the cluster to start a failover test for. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --force - - - - false - - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. - * - -h, --help - - - - false - - help for failover - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Failover test for '' started - - -Examples --------- - -.. code-block:: - :copyable: false - - # Test failover for a cluster named myCluster: - atlas clusters failover myCluster diff --git a/docs/command/atlas-clusters-indexes-create.txt b/docs/command/atlas-clusters-indexes-create.txt deleted file mode 100644 index a5316b9fc1..0000000000 --- a/docs/command/atlas-clusters-indexes-create.txt +++ /dev/null @@ -1,135 +0,0 @@ -.. _atlas-clusters-indexes-create: - -============================= -atlas clusters indexes create -============================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create a rolling index for the specified cluster for your project. - -To use this command, you must authenticate with a user account or an API key with the Project Data Access Admin role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas clusters indexes create [indexName] [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - indexName - - string - - false - - Name of the index. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --clusterName - - string - - true - - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. - * - --collection - - string - - false - - Name of the collection. - - Mutually exclusive with --file. - * - --db - - string - - false - - Name of the database. - - Mutually exclusive with --file. - * - -f, --file - - string - - false - - Path to an optional JSON configuration file that defines index settings. - - Mutually exclusive with --db, --collection, --key. - * - -h, --help - - - - false - - help for create - * - --key - - strings - - false - - Field to be indexed and the type of index in the following format: field:type. - - Mutually exclusive with --file. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --sparse - - - - false - - Flag that creates a sparse index. To learn more, see https://dochub.mongodb.org/core/index-sparse-manual. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - # Create an index named bedrooms_1 on the listings collection of the realestate database: - atlas clusters indexes create bedrooms_1 --clusterName Cluster0 --collection listings --db realestate --key bedrooms:1 - - -.. code-block:: - :copyable: false - - # Create a compound index named property_room_bedrooms on the - listings collection of the realestate database: - atlas clusters indexes create property_room_bedrooms --clusterName Cluster0 --collection listings --db realestate --key property_type:1 --key room_type:1 --key bedrooms:1 - - -.. code-block:: - :copyable: false - - # Create an index named my_index from a JSON configuration file named myfile.json: - atlas clusters indexes create my_index --clusterName Cluster0 --file file.json diff --git a/docs/command/atlas-clusters-indexes.txt b/docs/command/atlas-clusters-indexes.txt deleted file mode 100644 index 2fb07225f6..0000000000 --- a/docs/command/atlas-clusters-indexes.txt +++ /dev/null @@ -1,59 +0,0 @@ -.. _atlas-clusters-indexes: - -====================== -atlas clusters indexes -====================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage cluster rolling indexes for your project. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for indexes - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-clusters-indexes-create` - Create a rolling index for the specified cluster for your project. - - -.. toctree:: - :titlesonly: - - create - diff --git a/docs/command/atlas-clusters-list.txt b/docs/command/atlas-clusters-list.txt deleted file mode 100644 index 4c6815e5b5..0000000000 --- a/docs/command/atlas-clusters-list.txt +++ /dev/null @@ -1,103 +0,0 @@ -.. _atlas-clusters-list: - -=================== -atlas clusters list -=================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return all clusters for your project. - -To use this command, you must authenticate with a user account or an API key with the Project Read Only role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas clusters list [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for list - * - --limit - - int - - false - - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. - * - --omitCount - - - - false - - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --page - - int - - false - - Page number that specifies a page of results. This value defaults to 1. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --tier - - string - - false - - Tier for each data-bearing server in the cluster. To learn more about cluster tiers, see https://dochub.mongodb.org/core/cluster-tier-atlas. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - ID NAME MDB VER STATE - - - -Examples --------- - -.. code-block:: - :copyable: false - - # Return a JSON-formatted list of all clusters for the project with ID 5e2211c17a3e5a48f5497de3: - atlas clusters list --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-clusters-onlineArchives-create.txt b/docs/command/atlas-clusters-onlineArchives-create.txt deleted file mode 100644 index 02f59d6052..0000000000 --- a/docs/command/atlas-clusters-onlineArchives-create.txt +++ /dev/null @@ -1,139 +0,0 @@ -.. _atlas-clusters-onlineArchives-create: - -==================================== -atlas clusters onlineArchives create -==================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create an online archive for a collection in the specified cluster. - -You can create an online archive for an M10 or larger cluster. - -To learn more about online archives, see https://www.mongodb.com/docs/atlas/online-archive/manage-online-archive/. - -To use this command, you must authenticate with a user account or an API key with the Project Data Access Admin role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas clusters onlineArchives create [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --archiveAfter - - int - - false - - Number of days after which to archive cluster data. - - Mutually exclusive with --file. - * - --clusterName - - string - - true - - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. - * - --collection - - string - - false - - Name of the collection. - - Mutually exclusive with --file. - * - --dateField - - string - - false - - Name of an already indexed date field from the documents. - - Mutually exclusive with --file. - * - --dateFormat - - string - - false - - Date format for the date field. Valid values are "ISODATE", "EPOCH_SECONDS", "EPOCH_MILLIS", or "EPOCH_NANOSECONDS". - - Mutually exclusive with --file. This value defaults to "ISODATE". - * - --db - - string - - false - - Name of the database. - - Mutually exclusive with --file. - * - --expireAfterDays - - int - - false - - Number of days used in the date criteria for nominating documents for deletion. - - Mutually exclusive with --file. - * - --file - - string - - false - - Path to an optional JSON configuration file that defines online archive settings. To learn more about online archive configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-json-online-archive-config. - - Mutually exclusive with --db, --collection, --dateField, --dateFormat, --archiveAfter, --expireAfterDays, --partition. - * - -h, --help - - - - false - - help for create - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --partition - - strings - - false - - Fields to use to partition data. You can specify up to two frequently queried fields separated by a comma. - - Mutually exclusive with --file. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - # Create an online archive for the sample_mflix.movies collection in a cluster named myTestCluster when the current date is greater than the value of released date plus 2 days: - atlas clusters onlineArchive create --clusterName myTestCluster --db sample_mflix --collection movies --dateField released --archiveAfter 2 --output json - - -.. code-block:: - :copyable: false - - # Create an online archive for the sample_mflix.movies collection in a cluster named myTestCluster using a profile named egAtlasProfile when the current date is greater than the value of the released date plus 2 days. Data is partitioned based on the title field, year field, and released field from the documents in the collection: - atlas clusters onlineArchive create --clusterName myTestCluster --db sample_mflix --collection movies --dateField released --archiveAfter 2 --partition title,year --output json -P egAtlasProfile diff --git a/docs/command/atlas-clusters-onlineArchives-delete.txt b/docs/command/atlas-clusters-onlineArchives-delete.txt deleted file mode 100644 index 1565262de1..0000000000 --- a/docs/command/atlas-clusters-onlineArchives-delete.txt +++ /dev/null @@ -1,106 +0,0 @@ -.. _atlas-clusters-onlineArchives-delete: - -==================================== -atlas clusters onlineArchives delete -==================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Remove the specified online archive from your cluster. - -To use this command, you must authenticate with a user account or an API key with the Project Data Access Admin role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas clusters onlineArchives delete [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - archiveId - - string - - true - - Unique identifier of the online archive to delete. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --clusterName - - string - - true - - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. - * - --force - - - - false - - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. - * - -h, --help - - - - false - - help for delete - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Archive '' deleted - - -Examples --------- - -.. code-block:: - :copyable: false - - # Remove an online archive with the ID 5f189832e26ec075e10c32d3 for the cluster named myCluster: - atlas clusters onlineArchives delete 5f189832e26ec075e10c32d3 --clusterName myCluster diff --git a/docs/command/atlas-clusters-onlineArchives-describe.txt b/docs/command/atlas-clusters-onlineArchives-describe.txt deleted file mode 100644 index 61d98b1ab0..0000000000 --- a/docs/command/atlas-clusters-onlineArchives-describe.txt +++ /dev/null @@ -1,107 +0,0 @@ -.. _atlas-clusters-onlineArchives-describe: - -====================================== -atlas clusters onlineArchives describe -====================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return the details for the specified online archive for your cluster. - -To use this command, you must authenticate with a user account or an API key with the Project Read Only role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas clusters onlineArchives describe [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - archiveId - - string - - true - - Unique identifier of the online archive to retrieve. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --clusterName - - string - - true - - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. - * - -h, --help - - - - false - - help for describe - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - ID CLUSTER DATABASE COLLECTION STATE - - - -Examples --------- - -.. code-block:: - :copyable: false - - # Return the JSON-formatted details for the online archive with the ID 5f189832e26ec075e10c32d3 for the cluster named myCluster: - atlas clusters onlineArchives describe 5f189832e26ec075e10c32d3 --clusterName myCluster --output json diff --git a/docs/command/atlas-clusters-onlineArchives-list.txt b/docs/command/atlas-clusters-onlineArchives-list.txt deleted file mode 100644 index 31303c36d0..0000000000 --- a/docs/command/atlas-clusters-onlineArchives-list.txt +++ /dev/null @@ -1,103 +0,0 @@ -.. _atlas-clusters-onlineArchives-list: - -================================== -atlas clusters onlineArchives list -================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return all online archives for your cluster. - -To use this command, you must authenticate with a user account or an API key with the Project Read Only role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas clusters onlineArchives list [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --clusterName - - string - - true - - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. - * - -h, --help - - - - false - - help for list - * - --limit - - int - - false - - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. - * - --omitCount - - - - false - - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --page - - int - - false - - Page number that specifies a page of results. This value defaults to 1. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - ID DATABASE COLLECTION STATE - - - -Examples --------- - -.. code-block:: - :copyable: false - - # Return a JSON-formatted list of online archives for the cluster named myCluster: - atlas clusters onlineArchives list --clusterName myCluster --output json diff --git a/docs/command/atlas-clusters-onlineArchives-pause.txt b/docs/command/atlas-clusters-onlineArchives-pause.txt deleted file mode 100644 index 996bf97623..0000000000 --- a/docs/command/atlas-clusters-onlineArchives-pause.txt +++ /dev/null @@ -1,106 +0,0 @@ -.. _atlas-clusters-onlineArchives-pause: - -=================================== -atlas clusters onlineArchives pause -=================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Pause the specfied online archive for your cluster. - -To use this command, you must authenticate with a user account or an API key with the Project Data Access Admin role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas clusters onlineArchives pause [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - archiveId - - string - - true - - Unique identifier of the online archive to pause. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --clusterName - - string - - true - - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. - * - -h, --help - - - - false - - help for pause - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Online archive '' paused. - - -Examples --------- - -.. code-block:: - :copyable: false - - # Pause the online archive with the ID 5f189832e26ec075e10c32d3 for the cluster named myCluster: - atlas clusters onlineArchives pause 5f189832e26ec075e10c32d3 --clusterName myCluster --output json diff --git a/docs/command/atlas-clusters-onlineArchives-start.txt b/docs/command/atlas-clusters-onlineArchives-start.txt deleted file mode 100644 index 9b9f22efdd..0000000000 --- a/docs/command/atlas-clusters-onlineArchives-start.txt +++ /dev/null @@ -1,98 +0,0 @@ -.. _atlas-clusters-onlineArchives-start: - -=================================== -atlas clusters onlineArchives start -=================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Start a paused online archive from a cluster. - -To use this command, you must authenticate with a user account or an API key with the Project Data Access Admin role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas clusters onlineArchives start [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - archiveId - - string - - true - - Unique identifier of the online archive to start. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --clusterName - - string - - true - - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. - * - -h, --help - - - - false - - help for start - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Online archive '' started. - - diff --git a/docs/command/atlas-clusters-onlineArchives-update.txt b/docs/command/atlas-clusters-onlineArchives-update.txt deleted file mode 100644 index 964cf5e365..0000000000 --- a/docs/command/atlas-clusters-onlineArchives-update.txt +++ /dev/null @@ -1,124 +0,0 @@ -.. _atlas-clusters-onlineArchives-update: - -==================================== -atlas clusters onlineArchives update -==================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Modify the archiving rule for the specified online archive for a cluster. - -To use this command, you must authenticate with a user account or an API key with the Project Data Access Admin role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas clusters onlineArchives update [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - archiveId - - string - - true - - Unique identifier of the online archive to update. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --archiveAfter - - int - - false - - Number of days after which to archive cluster data. - - Mutually exclusive with --file. - * - --clusterName - - string - - true - - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. - * - --expireAfterDays - - int - - false - - Number of days used in the date criteria for nominating documents for deletion. - - Mutually exclusive with --file. - * - --file - - string - - false - - Path to an optional JSON configuration file that defines online archive settings. To learn more about online archive configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-json-online-archive-config. - - Mutually exclusive with --archiveAfter, --expireAfterDays. - * - -h, --help - - - - false - - help for update - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Online archive '' updated. - - -Examples --------- - -.. code-block:: - :copyable: false - - # Update the archiving rule to archive after 5 days for the online archive with the ID 5f189832e26ec075e10c32d3 for the cluster named myCluster: - atlas clusters onlineArchives update 5f189832e26ec075e10c32d3 --clusterName --archiveAfter 5 myCluster --output json diff --git a/docs/command/atlas-clusters-onlineArchives-watch.txt b/docs/command/atlas-clusters-onlineArchives-watch.txt deleted file mode 100644 index dd7d016207..0000000000 --- a/docs/command/atlas-clusters-onlineArchives-watch.txt +++ /dev/null @@ -1,107 +0,0 @@ -.. _atlas-clusters-onlineArchives-watch: - -=================================== -atlas clusters onlineArchives watch -=================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Watch for an archive to be available. - -This command checks the archive's status periodically until it reaches a state different from PENDING or PAUSING. -Once the archive reaches the expected status, the command prints "Online archive available." -If you run the command in the terminal, it blocks the terminal session until the resource status changes to the expected status. -You can interrupt the command's polling at any time with CTRL-C. - -To use this command, you must authenticate with a user account or an API key with the Project Read Only role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas clusters onlineArchives watch [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - archiveId - - string - - true - - Unique identifier of the online archive to watch. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --clusterName - - string - - false - - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. - * - -h, --help - - - - false - - help for watch - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - - Online archive available. - - -Examples --------- - -.. code-block:: - :copyable: false - - atlas cluster onlineArchive watch archiveIdSample --clusterName clusterNameSample diff --git a/docs/command/atlas-clusters-onlineArchives.txt b/docs/command/atlas-clusters-onlineArchives.txt deleted file mode 100644 index b689acf59a..0000000000 --- a/docs/command/atlas-clusters-onlineArchives.txt +++ /dev/null @@ -1,73 +0,0 @@ -.. _atlas-clusters-onlineArchives: - -============================= -atlas clusters onlineArchives -============================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage online archives for your cluster. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for onlineArchives - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-clusters-onlineArchives-create` - Create an online archive for a collection in the specified cluster. -* :ref:`atlas-clusters-onlineArchives-delete` - Remove the specified online archive from your cluster. -* :ref:`atlas-clusters-onlineArchives-describe` - Return the details for the specified online archive for your cluster. -* :ref:`atlas-clusters-onlineArchives-list` - Return all online archives for your cluster. -* :ref:`atlas-clusters-onlineArchives-pause` - Pause the specfied online archive for your cluster. -* :ref:`atlas-clusters-onlineArchives-start` - Start a paused online archive from a cluster. -* :ref:`atlas-clusters-onlineArchives-update` - Modify the archiving rule for the specified online archive for a cluster. -* :ref:`atlas-clusters-onlineArchives-watch` - Watch for an archive to be available. - - -.. toctree:: - :titlesonly: - - create - delete - describe - list - pause - start - update - watch - diff --git a/docs/command/atlas-clusters-pause.txt b/docs/command/atlas-clusters-pause.txt deleted file mode 100644 index 6f369603dc..0000000000 --- a/docs/command/atlas-clusters-pause.txt +++ /dev/null @@ -1,103 +0,0 @@ -.. _atlas-clusters-pause: - -==================== -atlas clusters pause -==================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Pause the specified running MongoDB cluster. - -To use this command, you must authenticate with a user account or an API key with the Project Cluster Manager role. -Atlas supports this command only for M10+ clusters. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas clusters pause [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - clusterName - - string - - true - - Name of the cluster to pause. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for pause - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Pausing cluster ''. - - -Examples --------- - -.. code-block:: - :copyable: false - - # Pause the cluster named myCluster for the project with ID 5e2211c17a3e5a48f5497de3: - atlas clusters pause myCluster --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-clusters-sampleData-describe.txt b/docs/command/atlas-clusters-sampleData-describe.txt deleted file mode 100644 index 4582679f53..0000000000 --- a/docs/command/atlas-clusters-sampleData-describe.txt +++ /dev/null @@ -1,103 +0,0 @@ -.. _atlas-clusters-sampleData-describe: - -================================== -atlas clusters sampleData describe -================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return the details for the specified sample data load job. - -To use this command, you must authenticate with a user account or an API key with the Project Read Only role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas clusters sampleData describe [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - id - - string - - true - - Unique identifier of the sample data job. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for describe - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - ID CLUSTER NAME STATE - - - -Examples --------- - -.. code-block:: - :copyable: false - - # Return the JSON-formatted details for the sample data load job: - atlas clusters sampleData describe 5e98249d937cfc52efdc2a9f --output json diff --git a/docs/command/atlas-clusters-sampleData-load.txt b/docs/command/atlas-clusters-sampleData-load.txt deleted file mode 100644 index 89f96848c5..0000000000 --- a/docs/command/atlas-clusters-sampleData-load.txt +++ /dev/null @@ -1,102 +0,0 @@ -.. _atlas-clusters-sampleData-load: - -============================== -atlas clusters sampleData load -============================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Load sample data into the specified cluster for your project. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas clusters sampleData load [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - clusterName - - string - - true - - Name of the cluster for which you want to load sample data. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for load - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Sample Data Job created. - - -Examples --------- - -.. code-block:: - :copyable: false - - # Load sample data into the cluster named myCluster: - atlas clusters sampleData load myCluster --output json diff --git a/docs/command/atlas-clusters-sampleData-watch.txt b/docs/command/atlas-clusters-sampleData-watch.txt deleted file mode 100644 index 6999b01897..0000000000 --- a/docs/command/atlas-clusters-sampleData-watch.txt +++ /dev/null @@ -1,103 +0,0 @@ -.. _atlas-clusters-sampleData-watch: - -=============================== -atlas clusters sampleData watch -=============================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Watch the specified sample data job in your cluster until it completes. - -This command checks the sample data job's status periodically until it reaches an COMPLETED state. -If you run the command in the terminal, it blocks the terminal session until the resource state changes to COMPLETED. -You can interrupt the command's polling at any time with CTRL-C. - -To use this command, you must authenticate with a user account or an API key with the Project Read Only role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas clusters sampleData watch [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - id - - string - - true - - Unique identifier of the sample data job. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for watch - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - - Sample data available. - - -Examples --------- - -.. code-block:: - :copyable: false - - # Watch for the sample data job with ID 5e2211c17a3e5a48f5497de3 to complete: - atlas clusters sampledata watch 5e2211c17a3e5a48f5497de3 diff --git a/docs/command/atlas-clusters-sampleData.txt b/docs/command/atlas-clusters-sampleData.txt deleted file mode 100644 index 60fb597813..0000000000 --- a/docs/command/atlas-clusters-sampleData.txt +++ /dev/null @@ -1,65 +0,0 @@ -.. _atlas-clusters-sampleData: - -========================= -atlas clusters sampleData -========================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage sample data for your cluster. - -The sampleData command provides access to sample data to be loaded onto your cluster. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for sampleData - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-clusters-sampleData-describe` - Return the details for the specified sample data load job. -* :ref:`atlas-clusters-sampleData-load` - Load sample data into the specified cluster for your project. -* :ref:`atlas-clusters-sampleData-watch` - Watch the specified sample data job in your cluster until it completes. - - -.. toctree:: - :titlesonly: - - describe - load - watch - diff --git a/docs/command/atlas-clusters-search-indexes-create.txt b/docs/command/atlas-clusters-search-indexes-create.txt deleted file mode 100644 index 798abf7b66..0000000000 --- a/docs/command/atlas-clusters-search-indexes-create.txt +++ /dev/null @@ -1,110 +0,0 @@ -.. _atlas-clusters-search-indexes-create: - -==================================== -atlas clusters search indexes create -==================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create a search index for a cluster. - -To use this command, you must authenticate with a user account or an API key with the Project Data Access Admin role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas clusters search indexes create [indexName] [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - indexName - - string - - false - - Name of the index. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --clusterName - - string - - true - - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. - * - -f, --file - - string - - false - - Name of the JSON index configuration file to use. To learn about the Atlas Search and Atlas Vector Search index configuration file, see https://dochub.mongodb.org/core/search-index-config-file-atlascli. To learn about the Atlas Search index syntax and options that you can define in your configuration file, see https://dochub.mongodb.org/core/index-definitions-fts. To learn about the Atlas Vector Search index syntax and options that you can define in your configuration file, see https://dochub.mongodb.org/core/index-definition-avs. - * - -h, --help - - - - false - - help for create - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Index created. - - -Examples --------- - -.. code-block:: - :copyable: false - - # Create a search index for the cluster named myCluster using a JSON index configuration file named search-config.json: - atlas clusters search indexes create --clusterName myCluster --file search-config.json --output json diff --git a/docs/command/atlas-clusters-search-indexes-delete.txt b/docs/command/atlas-clusters-search-indexes-delete.txt deleted file mode 100644 index 7541ce1050..0000000000 --- a/docs/command/atlas-clusters-search-indexes-delete.txt +++ /dev/null @@ -1,106 +0,0 @@ -.. _atlas-clusters-search-indexes-delete: - -==================================== -atlas clusters search indexes delete -==================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Delete the specified search index from the specified cluster. - -To use this command, you must authenticate with a user account or an API key with the Project Data Access Admin role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas clusters search indexes delete [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - indexId - - string - - true - - ID of the index. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --clusterName - - string - - true - - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. - * - --force - - - - false - - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. - * - -h, --help - - - - false - - help for delete - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Index '' deleted - - -Examples --------- - -.. code-block:: - :copyable: false - - # Delete the search index with the ID 5f2099cd683fc55fbb30bef6 for the cluster named myCluster without requiring confirmation: - atlas clusters search indexes delete 5f2099cd683fc55fbb30bef6 --clusterName myCluster --force diff --git a/docs/command/atlas-clusters-search-indexes-describe.txt b/docs/command/atlas-clusters-search-indexes-describe.txt deleted file mode 100644 index eef63fa825..0000000000 --- a/docs/command/atlas-clusters-search-indexes-describe.txt +++ /dev/null @@ -1,107 +0,0 @@ -.. _atlas-clusters-search-indexes-describe: - -====================================== -atlas clusters search indexes describe -====================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return the details for the search index for a cluster. - -To use this command, you must authenticate with a user account or an API key with the Project Data Access Read/Write role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas clusters search indexes describe [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - indexId - - string - - true - - ID of the index. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --clusterName - - string - - true - - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. - * - -h, --help - - - - false - - help for describe - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - ID NAME DATABASE COLLECTION TYPE - - - -Examples --------- - -.. code-block:: - :copyable: false - - # Return the JSON-formatted details for the search index with the ID 5f1f40842f2ac35f49190c20 for the cluster named myCluster: - atlas clusters search indexes describe 5f1f40842f2ac35f49190c20 --clusterName myCluster --output json diff --git a/docs/command/atlas-clusters-search-indexes-list.txt b/docs/command/atlas-clusters-search-indexes-list.txt deleted file mode 100644 index e17eb4d23a..0000000000 --- a/docs/command/atlas-clusters-search-indexes-list.txt +++ /dev/null @@ -1,99 +0,0 @@ -.. _atlas-clusters-search-indexes-list: - -================================== -atlas clusters search indexes list -================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -List all Atlas Search indexes for a cluster. - -To use this command, you must authenticate with a user account or an API key with the Project Data Access Read/Write role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas clusters search indexes list [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --clusterName - - string - - true - - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. - * - --collection - - string - - true - - Name of the collection. - * - --db - - string - - true - - Name of the database. - * - -h, --help - - - - false - - help for list - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - ID NAME DATABASE COLLECTION TYPE - - - -Examples --------- - -.. code-block:: - :copyable: false - - # Return the JSON-formatted list of Atlas search indexes on the sample_mflix.movies database in the cluster named myCluster: - atlas clusters search indexes list --clusterName myCluster --db sample_mflix --collection movies --output json diff --git a/docs/command/atlas-clusters-search-indexes-update.txt b/docs/command/atlas-clusters-search-indexes-update.txt deleted file mode 100644 index 87c5a17dd3..0000000000 --- a/docs/command/atlas-clusters-search-indexes-update.txt +++ /dev/null @@ -1,110 +0,0 @@ -.. _atlas-clusters-search-indexes-update: - -==================================== -atlas clusters search indexes update -==================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Modify a search index for a cluster. - -To use this command, you must authenticate with a user account or an API key with the Project Data Access Admin role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas clusters search indexes update [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - indexId - - string - - true - - ID of the index. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --clusterName - - string - - true - - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. - * - -f, --file - - string - - false - - Name of the JSON index configuration file to use. To learn about the Atlas Search and Atlas Vector Search index configuration file, see https://dochub.mongodb.org/core/search-index-config-file-atlascli. To learn about the Atlas Search index syntax and options that you can define in your configuration file, see https://dochub.mongodb.org/core/index-definitions-fts. To learn about the Atlas Vector Search index syntax and options that you can define in your configuration file, see https://dochub.mongodb.org/core/index-definition-avs. - * - -h, --help - - - - false - - help for update - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Index updated. - - -Examples --------- - -.. code-block:: - :copyable: false - - # Modify the search index with the ID 5f2099cd683fc55fbb30bef6 for the cluster named myCluster: - atlas clusters search indexes update 5f2099cd683fc55fbb30bef6 --clusterName myCluster --output json diff --git a/docs/command/atlas-clusters-search-indexes.txt b/docs/command/atlas-clusters-search-indexes.txt deleted file mode 100644 index 160e679678..0000000000 --- a/docs/command/atlas-clusters-search-indexes.txt +++ /dev/null @@ -1,67 +0,0 @@ -.. _atlas-clusters-search-indexes: - -============================= -atlas clusters search indexes -============================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage Atlas Search indexes for your cluster. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for indexes - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-clusters-search-indexes-create` - Create a search index for a cluster. -* :ref:`atlas-clusters-search-indexes-delete` - Delete the specified search index from the specified cluster. -* :ref:`atlas-clusters-search-indexes-describe` - Return the details for the search index for a cluster. -* :ref:`atlas-clusters-search-indexes-list` - List all Atlas Search indexes for a cluster. -* :ref:`atlas-clusters-search-indexes-update` - Modify a search index for a cluster. - - -.. toctree:: - :titlesonly: - - create - delete - describe - list - update - diff --git a/docs/command/atlas-clusters-search-nodes-create.txt b/docs/command/atlas-clusters-search-nodes-create.txt deleted file mode 100644 index b60cc0fa92..0000000000 --- a/docs/command/atlas-clusters-search-nodes-create.txt +++ /dev/null @@ -1,102 +0,0 @@ -.. _atlas-clusters-search-nodes-create: - -================================== -atlas clusters search nodes create -================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create a search node for a cluster. - -To use this command, you must authenticate with a user account or an API key with the Organization Owner or Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas clusters search nodes create [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --clusterName - - string - - true - - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. - * - -f, --file - - string - - true - - Name of the JSON index configuration file to use. To learn about the Atlas Search Nodes configuration file, see https://dochub.mongodb.org/core/search-nodes-config-file-atlascli. - * - -h, --help - - - - false - - help for create - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - -w, --watch - - - - false - - Flag that indicates whether to watch the command until it completes its execution or the watch times out. - * - --watchTimeout - - int - - false - - Time in seconds until a watch times out. After a watch times out, the CLI no longer watches the command. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Search nodes are being created. - - -Examples --------- - -.. code-block:: - :copyable: false - - # Create a search node for the cluster named myCluster using a JSON node spec configuration file named spec.json: - atlas clusters search nodes create --clusterName myCluster --file spec.json --output json diff --git a/docs/command/atlas-clusters-search-nodes-delete.txt b/docs/command/atlas-clusters-search-nodes-delete.txt deleted file mode 100644 index fff9832631..0000000000 --- a/docs/command/atlas-clusters-search-nodes-delete.txt +++ /dev/null @@ -1,92 +0,0 @@ -.. _atlas-clusters-search-nodes-delete: - -================================== -atlas clusters search nodes delete -================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Delete a search node for a cluster. - -To use this command, you must authenticate with a user account or an API key with the Organization Owner or Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas clusters search nodes delete [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --clusterName - - string - - true - - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. - * - --force - - - - false - - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. - * - -h, --help - - - - false - - help for delete - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - -w, --watch - - - - false - - Flag that indicates whether to watch the command until it completes its execution or the watch times out. - * - --watchTimeout - - int - - false - - Time in seconds until a watch times out. After a watch times out, the CLI no longer watches the command. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - # Delete a search node for the cluster named myCluster: - atlas clusters search nodes delete --clusterName myCluster diff --git a/docs/command/atlas-clusters-search-nodes-list.txt b/docs/command/atlas-clusters-search-nodes-list.txt deleted file mode 100644 index c0d3460121..0000000000 --- a/docs/command/atlas-clusters-search-nodes-list.txt +++ /dev/null @@ -1,91 +0,0 @@ -.. _atlas-clusters-search-nodes-list: - -================================ -atlas clusters search nodes list -================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -List all Atlas Search nodes for a cluster. - -To use this command, you must authenticate with a user account or an API key with the Project Read Only role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas clusters search nodes list [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --clusterName - - string - - true - - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. - * - -h, --help - - - - false - - help for list - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - ID STATE INSTANCE SIZE NODE COUNT{{ $id:=.Id>{{ $state:=.StateName > - {{$id> {{$state> - - -Examples --------- - -.. code-block:: - :copyable: false - - # Return the JSON-formatted list of Atlas search nodes in the cluster named myCluster: - atlas clusters search nodes list --clusterName myCluster --output json diff --git a/docs/command/atlas-clusters-search-nodes-update.txt b/docs/command/atlas-clusters-search-nodes-update.txt deleted file mode 100644 index bab41d6284..0000000000 --- a/docs/command/atlas-clusters-search-nodes-update.txt +++ /dev/null @@ -1,102 +0,0 @@ -.. _atlas-clusters-search-nodes-update: - -================================== -atlas clusters search nodes update -================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Update a search node for a cluster. - -To use this command, you must authenticate with a user account or an API key with the Organization Owner or Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas clusters search nodes update [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --clusterName - - string - - true - - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. - * - -f, --file - - string - - true - - Name of the JSON index configuration file to use. To learn about the Atlas Search Nodes configuration file, see https://dochub.mongodb.org/core/search-nodes-config-file-atlascli. - * - -h, --help - - - - false - - help for update - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - -w, --watch - - - - false - - Flag that indicates whether to watch the command until it completes its execution or the watch times out. - * - --watchTimeout - - int - - false - - Time in seconds until a watch times out. After a watch times out, the CLI no longer watches the command. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Started updating search nodes. - - -Examples --------- - -.. code-block:: - :copyable: false - - # Update a search node for the cluster named myCluster using a JSON node spec configuration file named spec.json: - atlas clusters search nodes update --clusterName myCluster --file spec.json --output json diff --git a/docs/command/atlas-clusters-search-nodes.txt b/docs/command/atlas-clusters-search-nodes.txt deleted file mode 100644 index 958a089711..0000000000 --- a/docs/command/atlas-clusters-search-nodes.txt +++ /dev/null @@ -1,65 +0,0 @@ -.. _atlas-clusters-search-nodes: - -=========================== -atlas clusters search nodes -=========================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage Atlas Search nodes for your cluster. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for nodes - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-clusters-search-nodes-create` - Create a search node for a cluster. -* :ref:`atlas-clusters-search-nodes-delete` - Delete a search node for a cluster. -* :ref:`atlas-clusters-search-nodes-list` - List all Atlas Search nodes for a cluster. -* :ref:`atlas-clusters-search-nodes-update` - Update a search node for a cluster. - - -.. toctree:: - :titlesonly: - - create - delete - list - update - diff --git a/docs/command/atlas-clusters-search.txt b/docs/command/atlas-clusters-search.txt deleted file mode 100644 index d8ffd2b0ba..0000000000 --- a/docs/command/atlas-clusters-search.txt +++ /dev/null @@ -1,61 +0,0 @@ -.. _atlas-clusters-search: - -===================== -atlas clusters search -===================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage Atlas Search for your cluster. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for search - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-clusters-search-indexes` - Manage Atlas Search indexes for your cluster. -* :ref:`atlas-clusters-search-nodes` - Manage Atlas Search nodes for your cluster. - - -.. toctree:: - :titlesonly: - - indexes - nodes - diff --git a/docs/command/atlas-clusters-start.txt b/docs/command/atlas-clusters-start.txt deleted file mode 100644 index 943c8f079f..0000000000 --- a/docs/command/atlas-clusters-start.txt +++ /dev/null @@ -1,103 +0,0 @@ -.. _atlas-clusters-start: - -==================== -atlas clusters start -==================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Start the specified paused MongoDB cluster. - -To use this command, you must authenticate with a user account or an API key with the Project Cluster Manager role. -Atlas supports this command only for M10+ clusters. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas clusters start [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - clusterName - - string - - true - - Name of the cluster to start. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for start - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Starting cluster ''. - - -Examples --------- - -.. code-block:: - :copyable: false - - # Start a cluster named myCluster for the project with ID 5e2211c17a3e5a48f5497de3: - atlas clusters start myCluster --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-clusters-update.txt b/docs/command/atlas-clusters-update.txt deleted file mode 100644 index 858079e5a8..0000000000 --- a/docs/command/atlas-clusters-update.txt +++ /dev/null @@ -1,184 +0,0 @@ -.. _atlas-clusters-update: - -===================== -atlas clusters update -===================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Modify the settings of the specified cluster. - -You can specify modifications in a JSON configuration file with the --file flag. - -You can't change the name of the cluster or downgrade the MongoDB version of your cluster. - -You can only update a replica set to a single-shard cluster; you cannot update a replica set to a multi-sharded cluster. To learn more, see https://www.mongodb.com/docs/atlas/scale-cluster/#convert-a-replica-set-to-a-sharded-cluster and https://www.mongodb.com/docs/upcoming/tutorial/convert-replica-set-to-replicated-shard-cluster. - -To use this command, you must authenticate with a user account or an API key with the Project Cluster Manager role. -Atlas supports this command only for M10+ clusters - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas clusters update [clusterName] [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - clusterName - - string - - false - - Name of the cluster to update. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --disableTerminationProtection - - - - false - - Disables termination protection for your cluster. You can delete a cluster with termination protection disabled. - - Mutually exclusive with --enableTerminationProtection, --file. - * - --diskSizeGB - - float - - false - - Capacity, in gigabytes, of the host's root volume. - - Mutually exclusive with --file. - * - --enableTerminationProtection - - - - false - - Enables termination protection for your cluster. You can't delete a cluster with termination protection enabled. - - Mutually exclusive with --disableTerminationProtection, --file. - * - -f, --file - - string - - false - - Path to an optional JSON configuration file that defines cluster settings. To learn more about cluster configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/cluster-config-file-atlascli. - - Mutually exclusive with --tier, --diskSizeGB, --enableTerminationProtection, --disableTerminationProtection, --tag. - * - -h, --help - - - - false - - help for update - * - --mdbVersion - - string - - false - - Major MongoDB version of the cluster. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --tag - - key=value - - false - - List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. Passing this flag replaces preexisting data. - - Mutually exclusive with --file. - * - --tier - - string - - false - - Tier for each data-bearing server in the cluster. To learn more about cluster tiers, see https://dochub.mongodb.org/core/cluster-tier-atlas. - - Mutually exclusive with --file. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Updating cluster ''. - - -Examples --------- - -.. code-block:: - :copyable: false - - # Update the tier for a cluster named myCluster for the project with ID 5e2211c17a3e5a48f5497de3: - atlas cluster update myCluster --projectId 5e2211c17a3e5a48f5497de3 --tier M50 - - -.. code-block:: - :copyable: false - - # Replace tags cluster named myCluster for the project with ID 5e2211c17a3e5a48f5497de3: - atlas cluster update myCluster --projectId 5e2211c17a3e5a48f5497de3 --tag key1=value1 - - -.. code-block:: - :copyable: false - - # Remove all tags from cluster named myCluster for the project with ID 5e2211c17a3e5a48f5497de3: - atlas cluster update myCluster --projectId 5e2211c17a3e5a48f5497de3 --tag = - - -.. code-block:: - :copyable: false - - # Update the disk size for a cluster named myCluster for the project with ID 5e2211c17a3e5a48f5497de3: - atlas cluster update myCluster --projectId 5e2211c17a3e5a48f5497de3 --diskSizeGB 20 - - -.. code-block:: - :copyable: false - - # Update the MongoDB version for a cluster named myCluster for the project with ID 5e2211c17a3e5a48f5497de3: - atlas cluster update myCluster --projectId 5e2211c17a3e5a48f5497de3 --mdbVersion 5.0 - - -.. code-block:: - :copyable: false - - # Use a configuration file named cluster-config.json to update a cluster named myCluster for the project with ID 5e2211c17a3e5a48f5497de3: - atlas cluster update myCluster --projectId 5e2211c17a3e5a48f5497de3 --file cluster-config.json --output json diff --git a/docs/command/atlas-clusters-upgrade.txt b/docs/command/atlas-clusters-upgrade.txt deleted file mode 100644 index 0ad728e87a..0000000000 --- a/docs/command/atlas-clusters-upgrade.txt +++ /dev/null @@ -1,146 +0,0 @@ -.. _atlas-clusters-upgrade: - -====================== -atlas clusters upgrade -====================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Upgrade a shared cluster's tier, disk size, and/or MongoDB version. - -This command is unavailable for dedicated clusters. - -To use this command, you must authenticate with a user account or an API key with the Project Cluster Manager role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas clusters upgrade [clusterName] [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - clusterName - - string - - false - - Name of the cluster to upgrade. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --disableTerminationProtection - - - - false - - Disables termination protection for your cluster. You can delete a cluster with termination protection disabled. - - Mutually exclusive with --enableTerminationProtection, --file. - * - --diskSizeGB - - float - - false - - Capacity, in gigabytes, of the host's root volume. - - Mutually exclusive with --file. - * - --enableTerminationProtection - - - - false - - Enables termination protection for your cluster. You can't delete a cluster with termination protection enabled. - - Mutually exclusive with --disableTerminationProtection, --file. - * - -f, --file - - string - - false - - Path to an optional JSON configuration file that defines cluster settings. To learn more about cluster configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/cluster-config-file-atlascli. - - Mutually exclusive with --tier, --diskSizeGB, --mdbVersion, --enableTerminationProtection, --disableTerminationProtection, --tag. - * - -h, --help - - - - false - - help for upgrade - * - --mdbVersion - - string - - false - - Major MongoDB version of the cluster. - - Mutually exclusive with --file. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --tag - - key=value - - false - - List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. Passing this flag replaces preexisting data. - - Mutually exclusive with --file. - * - --tier - - string - - false - - Tier for each data-bearing server in the cluster. To learn more about cluster tiers, see https://dochub.mongodb.org/core/cluster-tier-atlas. - - Mutually exclusive with --file. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Upgrading cluster ''. - - -Examples --------- - -.. code-block:: - :copyable: false - - # Upgrade the tier, disk size, and MongoDB version for the shared cluster named myCluster in the project with the ID 5e2211c17a3e5a48f5497de3: - atlas cluster upgrade myCluster --projectId 5e2211c17a3e5a48f5497de3 --tier M50 --diskSizeGB 20 --mdbVersion 7.0 --tag env=dev diff --git a/docs/command/atlas-clusters-watch.txt b/docs/command/atlas-clusters-watch.txt deleted file mode 100644 index 9370e54689..0000000000 --- a/docs/command/atlas-clusters-watch.txt +++ /dev/null @@ -1,104 +0,0 @@ -.. _atlas-clusters-watch: - -==================== -atlas clusters watch -==================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Watch the specified cluster in your project until it becomes available. - -This command checks the cluster's status periodically until it reaches an IDLE state. -Once the cluster reaches the expected state, the command prints "Cluster available." -If you run the command in the terminal, it blocks the terminal session until the resource state changes to IDLE. -You can interrupt the command's polling at any time with CTRL-C. - -To use this command, you must authenticate with a user account or an API key with the Project Read Only role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas clusters watch [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - clusterName - - string - - true - - Name of the cluster to watch. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for watch - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - - Cluster available. - - -Examples --------- - -.. code-block:: - :copyable: false - - # Watch for the cluster named myCluster to become available for the project with ID 5e2211c17a3e5a48f5497de3: - atlas clusters watch myCluster --projectId 5e2211c17a3e5a48f5497de3 diff --git a/docs/command/atlas-clusters.txt b/docs/command/atlas-clusters.txt deleted file mode 100644 index 5f49f0d466..0000000000 --- a/docs/command/atlas-clusters.txt +++ /dev/null @@ -1,93 +0,0 @@ -.. _atlas-clusters: - -============== -atlas clusters -============== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage clusters for your project. - -The clusters command provides access to your cluster configurations. You can create, edit, and delete clusters. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for clusters - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-clusters-advancedSettings` - Manage advanced configuration settings for your cluster. -* :ref:`atlas-clusters-availableRegions` - Manage available regions for your project. -* :ref:`atlas-clusters-connectionStrings` - Manage MongoDB cluster connection string. -* :ref:`atlas-clusters-create` - Create a cluster for your project. -* :ref:`atlas-clusters-delete` - Remove the specified cluster from your project. -* :ref:`atlas-clusters-describe` - Return the details for the specified cluster for your project. -* :ref:`atlas-clusters-failover` - Starts a failover test for the specified cluster in the specified project. -* :ref:`atlas-clusters-indexes` - Manage cluster rolling indexes for your project. -* :ref:`atlas-clusters-list` - Return all clusters for your project. -* :ref:`atlas-clusters-onlineArchives` - Manage online archives for your cluster. -* :ref:`atlas-clusters-pause` - Pause the specified running MongoDB cluster. -* :ref:`atlas-clusters-sampleData` - Manage sample data for your cluster. -* :ref:`atlas-clusters-search` - Manage Atlas Search for your cluster. -* :ref:`atlas-clusters-start` - Start the specified paused MongoDB cluster. -* :ref:`atlas-clusters-update` - Modify the settings of the specified cluster. -* :ref:`atlas-clusters-upgrade` - Upgrade a shared cluster's tier, disk size, and/or MongoDB version. -* :ref:`atlas-clusters-watch` - Watch the specified cluster in your project until it becomes available. - - -.. toctree:: - :titlesonly: - - advancedSettings - availableRegions - connectionStrings - create - delete - describe - failover - indexes - list - onlineArchives - pause - sampleData - search - start - update - upgrade - watch - diff --git a/docs/command/atlas-completion-bash.txt b/docs/command/atlas-completion-bash.txt deleted file mode 100644 index 14d36aabc8..0000000000 --- a/docs/command/atlas-completion-bash.txt +++ /dev/null @@ -1,76 +0,0 @@ -.. _atlas-completion-bash: - -===================== -atlas completion bash -===================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Generate the autocompletion script for bash - - -Generate the autocompletion script for the bash shell. -This script depends on the 'bash-completion' package. -If it is not installed already, you can install it via your OS's package manager. -To load completions in your current shell session: -$ source <(atlas completion bash) -To load completions for every new session, execute once: -Linux: -$ atlas completion bash > /etc/bash_completion.d/atlas -MacOS: -$ atlas completion bash > /usr/local/etc/bash_completion.d/atlas -You will need to start a new shell for this setup to take effect. - - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas completion bash - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for bash - * - --no-descriptions - - - - false - - disable completion descriptions - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - diff --git a/docs/command/atlas-completion-fish.txt b/docs/command/atlas-completion-fish.txt deleted file mode 100644 index cdb18085f7..0000000000 --- a/docs/command/atlas-completion-fish.txt +++ /dev/null @@ -1,75 +0,0 @@ -.. _atlas-completion-fish: - -===================== -atlas completion fish -===================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Generate the autocompletion script for fish - -Generate the autocompletion script for the fish shell. - -To load completions in your current shell session: - - atlas completion fish | source - -To load completions for every new session, execute once: - - atlas completion fish > ~/.config/fish/completions/atlas.fish - -You will need to start a new shell for this setup to take effect. - - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas completion fish [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for fish - * - --no-descriptions - - - - false - - disable completion descriptions - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - diff --git a/docs/command/atlas-completion-powershell.txt b/docs/command/atlas-completion-powershell.txt deleted file mode 100644 index 4ec9d22b11..0000000000 --- a/docs/command/atlas-completion-powershell.txt +++ /dev/null @@ -1,72 +0,0 @@ -.. _atlas-completion-powershell: - -=========================== -atlas completion powershell -=========================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Generate the autocompletion script for powershell - -Generate the autocompletion script for powershell. - -To load completions in your current shell session: - - atlas completion powershell | Out-String | Invoke-Expression - -To load completions for every new session, add the output of the above command -to your powershell profile. - - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas completion powershell [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for powershell - * - --no-descriptions - - - - false - - disable completion descriptions - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - diff --git a/docs/command/atlas-completion-zsh.txt b/docs/command/atlas-completion-zsh.txt deleted file mode 100644 index f5052fa504..0000000000 --- a/docs/command/atlas-completion-zsh.txt +++ /dev/null @@ -1,86 +0,0 @@ -.. _atlas-completion-zsh: - -==================== -atlas completion zsh -==================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Generate the autocompletion script for zsh - -Generate the autocompletion script for the zsh shell. - -If shell completion is not already enabled in your environment you will need -to enable it. You can execute the following once: - - echo "autoload -U compinit; compinit" >> ~/.zshrc - -To load completions in your current shell session: - - source <(atlas completion zsh) - -To load completions for every new session, execute once: - -#### Linux: - - atlas completion zsh > "${fpath[1]}/_atlas" - -#### macOS: - - atlas completion zsh > $(brew --prefix)/share/zsh/site-functions/_atlas - -You will need to start a new shell for this setup to take effect. - - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas completion zsh [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for zsh - * - --no-descriptions - - - - false - - disable completion descriptions - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - diff --git a/docs/command/atlas-completion.txt b/docs/command/atlas-completion.txt deleted file mode 100644 index 57d74af29c..0000000000 --- a/docs/command/atlas-completion.txt +++ /dev/null @@ -1,69 +0,0 @@ -.. _atlas-completion: - -================ -atlas completion -================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Generate the autocompletion script for the specified shell - -Generate the autocompletion script for atlas for the specified shell. -See each sub-command's help for details on how to use the generated script. - - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for completion - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-completion-bash` - Generate the autocompletion script for bash -* :ref:`atlas-completion-fish` - Generate the autocompletion script for fish -* :ref:`atlas-completion-powershell` - Generate the autocompletion script for powershell -* :ref:`atlas-completion-zsh` - Generate the autocompletion script for zsh - - -.. toctree:: - :titlesonly: - - bash - fish - powershell - zsh - diff --git a/docs/command/atlas-config-delete.txt b/docs/command/atlas-config-delete.txt deleted file mode 100644 index 767cc09906..0000000000 --- a/docs/command/atlas-config-delete.txt +++ /dev/null @@ -1,103 +0,0 @@ -.. _atlas-config-delete: - -=================== -atlas config delete -=================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Delete a profile. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas config delete [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - name - - string - - true - - Name of the profile. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --force - - - - false - - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. - * - -h, --help - - - - false - - help for delete - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Profile '' deleted - - -Examples --------- - -.. code-block:: - :copyable: false - - # Delete the default profile configuration: - atlas config delete default - - -.. code-block:: - :copyable: false - - # Skip the confirmation question and delete the default profile configuration: - atlas config delete default --force diff --git a/docs/command/atlas-config-describe.txt b/docs/command/atlas-config-describe.txt deleted file mode 100644 index 56359f1812..0000000000 --- a/docs/command/atlas-config-describe.txt +++ /dev/null @@ -1,78 +0,0 @@ -.. _atlas-config-describe: - -===================== -atlas config describe -===================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return the profile you specify. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas config describe [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - name - - string - - true - - Label that identifies the profile. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for describe - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - diff --git a/docs/command/atlas-config-edit.txt b/docs/command/atlas-config-edit.txt deleted file mode 100644 index 3f79872c73..0000000000 --- a/docs/command/atlas-config-edit.txt +++ /dev/null @@ -1,74 +0,0 @@ -.. _atlas-config-edit: - -================= -atlas config edit -================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Opens the config file with the default text editor. - -Uses the default editor to open the config file. You can use EDITOR or VISUAL envs to change the default. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas config edit [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for edit - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - # To open the config - atlas config edit - - -.. toctree:: - :titlesonly: - - diff --git a/docs/command/atlas-config-init.txt b/docs/command/atlas-config-init.txt deleted file mode 100644 index 5869b38318..0000000000 --- a/docs/command/atlas-config-init.txt +++ /dev/null @@ -1,77 +0,0 @@ -.. _atlas-config-init: - -================= -atlas config init -================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Configure a profile to store access settings for your MongoDB deployment. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas config init [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --gov - - - - false - - Create a default profile for atlas for gov - * - -h, --help - - - - false - - help for init - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - # To configure the tool to work with Atlas: - atlas config init - - -.. code-block:: - :copyable: false - - # To configure the tool to work with Atlas for Government: - atlas config init --gov diff --git a/docs/command/atlas-config-list.txt b/docs/command/atlas-config-list.txt deleted file mode 100644 index 36cee08ac7..0000000000 --- a/docs/command/atlas-config-list.txt +++ /dev/null @@ -1,71 +0,0 @@ -.. _atlas-config-list: - -================= -atlas config list -================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return a list of available profiles by name. - -If you did not specify a name for your profile, it displays as the default profile. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas config list [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for list - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - atlas config ls diff --git a/docs/command/atlas-config-rename.txt b/docs/command/atlas-config-rename.txt deleted file mode 100644 index cd801e52d7..0000000000 --- a/docs/command/atlas-config-rename.txt +++ /dev/null @@ -1,86 +0,0 @@ -.. _atlas-config-rename: - -=================== -atlas config rename -=================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Rename a profile. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas config rename [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - oldProfileName - - string - - true - - Name of the profile to rename. - * - newProfileName - - string - - true - - New name of the profile. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for rename - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - # Rename a profile called myProfile to testProfile: - atlas config rename myProfile testProfile diff --git a/docs/command/atlas-config-set.txt b/docs/command/atlas-config-set.txt deleted file mode 100644 index dd1be889b6..0000000000 --- a/docs/command/atlas-config-set.txt +++ /dev/null @@ -1,87 +0,0 @@ -.. _atlas-config-set: - -================ -atlas config set -================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Configure specific properties of a profile. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas config set [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - propertyName - - string - - true - - Property to set in the profile. Valid values for Atlas CLI are project_id, org_id, service, public_api_key, private_api_key, output, mongosh_path, skip_update_check, telemetry_enabled, access_token, and refresh_token. - * - value - - string - - true - - Value for the property to set in the profile. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for set - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - - Set the organization ID in the default profile to 5dd5aaef7a3e5a6c5bd12de4: - atlas config set org_id 5dd5aaef7a3e5a6c5bd12de4 diff --git a/docs/command/atlas-config.txt b/docs/command/atlas-config.txt deleted file mode 100644 index 407faf6a3a..0000000000 --- a/docs/command/atlas-config.txt +++ /dev/null @@ -1,78 +0,0 @@ -.. _atlas-config: - -============ -atlas config -============ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Configure and manage your user profiles. - -Configure settings in a user profile. -All settings are optional. You can specify settings individually by running: -$ atlas config set --help - -You can also use environment variables (MONGODB_ATLAS_*) when running the tool. -To find out more, see the documentation: https://dochub.mongodb.org/core/atlas-cli-env-variables. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for config - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-config-delete` - Delete a profile. -* :ref:`atlas-config-describe` - Return the profile you specify. -* :ref:`atlas-config-edit` - Opens the config file with the default text editor. -* :ref:`atlas-config-init` - Configure a profile to store access settings for your MongoDB deployment. -* :ref:`atlas-config-list` - Return a list of available profiles by name. -* :ref:`atlas-config-rename` - Rename a profile. -* :ref:`atlas-config-set` - Configure specific properties of a profile. - - -.. toctree:: - :titlesonly: - - delete - describe - edit - init - list - rename - set - diff --git a/docs/command/atlas-customDbRoles-create.txt b/docs/command/atlas-customDbRoles-create.txt deleted file mode 100644 index 9b8a215906..0000000000 --- a/docs/command/atlas-customDbRoles-create.txt +++ /dev/null @@ -1,131 +0,0 @@ -.. _atlas-customDbRoles-create: - -========================== -atlas customDbRoles create -========================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create a custom database role for your project. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas customDbRoles create [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - roleName - - string - - true - - Name of the custom role to create. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for create - * - --inheritedRole - - strings - - false - - List of inherited roles and the database on which the role is granted. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --privilege - - strings - - false - - List of actions per database and collection. If no database or collections are provided, cluster scope is assumed. For details on actions specific to clusters, databases, or collections, see https://dochub.mongodb.org/core/privilege-actions. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Custom database role '' successfully created. - - -Examples --------- - -.. code-block:: - :copyable: false - - # Create a custom database role - atlas customDbRoles create customRole --privilege FIND@databaseName,UPDATE@databaseName.collectionName - - -.. code-block:: - :copyable: false - - # Create a custom database role on multiple collections - atlas customDbRoles create customRole --privilege FIND@databaseName,UPDATE@databaseName.firstCollectionName,UPDATE@databaseName.secondCollectionName - - -.. code-block:: - :copyable: false - - # Create a customer database role with granted action on the cluster resource - atlas customDbRoles create customRole --privilege GET_CMD_LINE_OPTS - - -.. code-block:: - :copyable: false - - # Use an inherited role - atlas customDbRoles create customRole --inheritedRole read@databaseName diff --git a/docs/command/atlas-customDbRoles-delete.txt b/docs/command/atlas-customDbRoles-delete.txt deleted file mode 100644 index 15ac1aa8a1..0000000000 --- a/docs/command/atlas-customDbRoles-delete.txt +++ /dev/null @@ -1,94 +0,0 @@ -.. _atlas-customDbRoles-delete: - -========================== -atlas customDbRoles delete -========================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Remove the specified custom database role from your project. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas customDbRoles delete [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - roleName - - string - - true - - Name of the custom role to delete. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --force - - - - false - - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. - * - -h, --help - - - - false - - help for delete - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Custom database role '' deleted - - diff --git a/docs/command/atlas-customDbRoles-describe.txt b/docs/command/atlas-customDbRoles-describe.txt deleted file mode 100644 index fc55e02673..0000000000 --- a/docs/command/atlas-customDbRoles-describe.txt +++ /dev/null @@ -1,84 +0,0 @@ -.. _atlas-customDbRoles-describe: - -============================ -atlas customDbRoles describe -============================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return a single custom database role for your project. - -To use this command, you must authenticate with a user account or an API key with the Project Read Only role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas customDbRoles describe [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - roleName - - string - - true - - Name of the custom role to retrieve. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for describe - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - diff --git a/docs/command/atlas-customDbRoles-list.txt b/docs/command/atlas-customDbRoles-list.txt deleted file mode 100644 index 68e8f8d518..0000000000 --- a/docs/command/atlas-customDbRoles-list.txt +++ /dev/null @@ -1,68 +0,0 @@ -.. _atlas-customDbRoles-list: - -======================== -atlas customDbRoles list -======================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -List custom database roles for your project. - -To use this command, you must authenticate with a user account or an API key with the Project Read Only role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas customDbRoles list [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for list - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - diff --git a/docs/command/atlas-customDbRoles-update.txt b/docs/command/atlas-customDbRoles-update.txt deleted file mode 100644 index eb665640dc..0000000000 --- a/docs/command/atlas-customDbRoles-update.txt +++ /dev/null @@ -1,106 +0,0 @@ -.. _atlas-customDbRoles-update: - -========================== -atlas customDbRoles update -========================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Update a custom database role for your project. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas customDbRoles update [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - roleName - - string - - true - - Name of the custom role to update. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --append - - - - false - - Input action and inheritedRoles to append to the existing role. - * - -h, --help - - - - false - - help for update - * - --inheritedRole - - strings - - false - - List of inherited roles and the database on which the role is granted. Passing this flag replaces preexisting data. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --privilege - - strings - - false - - List of actions per database and collection. If no database or collections are provided, cluster scope is assumed. For details on actions specific to clusters, databases, or collections, see https://dochub.mongodb.org/core/privilege-actions. Passing this flag replaces preexisting data. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Custom database role '' successfully updated. - - diff --git a/docs/command/atlas-customDbRoles.txt b/docs/command/atlas-customDbRoles.txt deleted file mode 100644 index 674eaa626a..0000000000 --- a/docs/command/atlas-customDbRoles.txt +++ /dev/null @@ -1,67 +0,0 @@ -.. _atlas-customDbRoles: - -=================== -atlas customDbRoles -=================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage custom database roles for your project. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for customDbRoles - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-customDbRoles-create` - Create a custom database role for your project. -* :ref:`atlas-customDbRoles-delete` - Remove the specified custom database role from your project. -* :ref:`atlas-customDbRoles-describe` - Return a single custom database role for your project. -* :ref:`atlas-customDbRoles-list` - List custom database roles for your project. -* :ref:`atlas-customDbRoles-update` - Update a custom database role for your project. - - -.. toctree:: - :titlesonly: - - create - delete - describe - list - update - diff --git a/docs/command/atlas-customDns-aws-describe.txt b/docs/command/atlas-customDns-aws-describe.txt deleted file mode 100644 index f19e00caa6..0000000000 --- a/docs/command/atlas-customDns-aws-describe.txt +++ /dev/null @@ -1,87 +0,0 @@ -.. _atlas-customDns-aws-describe: - -============================ -atlas customDns aws describe -============================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Describe the custom DNS configuration of an Atlas cluster deployed to AWS in the specified project. - -To use this command, you must authenticate with a user account or an API key with the Project Read Only role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas customDns aws describe [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for describe - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - ENABLED - - - -Examples --------- - -.. code-block:: - :copyable: false - - # Return the details for the custom DNS configuration deployed to AWS in the project with ID 618d48e05277a606ed2496fe: - atlas customDns aws describe --projectId 618d48e05277a606ed2496fe diff --git a/docs/command/atlas-customDns-aws-disable.txt b/docs/command/atlas-customDns-aws-disable.txt deleted file mode 100644 index fe8931480d..0000000000 --- a/docs/command/atlas-customDns-aws-disable.txt +++ /dev/null @@ -1,86 +0,0 @@ -.. _atlas-customDns-aws-disable: - -=========================== -atlas customDns aws disable -=========================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Disable the custom DNS configuration of an Atlas cluster deployed to AWS in the specified project. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas customDns aws disable [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for disable - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - DNS configuration disabled. - - -Examples --------- - -.. code-block:: - :copyable: false - - # Disable the custom DNS configuration deployed to AWS in the project with ID 618d48e05277a606ed2496fe: - atlas customDns aws disable --projectId 618d48e05277a606ed2496fe diff --git a/docs/command/atlas-customDns-aws-enable.txt b/docs/command/atlas-customDns-aws-enable.txt deleted file mode 100644 index 7ebf795a8b..0000000000 --- a/docs/command/atlas-customDns-aws-enable.txt +++ /dev/null @@ -1,86 +0,0 @@ -.. _atlas-customDns-aws-enable: - -========================== -atlas customDns aws enable -========================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Enable the custom DNS configuration of an Atlas cluster deployed to AWS in the specified project. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas customDns aws enable [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for enable - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - DNS configuration enabled. - - -Examples --------- - -.. code-block:: - :copyable: false - - # Enable the custom DNS configuration deployed to AWS in the project with ID 618d48e05277a606ed2496fe: - atlas customDns aws enable --projectId 618d48e05277a606ed2496fe diff --git a/docs/command/atlas-customDns-aws.txt b/docs/command/atlas-customDns-aws.txt deleted file mode 100644 index 2b385960ad..0000000000 --- a/docs/command/atlas-customDns-aws.txt +++ /dev/null @@ -1,63 +0,0 @@ -.. _atlas-customDns-aws: - -=================== -atlas customDns aws -=================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage DNS configuration of an Atlas project’s cluster deployed to AWS. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for aws - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-customDns-aws-describe` - Describe the custom DNS configuration of an Atlas cluster deployed to AWS in the specified project. -* :ref:`atlas-customDns-aws-disable` - Disable the custom DNS configuration of an Atlas cluster deployed to AWS in the specified project. -* :ref:`atlas-customDns-aws-enable` - Enable the custom DNS configuration of an Atlas cluster deployed to AWS in the specified project. - - -.. toctree:: - :titlesonly: - - describe - disable - enable - diff --git a/docs/command/atlas-customDns.txt b/docs/command/atlas-customDns.txt deleted file mode 100644 index a613a48d18..0000000000 --- a/docs/command/atlas-customDns.txt +++ /dev/null @@ -1,59 +0,0 @@ -.. _atlas-customDns: - -=============== -atlas customDns -=============== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage DNS configuration of Atlas project’s clusters deployed to AWS. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for customDns - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-customDns-aws` - Manage DNS configuration of an Atlas project’s cluster deployed to AWS. - - -.. toctree:: - :titlesonly: - - aws - diff --git a/docs/command/atlas-dataFederation-create.txt b/docs/command/atlas-dataFederation-create.txt deleted file mode 100644 index 4459c6c491..0000000000 --- a/docs/command/atlas-dataFederation-create.txt +++ /dev/null @@ -1,126 +0,0 @@ -.. _atlas-dataFederation-create: - -=========================== -atlas dataFederation create -=========================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Creates a new Data Federation database. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas dataFederation create [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - name - - string - - true - - Name of the data federation database. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --awsRoleId - - string - - false - - Amazon Resource Name (ARN) of the role which Atlas Data Federation uses for accessing the data stores. - - Mutually exclusive with --file. - * - --awsTestS3Bucket - - string - - false - - Name of an Amazon S3 data bucket that Atlas Data Federation uses to validate the provided role. - - Mutually exclusive with --file. - * - -f, --file - - string - - false - - Path to an optional JSON configuration file that defines data federation settings. To learn more about data federation configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-json-data-federation-config. - - Mutually exclusive with --region, --awsRoleId, --awsTestS3Bucket. - * - -h, --help - - - - false - - help for create - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --region - - string - - false - - Name of the region to which Atlas Data Federation routes client connections for data processing. - - Mutually exclusive with --file. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Data federation created. - -Examples --------- - -.. code-block:: - :copyable: false - - # create data federation database: - atlas dataFederation create DataFederation1 --region us_east_1 --awsRoleId role --awsTestS3Bucket bucket - diff --git a/docs/command/atlas-dataFederation-delete.txt b/docs/command/atlas-dataFederation-delete.txt deleted file mode 100644 index e382667aa3..0000000000 --- a/docs/command/atlas-dataFederation-delete.txt +++ /dev/null @@ -1,103 +0,0 @@ -.. _atlas-dataFederation-delete: - -=========================== -atlas dataFederation delete -=========================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Remove the specified data federation database from your project. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas dataFederation delete [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - name - - string - - true - - Name of the data federation database. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --force - - - - false - - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. - * - -h, --help - - - - false - - help for delete - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - '' deleted - - -Examples --------- - -.. code-block:: - :copyable: false - - # deletes data federation 'DataFederation1': - atlas dataFederation delete DataFederation1 - diff --git a/docs/command/atlas-dataFederation-describe.txt b/docs/command/atlas-dataFederation-describe.txt deleted file mode 100644 index 5499f34860..0000000000 --- a/docs/command/atlas-dataFederation-describe.txt +++ /dev/null @@ -1,93 +0,0 @@ -.. _atlas-dataFederation-describe: - -============================= -atlas dataFederation describe -============================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return the details for the specified data federation database for your project. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas dataFederation describe [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - name - - string - - true - - Name of the data federation database. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for describe - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - # retrieves data federation 'DataFederation1': - atlas dataFederation describe DataFederation1 - diff --git a/docs/command/atlas-dataFederation-list.txt b/docs/command/atlas-dataFederation-list.txt deleted file mode 100644 index 59c6ee9682..0000000000 --- a/docs/command/atlas-dataFederation-list.txt +++ /dev/null @@ -1,81 +0,0 @@ -.. _atlas-dataFederation-list: - -========================= -atlas dataFederation list -========================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns all data federation databases for your project. - -To use this command, you must authenticate with a user account or an API key with the Project Read Only role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas dataFederation list [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for list - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --type - - string - - false - - Type of Federated Database Instances to return. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - # list all data federation databases: - atlas dataFederation list - diff --git a/docs/command/atlas-dataFederation-logs.txt b/docs/command/atlas-dataFederation-logs.txt deleted file mode 100644 index 708beaf639..0000000000 --- a/docs/command/atlas-dataFederation-logs.txt +++ /dev/null @@ -1,105 +0,0 @@ -.. _atlas-dataFederation-logs: - -========================= -atlas dataFederation logs -========================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns logs of the specified data federation database for your project. - -To use this command, you must authenticate with a user account or an API key with the Project Read Only role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas dataFederation logs [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - name - - string - - true - - Name of the data federation database. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --end - - int - - false - - Timestamp in UNIX epoch format when the logs end. - * - --force - - - - false - - Flag that indicates whether to overwrite the destination file. - * - -h, --help - - - - false - - help for logs - * - --out - - string - - true - - Output file name. This value defaults to the log name. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --start - - int - - false - - Timestamp in UNIX epoch format when the logs start. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - # download logs of data federation database 'DataFederation1': - atlas dataFederation logs DataFederation1 - diff --git a/docs/command/atlas-dataFederation-privateEndpoints-create.txt b/docs/command/atlas-dataFederation-privateEndpoints-create.txt deleted file mode 100644 index 92cbbefc52..0000000000 --- a/docs/command/atlas-dataFederation-privateEndpoints-create.txt +++ /dev/null @@ -1,106 +0,0 @@ -.. _atlas-dataFederation-privateEndpoints-create: - -============================================ -atlas dataFederation privateEndpoints create -============================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Creates a new Data Federation private endpoint. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas dataFederation privateEndpoints create [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - endpointId - - string - - true - - Endpoint identifier of the data federation private endpoint. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --comment - - string - - false - - Optional description or comment for the entry. - * - -h, --help - - - - false - - help for create - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Data federation private endpoint {{(index .Results 0).EndpointId> created. - -Examples --------- - -.. code-block:: - :copyable: false - - # create data federation private endpoint: - atlas dataFederation privateEndpoints create 507f1f77bcf86cd799439011 --comment "comment" - diff --git a/docs/command/atlas-dataFederation-privateEndpoints-delete.txt b/docs/command/atlas-dataFederation-privateEndpoints-delete.txt deleted file mode 100644 index b120e76382..0000000000 --- a/docs/command/atlas-dataFederation-privateEndpoints-delete.txt +++ /dev/null @@ -1,103 +0,0 @@ -.. _atlas-dataFederation-privateEndpoints-delete: - -============================================ -atlas dataFederation privateEndpoints delete -============================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Remove the specified data federation private endpoint from your project. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas dataFederation privateEndpoints delete [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - endpointId - - string - - true - - Endpoint identifier of the data federation private endpoint. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --force - - - - false - - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. - * - -h, --help - - - - false - - help for delete - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - '' deleted - - -Examples --------- - -.. code-block:: - :copyable: false - - # deletes data federation private endpoint '507f1f77bcf86cd799439011': - atlas dataFederation privateEndpoints delete 507f1f77bcf86cd799439011 - diff --git a/docs/command/atlas-dataFederation-privateEndpoints-describe.txt b/docs/command/atlas-dataFederation-privateEndpoints-describe.txt deleted file mode 100644 index f6c4a32295..0000000000 --- a/docs/command/atlas-dataFederation-privateEndpoints-describe.txt +++ /dev/null @@ -1,93 +0,0 @@ -.. _atlas-dataFederation-privateEndpoints-describe: - -============================================== -atlas dataFederation privateEndpoints describe -============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return the details for the specified data federation private endpoint for your project. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas dataFederation privateEndpoints describe [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - endpointId - - string - - true - - Endpoint identifier of the data federation private endpoint. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for describe - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - # retrieves data federation private endpoint '507f1f77bcf86cd799439011': - atlas dataFederation privateEndpoints describe 507f1f77bcf86cd799439011 - diff --git a/docs/command/atlas-dataFederation-privateEndpoints-list.txt b/docs/command/atlas-dataFederation-privateEndpoints-list.txt deleted file mode 100644 index 11c74755fa..0000000000 --- a/docs/command/atlas-dataFederation-privateEndpoints-list.txt +++ /dev/null @@ -1,77 +0,0 @@ -.. _atlas-dataFederation-privateEndpoints-list: - -========================================== -atlas dataFederation privateEndpoints list -========================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns all data federation private endpoints for your project. - -To use this command, you must authenticate with a user account or an API key with the Project Read Only role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas dataFederation privateEndpoints list [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for list - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - # list all data federation private endpoints: - atlas dataFederation privateEndpoints list - diff --git a/docs/command/atlas-dataFederation-privateEndpoints.txt b/docs/command/atlas-dataFederation-privateEndpoints.txt deleted file mode 100644 index 2bb92609a9..0000000000 --- a/docs/command/atlas-dataFederation-privateEndpoints.txt +++ /dev/null @@ -1,65 +0,0 @@ -.. _atlas-dataFederation-privateEndpoints: - -===================================== -atlas dataFederation privateEndpoints -===================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Data federation private endpoints. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for privateEndpoints - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-dataFederation-privateEndpoints-create` - Creates a new Data Federation private endpoint. -* :ref:`atlas-dataFederation-privateEndpoints-delete` - Remove the specified data federation private endpoint from your project. -* :ref:`atlas-dataFederation-privateEndpoints-describe` - Return the details for the specified data federation private endpoint for your project. -* :ref:`atlas-dataFederation-privateEndpoints-list` - Returns all data federation private endpoints for your project. - - -.. toctree:: - :titlesonly: - - create - delete - describe - list - diff --git a/docs/command/atlas-dataFederation-queryLimits-create.txt b/docs/command/atlas-dataFederation-queryLimits-create.txt deleted file mode 100644 index eaa5f1f2cf..0000000000 --- a/docs/command/atlas-dataFederation-queryLimits-create.txt +++ /dev/null @@ -1,114 +0,0 @@ -.. _atlas-dataFederation-queryLimits-create: - -======================================= -atlas dataFederation queryLimits create -======================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Creates a new Data Federation query limit. - -To learn more about the query limits, see https://dochub.mongodb.org/core/adf-query-limits.To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas dataFederation queryLimits create [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - name - - string - - true - - Identifier of the data federation query limit. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --dataFederation - - string - - true - - Identifier of the Federated Database Instance. - * - -h, --help - - - - false - - help for create - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --overrunPolicy - - string - - false - - Action to take when the usage limit is exceeded. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --value - - int - - true - - Value given to the query limit. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Data federation query limit created. - -Examples --------- - -.. code-block:: - :copyable: false - - # create data federation query limit: - atlas dataFederation queryLimit create bytesProcessed.query --value 1000 --dataFederation DataFederation1 - diff --git a/docs/command/atlas-dataFederation-queryLimits-delete.txt b/docs/command/atlas-dataFederation-queryLimits-delete.txt deleted file mode 100644 index 3291c783d6..0000000000 --- a/docs/command/atlas-dataFederation-queryLimits-delete.txt +++ /dev/null @@ -1,107 +0,0 @@ -.. _atlas-dataFederation-queryLimits-delete: - -======================================= -atlas dataFederation queryLimits delete -======================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Remove the specified data federation query limit from your project. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas dataFederation queryLimits delete [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - name - - string - - true - - Identifier of the data federation query limit. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --dataFederation - - string - - true - - Identifier of the Federated Database Instance. - * - --force - - - - false - - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. - * - -h, --help - - - - false - - help for delete - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - '' deleted - - -Examples --------- - -.. code-block:: - :copyable: false - - # deletes data federation query limits "bytesProcessed.query" for 'DataFederation1': - atlas dataFederation queryLimits delete bytesProcessed.query --tenantName DataFederation1 - diff --git a/docs/command/atlas-dataFederation-queryLimits-describe.txt b/docs/command/atlas-dataFederation-queryLimits-describe.txt deleted file mode 100644 index 63f1b1b213..0000000000 --- a/docs/command/atlas-dataFederation-queryLimits-describe.txt +++ /dev/null @@ -1,97 +0,0 @@ -.. _atlas-dataFederation-queryLimits-describe: - -========================================= -atlas dataFederation queryLimits describe -========================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return the details for the specified data federation query limit for your project. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas dataFederation queryLimits describe [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - name - - string - - true - - Identifier of the data federation query limit. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --dataFederation - - string - - true - - Identifier of the Federated Database Instance. - * - -h, --help - - - - false - - help for describe - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - # retrieves data federation query limits "bytesProcessed.query" for 'DataFederation1': - atlas dataFederation queryLimits describe bytesProcessed.query --tenantName DataFederation1 - diff --git a/docs/command/atlas-dataFederation-queryLimits-list.txt b/docs/command/atlas-dataFederation-queryLimits-list.txt deleted file mode 100644 index 9f30232375..0000000000 --- a/docs/command/atlas-dataFederation-queryLimits-list.txt +++ /dev/null @@ -1,81 +0,0 @@ -.. _atlas-dataFederation-queryLimits-list: - -===================================== -atlas dataFederation queryLimits list -===================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns all data federation query limits for your project. - -To use this command, you must authenticate with a user account or an API key with the Project Read Only role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas dataFederation queryLimits list [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --dataFederation - - string - - true - - Identifier of the Federated Database Instance. - * - -h, --help - - - - false - - help for list - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - # list all data federation query limits for the database federated instance "myInstance": - atlas dataFederation queryLimits list --dataFederation myInstance - diff --git a/docs/command/atlas-dataFederation-queryLimits.txt b/docs/command/atlas-dataFederation-queryLimits.txt deleted file mode 100644 index 9667d5ede8..0000000000 --- a/docs/command/atlas-dataFederation-queryLimits.txt +++ /dev/null @@ -1,65 +0,0 @@ -.. _atlas-dataFederation-queryLimits: - -================================ -atlas dataFederation queryLimits -================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Data federation query limits. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for queryLimits - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-dataFederation-queryLimits-create` - Creates a new Data Federation query limit. -* :ref:`atlas-dataFederation-queryLimits-delete` - Remove the specified data federation query limit from your project. -* :ref:`atlas-dataFederation-queryLimits-describe` - Return the details for the specified data federation query limit for your project. -* :ref:`atlas-dataFederation-queryLimits-list` - Returns all data federation query limits for your project. - - -.. toctree:: - :titlesonly: - - create - delete - describe - list - diff --git a/docs/command/atlas-dataFederation-update.txt b/docs/command/atlas-dataFederation-update.txt deleted file mode 100644 index d9efdf2fda..0000000000 --- a/docs/command/atlas-dataFederation-update.txt +++ /dev/null @@ -1,126 +0,0 @@ -.. _atlas-dataFederation-update: - -=========================== -atlas dataFederation update -=========================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Modify the details of the specified data federation database for your project. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas dataFederation update [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - name - - string - - true - - Name of the data federation database. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --awsRoleId - - string - - false - - Amazon Resource Name (ARN) of the role which Atlas Data Federation uses for accessing the data stores. - - Mutually exclusive with --file. - * - --awsTestS3Bucket - - string - - false - - Name of an Amazon S3 data bucket that Atlas Data Federation uses to validate the provided role. - - Mutually exclusive with --file. - * - -f, --file - - string - - false - - Path to an optional JSON configuration file that defines data federation settings. To learn more about data federation configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-json-data-federation-config. - - Mutually exclusive with --region, --awsRoleId, --awsTestS3Bucket. - * - -h, --help - - - - false - - help for update - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --region - - string - - false - - Name of the region to which Atlas Data Federation routes client connections for data processing. - - Mutually exclusive with --file. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Pipeline updated. - -Examples --------- - -.. code-block:: - :copyable: false - - # update data lake pipeline: - atlas dataFederation update DataFederation1 - diff --git a/docs/command/atlas-dataFederation.txt b/docs/command/atlas-dataFederation.txt deleted file mode 100644 index f548e43470..0000000000 --- a/docs/command/atlas-dataFederation.txt +++ /dev/null @@ -1,73 +0,0 @@ -.. _atlas-dataFederation: - -==================== -atlas dataFederation -==================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Data federation. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for dataFederation - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-dataFederation-create` - Creates a new Data Federation database. -* :ref:`atlas-dataFederation-delete` - Remove the specified data federation database from your project. -* :ref:`atlas-dataFederation-describe` - Return the details for the specified data federation database for your project. -* :ref:`atlas-dataFederation-list` - Returns all data federation databases for your project. -* :ref:`atlas-dataFederation-logs` - Returns logs of the specified data federation database for your project. -* :ref:`atlas-dataFederation-privateEndpoints` - Data federation private endpoints. -* :ref:`atlas-dataFederation-queryLimits` - Data federation query limits. -* :ref:`atlas-dataFederation-update` - Modify the details of the specified data federation database for your project. - - -.. toctree:: - :titlesonly: - - create - delete - describe - list - logs - privateEndpoints - queryLimits - update - diff --git a/docs/command/atlas-dbusers-certs-create.txt b/docs/command/atlas-dbusers-certs-create.txt deleted file mode 100644 index a5771b97af..0000000000 --- a/docs/command/atlas-dbusers-certs-create.txt +++ /dev/null @@ -1,94 +0,0 @@ -.. _atlas-dbusers-certs-create: - -========================== -atlas dbusers certs create -========================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create a new Atlas-managed X.509 certificate for the specified database user. - -The user you specify must authenticate using X.509 certificates. You can't use this command to create certificates if you are managing your own Certificate Authority (CA) in self-managed X.509 mode. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas dbusers certs create [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for create - * - --monthsUntilExpiration - - int - - false - - Number of months until the X.509 certificate expires. This value defaults to 3. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --username - - string - - true - - Username of a database user. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - <> - - -Examples --------- - -.. code-block:: - :copyable: false - - # Create an Atlas-managed X.509 certificate that expires in 5 months for a MongoDB user named dbuser for the project with ID 5e2211c17a3e5a48f5497de3: - atlas dbusers certs create --username dbuser --monthsUntilExpiration 5 --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-dbusers-certs-list.txt b/docs/command/atlas-dbusers-certs-list.txt deleted file mode 100644 index 03952ae8bb..0000000000 --- a/docs/command/atlas-dbusers-certs-list.txt +++ /dev/null @@ -1,94 +0,0 @@ -.. _atlas-dbusers-certs-list: - -======================== -atlas dbusers certs list -======================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return all Atlas-managed, unexpired X.509 certificates for the specified database user. - -You can't use this command to return certificates if you are managing your own Certificate Authority (CA) in self-managed X.509 mode. - -The user you specify must authenticate using X.509 certificates. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas dbusers certs list [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - username - - string - - true - - Username of the database user for whom you want to list Atlas-managed certificates. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for list - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - # Return a JSON-formatted list of all Atlas-managed X.509 certificates for a MongoDB user named dbuser for the project with ID 5e2211c17a3e5a48f5497de3: - atlas dbusers certs list dbuser --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-dbusers-certs.txt b/docs/command/atlas-dbusers-certs.txt deleted file mode 100644 index e5cf674a70..0000000000 --- a/docs/command/atlas-dbusers-certs.txt +++ /dev/null @@ -1,61 +0,0 @@ -.. _atlas-dbusers-certs: - -=================== -atlas dbusers certs -=================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage Atlas x509 certificates for your database users. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for certs - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-dbusers-certs-create` - Create a new Atlas-managed X.509 certificate for the specified database user. -* :ref:`atlas-dbusers-certs-list` - Return all Atlas-managed, unexpired X.509 certificates for the specified database user. - - -.. toctree:: - :titlesonly: - - create - list - diff --git a/docs/command/atlas-dbusers-create.txt b/docs/command/atlas-dbusers-create.txt deleted file mode 100644 index 53cf35d052..0000000000 --- a/docs/command/atlas-dbusers-create.txt +++ /dev/null @@ -1,178 +0,0 @@ -.. _atlas-dbusers-create: - -==================== -atlas dbusers create -==================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create a database user for your project. - -If you set --ldapType, --x509Type, --oidcType and --awsIAMType to NONE, Atlas authenticates this user through SCRAM-SHA. To learn more, see https://www.mongodb.com/docs/manual/core/security-scram/. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas dbusers create [builtInRole]... [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - builtInRole - - string - - false - - Atlas built-in role that you want to assign to the user. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --awsIAMType - - string - - false - - AWS IAM method by which the provided username is authenticated. Valid values are NONE, USER, or ROLE. If you set this to USER or ROLE, the user authenticates with IAM credentials and doesn't need a password. - - Mutually exclusive with --ldapType, --x509Type, --oidcType. This value defaults to "NONE". - * - --deleteAfter - - string - - false - - Timestamp in ISO 8601 in UTC after which Atlas deletes the user. - * - --desc - - string - - false - - Description of this database user. - * - -h, --help - - - - false - - help for create - * - --ldapType - - string - - false - - LDAP method by which the provided username is authenticated. Valid values are NONE, USER, or GROUP. If you set this to USER or GROUP, the user authenticates with LDAP. - - Mutually exclusive with --awsIAMType, --x509Type, --oidcType. This value defaults to "NONE". - * - --oidcType - - string - - false - - OIDC method by which the provided database user is authenticated. Valid values are NONE, USER, or IDP_GROUP. If you set this to USER or GROUP_ID, the user authenticates with OIDC. - - Mutually exclusive with --awsIAMType, --ldapType, --x509Type, --password. This value defaults to "NONE". - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - -p, --password - - string - - false - - Password for the database user. - - Mutually exclusive with --oidcType. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --role - - strings - - false - - Comma-separated list that specifies the user's roles and the databases or collections on which the roles apply. - The roles format is roleName[@dbName[.collection]]. - roleName can either be a built-in role or a custom role. - dbName and collection are required only for built-in roles. - * - --scope - - strings - - false - - Array of clusters that this user has access to. - * - -u, --username - - string - - true - - Username for authenticating to MongoDB. - * - --x509Type - - string - - false - - X.509 method for authenticating the specified username. Valid values include NONE, MANAGED, and CUSTOMER. If you set this to MANAGED the user authenticates with an Atlas-managed X.509 certificate. If you set this to CUSTOMER, the user authenticates with a self-managed X.509 certificate. - - Mutually exclusive with --awsIAMType, --ldapType, --oidcType. This value defaults to "NONE". - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Database user '' successfully created. - - -Examples --------- - -.. code-block:: - :copyable: false - - # Create an Atlas database admin user named myAdmin for the project with ID 5e2211c17a3e5a48f5497de3: - atlas dbusers create atlasAdmin --username myAdmin --projectId 5e2211c17a3e5a48f5497de3 - - -.. code-block:: - :copyable: false - - # Create a database user named myUser with read/write access to any database for the project with ID 5e2211c17a3e5a48f5497de3: - atlas dbusers create readWriteAnyDatabase --username myUser --projectId 5e2211c17a3e5a48f5497de3 - - -.. code-block:: - :copyable: false - - # Create a database user named myUser with multiple roles for the project with ID 5e2211c17a3e5a48f5497de3: - atlas dbusers create --username myUser --role clusterMonitor,backup --projectId 5e2211c17a3e5a48f5497de3 - - -.. code-block:: - :copyable: false - - # Create a database user named myUser with multiple scopes for the project with ID 5e2211c17a3e5a48f5497de3: - atlas dbusers create --username myUser --role clusterMonitor --scope , --projectId 5e2211c17a3e5a48f5497de3 diff --git a/docs/command/atlas-dbusers-delete.txt b/docs/command/atlas-dbusers-delete.txt deleted file mode 100644 index 78e7aec17f..0000000000 --- a/docs/command/atlas-dbusers-delete.txt +++ /dev/null @@ -1,120 +0,0 @@ -.. _atlas-dbusers-delete: - -==================== -atlas dbusers delete -==================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Remove the specified database user from your project. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas dbusers delete [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - username - - string - - true - - Username to delete from the MongoDB database. The format of the username depends on the user's method of authentication. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --authDB - - string - - false - - Authentication database name. If the user authenticates with AWS IAM, x.509, or LDAP, this value should be $external. If the user authenticates with SCRAM-SHA, this value should be admin. This value defaults to "admin". - * - --force - - - - false - - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. - * - -h, --help - - - - false - - help for delete - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - DB user '' deleted - - -Examples --------- - -.. code-block:: - :copyable: false - - # Delete the SCRAM SHA-authenticating database user named dylan for the project with the ID 5e2211c17a3e5a48f5497de3: - atlas dbusers delete dylan --projectId 5e2211c17a3e5a48f5497de3 - - -.. code-block:: - :copyable: false - - # Delete the AWS IAM-authenticating database user with the ARN arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs for the project with ID 5e2211c17a3e5a48f5497de3. Prepend $external with \ to escape the special-use character: - atlas dbusers delete arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs --authDB \$external --projectId 5e2211c17a3e5a48f5497de3 - - -.. code-block:: - :copyable: false - - # Delete the xLDAP-authenticating database user with the RFC 2253 Distinguished Name CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM for the project with ID 5e2211c17a3e5a48f5497de3. Prepend $external with \ to escape the special-use character: - atlas dbusers delete CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM --authDB \$external --projectId 5e2211c17a3e5a48f5497de3 diff --git a/docs/command/atlas-dbusers-describe.txt b/docs/command/atlas-dbusers-describe.txt deleted file mode 100644 index 275db941a8..0000000000 --- a/docs/command/atlas-dbusers-describe.txt +++ /dev/null @@ -1,121 +0,0 @@ -.. _atlas-dbusers-describe: - -====================== -atlas dbusers describe -====================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return the details for the specified database user for your project. - -To use this command, you must authenticate with a user account or an API key with the Project Read Only role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas dbusers describe [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - username - - string - - true - - Username to retrieve from the MongoDB database. The format of the username depends on the user's method of authentication. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --authDB - - string - - false - - Authentication database name. If the user authenticates with AWS IAM, x.509, or LDAP, this value should be $external. If the user authenticates with SCRAM-SHA, this value should be admin. This value defaults to "admin". - * - -h, --help - - - - false - - help for describe - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - USERNAME DATABASE - - - -Examples --------- - -.. code-block:: - :copyable: false - - # Return the details for the SCRAM SHA-authenticating database user named myDbUser: - atlas dbuser describe myDbUser --authDB admin --output json - - -.. code-block:: - :copyable: false - - # Return the details for the AWS IAM-authenticating database user with the ARN arn:aws:iam::772401394250:user/my-test-user. Prepend $external with \ to escape the special-use character: - atlas dbuser describe arn:aws:iam::772401394250:user/my-test-user --authDB \$external --output json - - -.. code-block:: - :copyable: false - - # Return the details for the X.509-authenticating database user with the RFC 2253 Distinguished Name CN=ellen@example.com,OU=users,DC=example,DC=com. Prepend $external with \ to escape the special-use character: - atlas dbuser describe CN=ellen@example.com,OU=users,DC=example,DC=com --authDB \$external --output json diff --git a/docs/command/atlas-dbusers-list.txt b/docs/command/atlas-dbusers-list.txt deleted file mode 100644 index cebb33b69f..0000000000 --- a/docs/command/atlas-dbusers-list.txt +++ /dev/null @@ -1,92 +0,0 @@ -.. _atlas-dbusers-list: - -================== -atlas dbusers list -================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return all database users for your project. - -To use this command, you must authenticate with a user account or an API key with the Project Read Only role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas dbusers list [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -c, --compact - - - - false - - Flag that enables the compact array response structure for a json output. The --compact option returns array objects as top-level responses and allows backward compatibility for scripts based on previous CLI versions. Omitting the --compact option for a json output returns array objects within a 'results' sub-array. You must specify --output json to use this option. - * - -h, --help - - - - false - - help for list - * - --limit - - int - - false - - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. - * - --omitCount - - - - false - - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --page - - int - - false - - Page number that specifies a page of results. This value defaults to 1. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - # Return a JSON-formatted list of all database users for the project with the ID 5e2211c17a3e5a48f5497de3: - atlas dbusers list --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-dbusers-update.txt b/docs/command/atlas-dbusers-update.txt deleted file mode 100644 index 55583100e8..0000000000 --- a/docs/command/atlas-dbusers-update.txt +++ /dev/null @@ -1,137 +0,0 @@ -.. _atlas-dbusers-update: - -==================== -atlas dbusers update -==================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Modify the details of a database user in your project. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas dbusers update [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - username - - string - - true - - Username to update in the MongoDB database. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --authDB - - string - - false - - Authentication database name. If the user authenticates with AWS IAM, x.509, or LDAP, this value should be $external. If the user authenticates with SCRAM-SHA, this value should be admin. - * - --desc - - string - - false - - Description of this database user. - * - -h, --help - - - - false - - help for update - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - -p, --password - - string - - false - - Password for the database user. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --role - - strings - - false - - User's roles and the databases or collections on which the roles apply. Passing this flag replaces preexisting data. - * - --scope - - strings - - false - - Array of clusters that this user has access to. Passing this flag replaces preexisting data. - * - -u, --username - - string - - false - - Username for authenticating to MongoDB. - * - --x509Type - - string - - false - - X.509 method for authenticating the specified username. Valid values include NONE, MANAGED, and CUSTOMER. If you set this to MANAGED the user authenticates with an Atlas-managed X.509 certificate. If you set this to CUSTOMER, the user authenticates with a self-managed X.509 certificate. This value defaults to "NONE". - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Successfully updated database user ''. - - -Examples --------- - -.. code-block:: - :copyable: false - - # Update roles for a database user named myUser for the project with the ID 5e2211c17a3e5a48f5497de3: - atlas dbuser update myUser --role readWriteAnyDatabase --projectId 5e2211c17a3e5a48f5497de3 - - -.. code-block:: - :copyable: false - - # Update scopes for a database user named myUser for the project with the ID 5e2211c17a3e5a48f5497de3: - atlas dbuser update myUser --scope resourceName:resourceType --projectId 5e2211c17a3e5a48f5497de3 diff --git a/docs/command/atlas-dbusers.txt b/docs/command/atlas-dbusers.txt deleted file mode 100644 index bf2938b99d..0000000000 --- a/docs/command/atlas-dbusers.txt +++ /dev/null @@ -1,73 +0,0 @@ -.. _atlas-dbusers: - -============= -atlas dbusers -============= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage database users for your project. - -The dbusers command retrieves, creates and modifies the MongoDB database users in your project. -Each user has a set of roles that provide access to the project’s databases. -A user’s roles apply to all the clusters in the project. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for dbusers - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-dbusers-certs` - Manage Atlas x509 certificates for your database users. -* :ref:`atlas-dbusers-create` - Create a database user for your project. -* :ref:`atlas-dbusers-delete` - Remove the specified database user from your project. -* :ref:`atlas-dbusers-describe` - Return the details for the specified database user for your project. -* :ref:`atlas-dbusers-list` - Return all database users for your project. -* :ref:`atlas-dbusers-update` - Modify the details of a database user in your project. - - -.. toctree:: - :titlesonly: - - certs - create - delete - describe - list - update - diff --git a/docs/command/atlas-deployments-connect.txt b/docs/command/atlas-deployments-connect.txt deleted file mode 100644 index dad7db2f13..0000000000 --- a/docs/command/atlas-deployments-connect.txt +++ /dev/null @@ -1,98 +0,0 @@ -.. _atlas-deployments-connect: - -========================= -atlas deployments connect -========================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Connect to a deployment that is running locally or in Atlas. If the deployment is paused, make sure to run atlas deployments start first. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas deployments connect [deploymentName] [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - deploymentName - - string - - false - - Name of the deployment that you want to connect to. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --connectWith - - string - - false - - Method for connecting to the deployment. Valid values are compass, connectionString and mongosh. - * - --connectionStringType - - string - - false - - Type of connection string. If you specify 'private', this option retrieves the connection string for the network peering endpoint. If you specify 'privateEndpoint', this option retrieves the shard optimized connection strings for the private endpoints. This value defaults to "standard". - * - -h, --help - - - - false - - help for connect - * - --password - - string - - false - - Password for the user. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --type - - string - - false - - Type of deployment. Valid values are ATLAS or LOCAL. - * - --username - - string - - false - - Username for authenticating to MongoDB. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - diff --git a/docs/command/atlas-deployments-delete.txt b/docs/command/atlas-deployments-delete.txt deleted file mode 100644 index c5045c6a38..0000000000 --- a/docs/command/atlas-deployments-delete.txt +++ /dev/null @@ -1,133 +0,0 @@ -.. _atlas-deployments-delete: - -======================== -atlas deployments delete -======================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Delete a deployment. - -The command prompts you to confirm the operation when you run the command without the --force option. - -Deleting an Atlas deployment also deletes any backup snapshots for that cluster. -Deleting a Local deployment also deletes any local data volumes. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas deployments delete [deploymentName] [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - deploymentName - - string - - false - - Name of the deployment that you want to delete. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --force - - - - false - - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. - * - -h, --help - - - - false - - help for delete - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --type - - string - - false - - Type of deployment. Valid values are ATLAS or LOCAL. - * - -w, --watch - - - - false - - Flag that indicates whether to watch the command until it completes its execution or the watch times out. To set the time that the watch times out, use the --watchTimeout option. - * - --watchTimeout - - int - - false - - Time in seconds until a watch times out. After a watch times out, the CLI no longer watches the command. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Deployment '' deleted - - -Examples --------- - -.. code-block:: - :copyable: false - - # Remove an Atlas deployment named myDeployment after prompting for a confirmation: - atlas deployments delete myDeployment --type ATLAS - - -.. code-block:: - :copyable: false - - # Remove an Atlas deployment named myDeployment without requiring confirmation: - atlas deployments delete myDeployment --type ATLAS --force - - -.. code-block:: - :copyable: false - - # Remove an Local deployment named myDeployment without requiring confirmation: - atlas deployments delete myDeployment --type LOCAL --force diff --git a/docs/command/atlas-deployments-list.txt b/docs/command/atlas-deployments-list.txt deleted file mode 100644 index 6cd4592154..0000000000 --- a/docs/command/atlas-deployments-list.txt +++ /dev/null @@ -1,73 +0,0 @@ -.. _atlas-deployments-list: - -====================== -atlas deployments list -====================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return all deployments. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas deployments list [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for list - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - NAME TYPE MDB VER STATE - - - diff --git a/docs/command/atlas-deployments-logs.txt b/docs/command/atlas-deployments-logs.txt deleted file mode 100644 index 9d4c889676..0000000000 --- a/docs/command/atlas-deployments-logs.txt +++ /dev/null @@ -1,94 +0,0 @@ -.. _atlas-deployments-logs: - -====================== -atlas deployments logs -====================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Get deployment logs. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas deployments logs [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --deploymentName - - string - - false - - Name of the deployment. - * - --end - - int - - false - - Ending date and time for the range of log messages to retrieve, given in UNIX time. Defaults to the start date plus 24 hours, if the start date is set. If start date is not provided, ending time defaults to the current time. - * - --force - - - - false - - Flag that indicates whether to overwrite the destination file. - * - -h, --help - - - - false - - help for logs - * - --hostname - - string - - false - - Name of the host that stores the log files that you want to download. - * - --name - - string - - false - - Name of the log file (e.g. mongodb.gz|mongos.gz|mongosqld.gz|mongodb-audit-log.gz|mongos-audit-log.gz). - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --start - - int - - false - - UNIX Epoch-formatted starting date and time for the range of log messages to retrieve. This value defaults to 24 hours prior to the current timestamp. - * - --type - - string - - false - - Type of deployment. Valid values are ATLAS or LOCAL. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - diff --git a/docs/command/atlas-deployments-pause.txt b/docs/command/atlas-deployments-pause.txt deleted file mode 100644 index 0508178d28..0000000000 --- a/docs/command/atlas-deployments-pause.txt +++ /dev/null @@ -1,92 +0,0 @@ -.. _atlas-deployments-pause: - -======================= -atlas deployments pause -======================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Pause a deployment. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas deployments pause [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - deploymentName - - string - - true - - Name of the deployment. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for pause - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --type - - string - - false - - Type of deployment. Valid values are ATLAS or LOCAL. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Pausing deployment ''. - - diff --git a/docs/command/atlas-deployments-search-indexes-create.txt b/docs/command/atlas-deployments-search-indexes-create.txt deleted file mode 100644 index 6948f1a187..0000000000 --- a/docs/command/atlas-deployments-search-indexes-create.txt +++ /dev/null @@ -1,120 +0,0 @@ -.. _atlas-deployments-search-indexes-create: - -======================================= -atlas deployments search indexes create -======================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create a search index for the specified deployment. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas deployments search indexes create [indexName] [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - indexName - - string - - false - - Name of the index. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --collection - - string - - false - - Name of the collection. - - Mutually exclusive with --file. - * - --db - - string - - false - - Name of the database. - - Mutually exclusive with --file. - * - --deploymentName - - string - - false - - Name of the deployment. - * - -f, --file - - string - - false - - Name of the JSON index configuration file to use. To learn about the Atlas Search and Atlas Vector Search index configuration file, see https://dochub.mongodb.org/core/search-index-config-file-atlascli. To learn about the Atlas Search index syntax and options that you can define in your configuration file, see https://dochub.mongodb.org/core/index-definitions-fts. To learn about the Atlas Vector Search index syntax and options that you can define in your configuration file, see https://dochub.mongodb.org/core/index-definition-avs. - - Mutually exclusive with --db, --collection. - * - -h, --help - - - - false - - help for create - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --password - - string - - false - - Password for the user. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --type - - string - - false - - Type of deployment. Valid values are ATLAS or LOCAL. - * - --username - - string - - false - - Username for authenticating to MongoDB. - * - -w, --watch - - - - false - - Flag that indicates whether to watch the command until it completes its execution or the watch times out. To set the time that the watch times out, use the --watchTimeout option. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - diff --git a/docs/command/atlas-deployments-search-indexes-delete.txt b/docs/command/atlas-deployments-search-indexes-delete.txt deleted file mode 100644 index 49f5287e6b..0000000000 --- a/docs/command/atlas-deployments-search-indexes-delete.txt +++ /dev/null @@ -1,111 +0,0 @@ -.. _atlas-deployments-search-indexes-delete: - -======================================= -atlas deployments search indexes delete -======================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Delete the specified search index from the specified deployment. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas deployments search indexes delete [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - indexId - - string - - true - - ID of the index. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --deploymentName - - string - - false - - Name of the deployment. - * - --force - - - - false - - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. - * - -h, --help - - - - false - - help for delete - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --password - - string - - false - - Password for the user. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --type - - string - - false - - Type of deployment. Valid values are ATLAS or LOCAL. - * - --username - - string - - false - - Username for authenticating to MongoDB. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Index '' deleted - diff --git a/docs/command/atlas-deployments-search-indexes-describe.txt b/docs/command/atlas-deployments-search-indexes-describe.txt deleted file mode 100644 index fef7fb2e84..0000000000 --- a/docs/command/atlas-deployments-search-indexes-describe.txt +++ /dev/null @@ -1,109 +0,0 @@ -.. _atlas-deployments-search-indexes-describe: - -========================================= -atlas deployments search indexes describe -========================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Describe a search index for the specified deployment. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas deployments search indexes describe [indexId] [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - indexId - - string - - false - - ID of the index. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --deploymentName - - string - - false - - Name of the deployment. - * - -h, --help - - - - false - - help for describe - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --password - - string - - false - - Password for the user. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --type - - string - - false - - Type of deployment. Valid values are ATLAS or LOCAL. - * - --username - - string - - false - - Username for authenticating to MongoDB. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - ID NAME DATABASE COLLECTION STATUS TYPE - - - diff --git a/docs/command/atlas-deployments-search-indexes-list.txt b/docs/command/atlas-deployments-search-indexes-list.txt deleted file mode 100644 index 75ba7080a4..0000000000 --- a/docs/command/atlas-deployments-search-indexes-list.txt +++ /dev/null @@ -1,101 +0,0 @@ -.. _atlas-deployments-search-indexes-list: - -===================================== -atlas deployments search indexes list -===================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -List all Atlas Search indexes for a deployment. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas deployments search indexes list [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --collection - - string - - false - - Name of the collection. - * - --db - - string - - false - - Name of the database. - * - --deploymentName - - string - - false - - Name of the deployment. - * - -h, --help - - - - false - - help for list - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --password - - string - - false - - Password for the user. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --type - - string - - false - - Type of deployment. Valid values are ATLAS or LOCAL. - * - --username - - string - - false - - Username for authenticating to MongoDB. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - ID NAME DATABASE COLLECTION STATUS TYPE - - - diff --git a/docs/command/atlas-deployments-search-indexes.txt b/docs/command/atlas-deployments-search-indexes.txt deleted file mode 100644 index e585c945e0..0000000000 --- a/docs/command/atlas-deployments-search-indexes.txt +++ /dev/null @@ -1,65 +0,0 @@ -.. _atlas-deployments-search-indexes: - -================================ -atlas deployments search indexes -================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage cloud and local search indexes. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for indexes - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-deployments-search-indexes-create` - Create a search index for the specified deployment. -* :ref:`atlas-deployments-search-indexes-delete` - Delete the specified search index from the specified deployment. -* :ref:`atlas-deployments-search-indexes-describe` - Describe a search index for the specified deployment. -* :ref:`atlas-deployments-search-indexes-list` - List all Atlas Search indexes for a deployment. - - -.. toctree:: - :titlesonly: - - create - delete - describe - list - diff --git a/docs/command/atlas-deployments-search.txt b/docs/command/atlas-deployments-search.txt deleted file mode 100644 index dc0b73c8b1..0000000000 --- a/docs/command/atlas-deployments-search.txt +++ /dev/null @@ -1,59 +0,0 @@ -.. _atlas-deployments-search: - -======================== -atlas deployments search -======================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage search for cloud and local deployments. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for search - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-deployments-search-indexes` - Manage cloud and local search indexes. - - -.. toctree:: - :titlesonly: - - indexes - diff --git a/docs/command/atlas-deployments-setup.txt b/docs/command/atlas-deployments-setup.txt deleted file mode 100644 index fce53c6e86..0000000000 --- a/docs/command/atlas-deployments-setup.txt +++ /dev/null @@ -1,154 +0,0 @@ -.. _atlas-deployments-setup: - -======================= -atlas deployments setup -======================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create a local deployment. - -To learn more about local atlas deployments, see https://www.mongodb.com/docs/atlas/cli/current/atlas-cli-deploy-local/ - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas deployments setup [deploymentName] [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - deploymentName - - string - - false - - Name of the deployment that you want to set up. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --accessListIp - - strings - - false - - IP address to grant access to the deployment. - - Mutually exclusive with --currentIp. - * - --bindIpAll - - - - false - - Flag that indicates whether the LOCAL deployment port binding should happen for all IPs or only for the localhost interface 127.0.0.1. - * - --connectWith - - string - - false - - Method for connecting to the deployment. Valid values are compass, mongosh and skip. - - Mutually exclusive with --skipMongosh. - * - --currentIp - - - - false - - Flag that adds the IP address from the host that is currently executing the command to the access list. - - Mutually exclusive with --accessListIp. - * - --enableTerminationProtection - - - - false - - Enables termination protection for your deployment. You can't delete a deployment with termination protection enabled. - * - --force - - - - false - - Flag that indicates whether to skip the request for input and create a deployment with the default settings for any unspecified options. - * - -h, --help - - - - false - - help for setup - * - --initdb - - string - - false - - Flag that uses a folder to be mapped into LOCAL deployment for initialization - * - --mdbVersion - - string - - false - - Major MongoDB version of the deployment. - * - --password - - string - - false - - Password for the user. - * - --port - - int - - false - - Port that the MongoDB server listens to for client connections. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --provider - - string - - false - - Name of your cloud service provider. Valid values are AWS, AZURE, or GCP. - * - -r, --region - - string - - false - - Physical location of your MongoDB deployment. For a complete list of supported AWS regions, see: https://dochub.mongodb.org/core/aws-atlas. For a complete list of supported Azure regions, see: https://dochub.mongodb.org/core/azure-atlas. For a complete list of supported GCP regions, see: https://dochub.mongodb.org/core/gcp-atlas. - * - --skipSampleData - - - - false - - Flag that indicates whether to skip loading sample data into your MongoDB deployment. - * - --tag - - key=value - - false - - List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the deployment. - * - --tier - - string - - false - - Tier for each data-bearing server in the deployment. To learn more about cluster tiers, see https://dochub.mongodb.org/core/cluster-tier-atlas. This value defaults to "M0". - * - --type - - string - - false - - Type of deployment that you want to create. Valid values are ATLAS or LOCAL. - * - --username - - string - - false - - Username for authenticating to MongoDB. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - diff --git a/docs/command/atlas-deployments-start.txt b/docs/command/atlas-deployments-start.txt deleted file mode 100644 index 803e81ada9..0000000000 --- a/docs/command/atlas-deployments-start.txt +++ /dev/null @@ -1,95 +0,0 @@ -.. _atlas-deployments-start: - -======================= -atlas deployments start -======================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Start a deployment. - -After you stop a machine, it goes into sleep mode, or restarts. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas deployments start [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - deploymentName - - string - - true - - Name of the deployment. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for start - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --type - - string - - false - - Type of deployment. Valid values are ATLAS or LOCAL. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - - Starting deployment ''. - - diff --git a/docs/command/atlas-deployments.txt b/docs/command/atlas-deployments.txt deleted file mode 100644 index fea6b69c08..0000000000 --- a/docs/command/atlas-deployments.txt +++ /dev/null @@ -1,73 +0,0 @@ -.. _atlas-deployments: - -================= -atlas deployments -================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage cloud and local deployments. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for deployments - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-deployments-connect` - Connect to a deployment that is running locally or in Atlas. If the deployment is paused, make sure to run atlas deployments start first. -* :ref:`atlas-deployments-delete` - Delete a deployment. -* :ref:`atlas-deployments-list` - Return all deployments. -* :ref:`atlas-deployments-logs` - Get deployment logs. -* :ref:`atlas-deployments-pause` - Pause a deployment. -* :ref:`atlas-deployments-search` - Manage search for cloud and local deployments. -* :ref:`atlas-deployments-setup` - Create a local deployment. -* :ref:`atlas-deployments-start` - Start a deployment. - - -.. toctree:: - :titlesonly: - - connect - delete - list - logs - pause - search - setup - start - diff --git a/docs/command/atlas-events-organizations-list.txt b/docs/command/atlas-events-organizations-list.txt deleted file mode 100644 index 86fc6039d1..0000000000 --- a/docs/command/atlas-events-organizations-list.txt +++ /dev/null @@ -1,105 +0,0 @@ -.. _atlas-events-organizations-list: - -=============================== -atlas events organizations list -=============================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return all events for the specified organization. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas events organizations list [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for list - * - --limit - - int - - false - - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. - * - --maxDate - - string - - false - - Maximum created date. This option returns events whose created date is less than or equal to the specified value. This parameter uses the ISO 8601 timestamp format in UTC. - * - --minDate - - string - - false - - Minimum created date. This option returns events whose created date is greater than or equal to the specified value. This parameter uses the ISO 8601 timestamp format in UTC. - * - --omitCount - - - - false - - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. - * - --orgId - - string - - false - - Organization ID to use. This option overrides the settings in the configuration file or environment variable. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --page - - int - - false - - Page number that specifies a page of results. This value defaults to 1. - * - --type - - strings - - false - - Type of event that triggered the alert. To learn which values the CLI accepts, see the Enum for eventTypeName in the Atlas Admin API spec: https://dochub.mongodb.org/core/atlas-event-names. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - # Return a JSON-formatted list of events for the organization with the ID 5dd5a6b6f10fab1d71a58495: - atlas events organizations list --orgId 5dd5a6b6f10fab1d71a58495 --output json - - -.. code-block:: - :copyable: false - - # Return a JSON-formatted list of events between 2024-03-18T14:40:03-0000 and 2024-03-18T15:00:03-0000 and for the project with the ID 5e2211c17a3e5a48f5497de3 - atlas events projects list --output json --projectId 5e2211c17a3e5a48f5497de3 --minDate 2024-03-18T14:40:03-0000 --maxDate 2024-03-18T15:00:03-0000 diff --git a/docs/command/atlas-events-organizations.txt b/docs/command/atlas-events-organizations.txt deleted file mode 100644 index aca25de921..0000000000 --- a/docs/command/atlas-events-organizations.txt +++ /dev/null @@ -1,61 +0,0 @@ -.. _atlas-events-organizations: - -========================== -atlas events organizations -========================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Organization operations. - -List organization events. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for organizations - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-events-organizations-list` - Return all events for the specified organization. - - -.. toctree:: - :titlesonly: - - list - diff --git a/docs/command/atlas-events-projects-list.txt b/docs/command/atlas-events-projects-list.txt deleted file mode 100644 index 06ea1ee489..0000000000 --- a/docs/command/atlas-events-projects-list.txt +++ /dev/null @@ -1,105 +0,0 @@ -.. _atlas-events-projects-list: - -========================== -atlas events projects list -========================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return all events for the specified project. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas events projects list [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for list - * - --limit - - int - - false - - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. - * - --maxDate - - string - - false - - Maximum created date. This option returns events whose created date is less than or equal to the specified value. This parameter uses the ISO 8601 timestamp format in UTC. - * - --minDate - - string - - false - - Minimum created date. This option returns events whose created date is greater than or equal to the specified value. This parameter uses the ISO 8601 timestamp format in UTC. - * - --omitCount - - - - false - - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --page - - int - - false - - Page number that specifies a page of results. This value defaults to 1. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --type - - strings - - false - - Type of event that triggered the alert. To learn which values the CLI accepts, see the Enum for eventTypeName in the Atlas Admin API spec: https://dochub.mongodb.org/core/atlas-event-names. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - # Return a JSON-formatted list of events for the project with the ID 5e2211c17a3e5a48f5497de3: - atlas events projects list --Id 5e2211c17a3e5a48f5497de3 --output json - - -.. code-block:: - :copyable: false - - # Return a JSON-formatted list of events between 2024-03-18T14:40:03-0000 and 2024-03-18T15:00:03-0000 and for the project with the ID 5e2211c17a3e5a48f5497de3 - atlas events projects list --output json --projectId 5e2211c17a3e5a48f5497de3 --minDate 2024-03-18T14:40:03-0000 --maxDate 2024-03-18T15:00:03-0000 diff --git a/docs/command/atlas-events-projects.txt b/docs/command/atlas-events-projects.txt deleted file mode 100644 index 1eeef0b881..0000000000 --- a/docs/command/atlas-events-projects.txt +++ /dev/null @@ -1,61 +0,0 @@ -.. _atlas-events-projects: - -===================== -atlas events projects -===================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Project operations. - -List projects events. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for projects - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-events-projects-list` - Return all events for the specified project. - - -.. toctree:: - :titlesonly: - - list - diff --git a/docs/command/atlas-events.txt b/docs/command/atlas-events.txt deleted file mode 100644 index 83e44e0a93..0000000000 --- a/docs/command/atlas-events.txt +++ /dev/null @@ -1,61 +0,0 @@ -.. _atlas-events: - -============ -atlas events -============ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage events for your organization or project. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for events - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-events-organizations` - Organization operations. -* :ref:`atlas-events-projects` - Project operations. - - -.. toctree:: - :titlesonly: - - organizations - projects - diff --git a/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-connect.txt b/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-connect.txt deleted file mode 100644 index 849ea4f68f..0000000000 --- a/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-connect.txt +++ /dev/null @@ -1,93 +0,0 @@ -.. _atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-connect: - -============================================================================ -atlas federatedAuthentication federationSettings connectedOrgConfigs connect -============================================================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Connect an Identity Provider to an Organization. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas federatedAuthentication federationSettings connectedOrgConfigs connect [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --federationSettingsId - - string - - true - - Unique 24-hexadecimal digit string that identifies the federation settings. - * - -h, --help - - - - false - - help for connect - * - --identityProviderId - - string - - true - - Unique identifier of the identity provider. - * - --orgId - - string - - false - - Organization ID to use. This option overrides the settings in the configuration file or environment variable. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --protocol - - string - - false - - Protocol used to authenticate the user. Valid value is OIDC or SAML. This value defaults to "OIDC". - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - # Connect the current profile org to identity provider with ID 7d1113b25a115342acc2d1aa and federationSettingsId 5d1113b25a115342acc2d1aa - atlas federatedAuthentication federationSettings connectedOrgConfigs connect --identityProviderId 7d1113b25a115342acc2d1aa --federationSettingsId 5d1113b25a115342acc2d1aa - -.. code-block:: - :copyable: false - - # Connect the org with ID 7d1113b25a115342acc2d1aa to identity provider with ID 7d1113b25a115342acc2d1aa and federationSettingsId 5d1113b25a115342acc2d1aa - atlas federatedAuthentication federationSettings connectedOrgConfigs connect --orgId 7d1113b25a115342acc2d1aa --identityProviderId 7d1113b25a115342acc2d1aa --federationSettingsId 5d1113b25a115342acc2d1aa - diff --git a/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-delete.txt b/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-delete.txt deleted file mode 100644 index 47ac1a50b4..0000000000 --- a/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-delete.txt +++ /dev/null @@ -1,89 +0,0 @@ -.. _atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-delete: - -=========================================================================== -atlas federatedAuthentication federationSettings connectedOrgConfigs delete -=========================================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Delete a connected org config Organization. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas federatedAuthentication federationSettings connectedOrgConfigs delete [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --federationSettingsId - - string - - true - - Unique 24-hexadecimal digit string that identifies the federation settings. - * - --force - - - - false - - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. - * - -h, --help - - - - false - - help for delete - * - --orgId - - string - - false - - Organization ID to use. This option overrides the settings in the configuration file or environment variable. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - # Delete a connected org config from the current profile org and federationSettingsId 5d1113b25a115342acc2d1aa - atlas federatedAuthentication federationSettings connectedOrgConfigs delete --federationSettingsId 5d1113b25a115342acc2d1aa - -.. code-block:: - :copyable: false - - # Delete a connected org config from the org with ID 7d1113b25a115342acc2d1aa and federationSettingsId 5d1113b25a115342acc2d1aa - atlas federatedAuthentication federationSettings connectedOrgConfigs delete --orgId 7d1113b25a115342acc2d1aa --federationSettingsId 5d1113b25a115342acc2d1aa - diff --git a/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-describe.txt b/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-describe.txt deleted file mode 100644 index 0986820f52..0000000000 --- a/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-describe.txt +++ /dev/null @@ -1,85 +0,0 @@ -.. _atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-describe: - -============================================================================= -atlas federatedAuthentication federationSettings connectedOrgConfigs describe -============================================================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Describe a Connected Org Config. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas federatedAuthentication federationSettings connectedOrgConfigs describe [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --federationSettingsId - - string - - true - - Unique 24-hexadecimal digit string that identifies the federation settings. - * - -h, --help - - - - false - - help for describe - * - --orgId - - string - - false - - Organization ID to use. This option overrides the settings in the configuration file or environment variable. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - # Describe a connected org config from the current profile org and federationSettingsId 5d1113b25a115342acc2d1aa - atlas federatedAuthentication federationSettings connectedOrgConfigsConfig describe --federationSettingsId 5d1113b25a115342acc2d1aa - -.. code-block:: - :copyable: false - - # Describe a connected org config from the org with ID 7d1113b25a115342acc2d1aa and federationSettingsId 5d1113b25a115342acc2d1aa - atlas federatedAuthentication federationSettings connectedOrgConfigs describe --orgId 7d1113b25a115342acc2d1aa --federationSettingsId 5d1113b25a115342acc2d1aa - diff --git a/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-disconnect.txt b/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-disconnect.txt deleted file mode 100644 index aa8916a3f1..0000000000 --- a/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-disconnect.txt +++ /dev/null @@ -1,102 +0,0 @@ -.. _atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-disconnect: - -=============================================================================== -atlas federatedAuthentication federationSettings connectedOrgConfigs disconnect -=============================================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Connect an Identity Provider to an Organization. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas federatedAuthentication federationSettings connectedOrgConfigs disconnect [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --federationSettingsId - - string - - true - - Unique 24-hexadecimal digit string that identifies the federation settings. - * - -h, --help - - - - false - - help for disconnect - * - --identityProviderId - - string - - true - - Unique identifier of the identity provider. - * - --orgId - - string - - false - - Organization ID to use. This option overrides the settings in the configuration file or environment variable. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --protocol - - string - - false - - Protocol used to authenticate the user. Valid value is OIDC or SAML. This value defaults to "OIDC". - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Org Configs disconnected. - -Examples --------- - -.. code-block:: - :copyable: false - - # Disconnect the current profile org from identity provider with ID 5d1113b25a115342acc2d1aa and federationSettingsId 7d1113b25a115342acc2d1aa - atlas federatedAuthentication federationSettings connectedOrgConfigs disconnect --identityProviderId 5d1113b25a115342acc2d1aa --federationSettingsId 7d1113b25a115342acc2d1aa - -.. code-block:: - :copyable: false - - # Disconnect the org with ID 7d1113b25a115342acc2d1aa to identity provider with ID 5d1113b25a115342acc2d1aa and federationSettingsId 7d1113b25a115342acc2d1aa - atlas federatedAuthentication federationSettings connectedOrgConfigs disconnect --orgId 7d1113b25a115342acc2d1aa --identityProviderId 5d1113b25a115342acc2d1aa --federationSettingsId 7d1113b25a115342acc2d1aa - diff --git a/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-list.txt b/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-list.txt deleted file mode 100644 index 7093c3112f..0000000000 --- a/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-list.txt +++ /dev/null @@ -1,87 +0,0 @@ -.. _atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-list: - -========================================================================= -atlas federatedAuthentication federationSettings connectedOrgConfigs list -========================================================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Describe a Connected Org Config. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas federatedAuthentication federationSettings connectedOrgConfigs list [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --federationSettingsId - - string - - true - - Unique 24-hexadecimal digit string that identifies the federation settings. - * - -h, --help - - - - false - - help for list - * - --limit - - int - - false - - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. - * - --orgId - - string - - false - - Organization ID to use. This option overrides the settings in the configuration file or environment variable. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --page - - int - - false - - Page number that specifies a page of results. This value defaults to 1. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - # List all connected org config with federationSettingsId 5d1113b25a115342acc2d1aa - atlas federatedAuthentication federationSettings connectedOrgsConfig list --federationSettingsId 5d1113b25a115342acc2d1aa - diff --git a/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-update.txt b/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-update.txt deleted file mode 100644 index bb07cefed4..0000000000 --- a/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-update.txt +++ /dev/null @@ -1,83 +0,0 @@ -.. _atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-update: - -=========================================================================== -atlas federatedAuthentication federationSettings connectedOrgConfigs update -=========================================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Update One Org Config Connected to One Federation Setting. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas federatedAuthentication federationSettings connectedOrgConfigs update [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --federationSettingsId - - string - - true - - Unique 24-hexadecimal digit string that identifies the federation settings. - * - --file - - string - - true - - Path to a JSON configuration file that defines connected orgs configurations. To learn more about connected org configuration file format, see the request body in https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/updateConnectedOrgConfig. - * - -h, --help - - - - false - - help for update - * - --orgId - - string - - false - - Organization ID to use. This option overrides the settings in the configuration file or environment variable. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - # Update the connected orgs config with the current profile org and federationSettingsId 5d1113b25a115342acc2d1aa using the JSON configuration file config.json - atlas federatedAuthentication federationSettings connectedOrgConfigs update --federationSettingsId 5d1113b25a115342acc2d1aa --file config.json - diff --git a/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs.txt b/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs.txt deleted file mode 100644 index 5f21f5853f..0000000000 --- a/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs.txt +++ /dev/null @@ -1,69 +0,0 @@ -.. _atlas-federatedAuthentication-federationSettings-connectedOrgConfigs: - -==================================================================== -atlas federatedAuthentication federationSettings connectedOrgConfigs -==================================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage Atlas Federated Authentication Connected Orgs Config - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for connectedOrgConfigs - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-connect` - Connect an Identity Provider to an Organization. -* :ref:`atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-delete` - Delete a connected org config Organization. -* :ref:`atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-describe` - Describe a Connected Org Config. -* :ref:`atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-disconnect` - Connect an Identity Provider to an Organization. -* :ref:`atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-list` - Describe a Connected Org Config. -* :ref:`atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-update` - Update One Org Config Connected to One Federation Setting. - - -.. toctree:: - :titlesonly: - - connect - delete - describe - disconnect - list - update - diff --git a/docs/command/atlas-federatedAuthentication-federationSettings-describe.txt b/docs/command/atlas-federatedAuthentication-federationSettings-describe.txt deleted file mode 100644 index faa2be9d24..0000000000 --- a/docs/command/atlas-federatedAuthentication-federationSettings-describe.txt +++ /dev/null @@ -1,87 +0,0 @@ -.. _atlas-federatedAuthentication-federationSettings-describe: - -========================================================= -atlas federatedAuthentication federationSettings describe -========================================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return the Federation Settings details for the specified organization. - -To use this command, you must authenticate with a user account or an API key with the Organization Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas federatedAuthentication federationSettings describe [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for describe - * - --orgId - - string - - false - - Organization ID to use. This option overrides the settings in the configuration file or environment variable. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - ID IDENTITY PROVIDER ID IDENTITY PROVIDER STATUS - - - -Examples --------- - -.. code-block:: - :copyable: false - - # Return the JSON-formatted Federation Settings details: - atlas federatedAuthentication federationSettings describe --orgId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-create-oidc.txt b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-create-oidc.txt deleted file mode 100644 index c7b34f68d1..0000000000 --- a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-create-oidc.txt +++ /dev/null @@ -1,141 +0,0 @@ -.. _atlas-federatedAuthentication-federationSettings-identityProvider-create-oidc: - -============================================================================= -atlas federatedAuthentication federationSettings identityProvider create oidc -============================================================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create an OIDC identity provider. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas federatedAuthentication federationSettings identityProvider create oidc [displayName] [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - displayName - - string - - false - - The Identity Provider display name. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --associatedDomain - - strings - - false - - List of domains associated with the Identity Provider. - * - --audience - - string - - true - - Identifier of the intended recipient of the token. - * - --authorizationType - - string - - true - - Type of authorization. Valid values are NONE, JWT, or SAML. - * - --clientId - - string - - false - - Client identifier that is assigned to an application by the Identity Provider. - * - --desc - - string - - true - - Description of the Identity Provider. - * - --federationSettingsId - - string - - true - - Unique 24-hexadecimal digit string that identifies the federation settings. - * - --groupsClaim - - string - - true - - Identifier of the claim which contains IdP Group IDs in the token. - * - -h, --help - - - - false - - help for oidc - * - --idpType - - string - - true - - Type of Identity Provider. Valid values are WORKFORCE or WORKLOAD. - * - --issuerUri - - string - - true - - Unique string that identifies the issuer of the OIDC metadata/discovery document URL. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --requestedScope - - strings - - false - - Scopes that MongoDB applications will request from the authorization endpoint. - * - --userClaim - - string - - true - - Identifier of the claim which contains the user ID in the token. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Identity provider '' created. - - -Examples --------- - -.. code-block:: - :copyable: false - - # Create an identity provider with name IDPName and from your federation settings with federationSettingsId 5d1113b25a115342acc2d1aa. - atlas federatedAuthentication federationSettings identityProvider create oidc IDPName --audience "audience" --authorizationType "GROUP" --clientId clientId --desc "IDPName test" --federationSettingsId "5d1113b25a115342acc2d1aa" --groupsClaim "groups" --idpType "WORKLOAD" --issuerUri uri" --userClaim "user" --associatedDomain "domain" - diff --git a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-create.txt b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-create.txt deleted file mode 100644 index 58d31e6349..0000000000 --- a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-create.txt +++ /dev/null @@ -1,59 +0,0 @@ -.. _atlas-federatedAuthentication-federationSettings-identityProvider-create: - -======================================================================== -atlas federatedAuthentication federationSettings identityProvider create -======================================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create Federated Authentication Identity Providers. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for create - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-federatedAuthentication-federationSettings-identityProvider-create-oidc` - Create an OIDC identity provider. - - -.. toctree:: - :titlesonly: - - oidc - diff --git a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-delete.txt b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-delete.txt deleted file mode 100644 index c0aaad11b2..0000000000 --- a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-delete.txt +++ /dev/null @@ -1,107 +0,0 @@ -.. _atlas-federatedAuthentication-federationSettings-identityProvider-delete: - -======================================================================== -atlas federatedAuthentication federationSettings identityProvider delete -======================================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Remove the specified identity provider from your federation settings. - -To use this command, you must authenticate with a user account or an API key with the Org Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas federatedAuthentication federationSettings identityProvider delete [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - identityProviderId - - string - - true - - ID of the identityProvider. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --federationSettingsId - - string - - true - - Unique 24-hexadecimal digit string that identifies the federation settings. - * - --force - - - - false - - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. - * - -h, --help - - - - false - - help for delete - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Identity provider '' deleted - - -Examples --------- - -.. code-block:: - :copyable: false - - # elete the identity provider with ID aa2223b25a115342acc1f108 from your federation settings with federationSettingsId 5d1113b25a115342acc2d1aa. - atlas federatedAuthentication federationSettings identityProvider delete aa2223b25a115342acc1f108 --federationSettingsId 5d1113b25a115342acc2d1aa - diff --git a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-describe.txt b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-describe.txt deleted file mode 100644 index 1977c6cda7..0000000000 --- a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-describe.txt +++ /dev/null @@ -1,104 +0,0 @@ -.. _atlas-federatedAuthentication-federationSettings-identityProvider-describe: - -========================================================================== -atlas federatedAuthentication federationSettings identityProvider describe -========================================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Describe the specified identity provider from your federation settings. - -To use this command, you must authenticate with a user account or an API key with the Org Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas federatedAuthentication federationSettings identityProvider describe [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - identityProviderId - - string - - true - - ID of the identityProvider. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --federationSettingsId - - string - - true - - Unique 24-hexadecimal digit string that identifies the federation settings. - * - -h, --help - - - - false - - help for describe - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - ID DISPLAY NAME ISSUER URI CLIENT ID IDP TYPE - - - -Examples --------- - -.. code-block:: - :copyable: false - - # Describe the identity provider with ID aa2223b25a115342acc1f108 with federationSettingsId 5d1113b25a115342acc2d1aa. - atlas federatedAuthentication federationSettings identityProvider describe aa2223b25a115342acc1f108 --federationSettingsId 5d1113b25a115342acc2d1aa - diff --git a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-list.txt b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-list.txt deleted file mode 100644 index e0a92bbcd7..0000000000 --- a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-list.txt +++ /dev/null @@ -1,104 +0,0 @@ -.. _atlas-federatedAuthentication-federationSettings-identityProvider-list: - -====================================================================== -atlas federatedAuthentication federationSettings identityProvider list -====================================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -List the identity providers from your federation settings. - -To use this command, you must authenticate with a user account or an API key with the Org Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas federatedAuthentication federationSettings identityProvider list [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --federationSettingsId - - string - - true - - Unique 24-hexadecimal digit string that identifies the federation settings. - * - -h, --help - - - - false - - help for list - * - --idpType - - string - - false - - Type of Identity Provider. Valid values are WORKFORCE or WORKLOAD. This value defaults to "WORKFORCE". - * - --limit - - int - - false - - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --page - - int - - false - - Page number that specifies a page of results. This value defaults to 1. - * - --protocol - - string - - false - - Protocol used to authenticate the user. Valid value is OIDC or SAML. This value defaults to "OIDC". - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - ID DISPLAY NAME ISSUER URI CLIENT ID IDP TYPE - - - -Examples --------- - -.. code-block:: - :copyable: false - - # List the identity providers from your federation settings with federationSettingsId 5d1113b25a115342acc2d1aa and idpType WORKLOAD - atlas federatedAuthentication federationSettings identityProvider list --federationSettingsId 5d1113b25a115342acc2d1aa --idpType WORKLOAD - diff --git a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-revokeJwk.txt b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-revokeJwk.txt deleted file mode 100644 index 99f29fd56a..0000000000 --- a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-revokeJwk.txt +++ /dev/null @@ -1,93 +0,0 @@ -.. _atlas-federatedAuthentication-federationSettings-identityProvider-revokeJwk: - -=========================================================================== -atlas federatedAuthentication federationSettings identityProvider revokeJwk -=========================================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Revoke the JWK token from the specified identity provider from your federation settings. - -To use this command, you must authenticate with a user account or an API key with the Org Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas federatedAuthentication federationSettings identityProvider revokeJwk [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - identityProviderId - - string - - true - - ID of the identityProvider. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --federationSettingsId - - string - - true - - Unique 24-hexadecimal digit string that identifies the federation settings. - * - -h, --help - - - - false - - help for revokeJwk - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - # Revoke the Jwk from the identity provider with ID aa2223b25a115342acc1f108 and federation settings with federationSettingsId 5d1113b25a115342acc2d1aa. - atlas federatedAuthentication federationSettings identityProvider revokeJwk aa2223b25a115342acc1f108 --federationSettingsId 5d1113b25a115342acc2d1aa - diff --git a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-update-oidc.txt b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-update-oidc.txt deleted file mode 100644 index f760448046..0000000000 --- a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-update-oidc.txt +++ /dev/null @@ -1,141 +0,0 @@ -.. _atlas-federatedAuthentication-federationSettings-identityProvider-update-oidc: - -============================================================================= -atlas federatedAuthentication federationSettings identityProvider update oidc -============================================================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Update an OIDC identity provider. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas federatedAuthentication federationSettings identityProvider update oidc [identityProviderId] [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - identityProviderId - - string - - false - - The Identity Provider ID. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --associatedDomain - - strings - - false - - List of domains associated with the Identity Provider. - * - --audience - - string - - false - - Identifier of the intended recipient of the token. - * - --authorizationType - - string - - false - - Type of authorization. Valid values are NONE, JWT, or SAML. - * - --clientId - - string - - false - - Client identifier that is assigned to an application by the Identity Provider. - * - --desc - - string - - false - - Description of the Identity Provider. - * - --federationSettingsId - - string - - true - - Unique 24-hexadecimal digit string that identifies the federation settings. - * - --groupsClaim - - string - - false - - Identifier of the claim which contains IdP Group IDs in the token. - * - -h, --help - - - - false - - help for oidc - * - --idpType - - string - - true - - Type of Identity Provider. Valid values are WORKFORCE or WORKLOAD. - * - --issuerUri - - string - - false - - Unique string that identifies the issuer of the OIDC metadata/discovery document URL. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --requestedScope - - strings - - false - - Scopes that MongoDB applications will request from the authorization endpoint. - * - --userClaim - - string - - false - - Identifier of the claim which contains the user ID in the token. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Identity provider '' updated. - - -Examples --------- - -.. code-block:: - :copyable: false - - # Update the audience of the identity provider with ID aa2223b25a115342acc1f108 and from your federation settings with federationSettingsId 5d1113b25a115342acc2d1aa with IdpType WORKFORCE - atlas federatedAuthentication federationSettings identityProvider update aa2223b25a115342acc1f108 --federationSettingsId 5d1113b25a115342acc2d1aa --idpType WORKFORCE --audience newAudience - diff --git a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-update.txt b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-update.txt deleted file mode 100644 index 9ced3f51a8..0000000000 --- a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-update.txt +++ /dev/null @@ -1,59 +0,0 @@ -.. _atlas-federatedAuthentication-federationSettings-identityProvider-update: - -======================================================================== -atlas federatedAuthentication federationSettings identityProvider update -======================================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Update Federated Authentication Identity Providers. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for update - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-federatedAuthentication-federationSettings-identityProvider-update-oidc` - Update an OIDC identity provider. - - -.. toctree:: - :titlesonly: - - oidc - diff --git a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider.txt b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider.txt deleted file mode 100644 index 26ea30cb0a..0000000000 --- a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider.txt +++ /dev/null @@ -1,69 +0,0 @@ -.. _atlas-federatedAuthentication-federationSettings-identityProvider: - -================================================================= -atlas federatedAuthentication federationSettings identityProvider -================================================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage Federated Authentication Identity Providers. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for identityProvider - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-federatedAuthentication-federationSettings-identityProvider-create` - Create Federated Authentication Identity Providers. -* :ref:`atlas-federatedAuthentication-federationSettings-identityProvider-delete` - Remove the specified identity provider from your federation settings. -* :ref:`atlas-federatedAuthentication-federationSettings-identityProvider-describe` - Describe the specified identity provider from your federation settings. -* :ref:`atlas-federatedAuthentication-federationSettings-identityProvider-list` - List the identity providers from your federation settings. -* :ref:`atlas-federatedAuthentication-federationSettings-identityProvider-revokeJwk` - Revoke the JWK token from the specified identity provider from your federation settings. -* :ref:`atlas-federatedAuthentication-federationSettings-identityProvider-update` - Update Federated Authentication Identity Providers. - - -.. toctree:: - :titlesonly: - - create - delete - describe - list - revokeJwk - update - diff --git a/docs/command/atlas-federatedAuthentication-federationSettings.txt b/docs/command/atlas-federatedAuthentication-federationSettings.txt deleted file mode 100644 index 65ff2f3863..0000000000 --- a/docs/command/atlas-federatedAuthentication-federationSettings.txt +++ /dev/null @@ -1,63 +0,0 @@ -.. _atlas-federatedAuthentication-federationSettings: - -================================================ -atlas federatedAuthentication federationSettings -================================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage Atlas Federated Authentication Federation Settings - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for federationSettings - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-federatedAuthentication-federationSettings-connectedOrgConfigs` - Manage Atlas Federated Authentication Connected Orgs Config -* :ref:`atlas-federatedAuthentication-federationSettings-describe` - Return the Federation Settings details for the specified organization. -* :ref:`atlas-federatedAuthentication-federationSettings-identityProvider` - Manage Federated Authentication Identity Providers. - - -.. toctree:: - :titlesonly: - - connectedOrgConfigs - describe - identityProvider - diff --git a/docs/command/atlas-federatedAuthentication.txt b/docs/command/atlas-federatedAuthentication.txt deleted file mode 100644 index 20e4ac2898..0000000000 --- a/docs/command/atlas-federatedAuthentication.txt +++ /dev/null @@ -1,59 +0,0 @@ -.. _atlas-federatedAuthentication: - -============================= -atlas federatedAuthentication -============================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage Atlas Federated Authentication. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for federatedAuthentication - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-federatedAuthentication-federationSettings` - Manage Atlas Federated Authentication Federation Settings - - -.. toctree:: - :titlesonly: - - federationSettings - diff --git a/docs/command/atlas-integrations-create-DATADOG.txt b/docs/command/atlas-integrations-create-DATADOG.txt deleted file mode 100644 index 4ff69b54d8..0000000000 --- a/docs/command/atlas-integrations-create-DATADOG.txt +++ /dev/null @@ -1,100 +0,0 @@ -.. _atlas-integrations-create-DATADOG: - -================================= -atlas integrations create DATADOG -================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create or update a Datadog integration for your project. - -The requesting API key must have the Organization Owner or Project Owner role to configure an integration with Datadog. - -After you integrate with Datadog, you can send metric data about your project to your Datadog dashboard. To learn more about the metrics available to Datadog, see https://www.mongodb.com/docs/atlas/tutorial/datadog-integration/. - -Datadog integration is available only for M10+ clusters. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas integrations create DATADOG [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --apiKey - - string - - true - - Datadog API key that allows Atlas to access your Datadog account. - * - -h, --help - - - - false - - help for DATADOG - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --region - - string - - false - - Code that indicates which regional URL MongoDB uses to access the Datadog API. Valid values are US, EU, US3, US5, and AP1. This value defaults to "US". - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Datadog integration configured. - - -Examples --------- - -.. code-block:: - :copyable: false - - # Integrate Datadog with Atlas for the project with the ID 5e2211c17a3e5a48f5497de3: - atlas integrations create DATADOG --apiKey a1a23bcdef45ghijk6789 --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-integrations-create-OPS_GENIE.txt b/docs/command/atlas-integrations-create-OPS_GENIE.txt deleted file mode 100644 index f379cf6c82..0000000000 --- a/docs/command/atlas-integrations-create-OPS_GENIE.txt +++ /dev/null @@ -1,96 +0,0 @@ -.. _atlas-integrations-create-OPS_GENIE: - -=================================== -atlas integrations create OPS_GENIE -=================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create or update an Opsgenie integration for your project. - -The requesting API key must have the Organization Owner or Project Owner role to configure an integration with Opsgenie. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas integrations create OPS_GENIE [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --apiKey - - string - - true - - Opsgenie API key that allows Atlas to access your Opsgenie account. - * - -h, --help - - - - false - - help for OPS_GENIE - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --region - - string - - false - - Code that indicates which regional URL MongoDB uses to access the third-party API. Valid values are US and EU. This value defaults to "US". - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Ops Genie integration configured. - - -Examples --------- - -.. code-block:: - :copyable: false - - # Integrate Opsgenie with Atlas for the project with the ID 5e2211c17a3e5a48f5497de3: - atlas integrations create OPS_GENIE --apiKey a1a23bcdef45ghijk6789 --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-integrations-create-PAGER_DUTY.txt b/docs/command/atlas-integrations-create-PAGER_DUTY.txt deleted file mode 100644 index 4772a69a43..0000000000 --- a/docs/command/atlas-integrations-create-PAGER_DUTY.txt +++ /dev/null @@ -1,92 +0,0 @@ -.. _atlas-integrations-create-PAGER_DUTY: - -==================================== -atlas integrations create PAGER_DUTY -==================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create or update a PagerDuty integration for your project. - -The requesting API key must have the Organization Owner or Project Owner role to configure an integration with PagerDuty. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas integrations create PAGER_DUTY [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for PAGER_DUTY - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --serviceKey - - string - - true - - Service key associated with your PagerDuty account. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Pager Duty integration configured. - - -Examples --------- - -.. code-block:: - :copyable: false - - # Integrate PagerDuty with Atlas for the project with the ID 5e2211c17a3e5a48f5497de3: - atlas integrations create PAGER_DUTY --serviceKey a1a23bcdef45ghijk6789 --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-integrations-create-VICTOR_OPS.txt b/docs/command/atlas-integrations-create-VICTOR_OPS.txt deleted file mode 100644 index 8c7bf304a2..0000000000 --- a/docs/command/atlas-integrations-create-VICTOR_OPS.txt +++ /dev/null @@ -1,98 +0,0 @@ -.. _atlas-integrations-create-VICTOR_OPS: - -==================================== -atlas integrations create VICTOR_OPS -==================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create or update a Splunk On-Call integration for your project. - -VictorOps is now Splunk On-Call. - -The requesting API key must have the Organization Owner or Project Owner role to configure an integration with Splunk On-Call. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas integrations create VICTOR_OPS [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --apiKey - - string - - true - - Splunk On-Call API key that allows Atlas to access your Splunk On-Call account. - * - -h, --help - - - - false - - help for VICTOR_OPS - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --routingKey - - string - - true - - Routing key associated with your Splunk On-Call account. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Victor Ops integration configured. - - -Examples --------- - -.. code-block:: - :copyable: false - - # Integrate Splunk On-Call with Atlas using the routing key operations for the project with the ID 5e2211c17a3e5a48f5497de3: - atlas integrations create VICTOR_OPS --apiKey a1a23bcdef45ghijk6789 --routingKey operations --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-integrations-create-WEBHOOK.txt b/docs/command/atlas-integrations-create-WEBHOOK.txt deleted file mode 100644 index 32dccd71c0..0000000000 --- a/docs/command/atlas-integrations-create-WEBHOOK.txt +++ /dev/null @@ -1,96 +0,0 @@ -.. _atlas-integrations-create-WEBHOOK: - -================================= -atlas integrations create WEBHOOK -================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create or update a webhook integration for your project. - -The requesting API key must have the Organization Owner or Project Owner role to configure a webhook integration. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas integrations create WEBHOOK [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for WEBHOOK - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --secret - - string - - true - - Secret that secures your webhook. - * - --url - - string - - true - - Endpoint web address to which Atlas sends notifications. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Webhook integration configured. - - -Examples --------- - -.. code-block:: - :copyable: false - - # Integrate a webhook with Atlas that uses the secret mySecret for the project with the ID 5e2211c17a3e5a48f5497de3: - atlas integrations create WEBHOOK --url http://9b4ac7aa.abc.io/payload --secret mySecret --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-integrations-create.txt b/docs/command/atlas-integrations-create.txt deleted file mode 100644 index 85048bcdb1..0000000000 --- a/docs/command/atlas-integrations-create.txt +++ /dev/null @@ -1,67 +0,0 @@ -.. _atlas-integrations-create: - -========================= -atlas integrations create -========================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create operations. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for create - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-integrations-create-DATADOG` - Create or update a Datadog integration for your project. -* :ref:`atlas-integrations-create-OPS_GENIE` - Create or update an Opsgenie integration for your project. -* :ref:`atlas-integrations-create-PAGER_DUTY` - Create or update a PagerDuty integration for your project. -* :ref:`atlas-integrations-create-VICTOR_OPS` - Create or update a Splunk On-Call integration for your project. -* :ref:`atlas-integrations-create-WEBHOOK` - Create or update a webhook integration for your project. - - -.. toctree:: - :titlesonly: - - DATADOG - OPS_GENIE - PAGER_DUTY - VICTOR_OPS - WEBHOOK - diff --git a/docs/command/atlas-integrations-delete.txt b/docs/command/atlas-integrations-delete.txt deleted file mode 100644 index 63239e640e..0000000000 --- a/docs/command/atlas-integrations-delete.txt +++ /dev/null @@ -1,104 +0,0 @@ -.. _atlas-integrations-delete: - -========================= -atlas integrations delete -========================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Remove the specified third-party integration from your project. - -Deleting an integration from a project removes that integration configuration only for that project. This does not affect any other project or organization's configured integrations. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas integrations delete [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - integrationType - - string - - true - - Human-readable label that identifies the service integration to delete. Valid values are PAGER_DUTY, MICROSOFT_TEAMS, SLACK, DATADOG, NEW_RELIC, OPS_GENIE, VICTOR_OPS, WEBHOOK, PROMETHEUS. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --force - - - - false - - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. - * - -h, --help - - - - false - - help for delete - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Integration '' deleted - - -Examples --------- - -.. code-block:: - :copyable: false - - # Remove the Datadog integration for the project with the ID 5e2211c17a3e5a48f5497de3: - atlas integrations delete DATADOG --projectId 5e2211c17a3e5a48f5497de3 diff --git a/docs/command/atlas-integrations-describe.txt b/docs/command/atlas-integrations-describe.txt deleted file mode 100644 index 8d00468824..0000000000 --- a/docs/command/atlas-integrations-describe.txt +++ /dev/null @@ -1,92 +0,0 @@ -.. _atlas-integrations-describe: - -=========================== -atlas integrations describe -=========================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return the details for the specified third-party integration for your project. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas integrations describe [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - integrationType - - string - - true - - Human-readable label that identifies the integrated service. Valid values are PAGER_DUTY, MICROSOFT_TEAMS, SLACK, DATADOG, NEW_RELIC, OPS_GENIE, VICTOR_OPS, WEBHOOK, PROMETHEUS. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for describe - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - # Return the JSON-formatted details for the Datadog integration for the project with the ID 5e2211c17a3e5a48f5497de3: - atlas integrations describe DATADOG --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-integrations-list.txt b/docs/command/atlas-integrations-list.txt deleted file mode 100644 index 46aefedf60..0000000000 --- a/docs/command/atlas-integrations-list.txt +++ /dev/null @@ -1,87 +0,0 @@ -.. _atlas-integrations-list: - -======================= -atlas integrations list -======================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return all active third-party integrations for your project. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas integrations list [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for list - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - TYPE - - - -Examples --------- - -.. code-block:: - :copyable: false - - # Return a JSON-formatted list of active third-party integrations for the project with the ID 5e2211c17a3e5a48f5497de3: - atlas integrations list --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-integrations.txt b/docs/command/atlas-integrations.txt deleted file mode 100644 index 5324838902..0000000000 --- a/docs/command/atlas-integrations.txt +++ /dev/null @@ -1,65 +0,0 @@ -.. _atlas-integrations: - -================== -atlas integrations -================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Configure third-party integrations for your Atlas project. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for integrations - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-integrations-create` - Create operations. -* :ref:`atlas-integrations-delete` - Remove the specified third-party integration from your project. -* :ref:`atlas-integrations-describe` - Return the details for the specified third-party integration for your project. -* :ref:`atlas-integrations-list` - Return all active third-party integrations for your project. - - -.. toctree:: - :titlesonly: - - create - delete - describe - list - diff --git a/docs/command/atlas-kubernetes-config-apply.txt b/docs/command/atlas-kubernetes-config-apply.txt deleted file mode 100644 index ca9d805e03..0000000000 --- a/docs/command/atlas-kubernetes-config-apply.txt +++ /dev/null @@ -1,117 +0,0 @@ -.. _atlas-kubernetes-config-apply: - -============================= -atlas kubernetes config apply -============================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Generate and apply Kubernetes configuration resources for use with Atlas Kubernetes Operator. - -This command exports configurations for Atlas objects including projects, deployments, and users directly into Kubernetes, allowing you to manage these resources using the Atlas Kubernetes Operator. For more information, see https://www.mongodb.com/docs/atlas/atlas-operator/. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas kubernetes config apply [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --clusterName - - strings - - false - - One or more comma separated cluster names to import - * - -h, --help - - - - false - - help for apply - * - --kubeContext - - string - - false - - Name of the kubeconfig context to use. - * - --kubeconfig - - string - - false - - Path to the kubeconfig file to use for CLI requests. - * - --operatorVersion - - string - - false - - Version of Atlas Kubernetes Operator to generate resources for. - * - --orgId - - string - - false - - Organization ID to use. This option overrides the settings in the configuration file or environment variable. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --targetNamespace - - string - - false - - Namespaces to use for generated kubernetes entities - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - # Export and apply all supported resources of a specific project: - atlas kubernetes config apply --projectId= - - -.. code-block:: - :copyable: false - - # Export and apply all supported resources of a specific project and to a specific namespace: - atlas kubernetes config apply --projectId= --targetNamespace= - - -.. code-block:: - :copyable: false - - # Export and apply all supported Project resource, and only the described Deployment resources of a specific project to a specific namespace: - atlas kubernetes config apply --projectId= --clusterName= --targetNamespace= - - -.. code-block:: - :copyable: false - - # Export and apply all supported resources of a specific project to a specific namespace restricting the version of the Atlas Kubernetes Operator: - atlas kubernetes config apply --projectId= --targetNamespace= --operatorVersion=1.5.1 diff --git a/docs/command/atlas-kubernetes-config-generate.txt b/docs/command/atlas-kubernetes-config-generate.txt deleted file mode 100644 index b51afc6575..0000000000 --- a/docs/command/atlas-kubernetes-config-generate.txt +++ /dev/null @@ -1,142 +0,0 @@ -.. _atlas-kubernetes-config-generate: - -================================ -atlas kubernetes config generate -================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Generate Kubernetes configuration resources for use with Atlas Kubernetes Operator. - -This command exports configurations for Atlas objects including projects, deployments, and users in a Kubernetes-compatible format, allowing you to manage these resources using the Atlas Kubernetes Operator. For more information, see https://www.mongodb.com/docs/atlas/atlas-operator/ - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas kubernetes config generate [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --clusterName - - strings - - false - - One or more comma separated cluster names to import - * - --dataFederationName - - strings - - false - - One or more comma separated data federation names to import - * - -h, --help - - - - false - - help for generate - * - --includeSecrets - - - - false - - Flag that generates kubernetes secrets with data for projects, users, deployments entities. - * - --independentResources - - - - false - - Flag that makes the generated resources that support independent usage, to use external IDs rather than Kubernetes references. - * - --operatorVersion - - string - - false - - Version of Atlas Kubernetes Operator to generate resources for. This value defaults to "2.5.0". - * - --orgId - - string - - false - - Organization ID to use. This option overrides the settings in the configuration file or environment variable. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --targetNamespace - - string - - false - - Namespaces to use for generated kubernetes entities - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - # Export Project, DatabaseUsers, Deployments resources for a specific project without connection and integration secrets: - atlas kubernetes config generate --projectId= - - -.. code-block:: - :copyable: false - - # Export Project, DatabaseUsers, Deployments resources for a specific project, but use external IDs where supported: - atlas kubernetes config generate --projectId= --independentResources - - -.. code-block:: - :copyable: false - - # Export Project, DatabaseUsers, Deployments resources for a specific project including connection and integration secrets: - atlas kubernetes config generate --projectId= --includeSecrets - - -.. code-block:: - :copyable: false - - # Export Project, DatabaseUsers, Deployments resources for a specific project including connection and integration secrets to a specific namespace: - atlas kubernetes config generate --projectId= --includeSecrets --targetNamespace= - - -.. code-block:: - :copyable: false - - # Export Project, DatabaseUsers, DataFederations and specific Deployment resources for a specific project including connection and integration secrets to a specific namespace: - atlas kubernetes config generate --projectId= --clusterName= --includeSecrets --targetNamespace= - - -.. code-block:: - :copyable: false - - # Export resources for a specific version of the Atlas Kubernetes Operator: - atlas kubernetes config generate --projectId= --targetNamespace= --operatorVersion=1.5.1 - - -.. code-block:: - :copyable: false - - # Export Project, DatabaseUsers, Clusters and specific DataFederation resources for a specific project to a specific namespace: - atlas kubernetes config generate --projectId= --dataFederationName= --targetNamespace= diff --git a/docs/command/atlas-kubernetes-config.txt b/docs/command/atlas-kubernetes-config.txt deleted file mode 100644 index 78d1adf7a0..0000000000 --- a/docs/command/atlas-kubernetes-config.txt +++ /dev/null @@ -1,63 +0,0 @@ -.. _atlas-kubernetes-config: - -======================= -atlas kubernetes config -======================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage Kubernetes configuration resources. - -This command provides your Kubernetes configuration access to Atlas. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for config - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-kubernetes-config-apply` - Generate and apply Kubernetes configuration resources for use with Atlas Kubernetes Operator. -* :ref:`atlas-kubernetes-config-generate` - Generate Kubernetes configuration resources for use with Atlas Kubernetes Operator. - - -.. toctree:: - :titlesonly: - - apply - generate - diff --git a/docs/command/atlas-kubernetes-operator-install.txt b/docs/command/atlas-kubernetes-operator-install.txt deleted file mode 100644 index 881f335a6e..0000000000 --- a/docs/command/atlas-kubernetes-operator-install.txt +++ /dev/null @@ -1,164 +0,0 @@ -.. _atlas-kubernetes-operator-install: - -================================= -atlas kubernetes operator install -================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Install Atlas Kubernetes Operator to a cluster. - -This command installs a supported version of Atlas Kubernetes Operator to an existing cluster, and optionally imports Atlas resources that are managed by the operator. - -This command creates an API key for the Operator and adds it to Kubernetes as a secret, which the Operator then uses to make Atlas Admin API calls. -The key is scoped to the project when you specify the --projectName option and to the organization when you omit the --projectName option. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas kubernetes operator install [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --atlasGov - - - - false - - Flag that indicates whether to configure Atlas for Government as a target of the operator. - * - -h, --help - - - - false - - help for install - * - --import - - - - false - - Flag that indicates whether to import existing Atlas resources into the cluster for the operator to manage. - * - --kubeContext - - string - - false - - Name of the kubeconfig context to use. - * - --kubeconfig - - string - - false - - Path to the kubeconfig file to use for CLI requests. - * - --operatorVersion - - string - - false - - Version of the operator to install. - * - --orgId - - string - - false - - Organization ID to use. This option overrides the settings in the configuration file or environment variable. - * - --projectName - - string - - false - - Name of the project to create or use with the installed operator. - * - --resourceDeletionProtection - - - - false - - Toggle atlas operator deletion protection for resources like Projects, Deployments, etc. Read more: https://dochub.mongodb.org/core/ako-deletion-protection This value defaults to true. - * - --subresourceDeletionProtection - - - - false - - Toggle atlas operator deletion protection for subresources like Alerts, Integrations, etc. Read more: https://dochub.mongodb.org/core/ako-deletion-protection This value defaults to true. - * - --targetNamespace - - string - - false - - Namespace where to install the operator. - * - --watchNamespace - - strings - - false - - List that contains namespaces that the operator will listen to. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - # Install latest version of the operator into the default namespace: - atlas kubernetes operator install - - -.. code-block:: - :copyable: false - - # Install the latest version of the operator targeting Atlas for Government instead of regular commercial Atlas: - atlas kubernetes operator install --atlasGov - - -.. code-block:: - :copyable: false - - # Install a specific version of the operator: - atlas kubernetes operator install --operatorVersion=1.7.0 - - -.. code-block:: - :copyable: false - - # Install a specific version of the operator to a namespace and watch only this namespace and a second one: - atlas kubernetes operator install --operatorVersion=1.7.0 --targetNamespace= --watchNamespace=, - - -.. code-block:: - :copyable: false - - # Install and import all objects from an organization: - atlas kubernetes operator install --targetNamespace= --orgID --import - - -.. code-block:: - :copyable: false - - # Install and import objects from a specific project: - atlas kubernetes operator install --targetNamespace= --orgID --projectName --import - - -.. code-block:: - :copyable: false - - # Install the operator and disable deletion protection: - atlas kubernetes operator install --resourceDeletionProtection=false - - -.. code-block:: - :copyable: false - - # Install the operator and disable deletion protection for sub-resources (Atlas project integrations, private endpoints, etc.): - atlas kubernetes operator install --subresourceDeletionProtection=false diff --git a/docs/command/atlas-kubernetes-operator.txt b/docs/command/atlas-kubernetes-operator.txt deleted file mode 100644 index 47d7302cf7..0000000000 --- a/docs/command/atlas-kubernetes-operator.txt +++ /dev/null @@ -1,61 +0,0 @@ -.. _atlas-kubernetes-operator: - -========================= -atlas kubernetes operator -========================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage Atlas Kubernetes Operator. - -This command manages the Atlas Kubernetes Operator. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for operator - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-kubernetes-operator-install` - Install Atlas Kubernetes Operator to a cluster. - - -.. toctree:: - :titlesonly: - - install - diff --git a/docs/command/atlas-kubernetes.txt b/docs/command/atlas-kubernetes.txt deleted file mode 100644 index 5c8586c12c..0000000000 --- a/docs/command/atlas-kubernetes.txt +++ /dev/null @@ -1,63 +0,0 @@ -.. _atlas-kubernetes: - -================ -atlas kubernetes -================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage Kubernetes resources. - -This command provides access to Kubernetes features within Atlas. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for kubernetes - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-kubernetes-config` - Manage Kubernetes configuration resources. -* :ref:`atlas-kubernetes-operator` - Manage Atlas Kubernetes Operator. - - -.. toctree:: - :titlesonly: - - config - operator - diff --git a/docs/command/atlas-liveMigrations-create.txt b/docs/command/atlas-liveMigrations-create.txt deleted file mode 100644 index dbdd664ecd..0000000000 --- a/docs/command/atlas-liveMigrations-create.txt +++ /dev/null @@ -1,126 +0,0 @@ -.. _atlas-liveMigrations-create: - -=========================== -atlas liveMigrations create -=========================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create a new push live migration. - -To migrate using scripts, use mongomirror instead of the Atlas CLI. To learn more about mongomirror, see https://www.mongodb.com/docs/atlas/reference/mongomirror/. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas liveMigrations create [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --clusterName - - string - - true - - Human-readable label that identifies the Atlas destination cluster. - * - --drop - - - - false - - Flag that indicates whether this process should drop existing collections from the destination (Atlas) cluster given in --destinationClusterName before starting the migration of data from the source cluster. - * - --force - - - - false - - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. - * - -h, --help - - - - false - - help for create - * - --migrationHost - - strings - - true - - List of hosts running the MongoDB Agent that can transfer your MongoDB data from the source (Cloud Manager or Ops Manager) to destination (Atlas) deployments. Each live migration process uses its own dedicated migration host. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --sourceCACertificatePath - - string - - false - - Path to the CA certificate that signed TLS certificates use to authenticate to the source Cloud Manager or Ops Manager cluster. Omit this value if --sourceSSL is not passed. - * - --sourceClusterName - - string - - true - - Human-readable label that identifies the source Cloud Manager or Ops Manager cluster. - * - --sourceManagedAuthentication - - - - false - - Flag that indicates whether MongoDB Automation manages authentication to the source Cloud Manager or Ops Manager cluster. If you set this to true, don't provide values for --sourceUsername and --sourcePassword. - - Mutually exclusive with --sourceUsername. - * - -p, --sourcePassword - - string - - false - - Password that authenticates the username to the source Cloud Manager or Ops Manager cluster. Omit this value if --sourceManagedAuthentication is passed. - * - --sourceProjectId - - string - - true - - Unique 24-hexadecimal digit string that identifies the source project. - * - --sourceSsl - - - - false - - Flag that indicates whether data source has TLS enabled. - * - -u, --sourceUsername - - string - - false - - Human-readable label that identifies the SCRAM-SHA user that connects to the source Cloud Manager or Ops Manager cluster. Omit this value if --sourceManagedAuthentication is set. - - Mutually exclusive with --sourceManagedAuthentication. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - ID LAGTIME READY FOR CUTOVER STATUS - - diff --git a/docs/command/atlas-liveMigrations-cutover.txt b/docs/command/atlas-liveMigrations-cutover.txt deleted file mode 100644 index b52d4f9ee8..0000000000 --- a/docs/command/atlas-liveMigrations-cutover.txt +++ /dev/null @@ -1,82 +0,0 @@ -.. _atlas-liveMigrations-cutover: - -============================ -atlas liveMigrations cutover -============================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Start the cutover for a push live migration and confirm when the cutover completes. When the cutover completes, the application completes the live migration process and stops synchronizing with the source cluster. - -To migrate using scripts, use mongomirror instead of the Atlas CLI. To learn more about mongomirror, see https://www.mongodb.com/docs/atlas/reference/mongomirror/. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas liveMigrations cutover [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for cutover - * - --liveMigrationId - - string - - true - - Unique 24-hexadecimal digit string that identifies the live migration job. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Cutover process successfully started. - - diff --git a/docs/command/atlas-liveMigrations-describe.txt b/docs/command/atlas-liveMigrations-describe.txt deleted file mode 100644 index 2798a01192..0000000000 --- a/docs/command/atlas-liveMigrations-describe.txt +++ /dev/null @@ -1,62 +0,0 @@ -.. _atlas-liveMigrations-describe: - -============================= -atlas liveMigrations describe -============================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return a push live migration job. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas liveMigrations describe [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for describe - * - --liveMigrationId - - string - - true - - Unique 24-hexadecimal digit string that identifies the live migration job. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - diff --git a/docs/command/atlas-liveMigrations-link-create.txt b/docs/command/atlas-liveMigrations-link-create.txt deleted file mode 100644 index e736135d52..0000000000 --- a/docs/command/atlas-liveMigrations-link-create.txt +++ /dev/null @@ -1,82 +0,0 @@ -.. _atlas-liveMigrations-link-create: - -================================ -atlas liveMigrations link create -================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create a new link-token for a push live migration. - -To migrate using scripts, use mongomirror instead of the Atlas CLI. To learn more about mongomirror, see https://www.mongodb.com/docs/atlas/reference/mongomirror/. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas liveMigrations link create [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --accessListIp - - strings - - false - - IP address access list entries that are associated with the link-token. - * - -h, --help - - - - false - - help for create - * - --orgId - - string - - false - - Organization ID to use. This option overrides the settings in the configuration file or environment variable. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Link-token '' successfully created. - - diff --git a/docs/command/atlas-liveMigrations-link-delete.txt b/docs/command/atlas-liveMigrations-link-delete.txt deleted file mode 100644 index 5b4573824a..0000000000 --- a/docs/command/atlas-liveMigrations-link-delete.txt +++ /dev/null @@ -1,76 +0,0 @@ -.. _atlas-liveMigrations-link-delete: - -================================ -atlas liveMigrations link delete -================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Delete one link-token. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas liveMigrations link delete [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --force - - - - false - - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. - * - -h, --help - - - - false - - help for delete - * - --orgId - - string - - false - - Organization ID to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Link-token successfully deleted - - diff --git a/docs/command/atlas-liveMigrations-link.txt b/docs/command/atlas-liveMigrations-link.txt deleted file mode 100644 index 7d81d1f085..0000000000 --- a/docs/command/atlas-liveMigrations-link.txt +++ /dev/null @@ -1,61 +0,0 @@ -.. _atlas-liveMigrations-link: - -========================= -atlas liveMigrations link -========================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage the link-token for your organization. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for link - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-liveMigrations-link-create` - Create a new link-token for a push live migration. -* :ref:`atlas-liveMigrations-link-delete` - Delete one link-token. - - -.. toctree:: - :titlesonly: - - create - delete - diff --git a/docs/command/atlas-liveMigrations-validation-create.txt b/docs/command/atlas-liveMigrations-validation-create.txt deleted file mode 100644 index f47530b581..0000000000 --- a/docs/command/atlas-liveMigrations-validation-create.txt +++ /dev/null @@ -1,126 +0,0 @@ -.. _atlas-liveMigrations-validation-create: - -====================================== -atlas liveMigrations validation create -====================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create a new validation request for a push live migration. - -To migrate using scripts, use mongomirror instead of the Atlas CLI. To learn more about mongomirror, see https://www.mongodb.com/docs/atlas/reference/mongomirror/. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas liveMigrations validation create [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --clusterName - - string - - true - - Human-readable label that identifies the Atlas destination cluster. - * - --drop - - - - false - - Flag that indicates whether this process should drop existing collections from the destination (Atlas) cluster given in --destinationClusterName before starting the migration of data from the source cluster. - * - --force - - - - false - - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. - * - -h, --help - - - - false - - help for create - * - --migrationHost - - strings - - true - - List of hosts running the MongoDB Agent that can transfer your MongoDB data from the source (Cloud Manager or Ops Manager) to destination (Atlas) deployments. Each live migration process uses its own dedicated migration host. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --sourceCACertificatePath - - string - - false - - Path to the CA certificate that signed TLS certificates use to authenticate to the source Cloud Manager or Ops Manager cluster. Omit this value if --sourceSSL is not passed. - * - --sourceClusterName - - string - - true - - Human-readable label that identifies the source Cloud Manager or Ops Manager cluster. - * - --sourceManagedAuthentication - - - - false - - Flag that indicates whether MongoDB Automation manages authentication to the source Cloud Manager or Ops Manager cluster. If you set this to true, don't provide values for --sourceUsername and --sourcePassword. - - Mutually exclusive with --sourceUsername. - * - -p, --sourcePassword - - string - - false - - Password that authenticates the username to the source Cloud Manager or Ops Manager cluster. Omit this value if --sourceManagedAuthentication is passed. - * - --sourceProjectId - - string - - true - - Unique 24-hexadecimal digit string that identifies the source project. - * - --sourceSsl - - - - false - - Flag that indicates whether data source has TLS enabled. - * - -u, --sourceUsername - - string - - false - - Human-readable label that identifies the SCRAM-SHA user that connects to the source Cloud Manager or Ops Manager cluster. Omit this value if --sourceManagedAuthentication is set. - - Mutually exclusive with --sourceManagedAuthentication. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - ID PROJECT ID SOURCE PROJECT ID STATUS - - diff --git a/docs/command/atlas-liveMigrations-validation-describe.txt b/docs/command/atlas-liveMigrations-validation-describe.txt deleted file mode 100644 index 85cf8225b7..0000000000 --- a/docs/command/atlas-liveMigrations-validation-describe.txt +++ /dev/null @@ -1,80 +0,0 @@ -.. _atlas-liveMigrations-validation-describe: - -======================================== -atlas liveMigrations validation describe -======================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return one validation job. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas liveMigrations validation describe [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for describe - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --validationId - - string - - false - - Unique 24-hexadecimal digit string that identifies the validation job. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - ID PROJECT ID SOURCE PROJECT ID STATUS - - diff --git a/docs/command/atlas-liveMigrations-validation.txt b/docs/command/atlas-liveMigrations-validation.txt deleted file mode 100644 index e0e174761c..0000000000 --- a/docs/command/atlas-liveMigrations-validation.txt +++ /dev/null @@ -1,61 +0,0 @@ -.. _atlas-liveMigrations-validation: - -=============================== -atlas liveMigrations validation -=============================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage a Live Migration validation job for your project. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for validation - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-liveMigrations-validation-create` - Create a new validation request for a push live migration. -* :ref:`atlas-liveMigrations-validation-describe` - Return one validation job. - - -.. toctree:: - :titlesonly: - - create - describe - diff --git a/docs/command/atlas-liveMigrations.txt b/docs/command/atlas-liveMigrations.txt deleted file mode 100644 index 015e14547d..0000000000 --- a/docs/command/atlas-liveMigrations.txt +++ /dev/null @@ -1,67 +0,0 @@ -.. _atlas-liveMigrations: - -==================== -atlas liveMigrations -==================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage a Live Migration to Atlas for your organization. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for liveMigrations - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-liveMigrations-create` - Create a new push live migration. -* :ref:`atlas-liveMigrations-cutover` - Start the cutover for a push live migration and confirm when the cutover completes. When the cutover completes, the application completes the live migration process and stops synchronizing with the source cluster. -* :ref:`atlas-liveMigrations-describe` - Return a push live migration job. -* :ref:`atlas-liveMigrations-link` - Manage the link-token for your organization. -* :ref:`atlas-liveMigrations-validation` - Manage a Live Migration validation job for your project. - - -.. toctree:: - :titlesonly: - - create - cutover - describe - link - validation - diff --git a/docs/command/atlas-logs-download.txt b/docs/command/atlas-logs-download.txt deleted file mode 100644 index 576714f0de..0000000000 --- a/docs/command/atlas-logs-download.txt +++ /dev/null @@ -1,126 +0,0 @@ -.. _atlas-logs-download: - -=================== -atlas logs download -=================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Download a compressed file that contains the MongoDB logs for the specified host. - -This command downloads a file with a .gz extension. - -To find the hostnames for an Atlas project, use the process list command. - -To use this command, you must authenticate with a user account or an API key with the Project Data Access Read/Write role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas logs download [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - hostname - - string - - true - - Label that identifies the host that stores the log files that you want to download. - * - mongodb.gz|mongos.gz|mongosqld.gz|mongodb-audit-log.gz|mongos-audit-log.gz - - string - - true - - Log file that you want to return. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -d, --decompress - - - - false - - Flag that indicates whether to decompress the log files. - * - --end - - int - - false - - Ending date and time for the range of log messages to retrieve, given in UNIX time. Defaults to the start date plus 24 hours, if the start date is set. If start date is not provided, ending time defaults to the current time. - * - --force - - - - false - - Flag that indicates whether to overwrite the destination file. - * - -h, --help - - - - false - - help for download - * - --out - - string - - false - - Output file name. This value defaults to the log name. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --start - - int - - false - - UNIX Epoch-formatted starting date and time for the range of log messages to retrieve. This value defaults to 24 hours prior to the current timestamp. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Download of completed. - - -Examples --------- - -.. code-block:: - :copyable: false - - # Download the mongodb log file from the host atlas-123abc-shard-00-00.111xx.mongodb.net for the project with the ID 5e2211c17a3e5a48f5497de3: - atlas logs download atlas-123abc-shard-00-00.111xx.mongodb.net mongodb.gz --projectId 5e2211c17a3e5a48f5497de3 diff --git a/docs/command/atlas-logs.txt b/docs/command/atlas-logs.txt deleted file mode 100644 index 36035a512e..0000000000 --- a/docs/command/atlas-logs.txt +++ /dev/null @@ -1,59 +0,0 @@ -.. _atlas-logs: - -========== -atlas logs -========== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Download host logs for your project. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for logs - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-logs-download` - Download a compressed file that contains the MongoDB logs for the specified host. - - -.. toctree:: - :titlesonly: - - download - diff --git a/docs/command/atlas-maintenanceWindows-clear.txt b/docs/command/atlas-maintenanceWindows-clear.txt deleted file mode 100644 index 300aafbd30..0000000000 --- a/docs/command/atlas-maintenanceWindows-clear.txt +++ /dev/null @@ -1,92 +0,0 @@ -.. _atlas-maintenanceWindows-clear: - -============================== -atlas maintenanceWindows clear -============================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Clear the current maintenance window setting for your project. - -To learn more about maintenance windows, see https://www.mongodb.com/docs/atlas/tutorial/cluster-maintenance-window/. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas maintenanceWindows clear [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --force - - - - false - - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. - * - -h, --help - - - - false - - help for clear - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Maintenance window removed. - - -Examples --------- - -.. code-block:: - :copyable: false - - # Clear the current maintenance window for the project with the ID 5e2211c17a3e5a48f5497de3: - atlas maintenanceWindows clear --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-maintenanceWindows-defer.txt b/docs/command/atlas-maintenanceWindows-defer.txt deleted file mode 100644 index f586ce1e7e..0000000000 --- a/docs/command/atlas-maintenanceWindows-defer.txt +++ /dev/null @@ -1,88 +0,0 @@ -.. _atlas-maintenanceWindows-defer: - -============================== -atlas maintenanceWindows defer -============================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Defer scheduled maintenance for your project for one week. - -To learn more about maintenance windows, see https://www.mongodb.com/docs/atlas/tutorial/cluster-maintenance-window/. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas maintenanceWindows defer [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for defer - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Maintenance window deferred. - - -Examples --------- - -.. code-block:: - :copyable: false - - # Defer scheduled maintenance for one week for the project with the ID 5e2211c17a3e5a48f5497de3: - atlas maintenanceWindows defer --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-maintenanceWindows-describe.txt b/docs/command/atlas-maintenanceWindows-describe.txt deleted file mode 100644 index 2401651d5e..0000000000 --- a/docs/command/atlas-maintenanceWindows-describe.txt +++ /dev/null @@ -1,89 +0,0 @@ -.. _atlas-maintenanceWindows-describe: - -================================= -atlas maintenanceWindows describe -================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return the maintenance window details for your project. - -To learn more about maintenance windows, see https://www.mongodb.com/docs/atlas/tutorial/cluster-maintenance-window/. - -To use this command, you must authenticate with a user account or an API key with the Project Read Only role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas maintenanceWindows describe [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for describe - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - DAY OF THE WEEK HOUR OF DAY START ASAP - - - -Examples --------- - -.. code-block:: - :copyable: false - - # Return the maintenance window for the project with the ID 5e2211c17a3e5a48f5497de3: - atlas maintenanceWindows describe --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-maintenanceWindows-update.txt b/docs/command/atlas-maintenanceWindows-update.txt deleted file mode 100644 index affa97dd2f..0000000000 --- a/docs/command/atlas-maintenanceWindows-update.txt +++ /dev/null @@ -1,100 +0,0 @@ -.. _atlas-maintenanceWindows-update: - -=============================== -atlas maintenanceWindows update -=============================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Modify the maintenance window for your project. - -To learn more about maintenance windows, see https://www.mongodb.com/docs/atlas/tutorial/cluster-maintenance-window/. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas maintenanceWindows update [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --dayOfWeek - - int - - false - - Day of the week that you want the maintenance window to start, as a 1-based integer. Use 1 for Sunday, 2 for Monday, 3 for Tuesday, 4 for Wednesday, 5 for Thursday, 6 for Friday, or 7 for Saturday. - * - -h, --help - - - - false - - help for update - * - --hourOfDay - - int - - false - - Hour of the day that you want the maintenance window to start according to a 24-hour clock. Use 0 for midnight and 12 for noon. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --startASAP - - - - false - - Flag that starts maintenance immediately upon receiving this request. This flag resets to false after Atlas completes maintenance. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Maintenance window updated. - - -Examples --------- - -.. code-block:: - :copyable: false - - # Update the maintenance window to midnight on Saturdays for the project with the ID 5e2211c17a3e5a48f5497de3: - atlas maintenanceWindows update --dayOfWeek 7 --hourOfDay 0 --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-maintenanceWindows.txt b/docs/command/atlas-maintenanceWindows.txt deleted file mode 100644 index fa4ee9c2d8..0000000000 --- a/docs/command/atlas-maintenanceWindows.txt +++ /dev/null @@ -1,65 +0,0 @@ -.. _atlas-maintenanceWindows: - -======================== -atlas maintenanceWindows -======================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage Atlas maintenance windows. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for maintenanceWindows - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-maintenanceWindows-clear` - Clear the current maintenance window setting for your project. -* :ref:`atlas-maintenanceWindows-defer` - Defer scheduled maintenance for your project for one week. -* :ref:`atlas-maintenanceWindows-describe` - Return the maintenance window details for your project. -* :ref:`atlas-maintenanceWindows-update` - Modify the maintenance window for your project. - - -.. toctree:: - :titlesonly: - - clear - defer - describe - update - diff --git a/docs/command/atlas-metrics-databases-describe.txt b/docs/command/atlas-metrics-databases-describe.txt deleted file mode 100644 index 74def3d321..0000000000 --- a/docs/command/atlas-metrics-databases-describe.txt +++ /dev/null @@ -1,131 +0,0 @@ -.. _atlas-metrics-databases-describe: - -================================ -atlas metrics databases describe -================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return the measurements of a database on the specified host. - -To return the hostname and port needed for this command, run -atlas process list - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas metrics databases describe [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - hostname:port - - string - - true - - Hostname and port number of the instance running the MongoDB process. - * - databaseName - - string - - true - - Label that identifies the database from which you want to retrieve metrics. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --end - - string - - false - - ISO 8601-formatted date and time that specifies when to stop retrieving measurements. You can't set this parameter and period in the same request. - - Mutually exclusive with --period. - * - --granularity - - string - - true - - ISO 8601-formatted duration that specifies the interval between measurement data points. Only the following subset of ISO 8601-formatted time periods are supported: PT10S, PT1M, PT5M, PT1H, P1D. When you specify granularity, you must specify either period or start and end. - * - -h, --help - - - - false - - help for describe - * - --limit - - int - - false - - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --page - - int - - false - - Page number that specifies a page of results. This value defaults to 1. - * - --period - - string - - false - - ISO 8601-formatted time period that specifies the length of time in the past to query. You can't set this parameter and the start or end parameter in the same request. - - Mutually exclusive with --start, --end. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --start - - string - - false - - ISO 8601-formatted date and time that specifies when to start retrieving measurements. You can't set this parameter and period in the same request. - - Mutually exclusive with --period. - * - --type - - strings - - false - - Measurements to return. This option returns all measurements by default. Valid values include DATABASE_AVERAGE_OBJECT_SIZE, DATABASE_COLLECTION_COUNT, DATABASE_DATA_SIZE, DATABASE_STORAGE_SIZE, DATABASE_INDEX_SIZE, DATABASE_INDEX_COUNT, DATABASE_EXTENT_COUNT, DATABASE_OBJECT_COUNT, and DATABASE_VIEW_COUNT - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - # Return the JSON-formatted database metrics from the last 36 hours with 5-minute granularity for the database named testDB in the host atlas-lnmtkm-shard-00-00.ajlj3.mongodb.net:27017 - atlas metrics databases describe atlas-lnmtkm-shard-00-00.ajlj3.mongodb.net:27017 testDB --granularity PT1M --period P1DT12H --output json diff --git a/docs/command/atlas-metrics-databases-list.txt b/docs/command/atlas-metrics-databases-list.txt deleted file mode 100644 index b3cc899445..0000000000 --- a/docs/command/atlas-metrics-databases-list.txt +++ /dev/null @@ -1,118 +0,0 @@ -.. _atlas-metrics-databases-list: - -============================ -atlas metrics databases list -============================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return all databases running on the specified host for your project. - -To return the hostname and port needed for this command, run -atlas processes list - -To use this command, you must authenticate with a user account or an API key with the Project Read Only role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas metrics databases list [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - hostname:port - - string - - true - - Hostname and port number of the instance running the MongoDB process. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for list - * - --limit - - int - - false - - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. - * - --omitCount - - - - false - - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --page - - int - - false - - Page number that specifies a page of results. This value defaults to 1. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - DATABASE NAME - - - -Examples --------- - -.. code-block:: - :copyable: false - - # Return a JSON-formatted list of available databases for the host atlas-lnmtkm-shard-00-00.ajlj3.mongodb.net:27017 - atlas metrics databases list atlas-lnmtkm-shard-00-00.ajlj3.mongodb.net:27017 --output json diff --git a/docs/command/atlas-metrics-databases.txt b/docs/command/atlas-metrics-databases.txt deleted file mode 100644 index 2db0e1a894..0000000000 --- a/docs/command/atlas-metrics-databases.txt +++ /dev/null @@ -1,61 +0,0 @@ -.. _atlas-metrics-databases: - -======================= -atlas metrics databases -======================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -List available databases or database metrics for a given host. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for databases - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-metrics-databases-describe` - Return the measurements of a database on the specified host. -* :ref:`atlas-metrics-databases-list` - Return all databases running on the specified host for your project. - - -.. toctree:: - :titlesonly: - - describe - list - diff --git a/docs/command/atlas-metrics-disks-describe.txt b/docs/command/atlas-metrics-disks-describe.txt deleted file mode 100644 index 3e20344122..0000000000 --- a/docs/command/atlas-metrics-disks-describe.txt +++ /dev/null @@ -1,133 +0,0 @@ -.. _atlas-metrics-disks-describe: - -============================ -atlas metrics disks describe -============================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return the measurements of a disk or partition on the specified host. - -To return the hostname and port needed for this command, run -atlas processes list - -To use this command, you must authenticate with a user account or an API key with the Project Read Only role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas metrics disks describe [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - hostname:port - - string - - true - - Hostname and port number of the instance running the MongoDB process. - * - diskName - - string - - true - - Label that identifies the disk or partition from which you want to retrieve metrics. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --end - - string - - false - - ISO 8601-formatted date and time that specifies when to stop retrieving measurements. You can't set this parameter and period in the same request. - - Mutually exclusive with --period. - * - --granularity - - string - - true - - ISO 8601-formatted duration that specifies the interval between measurement data points. Only the following subset of ISO 8601-formatted time periods are supported: PT10S, PT1M, PT5M, PT1H, P1D. When you specify granularity, you must specify either period or start and end. - * - -h, --help - - - - false - - help for describe - * - --limit - - int - - false - - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --page - - int - - false - - Page number that specifies a page of results. This value defaults to 1. - * - --period - - string - - false - - ISO 8601-formatted time period that specifies the length of time in the past to query. You can't set this parameter and the start or end parameter in the same request. - - Mutually exclusive with --start, --end. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --start - - string - - false - - ISO 8601-formatted date and time that specifies when to start retrieving measurements. You can't set this parameter and period in the same request. - - Mutually exclusive with --period. - * - --type - - strings - - false - - Measurements to return. This option returns all measurements by default. Valid values include DATABASE_AVERAGE_OBJECT_SIZE, DATABASE_COLLECTION_COUNT, DATABASE_DATA_SIZE, DATABASE_STORAGE_SIZE, DATABASE_INDEX_SIZE, DATABASE_INDEX_COUNT, DATABASE_EXTENT_COUNT, DATABASE_OBJECT_COUNT, and DATABASE_VIEW_COUNT - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - # Return the JSON-formatted disk metrics from the last 36 hours with 5-minute granularity for the database named testDB in the host atlas-lnmtkm-shard-00-00.ajlj3.mongodb.net:27017 - atlas metrics disks describe atlas-lnmtkm-shard-00-00.ajlj3.mongodb.net:27017 testDB --granularity PT1M --period P1DT12H --output json diff --git a/docs/command/atlas-metrics-disks-list.txt b/docs/command/atlas-metrics-disks-list.txt deleted file mode 100644 index d541f41a04..0000000000 --- a/docs/command/atlas-metrics-disks-list.txt +++ /dev/null @@ -1,118 +0,0 @@ -.. _atlas-metrics-disks-list: - -======================== -atlas metrics disks list -======================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return all disks or disk partitions on the specified host for your project. - -To return the hostname and port needed for this command, run: -$ atlas processes list - -To use this command, you must authenticate with a user account or an API key with the Project Read Only role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas metrics disks list [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - hostname:port - - string - - true - - Hostname and port number of the instance running the MongoDB process. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for list - * - --limit - - int - - false - - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. - * - --omitCount - - - - false - - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --page - - int - - false - - Page number that specifies a page of results. This value defaults to 1. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - PARTITION NAME - - - -Examples --------- - -.. code-block:: - :copyable: false - - # Return a JSON-formatted list of disks and partitions for the host atlas-lnmtkm-shard-00-00.ajlj3.mongodb.net:27017 - atlas metrics disks list atlas-lnmtkm-shard-00-00.ajlj3.mongodb.net:27017 --output json diff --git a/docs/command/atlas-metrics-disks.txt b/docs/command/atlas-metrics-disks.txt deleted file mode 100644 index 42bd8f2120..0000000000 --- a/docs/command/atlas-metrics-disks.txt +++ /dev/null @@ -1,61 +0,0 @@ -.. _atlas-metrics-disks: - -=================== -atlas metrics disks -=================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -List available disks or disk metrics for a given host. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for disks - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-metrics-disks-describe` - Return the measurements of a disk or partition on the specified host. -* :ref:`atlas-metrics-disks-list` - Return all disks or disk partitions on the specified host for your project. - - -.. toctree:: - :titlesonly: - - describe - list - diff --git a/docs/command/atlas-metrics-processes.txt b/docs/command/atlas-metrics-processes.txt deleted file mode 100644 index 62cc60519f..0000000000 --- a/docs/command/atlas-metrics-processes.txt +++ /dev/null @@ -1,129 +0,0 @@ -.. _atlas-metrics-processes: - -======================= -atlas metrics processes -======================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return the process measurements for the specified host. - -To return the hostname and port needed for this command, run -atlas processes list - -To use this command, you must authenticate with a user account or an API key with the Project Read Only role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas metrics processes [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - hostname:port - - string - - true - - Hostname and port number of the instance running the MongoDB process. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --end - - string - - false - - ISO 8601-formatted date and time that specifies when to stop retrieving measurements. You can't set this parameter and period in the same request. - - Mutually exclusive with --period. - * - --granularity - - string - - true - - ISO 8601-formatted duration that specifies the interval between measurement data points. Only the following subset of ISO 8601-formatted time periods are supported: PT10S, PT1M, PT5M, PT1H, P1D. When you specify granularity, you must specify either period or start and end. - * - -h, --help - - - - false - - help for processes - * - --limit - - int - - false - - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --page - - int - - false - - Page number that specifies a page of results. This value defaults to 1. - * - --period - - string - - false - - ISO 8601-formatted time period that specifies the length of time in the past to query. You can't set this parameter and the start or end parameter in the same request. - - Mutually exclusive with --start, --end. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --start - - string - - false - - ISO 8601-formatted date and time that specifies when to start retrieving measurements. You can't set this parameter and period in the same request. - - Mutually exclusive with --period. - * - --type - - strings - - false - - Measurements to return. This option returns all measurements by default. To learn which values the CLI accepts, see the Items Enum for m in the Atlas API spec: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/#tag/Monitoring-and-Logs/operation/getHostMeasurements/. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - # Return the JSON-formatted process metrics for the host atlas-lnmtkm-shard-00-00.ajlj3.mongodb.net:27017 - atlas metrics processes atlas-lnmtkm-shard-00-00.ajlj3.mongodb.net:27017 --output json diff --git a/docs/command/atlas-metrics.txt b/docs/command/atlas-metrics.txt deleted file mode 100644 index a1c5aadc66..0000000000 --- a/docs/command/atlas-metrics.txt +++ /dev/null @@ -1,63 +0,0 @@ -.. _atlas-metrics: - -============= -atlas metrics -============= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Get metrics on the MongoDB process. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for metrics - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-metrics-databases` - List available databases or database metrics for a given host. -* :ref:`atlas-metrics-disks` - List available disks or disk metrics for a given host. -* :ref:`atlas-metrics-processes` - Return the process measurements for the specified host. - - -.. toctree:: - :titlesonly: - - databases - disks - processes - diff --git a/docs/command/atlas-networking-containers-delete.txt b/docs/command/atlas-networking-containers-delete.txt deleted file mode 100644 index 689524ce53..0000000000 --- a/docs/command/atlas-networking-containers-delete.txt +++ /dev/null @@ -1,102 +0,0 @@ -.. _atlas-networking-containers-delete: - -================================== -atlas networking containers delete -================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Remove the specified network peering container from your project before creating any clusters. Don't run this command if you have clusters in your project. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas networking containers delete [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - containerId - - string - - true - - Unique 24-hexadecimal digit string that identifies the network container that you want to remove. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --force - - - - false - - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. - * - -h, --help - - - - false - - help for delete - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Network peering container '' deleted - - -Examples --------- - -.. code-block:: - :copyable: false - - # Remove the network peering container with the ID 5e44103f8d614b2f0b6530d8 from the project with the ID 5e2211c17a3e5a48f5497de3: - atlas networking containers delete 5e44103f8d614b2f0b6530d8 --projectId 5e2211c17a3e5a48f5497de3 diff --git a/docs/command/atlas-networking-containers-list.txt b/docs/command/atlas-networking-containers-list.txt deleted file mode 100644 index a8750b67d6..0000000000 --- a/docs/command/atlas-networking-containers-list.txt +++ /dev/null @@ -1,92 +0,0 @@ -.. _atlas-networking-containers-list: - -================================ -atlas networking containers list -================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return all network peering containers for your project. - -To use this command, you must authenticate with a user account or an API key with the Project Read Only role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas networking containers list [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for list - * - --limit - - int - - false - - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. - * - --omitCount - - - - false - - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --page - - int - - false - - Page number that specifies a page of results. This value defaults to 1. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --provider - - string - - false - - Name of your cloud service provider. Valid values are AWS, AZURE, or GCP. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - # Return a JSON-formatted list of network peering containers in the project with the ID 5e2211c17a3e5a48f5497de3: - atlas networking containers list --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-networking-containers.txt b/docs/command/atlas-networking-containers.txt deleted file mode 100644 index 6756369132..0000000000 --- a/docs/command/atlas-networking-containers.txt +++ /dev/null @@ -1,61 +0,0 @@ -.. _atlas-networking-containers: - -=========================== -atlas networking containers -=========================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage Network Peering containers. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for containers - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-networking-containers-delete` - Remove the specified network peering container from your project before creating any clusters. Don't run this command if you have clusters in your project. -* :ref:`atlas-networking-containers-list` - Return all network peering containers for your project. - - -.. toctree:: - :titlesonly: - - delete - list - diff --git a/docs/command/atlas-networking-peering-create-aws.txt b/docs/command/atlas-networking-peering-create-aws.txt deleted file mode 100644 index 111a3de4cc..0000000000 --- a/docs/command/atlas-networking-peering-create-aws.txt +++ /dev/null @@ -1,110 +0,0 @@ -.. _atlas-networking-peering-create-aws: - -=================================== -atlas networking peering create aws -=================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create a network peering connection between the Atlas VPC and your AWS VPC. - -The network peering create command checks if a VPC exists in the region you specify for your Atlas project. If one exists, this command creates the peering connection between that VPC and your VPC. If an Atlas VPC doesn't exist, this command creates one and creates a connection between it and your VPC. - -To learn more about network peering connections, see https://www.mongodb.com/docs/atlas/security-vpc-peering/. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas networking peering create aws [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --accountId - - string - - true - - Unique twelve-digit AWS account ID that owns the peer VPC. - * - --atlasCidrBlock - - string - - false - - CIDR block that Atlas uses for all network peering connections created in the project. This option is required only if you do not already have an Atlas VPC. To learn more, see the Atlas UI tab at https://dochub.mongodb.org/core/peering-connection-atlas. - * - -h, --help - - - - false - - help for aws - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --region - - string - - true - - Cloud provider region where the VPC that you peered with the Atlas VPC resides. - * - --routeTableCidrBlock - - string - - true - - Peer VPC CIDR block or subnet. - * - --vpcId - - string - - true - - Unique identifier of the peer VPC. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Network peering connection '' created. - - -Examples --------- - -.. code-block:: - :copyable: false - - # Create a network peering connection between the Atlas VPC in CIDR block 192.168.0.0/24 and your AWS VPC in CIDR block 10.0.0.0/24 for AWS account number 854333054055: - atlas networking peering create aws --accountId 854333054055 --atlasCidrBlock 192.168.0.0/24 --region us-east-1 --routeTableCidrBlock 10.0.0.0/24 --vpcId vpc-078ac381aa90e1e63 diff --git a/docs/command/atlas-networking-peering-create-azure.txt b/docs/command/atlas-networking-peering-create-azure.txt deleted file mode 100644 index 714d7b51a0..0000000000 --- a/docs/command/atlas-networking-peering-create-azure.txt +++ /dev/null @@ -1,116 +0,0 @@ -.. _atlas-networking-peering-create-azure: - -===================================== -atlas networking peering create azure -===================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create a network peering connection between the Atlas VPC and your Azure VNet. - -Before you create an Azure network peering connection, complete the prerequisites listed here: https://www.mongodb.com/docs/atlas/reference/api/vpc-create-peering-connection/#prerequisites. - -The network peering create command checks if a VNet exists in the region you specify for your Atlas project. If one exists, this command creates the peering connection between that VNet and your VPC. If an Atlas VPC does not exist, this command creates one and creates a connection between it and your VNet. - -To learn more about network peering connections, see https://www.mongodb.com/docs/atlas/security-vpc-peering/. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas networking peering create azure [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --atlasCidrBlock - - string - - false - - CIDR block that Atlas uses for all network peering connections created in the project. This option is required only if you do not already have an Atlas VPC. To learn more, see the Atlas UI tab at https://dochub.mongodb.org/core/peering-connection-atlas. - * - --directoryId - - string - - true - - Unique identifier for an Azure AD directory. - * - -h, --help - - - - false - - help for azure - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --region - - string - - true - - Cloud provider region where the VPC that you peered with the Atlas VPC resides. - * - --resourceGroup - - string - - true - - Name of your Azure resource group. - * - --subscriptionId - - string - - true - - Unique identifier of the Azure subscription in which the VNet resides. - * - --vnet - - string - - true - - Name of your Azure VNet. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Network peering connection '' created. - - -Examples --------- - -.. code-block:: - :copyable: false - - # Create a network peering connection between the Atlas VPC in CIDR block 192.168.0.0/24 and your Azure VNet named atlascli-test in in US_EAST_2: - atlas networking peering create azure --atlasCidrBlock 192.168.0.0/24 --directoryId 56657fdb-ca45-40dc-fr56-77fd8b6d2b37 --subscriptionId 345654f3-77cf-4084-9e06-8943a079ed75 --resourceGroup atlascli-test --region US_EAST_2 --vnet atlascli-test diff --git a/docs/command/atlas-networking-peering-create-gcp.txt b/docs/command/atlas-networking-peering-create-gcp.txt deleted file mode 100644 index 6110e4fcd2..0000000000 --- a/docs/command/atlas-networking-peering-create-gcp.txt +++ /dev/null @@ -1,106 +0,0 @@ -.. _atlas-networking-peering-create-gcp: - -=================================== -atlas networking peering create gcp -=================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create a network peering connection between the Atlas VPC and your Google Cloud VPC. - -The network peering create command checks if a VPC exists in the region you specify for your Atlas project. If one exists, this command creates the peering connection between that VPC and your VPC. If an Atlas VPC doesn't exist, this command creates one and creates a connection between it and your VPC. - -To learn more about network peering connections, see https://www.mongodb.com/docs/atlas/security-vpc-peering/. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas networking peering create gcp [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --atlasCidrBlock - - string - - true - - CIDR block that Atlas uses for all network peering connections created in the project. This option is required only if you do not already have an Atlas VPC. To learn more, see the Atlas UI tab at https://dochub.mongodb.org/core/peering-connection-atlas. - * - --gcpProjectId - - string - - false - - Unique identifier of the GCP project in which the network peer resides. - * - -h, --help - - - - false - - help for gcp - * - --network - - string - - false - - Unique identifier of the Network Peering connection in the Atlas project. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --region - - strings - - false - - List of Atlas regions where the container resides. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Network peering connection '' created. - - -Examples --------- - -.. code-block:: - :copyable: false - - # Create a network peering connection between the Atlas VPC in CIDR block 192.168.0.0/24 and your GCP VPC with the GCP project ID grandiose-branch-256701 in the network named cli-test: - atlas networking peering create gcp --atlasCidrBlock 192.168.0.0/24 --gcpProjectId grandiose-branch-256701 --network cli-test --output json diff --git a/docs/command/atlas-networking-peering-create.txt b/docs/command/atlas-networking-peering-create.txt deleted file mode 100644 index fbe947b7b4..0000000000 --- a/docs/command/atlas-networking-peering-create.txt +++ /dev/null @@ -1,63 +0,0 @@ -.. _atlas-networking-peering-create: - -=============================== -atlas networking peering create -=============================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create a connection with AWS, Azure and Google Cloud. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for create - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-networking-peering-create-aws` - Create a network peering connection between the Atlas VPC and your AWS VPC. -* :ref:`atlas-networking-peering-create-azure` - Create a network peering connection between the Atlas VPC and your Azure VNet. -* :ref:`atlas-networking-peering-create-gcp` - Create a network peering connection between the Atlas VPC and your Google Cloud VPC. - - -.. toctree:: - :titlesonly: - - aws - azure - gcp - diff --git a/docs/command/atlas-networking-peering-delete.txt b/docs/command/atlas-networking-peering-delete.txt deleted file mode 100644 index ec44e2d033..0000000000 --- a/docs/command/atlas-networking-peering-delete.txt +++ /dev/null @@ -1,102 +0,0 @@ -.. _atlas-networking-peering-delete: - -=============================== -atlas networking peering delete -=============================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Remove the specified peering connection from your project. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas networking peering delete [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - peerId - - string - - true - - Unique ID of the network peering connection that you want to delete. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --force - - - - false - - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. - * - -h, --help - - - - false - - help for delete - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Peering connection '' deleted - - -Examples --------- - -.. code-block:: - :copyable: false - - # Remove the network peering connection with the ID 5f60c5bd0948295c093565ba in the project with the ID 5e2211c17a3e5a48f5497de3: - atlas networking peering delete 5f60c5bd0948295c093565ba --projectId 5e2211c17a3e5a48f5497de3 diff --git a/docs/command/atlas-networking-peering-list.txt b/docs/command/atlas-networking-peering-list.txt deleted file mode 100644 index e47c6e0848..0000000000 --- a/docs/command/atlas-networking-peering-list.txt +++ /dev/null @@ -1,92 +0,0 @@ -.. _atlas-networking-peering-list: - -============================= -atlas networking peering list -============================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return the details for all network peering connections for your project. - -To use this command, you must authenticate with a user account or an API key with the Project Read Only role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas networking peering list [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for list - * - --limit - - int - - false - - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. - * - --omitCount - - - - false - - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --page - - int - - false - - Page number that specifies a page of results. This value defaults to 1. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --provider - - string - - false - - Name of your cloud service provider. Valid values are AWS, AZURE, or GCP. This value defaults to "AWS". - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - # Return the JSON-formatted details for all network peering connections in the project with the ID 5e2211c17a3e5a48f5497de3: - atlas networking peering list --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-networking-peering-watch.txt b/docs/command/atlas-networking-peering-watch.txt deleted file mode 100644 index 7c8e3ec7af..0000000000 --- a/docs/command/atlas-networking-peering-watch.txt +++ /dev/null @@ -1,108 +0,0 @@ -.. _atlas-networking-peering-watch: - -============================== -atlas networking peering watch -============================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Watch the specified peering connection in your project until it becomes available. - -This command checks the peering connection's status periodically until it becomes available. -Once it reaches the expected state, the command prints "Network peering changes completed." -If you run the command in the terminal, it blocks the terminal session until the resource is available. -You can interrupt the command's polling at any time with CTRL-C. - -To use this command, you must authenticate with a user account or an API key with the Project Read Only role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas networking peering watch [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - peerId - - string - - true - - Unique ID of the network peering connection that you want to watch. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for watch - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - - Network peering changes completed. - - -Examples --------- - -.. code-block:: - :copyable: false - - Watch for the network peering connection with the ID 5f621dc701240c5b7c3a888e to become available in the project with the ID 5e2211c17a3e5a48f5497de3: - atlas networking peering watch 5f621dc701240c5b7c3a888e --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-networking-peering.txt b/docs/command/atlas-networking-peering.txt deleted file mode 100644 index fdeb3a8f5f..0000000000 --- a/docs/command/atlas-networking-peering.txt +++ /dev/null @@ -1,65 +0,0 @@ -.. _atlas-networking-peering: - -======================== -atlas networking peering -======================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage Network Peering connections. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for peering - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-networking-peering-create` - Create a connection with AWS, Azure and Google Cloud. -* :ref:`atlas-networking-peering-delete` - Remove the specified peering connection from your project. -* :ref:`atlas-networking-peering-list` - Return the details for all network peering connections for your project. -* :ref:`atlas-networking-peering-watch` - Watch the specified peering connection in your project until it becomes available. - - -.. toctree:: - :titlesonly: - - create - delete - list - watch - diff --git a/docs/command/atlas-networking.txt b/docs/command/atlas-networking.txt deleted file mode 100644 index e98acb29b2..0000000000 --- a/docs/command/atlas-networking.txt +++ /dev/null @@ -1,61 +0,0 @@ -.. _atlas-networking: - -================ -atlas networking -================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage or configure network peering for your Atlas project. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for networking - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-networking-containers` - Manage Network Peering containers. -* :ref:`atlas-networking-peering` - Manage Network Peering connections. - - -.. toctree:: - :titlesonly: - - containers - peering - diff --git a/docs/command/atlas-organizations-apiKeys-accessLists-create.txt b/docs/command/atlas-organizations-apiKeys-accessLists-create.txt deleted file mode 100644 index 7ba279eced..0000000000 --- a/docs/command/atlas-organizations-apiKeys-accessLists-create.txt +++ /dev/null @@ -1,104 +0,0 @@ -.. _atlas-organizations-apiKeys-accessLists-create: - -============================================== -atlas organizations apiKeys accessLists create -============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create an IP access list entry for your API Key. - -To view possible values for the apiKey option, run atlas organizations apiKeys list. - -To use this command, you must authenticate with a user account or an API key with the Read Write role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas organizations apiKeys accessLists create [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --apiKey - - string - - true - - Unique 24-digit ID that identifies your API key. - * - --cidr - - strings - - false - - Access list entry in CIDR notation to be added for your API key. To add more than one entry, you can specify each entry with a separate cidr flag or specify all the entries as a comma-separated list using one cidr flag. You can't set both cidr and ip in the same command. - * - --currentIp - - - - false - - Flag that adds the IP address from the host that is currently executing the command to the access list. Only applicable for type ipAddress entries. You don't need the entry argument when you use the currentIp option. - * - -h, --help - - - - false - - help for create - * - --ip - - strings - - false - - IP address to add to the access list for your API key. To add more than one IP address, specify each address with a separate ip flag or specify all addresses as a comma-separated list using one ip flag. You can't set both ip and cidr in the same command. - * - --orgId - - string - - false - - Organization ID to use. This option overrides the settings in the configuration file or environment variable. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Created new access list entry(s). - - -Examples --------- - -.. code-block:: - :copyable: false - - # Create access list entries for two IP addresses for the API key with the ID 5f24084d8dbffa3ad3f21234 in the organization with the ID 5a1b39eec902201990f12345: - atlas organizations apiKeys accessLists create --apiKey 5f24084d8dbffa3ad3f21234 --cidr 192.0.2.0/24,198.51.100.0/24 --orgId 5a1b39eec902201990f12345 --output json diff --git a/docs/command/atlas-organizations-apiKeys-accessLists-delete.txt b/docs/command/atlas-organizations-apiKeys-accessLists-delete.txt deleted file mode 100644 index 76735790d6..0000000000 --- a/docs/command/atlas-organizations-apiKeys-accessLists-delete.txt +++ /dev/null @@ -1,106 +0,0 @@ -.. _atlas-organizations-apiKeys-accessLists-delete: - -============================================== -atlas organizations apiKeys accessLists delete -============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Remove the specified IP access list entry from your API Key. - -To use this command, you must authenticate with a user account or an API key with the Read Write role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas organizations apiKeys accessLists delete [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - entry - - string - - true - - IP or CIDR address that you want to remove from the access list. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --apiKey - - string - - false - - Unique 24-digit ID that identifies your API key. - * - --force - - - - false - - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. - * - -h, --help - - - - false - - help for delete - * - --orgId - - string - - false - - Organization ID to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Access list entry '' deleted - - -Examples --------- - -.. code-block:: - :copyable: false - - # Remove the IP address 192.0.2.0 from the access list for the API key with the ID 5f24084d8dbffa3ad3f21234 in the organization with the ID 5a1b39eec902201990f12345: - atlas organizations apiKeys accessLists delete 192.0.2.0 --apiKey 5f24084d8dbffa3ad3f21234 --orgId 5a1b39eec902201990f12345 diff --git a/docs/command/atlas-organizations-apiKeys-accessLists-list.txt b/docs/command/atlas-organizations-apiKeys-accessLists-list.txt deleted file mode 100644 index b18ee729a7..0000000000 --- a/docs/command/atlas-organizations-apiKeys-accessLists-list.txt +++ /dev/null @@ -1,106 +0,0 @@ -.. _atlas-organizations-apiKeys-accessLists-list: - -============================================ -atlas organizations apiKeys accessLists list -============================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return all IP access list entries for your API Key. - -To view possible values for the apiKeyID argument, run atlas organizations apiKeys list. - -To use this command, you must authenticate with a user account or an API key with the Organization Member role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas organizations apiKeys accessLists list [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - apiKeyID - - string - - true - - Unique 24-digit string that identifies your API key. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for list - * - --limit - - int - - false - - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. - * - --omitCount - - - - false - - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. - * - --orgId - - string - - false - - Organization ID to use. This option overrides the settings in the configuration file or environment variable. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --page - - int - - false - - Page number that specifies a page of results. This value defaults to 1. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - # Return a JSON-formatted list of access list entries for the API key with the ID 5f24084d8dbffa3ad3f21234 in the organization with the ID 5a1b39eec902201990f12345: - atlas organizations apiKeys accessLists list --apiKey 5f24084d8dbffa3ad3f21234 --orgId 5a1b39eec902201990f12345 --output json diff --git a/docs/command/atlas-organizations-apiKeys-accessLists.txt b/docs/command/atlas-organizations-apiKeys-accessLists.txt deleted file mode 100644 index 93b1ff2009..0000000000 --- a/docs/command/atlas-organizations-apiKeys-accessLists.txt +++ /dev/null @@ -1,63 +0,0 @@ -.. _atlas-organizations-apiKeys-accessLists: - -======================================= -atlas organizations apiKeys accessLists -======================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage the IP access list for your API Key. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for accessLists - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-organizations-apiKeys-accessLists-create` - Create an IP access list entry for your API Key. -* :ref:`atlas-organizations-apiKeys-accessLists-delete` - Remove the specified IP access list entry from your API Key. -* :ref:`atlas-organizations-apiKeys-accessLists-list` - Return all IP access list entries for your API Key. - - -.. toctree:: - :titlesonly: - - create - delete - list - diff --git a/docs/command/atlas-organizations-apiKeys-assign.txt b/docs/command/atlas-organizations-apiKeys-assign.txt deleted file mode 100644 index 2104f5681b..0000000000 --- a/docs/command/atlas-organizations-apiKeys-assign.txt +++ /dev/null @@ -1,114 +0,0 @@ -.. _atlas-organizations-apiKeys-assign: - -================================== -atlas organizations apiKeys assign -================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Modify the roles or description for the specified organization API key. - -When you modify the roles for an organization API key with this command, the values you specify overwrite the existing roles assigned to the API key. - -To view possible values for the apiKeyId argument, run atlas organizations apiKeys list. - -To use this command, you must authenticate with a user account or an API key with the Organization User Admin role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas organizations apiKeys assign [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - apiKeyId - - string - - true - - Unique 24-digit string that identifies your API key. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --desc - - string - - false - - Description of the API key. - * - -h, --help - - - - false - - help for assign - * - --orgId - - string - - false - - Organization ID to use. This option overrides the settings in the configuration file or environment variable. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --role - - strings - - false - - Role or roles that you want to assign to the API key. To assign more than one role, specify each role with a separate role flag or specify all of the roles as a comma-separated list using one role flag. To learn which values the CLI accepts, see the Items Enum for roles in the Atlas API spec: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createApiKey/. Passing this flag replaces preexisting data. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - API Key '' successfully updated. - - -Examples --------- - -.. code-block:: - :copyable: false - - # Modify the role and description for the API key with the ID 5f24084d8dbffa3ad3f21234 for the organization with the ID 5a1b39eec902201990f12345: - atlas organizations apiKeys assign 5f24084d8dbffa3ad3f21234 --role ORG_MEMBER --desc "User1 Member Key" --orgId 5a1b39eec902201990f12345 --output json diff --git a/docs/command/atlas-organizations-apiKeys-create.txt b/docs/command/atlas-organizations-apiKeys-create.txt deleted file mode 100644 index 03523c1e46..0000000000 --- a/docs/command/atlas-organizations-apiKeys-create.txt +++ /dev/null @@ -1,98 +0,0 @@ -.. _atlas-organizations-apiKeys-create: - -================================== -atlas organizations apiKeys create -================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create an API Key for your organization. - -MongoDB returns the private API key only once. After you run this command, immediately copy, save, and secure both the public and private API keys. - -To use this command, you must authenticate with a user account or an API key with the Organization User Admin role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas organizations apiKeys create [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --desc - - string - - true - - Description of the API key. - * - -h, --help - - - - false - - help for create - * - --orgId - - string - - false - - Organization ID to use. This option overrides the settings in the configuration file or environment variable. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --role - - strings - - true - - Role or roles that you want to assign to the API key. To assign more than one role, specify each role with a separate role flag or specify all of the roles as a comma-separated list using one role flag. To learn which values the CLI accepts, see the Items Enum for roles in the Atlas API spec: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createApiKey/. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - API Key '' created. - Public API Key - Private API Key - - -Examples --------- - -.. code-block:: - :copyable: false - - # Create an organization API key with organization owner access in the organization with the ID 5a1b39eec902201990f12345: - atlas organizations apiKeys create --role ORG_OWNER --desc "My API Key" --orgId 5a1b39eec902201990f12345 --output json diff --git a/docs/command/atlas-organizations-apiKeys-delete.txt b/docs/command/atlas-organizations-apiKeys-delete.txt deleted file mode 100644 index 37edd780fe..0000000000 --- a/docs/command/atlas-organizations-apiKeys-delete.txt +++ /dev/null @@ -1,104 +0,0 @@ -.. _atlas-organizations-apiKeys-delete: - -================================== -atlas organizations apiKeys delete -================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Remove the specified API key for your organization. - -To view possible values for the ID argument, run atlas organizations apiKeys list. - -To use this command, you must authenticate with a user account or an API key with the Organization User Admin role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas organizations apiKeys delete [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - ID - - string - - true - - Unique 24-digit string that identifies the organization's API key. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --force - - - - false - - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. - * - -h, --help - - - - false - - help for delete - * - --orgId - - string - - false - - Organization ID to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - API Key '' deleted - - -Examples --------- - -.. code-block:: - :copyable: false - - # Remove the organization API key with the ID 5f24084d8dbffa3ad3f21234 for the organization with the ID 5a1b39eec902201990f12345: - atlas organizations apiKeys delete 5f24084d8dbffa3ad3f21234 --orgId 5a1b39eec902201990f12345 diff --git a/docs/command/atlas-organizations-apiKeys-describe.txt b/docs/command/atlas-organizations-apiKeys-describe.txt deleted file mode 100644 index 19b24d2cd3..0000000000 --- a/docs/command/atlas-organizations-apiKeys-describe.txt +++ /dev/null @@ -1,105 +0,0 @@ -.. _atlas-organizations-apiKeys-describe: - -==================================== -atlas organizations apiKeys describe -==================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return the details for the specified API key for your organization. - -To view possible values for the ID argument, run atlas organizations apiKeys list. - -To use this command, you must authenticate with a user account or an API key with the Organization Member role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas organizations apiKeys describe [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - ID - - string - - true - - Unique 24-digit string that identifies your API key. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for describe - * - --orgId - - string - - false - - Organization ID to use. This option overrides the settings in the configuration file or environment variable. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - ID DESCRIPTION PUBLIC KEY PRIVATE KEY - - - -Examples --------- - -.. code-block:: - :copyable: false - - # Return the JSON-formatted details for the organization API key with the ID 5f24084d8dbffa3ad3f21234 for the organization with the ID 5a1b39eec902201990f12345: - atlas organizations apiKeys describe 5f24084d8dbffa3ad3f21234 --orgId 5a1b39eec902201990f12345 -output json diff --git a/docs/command/atlas-organizations-apiKeys-list.txt b/docs/command/atlas-organizations-apiKeys-list.txt deleted file mode 100644 index 5c6d5e5410..0000000000 --- a/docs/command/atlas-organizations-apiKeys-list.txt +++ /dev/null @@ -1,92 +0,0 @@ -.. _atlas-organizations-apiKeys-list: - -================================ -atlas organizations apiKeys list -================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return all API keys for your organization. - -To use this command, you must authenticate with a user account or an API key with the Organization Member role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas organizations apiKeys list [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -c, --compact - - - - false - - Flag that enables the compact array response structure for a json output. The --compact option returns array objects as top-level responses and allows backward compatibility for scripts based on previous CLI versions. Omitting the --compact option for a json output returns array objects within a 'results' sub-array. You must specify --output json to use this option. - * - -h, --help - - - - false - - help for list - * - --limit - - int - - false - - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. - * - --omitCount - - - - false - - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. - * - --orgId - - string - - false - - Organization ID to use. This option overrides the settings in the configuration file or environment variable. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --page - - int - - false - - Page number that specifies a page of results. This value defaults to 1. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - # Return a JSON-formatted list of organization API keys for the organization with the ID 5a1b39eec902201990f12345: - atlas organizations apiKeys list --orgId 5a1b39eec902201990f12345 --output json diff --git a/docs/command/atlas-organizations-apiKeys.txt b/docs/command/atlas-organizations-apiKeys.txt deleted file mode 100644 index d4af319a1e..0000000000 --- a/docs/command/atlas-organizations-apiKeys.txt +++ /dev/null @@ -1,69 +0,0 @@ -.. _atlas-organizations-apiKeys: - -=========================== -atlas organizations apiKeys -=========================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Organization API Keys operations. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for apiKeys - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-organizations-apiKeys-accessLists` - Manage the IP access list for your API Key. -* :ref:`atlas-organizations-apiKeys-assign` - Modify the roles or description for the specified organization API key. -* :ref:`atlas-organizations-apiKeys-create` - Create an API Key for your organization. -* :ref:`atlas-organizations-apiKeys-delete` - Remove the specified API key for your organization. -* :ref:`atlas-organizations-apiKeys-describe` - Return the details for the specified API key for your organization. -* :ref:`atlas-organizations-apiKeys-list` - Return all API keys for your organization. - - -.. toctree:: - :titlesonly: - - accessLists - assign - create - delete - describe - list - diff --git a/docs/command/atlas-organizations-create.txt b/docs/command/atlas-organizations-create.txt deleted file mode 100644 index f427a5093a..0000000000 --- a/docs/command/atlas-organizations-create.txt +++ /dev/null @@ -1,104 +0,0 @@ -.. _atlas-organizations-create: - -========================== -atlas organizations create -========================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create an organization. - -When authenticating using API keys, the organization to which the API keys belong must have cross-organization billing enabled. The resulting org will be linked to the paying org. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas organizations create [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - name - - string - - true - - Label that identifies the organization. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --apiKeyDescription - - string - - false - - Description of the API key.Required when creating organizations authenticated with API Keys. - * - --apiKeyRole - - strings - - false - - Role or roles that you want to assign to the API key. To assign more than one role, specify each role with a separate role flag or specify all of the roles as a comma-separated list using one role flag. To learn which values the CLI accepts, see the Items Enum for roles in the Atlas API spec: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createApiKey/.Required when creating organizations authenticated with API Keys. - * - --federationSettingsId - - string - - false - - Unique 24-hexadecimal digit string that identifies the federation settings. - * - -h, --help - - - - false - - help for create - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --ownerId - - string - - false - - Unique 24-digit string that identifies the Atlas user to be granted the Org Owner role on the specified organization. Required if using API keys. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - # Create an Atlas organization with the name myOrg: - atlas organizations create myOrg --output json diff --git a/docs/command/atlas-organizations-delete.txt b/docs/command/atlas-organizations-delete.txt deleted file mode 100644 index 1f6a6afc13..0000000000 --- a/docs/command/atlas-organizations-delete.txt +++ /dev/null @@ -1,100 +0,0 @@ -.. _atlas-organizations-delete: - -========================== -atlas organizations delete -========================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Remove the specified organization. - -Organizations with active projects can't be removed. - -To use this command, you must authenticate with a user account or an API key with the Organization Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas organizations delete [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - ID - - string - - true - - Unique 24-digit string that identifies the organization. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --force - - - - false - - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. - * - -h, --help - - - - false - - help for delete - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Organization '' deleted - - -Examples --------- - -.. code-block:: - :copyable: false - - # Remove the organization with the ID 5e2211c17a3e5a48f5497de3: - atlas organizations delete 5e2211c17a3e5a48f5497de3 diff --git a/docs/command/atlas-organizations-describe.txt b/docs/command/atlas-organizations-describe.txt deleted file mode 100644 index 52b0e108ea..0000000000 --- a/docs/command/atlas-organizations-describe.txt +++ /dev/null @@ -1,99 +0,0 @@ -.. _atlas-organizations-describe: - -============================ -atlas organizations describe -============================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return the details for the specified organizations. - -To use this command, you must authenticate with a user account or an API key with the Organization Member role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas organizations describe [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - ID - - string - - true - - Unique 24-digit string that identifies the organization. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for describe - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - ID NAME - - - -Examples --------- - -.. code-block:: - :copyable: false - - # Return the JSON-formatted details for the organization with the ID 5e2211c17a3e5a48f5497de3: - atlas organizations describe 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-organizations-invitations-delete.txt b/docs/command/atlas-organizations-invitations-delete.txt deleted file mode 100644 index ebd795ec8b..0000000000 --- a/docs/command/atlas-organizations-invitations-delete.txt +++ /dev/null @@ -1,102 +0,0 @@ -.. _atlas-organizations-invitations-delete: - -====================================== -atlas organizations invitations delete -====================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Remove the specified pending invitation to your organization. - -To use this command, you must authenticate with a user account or an API key with the Organization User Admin role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas organizations invitations delete [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - invitationId - - string - - true - - Unique 24-digit string that identifies the invitation. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --force - - - - false - - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. - * - -h, --help - - - - false - - help for delete - * - --orgId - - string - - false - - Organization ID to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Invitation '' deleted - - -Examples --------- - -.. code-block:: - :copyable: false - - # Remove the pending invitation with the ID 5dd56c847a3e5a1f363d424d from the organization with the ID 5f71e5255afec75a3d0f96dc: - atlas organizations invitations delete 5dd56c847a3e5a1f363d424d --orgId 5f71e5255afec75a3d0f96dc diff --git a/docs/command/atlas-organizations-invitations-describe.txt b/docs/command/atlas-organizations-invitations-describe.txt deleted file mode 100644 index c842a75fb8..0000000000 --- a/docs/command/atlas-organizations-invitations-describe.txt +++ /dev/null @@ -1,92 +0,0 @@ -.. _atlas-organizations-invitations-describe: - -======================================== -atlas organizations invitations describe -======================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return the details for the specified pending invitation to your organization. - -To use this command, you must authenticate with a user account or an API key with the Organization User Admin role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas organizations invitations describe [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - invitationId - - string - - true - - Unique 24-digit string that identifies the invitation. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for describe - * - --orgId - - string - - false - - Organization ID to use. This option overrides the settings in the configuration file or environment variable. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - # Return the JSON-formatted details of the pending invitation with the ID 5dd56c847a3e5a1f363d424d for the organization with the ID 5f71e5255afec75a3d0f96dc: - atlas organizations invitations describe 5dd56c847a3e5a1f363d424d --orgId 5f71e5255afec75a3d0f96dc --output json diff --git a/docs/command/atlas-organizations-invitations-invite.txt b/docs/command/atlas-organizations-invitations-invite.txt deleted file mode 100644 index 43707f830f..0000000000 --- a/docs/command/atlas-organizations-invitations-invite.txt +++ /dev/null @@ -1,120 +0,0 @@ -.. _atlas-organizations-invitations-invite: - -====================================== -atlas organizations invitations invite -====================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Invite the specified MongoDB user to your organization. - -To use this command, you must authenticate with a user account or an API key with the Organization User Admin role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas organizations invitations invite [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - email - - string - - true - - Email address that belongs to the user that you want to invite to the organization. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -f, --file - - string - - false - - Path to an optional JSON configuration file that defines invitation settings. To learn more about invitation configuration files for the Atlas CLI, see https://XXX. - - Mutually exclusive with --role, --teamId. - * - -h, --help - - - - false - - help for invite - * - --orgId - - string - - false - - Organization ID to use. This option overrides the settings in the configuration file or environment variable. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --role - - strings - - false - - User's roles for the associated organization. Valid values include ORG_OWNER, ORG_MEMBER, ORG_GROUP_CREATOR, ORG_BILLING_ADMIN, and ORG_READ_ONLY. - - Mutually exclusive with --file. - * - --teamId - - strings - - false - - Unique 24-digit string that identifies the team. - - Mutually exclusive with --file. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - User '' invited. - - -Examples --------- - -.. code-block:: - :copyable: false - - # Invite the MongoDB user with the email user@example.com to the organization with the ID 5f71e5255afec75a3d0f96dc with ORG_OWNER access: - atlas organizations invitations invite user@example.com --orgId 5f71e5255afec75a3d0f96dc --role ORG_OWNER --output json diff --git a/docs/command/atlas-organizations-invitations-list.txt b/docs/command/atlas-organizations-invitations-list.txt deleted file mode 100644 index 074015dd98..0000000000 --- a/docs/command/atlas-organizations-invitations-list.txt +++ /dev/null @@ -1,80 +0,0 @@ -.. _atlas-organizations-invitations-list: - -==================================== -atlas organizations invitations list -==================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return all pending invitations to your organization. - -To use this command, you must authenticate with a user account or an API key with the Organization User Admin role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas organizations invitations list [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --email - - string - - false - - Email address for the user. - * - -h, --help - - - - false - - help for list - * - --orgId - - string - - false - - Organization ID to use. This option overrides the settings in the configuration file or environment variable. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - # Return a JSON-formatted list of pending invitations to the organization with the ID 5f71e5255afec75a3d0f96dc: - atlas organizations invitations list --orgId 5f71e5255afec75a3d0f96dc --output json diff --git a/docs/command/atlas-organizations-invitations-update.txt b/docs/command/atlas-organizations-invitations-update.txt deleted file mode 100644 index ad54295d85..0000000000 --- a/docs/command/atlas-organizations-invitations-update.txt +++ /dev/null @@ -1,119 +0,0 @@ -.. _atlas-organizations-invitations-update: - -====================================== -atlas organizations invitations update -====================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Modifies the details of the specified pending invitation to your organization. - -You can use either the invitation ID or the user's email address to specify the invitation. - -To use this command, you must authenticate with a user account or an API key with the Organization Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas organizations invitations update [invitationId] [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - invitationId - - string - - false - - Unique 24-digit string that identifies the invitation. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --email - - string - - false - - Email address for the user. - * - -h, --help - - - - false - - help for update - * - --orgId - - string - - false - - Organization ID to use. This option overrides the settings in the configuration file or environment variable. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --role - - strings - - true - - User's roles for the associated organization. Valid values include ORG_OWNER, ORG_MEMBER, ORG_GROUP_CREATOR, ORG_BILLING_ADMIN, and ORG_READ_ONLY. Passing this flag replaces preexisting data. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Invitation updated. - - -Examples --------- - -.. code-block:: - :copyable: false - - # Modify the pending invitation with the ID 5dd56c847a3e5a1f363d424d to grant ORG_OWNER access the organization with the ID 5f71e5255afec75a3d0f96dc: - atlas organizations invitations update 5dd56c847a3e5a1f363d424d --orgId 5f71e5255afec75a3d0f96dc --role ORG_OWNER --output json - - -.. code-block:: - :copyable: false - - # Modify the invitation for the user with the email address user@example.com to grant ORG_OWNER access the organization with the ID 5f71e5255afec75a3d0f96dc: - atlas organizations invitations update --email user@example.com --orgId 5f71e5255afec75a3d0f96dc --role ORG_OWNER --output json diff --git a/docs/command/atlas-organizations-invitations.txt b/docs/command/atlas-organizations-invitations.txt deleted file mode 100644 index 0135c98693..0000000000 --- a/docs/command/atlas-organizations-invitations.txt +++ /dev/null @@ -1,69 +0,0 @@ -.. _atlas-organizations-invitations: - -=============================== -atlas organizations invitations -=============================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Invitation operations. - -Create, list and manage your MongoDB organization invites. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for invitations - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-organizations-invitations-delete` - Remove the specified pending invitation to your organization. -* :ref:`atlas-organizations-invitations-describe` - Return the details for the specified pending invitation to your organization. -* :ref:`atlas-organizations-invitations-invite` - Invite the specified MongoDB user to your organization. -* :ref:`atlas-organizations-invitations-list` - Return all pending invitations to your organization. -* :ref:`atlas-organizations-invitations-update` - Modifies the details of the specified pending invitation to your organization. - - -.. toctree:: - :titlesonly: - - delete - describe - invite - list - update - diff --git a/docs/command/atlas-organizations-list.txt b/docs/command/atlas-organizations-list.txt deleted file mode 100644 index 5248147670..0000000000 --- a/docs/command/atlas-organizations-list.txt +++ /dev/null @@ -1,110 +0,0 @@ -.. _atlas-organizations-list: - -======================== -atlas organizations list -======================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return all organizations. - -To use this command, you must authenticate with a user account or an API key with the Organization Member role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas organizations list [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for list - * - --includeDeleted - - - - false - - Flag that indicates whether to include deleted organizations in the list. This option applies only to Ops Manager organizations. You can't return deleted Atlas or Cloud Manager organizations. - * - --limit - - int - - false - - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. - * - --name - - string - - false - - Organization name to perform a case-insensitive search for. - * - --omitCount - - - - false - - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --page - - int - - false - - Page number that specifies a page of results. This value defaults to 1. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - ID NAME - - - -Examples --------- - -.. code-block:: - :copyable: false - - # Return a JSON-formatted list of all organizations: - atlas organizations list --output json - - -.. code-block:: - :copyable: false - - # Return a JSON-formatted list that includes the organizations named org1 and Org1, but doesn't return org123: - atlas organizations list --name org1 --output json diff --git a/docs/command/atlas-organizations-users-list.txt b/docs/command/atlas-organizations-users-list.txt deleted file mode 100644 index 94299faa64..0000000000 --- a/docs/command/atlas-organizations-users-list.txt +++ /dev/null @@ -1,99 +0,0 @@ -.. _atlas-organizations-users-list: - -============================== -atlas organizations users list -============================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return all users for an organization. - -To use this command, you must authenticate with a user account or an API key with the Organization Member role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas organizations users list [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for list - * - --limit - - int - - false - - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. - * - --omitCount - - - - false - - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. - * - --orgId - - string - - false - - Organization ID to use. This option overrides the settings in the configuration file or environment variable. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --page - - int - - false - - Page number that specifies a page of results. This value defaults to 1. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - ID FIRST NAME LAST NAME USERNAME - - - -Examples --------- - -.. code-block:: - :copyable: false - - # Return a JSON-formatted list of all users for the organization with the ID 5e2211c17a3e5a48f5497de3: - atlas organizations users list --orgId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-organizations-users.txt b/docs/command/atlas-organizations-users.txt deleted file mode 100644 index 928a8825e1..0000000000 --- a/docs/command/atlas-organizations-users.txt +++ /dev/null @@ -1,59 +0,0 @@ -.. _atlas-organizations-users: - -========================= -atlas organizations users -========================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage your Atlas users. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for users - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-organizations-users-list` - Return all users for an organization. - - -.. toctree:: - :titlesonly: - - list - diff --git a/docs/command/atlas-organizations.txt b/docs/command/atlas-organizations.txt deleted file mode 100644 index fa2ee1e599..0000000000 --- a/docs/command/atlas-organizations.txt +++ /dev/null @@ -1,73 +0,0 @@ -.. _atlas-organizations: - -=================== -atlas organizations -=================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage your Atlas organizations. - -Create, list and manage your MongoDB organizations. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for organizations - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-organizations-apiKeys` - Organization API Keys operations. -* :ref:`atlas-organizations-create` - Create an organization. -* :ref:`atlas-organizations-delete` - Remove the specified organization. -* :ref:`atlas-organizations-describe` - Return the details for the specified organizations. -* :ref:`atlas-organizations-invitations` - Invitation operations. -* :ref:`atlas-organizations-list` - Return all organizations. -* :ref:`atlas-organizations-users` - Manage your Atlas users. - - -.. toctree:: - :titlesonly: - - apiKeys - create - delete - describe - invitations - list - users - diff --git a/docs/command/atlas-performanceAdvisor-namespaces-list.txt b/docs/command/atlas-performanceAdvisor-namespaces-list.txt deleted file mode 100644 index 19b5659d0d..0000000000 --- a/docs/command/atlas-performanceAdvisor-namespaces-list.txt +++ /dev/null @@ -1,92 +0,0 @@ -.. _atlas-performanceAdvisor-namespaces-list: - -======================================== -atlas performanceAdvisor namespaces list -======================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return up to 20 namespaces for collections experiencing slow queries on the specified host. - -Namespaces appear in the following format: {database}.{collection}. - -If you don't set the duration option or the since option, this command returns data from the last 24 hours. - -To use this command, you must authenticate with a user account or an API key with the Project Read Only role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas performanceAdvisor namespaces list [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --duration - - int - - false - - Length of time in milliseconds for which you want to return results. If you specify the since option, the duration starts at the date and time specified. If you don't set the since option, this command returns data from the duration before the current time. - * - -h, --help - - - - false - - help for list - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --processName - - string - - true - - Unique identifier for the host of a MongoDB process in the following format: {hostname}:{port}. You can obtain a list of possible values from the 'id' field when you run the 'atlas processes list' command. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --since - - int - - false - - Date and time from which the query retrieves the suggested indexes. Specify this value as the number of seconds that have elapsed since the UNIX epoch. If you don't set the duration option, this command returns data from the since value to the current time. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - # Return a JSON-formatted list of namespaces for collections with slow queries for the atlas-111ggi-shard-00-00.111xx.mongodb.net:27017 host in the project with the ID 5e2211c17a3e5a48f5497de3: - atlas performanceAdvisor namespaces list --processName atlas-111ggi-shard-00-00.111xx.mongodb.net:27017 --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-performanceAdvisor-namespaces.txt b/docs/command/atlas-performanceAdvisor-namespaces.txt deleted file mode 100644 index e05970fbc6..0000000000 --- a/docs/command/atlas-performanceAdvisor-namespaces.txt +++ /dev/null @@ -1,59 +0,0 @@ -.. _atlas-performanceAdvisor-namespaces: - -=================================== -atlas performanceAdvisor namespaces -=================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Retrieve namespaces for collections experiencing slow queries - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for namespaces - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-performanceAdvisor-namespaces-list` - Return up to 20 namespaces for collections experiencing slow queries on the specified host. - - -.. toctree:: - :titlesonly: - - list - diff --git a/docs/command/atlas-performanceAdvisor-slowOperationThreshold-disable.txt b/docs/command/atlas-performanceAdvisor-slowOperationThreshold-disable.txt deleted file mode 100644 index 09b64bb4cf..0000000000 --- a/docs/command/atlas-performanceAdvisor-slowOperationThreshold-disable.txt +++ /dev/null @@ -1,76 +0,0 @@ -.. _atlas-performanceAdvisor-slowOperationThreshold-disable: - -======================================================= -atlas performanceAdvisor slowOperationThreshold disable -======================================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Disable the application-managed slow operation threshold for your project. - -The slow operation threshold determines which operations are flagged by the Performance Advisor and Query Profiler. When disabled, the application considers any operation that takes longer than 100 milliseconds to be slow. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas performanceAdvisor slowOperationThreshold disable [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for disable - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Atlas management of the slow operation disabled - - diff --git a/docs/command/atlas-performanceAdvisor-slowOperationThreshold-enable.txt b/docs/command/atlas-performanceAdvisor-slowOperationThreshold-enable.txt deleted file mode 100644 index c47613c480..0000000000 --- a/docs/command/atlas-performanceAdvisor-slowOperationThreshold-enable.txt +++ /dev/null @@ -1,76 +0,0 @@ -.. _atlas-performanceAdvisor-slowOperationThreshold-enable: - -====================================================== -atlas performanceAdvisor slowOperationThreshold enable -====================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Enable the application-managed slow operation threshold for your project. - -The slow operation threshold determines which operations are flagged by the Performance Advisor and Query Profiler. When enabled, the application uses the average execution time for operations on your cluster to determine slow-running queries. As a result, the threshold is more pertinent to your cluster workload. Application-managed slow operation threshold is enabled by default for dedicated clusters (M10+). - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas performanceAdvisor slowOperationThreshold enable [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for enable - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Atlas management of the slow operation enabled - - diff --git a/docs/command/atlas-performanceAdvisor-slowOperationThreshold.txt b/docs/command/atlas-performanceAdvisor-slowOperationThreshold.txt deleted file mode 100644 index a5ad1e3e3e..0000000000 --- a/docs/command/atlas-performanceAdvisor-slowOperationThreshold.txt +++ /dev/null @@ -1,61 +0,0 @@ -.. _atlas-performanceAdvisor-slowOperationThreshold: - -=============================================== -atlas performanceAdvisor slowOperationThreshold -=============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Enable or disable management of the slow operation threshold for your cluster. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for slowOperationThreshold - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-performanceAdvisor-slowOperationThreshold-disable` - Disable the application-managed slow operation threshold for your project. -* :ref:`atlas-performanceAdvisor-slowOperationThreshold-enable` - Enable the application-managed slow operation threshold for your project. - - -.. toctree:: - :titlesonly: - - disable - enable - diff --git a/docs/command/atlas-performanceAdvisor-slowQueryLogs-list.txt b/docs/command/atlas-performanceAdvisor-slowQueryLogs-list.txt deleted file mode 100644 index 52ad8c405e..0000000000 --- a/docs/command/atlas-performanceAdvisor-slowQueryLogs-list.txt +++ /dev/null @@ -1,100 +0,0 @@ -.. _atlas-performanceAdvisor-slowQueryLogs-list: - -=========================================== -atlas performanceAdvisor slowQueryLogs list -=========================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return log lines for slow queries that the Performance Advisor and Query Profiler identified. - -The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. The threshold for slow queries varies based on the average time of operations on your cluster to provide recommendations pertinent to your workload. - -If you don't set the duration option or the since option, this command returns data from the last 24 hours. - -To use this command, you must authenticate with a user account or an API key with the Project Data Access Read/Write role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas performanceAdvisor slowQueryLogs list [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --duration - - int - - false - - Length of time in milliseconds for which you want to return results. If you specify the since option, the duration starts at the date and time specified. If you don't set the since option, this command returns data from the duration before the current time. - * - -h, --help - - - - false - - help for list - * - --nLog - - int - - false - - Maximum number of log lines to return. This value defaults to 20000. - * - --namespaces - - strings - - false - - Namespaces from which to retrieve suggested slow query logs formatted as .. Omit this parameter to return results for all namespaces. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --processName - - string - - true - - Unique identifier for the host of a MongoDB process in the following format: {hostname}:{port}. You can obtain a list of possible values from the 'id' field when you run the 'atlas processes list' command. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --since - - int - - false - - Date and time from which the query retrieves the suggested indexes. Specify this value as the number of seconds that have elapsed since the UNIX epoch. If you don't set the duration option, this command returns data from the since value to the current time. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - # Return a JSON-formatted list of log lines for collections with slow queries for the atlas-111ggi-shard-00-00.111xx.mongodb.net:27017 host in the project with the ID 5e2211c17a3e5a48f5497de3: - atlas performanceAdvisor slowQueryLogs list --processName atlas-111ggi-shard-00-00.111xx.mongodb.net:27017 --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-performanceAdvisor-slowQueryLogs.txt b/docs/command/atlas-performanceAdvisor-slowQueryLogs.txt deleted file mode 100644 index 55a1fb2c0d..0000000000 --- a/docs/command/atlas-performanceAdvisor-slowQueryLogs.txt +++ /dev/null @@ -1,59 +0,0 @@ -.. _atlas-performanceAdvisor-slowQueryLogs: - -====================================== -atlas performanceAdvisor slowQueryLogs -====================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Get log lines for slow queries for a specified host - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for slowQueryLogs - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-performanceAdvisor-slowQueryLogs-list` - Return log lines for slow queries that the Performance Advisor and Query Profiler identified. - - -.. toctree:: - :titlesonly: - - list - diff --git a/docs/command/atlas-performanceAdvisor-suggestedIndexes-list.txt b/docs/command/atlas-performanceAdvisor-suggestedIndexes-list.txt deleted file mode 100644 index bcf0b527fd..0000000000 --- a/docs/command/atlas-performanceAdvisor-suggestedIndexes-list.txt +++ /dev/null @@ -1,102 +0,0 @@ -.. _atlas-performanceAdvisor-suggestedIndexes-list: - -============================================== -atlas performanceAdvisor suggestedIndexes list -============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return the suggested indexes for collections experiencing slow queries. - -The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. - -To use this command, you must authenticate with a user account or an API key with the Project Read Only role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas performanceAdvisor suggestedIndexes list [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --duration - - int - - false - - Length of time in milliseconds for which you want to return results. If you specify the since option, the duration starts at the date and time specified. If you don't set the since option, this command returns data from the duration before the current time. - * - -h, --help - - - - false - - help for list - * - --nExamples - - int - - false - - Maximum number of example queries to provide that a suggested index will improve. - * - --nIndexes - - int - - false - - Maximum number of indexes to suggest. - * - --namespaces - - strings - - false - - Namespaces from which to retrieve suggested indexes. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --processName - - string - - true - - Unique identifier for the host of a MongoDB process in the following format: {hostname}:{port}. You can obtain a list of possible values from the 'id' field when you run the 'atlas processes list' command. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --since - - int - - false - - Date and time from which the query retrieves the suggested indexes. Specify this value as the number of seconds that have elapsed since the UNIX epoch. If you don't set the duration option, this command returns data from the since value to the current time. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - # Return a JSON-formatted list of suggested indexes for the atlas-111ggi-shard-00-00.111xx.mongodb.net:27017 host in the project with the ID 5e2211c17a3e5a48f5497de3: - atlas performanceAdvisor suggestedIndexes list --processName atlas-111ggi-shard-00-00.111xx.mongodb.net:27017 --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-performanceAdvisor-suggestedIndexes.txt b/docs/command/atlas-performanceAdvisor-suggestedIndexes.txt deleted file mode 100644 index b765cf2ebd..0000000000 --- a/docs/command/atlas-performanceAdvisor-suggestedIndexes.txt +++ /dev/null @@ -1,59 +0,0 @@ -.. _atlas-performanceAdvisor-suggestedIndexes: - -========================================= -atlas performanceAdvisor suggestedIndexes -========================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Get suggested indexes for collections experiencing slow queries - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for suggestedIndexes - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-performanceAdvisor-suggestedIndexes-list` - Return the suggested indexes for collections experiencing slow queries. - - -.. toctree:: - :titlesonly: - - list - diff --git a/docs/command/atlas-performanceAdvisor.txt b/docs/command/atlas-performanceAdvisor.txt deleted file mode 100644 index 4428b2f1ea..0000000000 --- a/docs/command/atlas-performanceAdvisor.txt +++ /dev/null @@ -1,65 +0,0 @@ -.. _atlas-performanceAdvisor: - -======================== -atlas performanceAdvisor -======================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Learn more about slow queries and get suggestions to improve database performance. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for performanceAdvisor - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-performanceAdvisor-namespaces` - Retrieve namespaces for collections experiencing slow queries -* :ref:`atlas-performanceAdvisor-slowOperationThreshold` - Enable or disable management of the slow operation threshold for your cluster. -* :ref:`atlas-performanceAdvisor-slowQueryLogs` - Get log lines for slow queries for a specified host -* :ref:`atlas-performanceAdvisor-suggestedIndexes` - Get suggested indexes for collections experiencing slow queries - - -.. toctree:: - :titlesonly: - - namespaces - slowOperationThreshold - slowQueryLogs - suggestedIndexes - diff --git a/docs/command/atlas-plugin-install.txt b/docs/command/atlas-plugin-install.txt deleted file mode 100644 index fa57e08fbc..0000000000 --- a/docs/command/atlas-plugin-install.txt +++ /dev/null @@ -1,99 +0,0 @@ -.. _atlas-plugin-install: - -==================== -atlas plugin install -==================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Install Atlas CLI plugin from a GitHub repository. - -Install an Atlas CLI plugin from a GitHub repository. -You can specify a GitHub repository using either the "/" format or a full URL. -When you install the plugin, its latest release on GitHub is used by default. -To install a specific version of the plugin, append the version number directly to the plugin name using the @ symbol. - -MongoDB provides an example plugin: https://github.com/mongodb/atlas-cli-plugin-example - - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas plugin install [/] [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - / - - string - - false - - Repository identifier. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for install - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - # Install the latest version of the plugin: - atlas plugin install mongodb/atlas-cli-plugin-example - atlas plugin install https://github.com/mongodb/atlas-cli-plugin-example - - -.. code-block:: - :copyable: false - - # Install a specific version of the plugin: - atlas plugin install mongodb/atlas-cli-plugin-example@1.0.4 - atlas plugin install https://github.com/mongodb/atlas-cli-plugin-example/@v1.2.3 diff --git a/docs/command/atlas-plugin-list.txt b/docs/command/atlas-plugin-list.txt deleted file mode 100644 index eced103a63..0000000000 --- a/docs/command/atlas-plugin-list.txt +++ /dev/null @@ -1,58 +0,0 @@ -.. _atlas-plugin-list: - -================= -atlas plugin list -================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns a list of all installed plugins. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas plugin list [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for list - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - diff --git a/docs/command/atlas-plugin-uninstall.txt b/docs/command/atlas-plugin-uninstall.txt deleted file mode 100644 index 6117d6b567..0000000000 --- a/docs/command/atlas-plugin-uninstall.txt +++ /dev/null @@ -1,87 +0,0 @@ -.. _atlas-plugin-uninstall: - -====================== -atlas plugin uninstall -====================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Uninstall Atlas CLI plugin. - -Uninstall an Atlas CLI plugin. -You can specify a plugin to uninstall using either the "/" format or the plugin name. - - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas plugin uninstall [plugin] [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - plugin - - string - - false - - Plugin identifier. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for uninstall - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - # Uninstall a plugin: - atlas plugin uninstall mongodb/atlas-cli-plugin-example - atlas plugin uninstall atlas-cli-plugin-example diff --git a/docs/command/atlas-plugin-update.txt b/docs/command/atlas-plugin-update.txt deleted file mode 100644 index e91b656145..0000000000 --- a/docs/command/atlas-plugin-update.txt +++ /dev/null @@ -1,99 +0,0 @@ -.. _atlas-plugin-update: - -=================== -atlas plugin update -=================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Update Atlas CLI plugin. - -Update an Atlas CLI plugin. -You can specify a plugin to update using either the "/" format or the plugin name. -Additionally, you can use the "--all" flag to update all plugins. - - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas plugin update [plugin] [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - plugin - - string - - false - - Plugin identifier. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --all - - - - false - - update all plugins - * - -h, --help - - - - false - - help for update - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - # Update a plugin: - atlas plugin update mongodb/atlas-cli-plugin-example - atlas plugin update atlas-cli-plugin-example - - -.. code-block:: - :copyable: false - - # Update all plugins - atlas plugin update --all diff --git a/docs/command/atlas-plugin.txt b/docs/command/atlas-plugin.txt deleted file mode 100644 index c3c489f453..0000000000 --- a/docs/command/atlas-plugin.txt +++ /dev/null @@ -1,65 +0,0 @@ -.. _atlas-plugin: - -============ -atlas plugin -============ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage plugins for the AtlasCLI. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for plugin - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-plugin-install` - Install Atlas CLI plugin from a GitHub repository. -* :ref:`atlas-plugin-list` - Returns a list of all installed plugins. -* :ref:`atlas-plugin-uninstall` - Uninstall Atlas CLI plugin. -* :ref:`atlas-plugin-update` - Update Atlas CLI plugin. - - -.. toctree:: - :titlesonly: - - install - list - uninstall - update - diff --git a/docs/command/atlas-privateEndpoints-aws-create.txt b/docs/command/atlas-privateEndpoints-aws-create.txt deleted file mode 100644 index 3dc0a82304..0000000000 --- a/docs/command/atlas-privateEndpoints-aws-create.txt +++ /dev/null @@ -1,92 +0,0 @@ -.. _atlas-privateEndpoints-aws-create: - -================================= -atlas privateEndpoints aws create -================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create a new AWS private endpoint for your project. - -To learn more about how to set up private endpoints with the Atlas CLI, see the tutorial on the Atlas CLI tab here: https://www.mongodb.com/docs/atlas/security-cluster-private-endpoint/. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas privateEndpoints aws create [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for create - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --region - - string - - true - - Cloud provider region in which you want to create the private endpoint connection. For a complete list of supported AWS regions, see: https://dochub.mongodb.org/core/aws-atlas. For a complete list of supported Azure regions, see: https://dochub.mongodb.org/core/azure-atlas. For a complete list of supported GCP regions, see: https://dochub.mongodb.org/core/gcp-atlas. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Private endpoint '' created. - - -Examples --------- - -.. code-block:: - :copyable: false - - # Create a private endpoint connection for AWS in the us-east-1 region for the project with the ID 5e2211c17a3e5a48f5497de3: - atlas privateEndpoints aws create --region us-east-1 --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-privateEndpoints-aws-delete.txt b/docs/command/atlas-privateEndpoints-aws-delete.txt deleted file mode 100644 index 99afb3ecc3..0000000000 --- a/docs/command/atlas-privateEndpoints-aws-delete.txt +++ /dev/null @@ -1,102 +0,0 @@ -.. _atlas-privateEndpoints-aws-delete: - -================================= -atlas privateEndpoints aws delete -================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Remove the specified AWS private endpoint from your project. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas privateEndpoints aws delete [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - privateEndpointId - - string - - true - - Unique 24-character alphanumeric string that identifies the private endpoint in Atlas. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --force - - - - false - - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. - * - -h, --help - - - - false - - help for delete - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Private endpoint '' deleted - - -Examples --------- - -.. code-block:: - :copyable: false - - # Remove the AWS private endpoint with the ID 5f4fc14da2b47835a58c63a2 from the project with the ID 5e2211c17a3e5a48f5497de3: - atlas privateEndpoints aws delete 5f4fc14da2b47835a58c63a2 --projectId 5e2211c17a3e5a48f5497de3 diff --git a/docs/command/atlas-privateEndpoints-aws-describe.txt b/docs/command/atlas-privateEndpoints-aws-describe.txt deleted file mode 100644 index 73d6bc46c0..0000000000 --- a/docs/command/atlas-privateEndpoints-aws-describe.txt +++ /dev/null @@ -1,103 +0,0 @@ -.. _atlas-privateEndpoints-aws-describe: - -=================================== -atlas privateEndpoints aws describe -=================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return the details for the specified AWS private endpoints for your project. - -To use this command, you must authenticate with a user account or an API key with the Project Read Only role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas privateEndpoints aws describe [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - privateEndpointId - - string - - true - - Unique 24-character alphanumeric string that identifies the private endpoint in Atlas. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for describe - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - ID ENDPOINT SERVICE STATUS ERROR - - - -Examples --------- - -.. code-block:: - :copyable: false - - # Return the JSON-formatted details for the AWS private endpoint connection with the ID 5f4fc81c1f03a835c2728ff7 for the project with the ID 5e2211c17a3e5a48f5497de3: - atlas privateEndpoints aws describe 5f4fc81c1f03a835c2728ff7 --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-privateEndpoints-aws-interfaces-create.txt b/docs/command/atlas-privateEndpoints-aws-interfaces-create.txt deleted file mode 100644 index fcaeafe85a..0000000000 --- a/docs/command/atlas-privateEndpoints-aws-interfaces-create.txt +++ /dev/null @@ -1,108 +0,0 @@ -.. _atlas-privateEndpoints-aws-interfaces-create: - -============================================ -atlas privateEndpoints aws interfaces create -============================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create a new interface for the specified AWS private endpoint. - -To learn more about how to set up private endpoints with the Atlas CLI, see the tutorial on the Atlas CLI tab here: https://www.mongodb.com/docs/atlas/security-cluster-private-endpoint/. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas privateEndpoints aws interfaces create [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - endpointServiceId - - string - - true - - Unique 24-character alphanumeric string that identifies the private endpoint in Atlas. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for create - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --privateEndpointId - - string - - true - - Unique 22-character alphanumeric string that identifies the AWS PrivateLink connection in AWS. You can find this value on the AWS VPC Dashboard under Endpoints > VPC ID. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Interface endpoint '' created. - - -Examples --------- - -.. code-block:: - :copyable: false - - # Create a new interface for an AWS private endpoint with the ID 5f4fc14da2b47835a58c63a2 in Atlas and the ID vpce-00713b5e644e830a3 in AWS for the project with the ID 5e2211c17a3e5a48f5497de3: - atlas privateEndpoints aws interfaces create 5f4fc14da2b47835a58c63a2 --privateEndpointId vpce-00713b5e644e830a3 --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-privateEndpoints-aws-interfaces-delete.txt b/docs/command/atlas-privateEndpoints-aws-interfaces-delete.txt deleted file mode 100644 index 11f4b27f9e..0000000000 --- a/docs/command/atlas-privateEndpoints-aws-interfaces-delete.txt +++ /dev/null @@ -1,106 +0,0 @@ -.. _atlas-privateEndpoints-aws-interfaces-delete: - -============================================ -atlas privateEndpoints aws interfaces delete -============================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Remove the specified AWS private endpoint interface and related service from your project. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas privateEndpoints aws interfaces delete [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - interfaceEndpointId - - string - - true - - Unique string that identifies the AWS private endpoint interface in AWS. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --endpointServiceId - - string - - false - - Unique 24-character alphanumeric string that identifies the private endpoint in Atlas. - * - --force - - - - false - - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. - * - -h, --help - - - - false - - help for delete - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Interface endpoint '' deleted - - -Examples --------- - -.. code-block:: - :copyable: false - - # Remove the AWS private endpoint interface with the ID vpce-00713b5e644e830a3 in AWS from the project with the ID 5e2211c17a3e5a48f5497de3: - atlas privateEndpoints aws interfaces delete vpce-00713b5e644e830a3 --projectId 5e2211c17a3e5a48f5497de3 diff --git a/docs/command/atlas-privateEndpoints-aws-interfaces-describe.txt b/docs/command/atlas-privateEndpoints-aws-interfaces-describe.txt deleted file mode 100644 index 4c42cf4c27..0000000000 --- a/docs/command/atlas-privateEndpoints-aws-interfaces-describe.txt +++ /dev/null @@ -1,109 +0,0 @@ -.. _atlas-privateEndpoints-aws-interfaces-describe: - -============================================== -atlas privateEndpoints aws interfaces describe -============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return the details for the specified AWS private endpoint interface for your project. - -To use this command, you must authenticate with a user account or an API key with the Project Read Only role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas privateEndpoints aws interfaces describe [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - interfaceEndpointId - - string - - true - - Unique string that identifies the AWS private endpoint interface in AWS. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --endpointServiceId - - string - - true - - Unique 24-character alphanumeric string that identifies the private endpoint in Atlas. - * - -h, --help - - - - false - - help for describe - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - ID STATUS ERROR - - - -Examples --------- - -.. code-block:: - :copyable: false - - # Return the JSON-formatted details of the AWS private endpoint interface with the ID - vpce-00713b5e644e830a3 in AWS for an AWS private endpoint with the ID 5f4fc14da2b47835a58c63a2 in Atlas: - atlas privateEndpoints aws interfaces describe - vpce-00713b5e644e830a3 --endpointServiceId 5f4fc14da2b47835a58c63a2 diff --git a/docs/command/atlas-privateEndpoints-aws-interfaces.txt b/docs/command/atlas-privateEndpoints-aws-interfaces.txt deleted file mode 100644 index eefb55825a..0000000000 --- a/docs/command/atlas-privateEndpoints-aws-interfaces.txt +++ /dev/null @@ -1,63 +0,0 @@ -.. _atlas-privateEndpoints-aws-interfaces: - -===================================== -atlas privateEndpoints aws interfaces -===================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage Atlas AWS private endpoint interfaces. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for interfaces - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-privateEndpoints-aws-interfaces-create` - Create a new interface for the specified AWS private endpoint. -* :ref:`atlas-privateEndpoints-aws-interfaces-delete` - Remove the specified AWS private endpoint interface and related service from your project. -* :ref:`atlas-privateEndpoints-aws-interfaces-describe` - Return the details for the specified AWS private endpoint interface for your project. - - -.. toctree:: - :titlesonly: - - create - delete - describe - diff --git a/docs/command/atlas-privateEndpoints-aws-list.txt b/docs/command/atlas-privateEndpoints-aws-list.txt deleted file mode 100644 index d73ffa7d70..0000000000 --- a/docs/command/atlas-privateEndpoints-aws-list.txt +++ /dev/null @@ -1,76 +0,0 @@ -.. _atlas-privateEndpoints-aws-list: - -=============================== -atlas privateEndpoints aws list -=============================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return all AWS private endpoints for your project. - -To use this command, you must authenticate with a user account or an API key with the Project Read Only role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas privateEndpoints aws list [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for list - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - # Return a JSON-formatted list of all AWS private endpoints for the project with the ID 5e2211c17a3e5a48f5497de3: - atlas privateEndpoints aws list --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-privateEndpoints-aws-watch.txt b/docs/command/atlas-privateEndpoints-aws-watch.txt deleted file mode 100644 index 2882272d4d..0000000000 --- a/docs/command/atlas-privateEndpoints-aws-watch.txt +++ /dev/null @@ -1,104 +0,0 @@ -.. _atlas-privateEndpoints-aws-watch: - -================================ -atlas privateEndpoints aws watch -================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Watch the specified AWS private endpoint in your project until it becomes available. - -This command checks the endpoint's state periodically until the endpoint reaches an AVAILABLE or FAILED state. -Once the endpoint reaches the expected state, the command prints "Private endpoint changes completed." -If you run the command in the terminal, it blocks the terminal session until the resource becomes available or fails. -You can interrupt the command's polling at any time with CTRL-C. - -To use this command, you must authenticate with a user account or an API key with the Project Read Only role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas privateEndpoints aws watch [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - privateEndpointId - - string - - true - - Unique 24-character alphanumeric string that identifies the private endpoint in Atlas. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for watch - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - - Private endpoint changes completed. - - -Examples --------- - -.. code-block:: - :copyable: false - - # Watch for the AWS private endpoint with the ID 5f4fc14da2b47835a58c63a2 to become available in the project with the ID 5e2211c17a3e5a48f5497de3: - atlas privateEndpoints aws watch 5f4fc14da2b47835a58c63a2 --projectId 5e2211c17a3e5a48f5497de3 diff --git a/docs/command/atlas-privateEndpoints-aws.txt b/docs/command/atlas-privateEndpoints-aws.txt deleted file mode 100644 index d761c7a4ed..0000000000 --- a/docs/command/atlas-privateEndpoints-aws.txt +++ /dev/null @@ -1,69 +0,0 @@ -.. _atlas-privateEndpoints-aws: - -========================== -atlas privateEndpoints aws -========================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage AWS Private Endpoints. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for aws - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-privateEndpoints-aws-create` - Create a new AWS private endpoint for your project. -* :ref:`atlas-privateEndpoints-aws-delete` - Remove the specified AWS private endpoint from your project. -* :ref:`atlas-privateEndpoints-aws-describe` - Return the details for the specified AWS private endpoints for your project. -* :ref:`atlas-privateEndpoints-aws-interfaces` - Manage Atlas AWS private endpoint interfaces. -* :ref:`atlas-privateEndpoints-aws-list` - Return all AWS private endpoints for your project. -* :ref:`atlas-privateEndpoints-aws-watch` - Watch the specified AWS private endpoint in your project until it becomes available. - - -.. toctree:: - :titlesonly: - - create - delete - describe - interfaces - list - watch - diff --git a/docs/command/atlas-privateEndpoints-azure-create.txt b/docs/command/atlas-privateEndpoints-azure-create.txt deleted file mode 100644 index 70c1bb7a91..0000000000 --- a/docs/command/atlas-privateEndpoints-azure-create.txt +++ /dev/null @@ -1,92 +0,0 @@ -.. _atlas-privateEndpoints-azure-create: - -=================================== -atlas privateEndpoints azure create -=================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create a new Azure private endpoint for your project. - -To learn more about how to set up private endpoints with the Atlas CLI, see the tutorial on the Atlas CLI tab here: https://www.mongodb.com/docs/atlas/security-cluster-private-endpoint/. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas privateEndpoints azure create [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for create - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --region - - string - - true - - Cloud provider region in which you want to create the private endpoint connection. For a complete list of supported AWS regions, see: https://dochub.mongodb.org/core/aws-atlas. For a complete list of supported Azure regions, see: https://dochub.mongodb.org/core/azure-atlas. For a complete list of supported GCP regions, see: https://dochub.mongodb.org/core/gcp-atlas. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Private endpoint '' created. - - -Examples --------- - -.. code-block:: - :copyable: false - - # Create a private endpoint connection for Azure in the eastus region for the project with the ID 5e2211c17a3e5a48f5497de3: - atlas privateEndpoints azure create --region eastus --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-privateEndpoints-azure-delete.txt b/docs/command/atlas-privateEndpoints-azure-delete.txt deleted file mode 100644 index d450ade535..0000000000 --- a/docs/command/atlas-privateEndpoints-azure-delete.txt +++ /dev/null @@ -1,102 +0,0 @@ -.. _atlas-privateEndpoints-azure-delete: - -=================================== -atlas privateEndpoints azure delete -=================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Remove the specified Azure private endpoint from your project. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas privateEndpoints azure delete [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - privateEndpointId - - string - - true - - Unique 24-character alphanumeric string that identifies the private endpoint in Atlas. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --force - - - - false - - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. - * - -h, --help - - - - false - - help for delete - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Private endpoint '' deleted - - -Examples --------- - -.. code-block:: - :copyable: false - - # Remove the Azure private endpoint with the ID 5f4fc14da2b47835a58c63a2 from the project with the ID 5e2211c17a3e5a48f5497de3: - atlas privateEndpoints azure delete 5f4fc14da2b47835a58c63a2 --projectId 5e2211c17a3e5a48f5497de3 diff --git a/docs/command/atlas-privateEndpoints-azure-describe.txt b/docs/command/atlas-privateEndpoints-azure-describe.txt deleted file mode 100644 index 08ea40362d..0000000000 --- a/docs/command/atlas-privateEndpoints-azure-describe.txt +++ /dev/null @@ -1,103 +0,0 @@ -.. _atlas-privateEndpoints-azure-describe: - -===================================== -atlas privateEndpoints azure describe -===================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return the details for the specified Azure private endpoint for your project. - -To use this command, you must authenticate with a user account or an API key with the Project Read Only role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas privateEndpoints azure describe [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - privateEndpointId - - string - - true - - Unique 24-character alphanumeric string that identifies the private endpoint in Atlas. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for describe - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - ID ENDPOINT SERVICE STATUS ERROR - - - -Examples --------- - -.. code-block:: - :copyable: false - - # Return the JSON-formatted details for the Azure private endpoint connection with the ID 5f4fc81c1f03a835c2728ff7 for the project with the ID 5e2211c17a3e5a48f5497de3: - atlas privateEndpoints azure describe 5f4fc81c1f03a835c2728ff7 --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-privateEndpoints-azure-interfaces-create.txt b/docs/command/atlas-privateEndpoints-azure-interfaces-create.txt deleted file mode 100644 index 78aaaa4164..0000000000 --- a/docs/command/atlas-privateEndpoints-azure-interfaces-create.txt +++ /dev/null @@ -1,113 +0,0 @@ -.. _atlas-privateEndpoints-azure-interfaces-create: - -============================================== -atlas privateEndpoints azure interfaces create -============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create a new interface for the specified Azure private endpoint. - -To learn more about how to set up private endpoints with the Atlas CLI, see the tutorial on the Atlas CLI tab here: https://www.mongodb.com/docs/atlas/security-cluster-private-endpoint/. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas privateEndpoints azure interfaces create [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - endpointServiceId - - string - - true - - Unique 24-character alphanumeric string that identifies the private endpoint in Atlas. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for create - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --privateEndpointId - - string - - true - - Unique string that identifies the Azure private endpoint in Azure. The Properties page for your private endpoint on your Azure dashboard displays this property in the Resource ID field. - * - --privateEndpointIpAddress - - string - - true - - Private IP address of the private endpoint network interface you created in your Azure VNet. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Interface endpoint '' created. - - -Examples --------- - -.. code-block:: - :copyable: false - - # Create a new interface for an Azure private endpoint with the ID 5f4fc14da2b47835a58c63a2 in Atlas and the ID /subscriptions/4e133d35-e734-4385-a565-c0945567ae346/resourceGroups/rg_95847a959b876e255dbb9b33_dfragd7w/providers/Microsoft.Network/privateEndpoints/test-endpoint in Azure for the project with the ID 5e2211c17a3e5a48f5497de3: - atlas privateEndpoints azure interfaces create 5f4fc14da2b47835a58c63a2 --privateEndpointId /subscriptions/4e133d35-e734-4385-a565-c0945567ae346/resourceGroups/rg_95847a959b876e255dbb9b33_dfragd7w/providers/Microsoft.Network/privateEndpoints/test-endpoint --projectId 5e2211c17a3e5a48f5497de3 --privateEndpointIpAddress 192.0.2.5 - --output json diff --git a/docs/command/atlas-privateEndpoints-azure-interfaces-delete.txt b/docs/command/atlas-privateEndpoints-azure-interfaces-delete.txt deleted file mode 100644 index f09ff091c7..0000000000 --- a/docs/command/atlas-privateEndpoints-azure-interfaces-delete.txt +++ /dev/null @@ -1,106 +0,0 @@ -.. _atlas-privateEndpoints-azure-interfaces-delete: - -============================================== -atlas privateEndpoints azure interfaces delete -============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Remove the specified Azure private endpoint interface and related service from your project. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas privateEndpoints azure interfaces delete [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - privateEndpointResourceId - - string - - true - - Unique string that identifies the Azure private endpoint interface in Azure. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --endpointServiceId - - string - - false - - Unique 24-character alphanumeric string that identifies the private endpoint in Atlas. - * - --force - - - - false - - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. - * - -h, --help - - - - false - - help for delete - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Interface endpoint '' deleted - - -Examples --------- - -.. code-block:: - :copyable: false - - # Remove the Azure private endpoint interface with the ID /subscriptions/4e133d35-e734-4385-a565-c0945567ae346/resourceGroups/rg_95847a959b876e255dbb9b33_dfragd7w/providers/Microsoft.Network/privateEndpoints/cli-test in Azure from the project with the ID 5e2211c17a3e5a48f5497de3: - atlas privateEndpoints azure interfaces delete /subscriptions/4e133d35-e734-4385-a565-c0945567ae346/resourceGroups/rg_95847a959b876e255dbb9b33_dfragd7w/providers/Microsoft.Network/privateEndpoints/cli-test --projectId 5e2211c17a3e5a48f5497de3 diff --git a/docs/command/atlas-privateEndpoints-azure-interfaces-describe.txt b/docs/command/atlas-privateEndpoints-azure-interfaces-describe.txt deleted file mode 100644 index bd17506aa5..0000000000 --- a/docs/command/atlas-privateEndpoints-azure-interfaces-describe.txt +++ /dev/null @@ -1,107 +0,0 @@ -.. _atlas-privateEndpoints-azure-interfaces-describe: - -================================================ -atlas privateEndpoints azure interfaces describe -================================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return the details for the specified Azure private endpoint interface for your project. - -To use this command, you must authenticate with a user account or an API key with the Project Read Only role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas privateEndpoints azure interfaces describe [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - privateEndpointResourceId - - string - - true - - Unique string that identifies the Azure private endpoint interface in Azure. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --endpointServiceId - - string - - true - - Unique 24-character alphanumeric string that identifies the private endpoint in Atlas. - * - -h, --help - - - - false - - help for describe - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - ID IP ADDRESS STATUS ERROR - - - -Examples --------- - -.. code-block:: - :copyable: false - - # Return the JSON-formatted details of the Azure private endpoint interface with the ID /subscriptions/4e133d35-e734-4385-a565-c0945567ae346/resourceGroups/rg_95847a959b876e255dbb9b33_dfragd7w/providers/Microsoft.Network/privateEndpoints/cli-test in Azure for an AWS private endpoint with the ID 5f4fc14da2b47835a58c63a2 in Atlas: - atlas privateEndpoints azure interfaces describe /subscriptions/4e133d35-e734-4385-a565-c0945567ae346/resourceGroups/rg_95847a959b876e255dbb9b33_dfragd7w/providers/Microsoft.Network/privateEndpoints/cli-test --endpointServiceId 5f4fc14da2b47835a58c63a2 diff --git a/docs/command/atlas-privateEndpoints-azure-interfaces.txt b/docs/command/atlas-privateEndpoints-azure-interfaces.txt deleted file mode 100644 index 937d2aacae..0000000000 --- a/docs/command/atlas-privateEndpoints-azure-interfaces.txt +++ /dev/null @@ -1,63 +0,0 @@ -.. _atlas-privateEndpoints-azure-interfaces: - -======================================= -atlas privateEndpoints azure interfaces -======================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage Atlas Azure private endpoint interfaces. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for interfaces - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-privateEndpoints-azure-interfaces-create` - Create a new interface for the specified Azure private endpoint. -* :ref:`atlas-privateEndpoints-azure-interfaces-delete` - Remove the specified Azure private endpoint interface and related service from your project. -* :ref:`atlas-privateEndpoints-azure-interfaces-describe` - Return the details for the specified Azure private endpoint interface for your project. - - -.. toctree:: - :titlesonly: - - create - delete - describe - diff --git a/docs/command/atlas-privateEndpoints-azure-list.txt b/docs/command/atlas-privateEndpoints-azure-list.txt deleted file mode 100644 index 3564976b5a..0000000000 --- a/docs/command/atlas-privateEndpoints-azure-list.txt +++ /dev/null @@ -1,76 +0,0 @@ -.. _atlas-privateEndpoints-azure-list: - -================================= -atlas privateEndpoints azure list -================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return all Azure private endpoints for your project. - -To use this command, you must authenticate with a user account or an API key with the Project Read Only role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas privateEndpoints azure list [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for list - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - # Return a JSON-formatted list of all Azure private endpoints for the project with the ID 5e2211c17a3e5a48f5497de3: - atlas privateEndpoints azure list --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-privateEndpoints-azure-watch.txt b/docs/command/atlas-privateEndpoints-azure-watch.txt deleted file mode 100644 index fa8ad3dec8..0000000000 --- a/docs/command/atlas-privateEndpoints-azure-watch.txt +++ /dev/null @@ -1,104 +0,0 @@ -.. _atlas-privateEndpoints-azure-watch: - -================================== -atlas privateEndpoints azure watch -================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Watch the specified Azure private endpoint in your project until it becomes available. - -This command checks the endpoint's state periodically until the endpoint reaches an AVAILABLE or FAILED state. -Once the endpoint reaches the expected state, the command prints "Private endpoint changes completed." -If you run the command in the terminal, it blocks the terminal session until the resource becomes available or fails. -You can interrupt the command's polling at any time with CTRL-C. - -To use this command, you must authenticate with a user account or an API key with the Project Read Only role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas privateEndpoints azure watch [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - privateEndpointId - - string - - true - - Unique 24-character alphanumeric string that identifies the private endpoint in Atlas. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for watch - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - - Private endpoint changes completed. - - -Examples --------- - -.. code-block:: - :copyable: false - - # Watch for the Azure private endpoint with the ID 5f4fc14da2b47835a58c63a2 to become available in the project with the ID 5e2211c17a3e5a48f5497de3: - atlas privateEndpoints azure watch 5f4fc14da2b47835a58c63a2 --projectId 5e2211c17a3e5a48f5497de3 diff --git a/docs/command/atlas-privateEndpoints-azure.txt b/docs/command/atlas-privateEndpoints-azure.txt deleted file mode 100644 index 23b7368dd2..0000000000 --- a/docs/command/atlas-privateEndpoints-azure.txt +++ /dev/null @@ -1,69 +0,0 @@ -.. _atlas-privateEndpoints-azure: - -============================ -atlas privateEndpoints azure -============================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage Azure Private Endpoints. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for azure - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-privateEndpoints-azure-create` - Create a new Azure private endpoint for your project. -* :ref:`atlas-privateEndpoints-azure-delete` - Remove the specified Azure private endpoint from your project. -* :ref:`atlas-privateEndpoints-azure-describe` - Return the details for the specified Azure private endpoint for your project. -* :ref:`atlas-privateEndpoints-azure-interfaces` - Manage Atlas Azure private endpoint interfaces. -* :ref:`atlas-privateEndpoints-azure-list` - Return all Azure private endpoints for your project. -* :ref:`atlas-privateEndpoints-azure-watch` - Watch the specified Azure private endpoint in your project until it becomes available. - - -.. toctree:: - :titlesonly: - - create - delete - describe - interfaces - list - watch - diff --git a/docs/command/atlas-privateEndpoints-gcp-create.txt b/docs/command/atlas-privateEndpoints-gcp-create.txt deleted file mode 100644 index 9da00080e5..0000000000 --- a/docs/command/atlas-privateEndpoints-gcp-create.txt +++ /dev/null @@ -1,89 +0,0 @@ -.. _atlas-privateEndpoints-gcp-create: - -================================= -atlas privateEndpoints gcp create -================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create a new GCP private endpoint for your project. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas privateEndpoints gcp create [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for create - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --region - - string - - true - - Cloud provider region in which you want to create the private endpoint connection. For a complete list of supported AWS regions, see: https://dochub.mongodb.org/core/aws-atlas. For a complete list of supported Azure regions, see: https://dochub.mongodb.org/core/azure-atlas. For a complete list of supported GCP regions, see: https://dochub.mongodb.org/core/gcp-atlas. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Private endpoint '' created. - - -Examples --------- - -.. code-block:: - :copyable: false - - atlas privateEndpoints gcp create --region CENTRAL_US diff --git a/docs/command/atlas-privateEndpoints-gcp-delete.txt b/docs/command/atlas-privateEndpoints-gcp-delete.txt deleted file mode 100644 index a9f0a42728..0000000000 --- a/docs/command/atlas-privateEndpoints-gcp-delete.txt +++ /dev/null @@ -1,101 +0,0 @@ -.. _atlas-privateEndpoints-gcp-delete: - -================================= -atlas privateEndpoints gcp delete -================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Delete a GCP private endpoint for your project. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas privateEndpoints gcp delete [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - privateEndpointId - - string - - true - - Unique 22-character alphanumeric string that identifies the private endpoint. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --force - - - - false - - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. - * - -h, --help - - - - false - - help for delete - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Private endpoint '' deleted - - -Examples --------- - -.. code-block:: - :copyable: false - - atlas privateEndpoint gcp delete tester-1 --force diff --git a/docs/command/atlas-privateEndpoints-gcp-describe.txt b/docs/command/atlas-privateEndpoints-gcp-describe.txt deleted file mode 100644 index aa00926e04..0000000000 --- a/docs/command/atlas-privateEndpoints-gcp-describe.txt +++ /dev/null @@ -1,91 +0,0 @@ -.. _atlas-privateEndpoints-gcp-describe: - -=================================== -atlas privateEndpoints gcp describe -=================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return a specific GCP private endpoint for your project. - -To use this command, you must authenticate with a user account or an API key with the Project Read Only role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas privateEndpoints gcp describe [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - privateEndpointId - - string - - true - - Unique 22-character alphanumeric string that identifies the private endpoint. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for describe - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - atlas privateEndpoint gcp describe tester-1 diff --git a/docs/command/atlas-privateEndpoints-gcp-interfaces-create.txt b/docs/command/atlas-privateEndpoints-gcp-interfaces-create.txt deleted file mode 100644 index c88a72796d..0000000000 --- a/docs/command/atlas-privateEndpoints-gcp-interfaces-create.txt +++ /dev/null @@ -1,116 +0,0 @@ -.. _atlas-privateEndpoints-gcp-interfaces-create: - -============================================ -atlas privateEndpoints gcp interfaces create -============================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create a GCP private endpoint interface. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas privateEndpoints gcp interfaces create [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - endpointGroupId - - string - - true - - Unique identifier for the endpoint group. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --endpoint - - strings - - false - - List of GCP endpoints in the group separated by commas, such as: endpointName1@ipAddress1,...,endpointNameN@ipAddressN - * - --endpointServiceId - - string - - true - - Unique 24-character alphanumeric string that identifies the private endpoint in Atlas. - * - --gcpProjectId - - string - - true - - Unique identifier of the GCP project in which the network peer resides. - * - -h, --help - - - - false - - help for create - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Interface endpoint '' created. - - -Examples --------- - -.. code-block:: - :copyable: false - - atlas privateEndpoints gcp interfaces create endpoint-1 \ - --endpointServiceId 61eaca605af86411903de1dd \ - --gcpProjectId mcli-private-endpoints \ - --endpoint endpoint-0@10.142.0.2,endpoint-1@10.142.0.3,endpoint-2@10.142.0.4,endpoint-3@10.142.0.5,endpoint-4@10.142.0.6,endpoint-5@10.142.0.7 diff --git a/docs/command/atlas-privateEndpoints-gcp-interfaces-delete.txt b/docs/command/atlas-privateEndpoints-gcp-interfaces-delete.txt deleted file mode 100644 index f9513ead7f..0000000000 --- a/docs/command/atlas-privateEndpoints-gcp-interfaces-delete.txt +++ /dev/null @@ -1,106 +0,0 @@ -.. _atlas-privateEndpoints-gcp-interfaces-delete: - -============================================ -atlas privateEndpoints gcp interfaces delete -============================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Delete a specific GCP private endpoint interface for your project. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas privateEndpoints gcp interfaces delete [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - id - - string - - true - - Unique identifier for the endpoint group. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --endpointServiceId - - string - - true - - Unique 24-character alphanumeric string that identifies the private endpoint in Atlas. - * - --force - - - - false - - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. - * - -h, --help - - - - false - - help for delete - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Interface endpoint '' deleted - - -Examples --------- - -.. code-block:: - :copyable: false - - atlas privateEndpoints gcp interfaces delete endpoint-1 \ - --endpointServiceId 61eaca605af86411903de1dd diff --git a/docs/command/atlas-privateEndpoints-gcp-interfaces-describe.txt b/docs/command/atlas-privateEndpoints-gcp-interfaces-describe.txt deleted file mode 100644 index db04731d9a..0000000000 --- a/docs/command/atlas-privateEndpoints-gcp-interfaces-describe.txt +++ /dev/null @@ -1,107 +0,0 @@ -.. _atlas-privateEndpoints-gcp-interfaces-describe: - -============================================== -atlas privateEndpoints gcp interfaces describe -============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return a specific GCP private endpoint interface for your project. - -To use this command, you must authenticate with a user account or an API key with the Project Read Only role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas privateEndpoints gcp interfaces describe [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - id - - string - - true - - Unique identifier of the private endpoint you want to retrieve. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --endpointServiceId - - string - - true - - Unique 24-character alphanumeric string that identifies the private endpoint in Atlas. - * - -h, --help - - - - false - - help for describe - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - ENDPOINT STATUS DELETE REQUESTED - - - -Examples --------- - -.. code-block:: - :copyable: false - - atlas privateEndpoints gcp interfaces describe endpoint-1 \ - --endpointServiceId 61eaca605af86411903de1dd diff --git a/docs/command/atlas-privateEndpoints-gcp-interfaces.txt b/docs/command/atlas-privateEndpoints-gcp-interfaces.txt deleted file mode 100644 index ec3ec345fc..0000000000 --- a/docs/command/atlas-privateEndpoints-gcp-interfaces.txt +++ /dev/null @@ -1,63 +0,0 @@ -.. _atlas-privateEndpoints-gcp-interfaces: - -===================================== -atlas privateEndpoints gcp interfaces -===================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage Atlas GCP private endpoint interfaces. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for interfaces - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-privateEndpoints-gcp-interfaces-create` - Create a GCP private endpoint interface. -* :ref:`atlas-privateEndpoints-gcp-interfaces-delete` - Delete a specific GCP private endpoint interface for your project. -* :ref:`atlas-privateEndpoints-gcp-interfaces-describe` - Return a specific GCP private endpoint interface for your project. - - -.. toctree:: - :titlesonly: - - create - delete - describe - diff --git a/docs/command/atlas-privateEndpoints-gcp-list.txt b/docs/command/atlas-privateEndpoints-gcp-list.txt deleted file mode 100644 index 26f48fd754..0000000000 --- a/docs/command/atlas-privateEndpoints-gcp-list.txt +++ /dev/null @@ -1,75 +0,0 @@ -.. _atlas-privateEndpoints-gcp-list: - -=============================== -atlas privateEndpoints gcp list -=============================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -List GCP private endpoints for your project. - -To use this command, you must authenticate with a user account or an API key with the Project Read Only role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas privateEndpoints gcp list [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for list - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - atlas privateEndpoint gcp ls diff --git a/docs/command/atlas-privateEndpoints-gcp-watch.txt b/docs/command/atlas-privateEndpoints-gcp-watch.txt deleted file mode 100644 index 5741d695f6..0000000000 --- a/docs/command/atlas-privateEndpoints-gcp-watch.txt +++ /dev/null @@ -1,103 +0,0 @@ -.. _atlas-privateEndpoints-gcp-watch: - -================================ -atlas privateEndpoints gcp watch -================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Watch the specified GCP private endpoint to detect changes in the endpoint's state. - -This command checks the endpoint's state periodically until the endpoint reaches an AVAILABLE or FAILED state. -Once the endpoint reaches the expected state, the command prints "GCP Private endpoint changes completed." -If you run the command in the terminal, it blocks the terminal session until the resource becomes available or fails. -You can interrupt the command's polling at any time with CTRL-C. - -To use this command, you must authenticate with a user account or an API key with the Project Read Only role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas privateEndpoints gcp watch [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - privateEndpointId - - string - - true - - Unique 22-character alphanumeric string that identifies the private endpoint. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for watch - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - - GCP Private endpoint changes completed. - - -Examples --------- - -.. code-block:: - :copyable: false - - atlas privateEndpoint gcp watch tester-1 diff --git a/docs/command/atlas-privateEndpoints-gcp.txt b/docs/command/atlas-privateEndpoints-gcp.txt deleted file mode 100644 index 29405adf0f..0000000000 --- a/docs/command/atlas-privateEndpoints-gcp.txt +++ /dev/null @@ -1,69 +0,0 @@ -.. _atlas-privateEndpoints-gcp: - -========================== -atlas privateEndpoints gcp -========================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage GCP private endpoints. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for gcp - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-privateEndpoints-gcp-create` - Create a new GCP private endpoint for your project. -* :ref:`atlas-privateEndpoints-gcp-delete` - Delete a GCP private endpoint for your project. -* :ref:`atlas-privateEndpoints-gcp-describe` - Return a specific GCP private endpoint for your project. -* :ref:`atlas-privateEndpoints-gcp-interfaces` - Manage Atlas GCP private endpoint interfaces. -* :ref:`atlas-privateEndpoints-gcp-list` - List GCP private endpoints for your project. -* :ref:`atlas-privateEndpoints-gcp-watch` - Watch the specified GCP private endpoint to detect changes in the endpoint's state. - - -.. toctree:: - :titlesonly: - - create - delete - describe - interfaces - list - watch - diff --git a/docs/command/atlas-privateEndpoints-regionalModes-describe.txt b/docs/command/atlas-privateEndpoints-regionalModes-describe.txt deleted file mode 100644 index f378aad693..0000000000 --- a/docs/command/atlas-privateEndpoints-regionalModes-describe.txt +++ /dev/null @@ -1,89 +0,0 @@ -.. _atlas-privateEndpoints-regionalModes-describe: - -============================================= -atlas privateEndpoints regionalModes describe -============================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return the regionalized private endpoint setting for your project. - -Use this command to check whether you can create multiple private resources per region. - -To use this command, you must authenticate with a user account or an API key with the Project Read Only role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas privateEndpoints regionalModes describe [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for describe - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - ENABLED - - - -Examples --------- - -.. code-block:: - :copyable: false - - # Return the regionalized private endpoint setting for the project with the ID 5e2211c17a3e5a48f5497de3: - atlas privateEndpoints regionalModes describe --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-privateEndpoints-regionalModes-disable.txt b/docs/command/atlas-privateEndpoints-regionalModes-disable.txt deleted file mode 100644 index 22b38a3e8b..0000000000 --- a/docs/command/atlas-privateEndpoints-regionalModes-disable.txt +++ /dev/null @@ -1,88 +0,0 @@ -.. _atlas-privateEndpoints-regionalModes-disable: - -============================================ -atlas privateEndpoints regionalModes disable -============================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Disable the regionalized private endpoint setting for your project. - -This disables the ability to create multiple private resources per region in all cloud service providers for this project. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas privateEndpoints regionalModes disable [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for disable - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Regionalized private endpoint setting disabled. - - -Examples --------- - -.. code-block:: - :copyable: false - - # Disable the regionalied private endpoint setting in the project with the ID 5e2211c17a3e5a48f5497de3: - atlas privateEndpoints regionalModes disable --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-privateEndpoints-regionalModes-enable.txt b/docs/command/atlas-privateEndpoints-regionalModes-enable.txt deleted file mode 100644 index e7caddbbe0..0000000000 --- a/docs/command/atlas-privateEndpoints-regionalModes-enable.txt +++ /dev/null @@ -1,88 +0,0 @@ -.. _atlas-privateEndpoints-regionalModes-enable: - -=========================================== -atlas privateEndpoints regionalModes enable -=========================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Enable the regionalized private endpoint setting for your project. - -This enables the ability to create multiple private resources per region in all cloud service providers for this project. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas privateEndpoints regionalModes enable [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for enable - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Regionalized private endpoint setting enabled. - - -Examples --------- - -.. code-block:: - :copyable: false - - # Enable the regionalied private endpoint setting in the project with the ID 5e2211c17a3e5a48f5497de3: - atlas privateEndpoints regionalModes enable --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-privateEndpoints-regionalModes.txt b/docs/command/atlas-privateEndpoints-regionalModes.txt deleted file mode 100644 index 87c8064d9b..0000000000 --- a/docs/command/atlas-privateEndpoints-regionalModes.txt +++ /dev/null @@ -1,63 +0,0 @@ -.. _atlas-privateEndpoints-regionalModes: - -==================================== -atlas privateEndpoints regionalModes -==================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage regionalized private endpoint setting for your Atlas project. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for regionalModes - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-privateEndpoints-regionalModes-describe` - Return the regionalized private endpoint setting for your project. -* :ref:`atlas-privateEndpoints-regionalModes-disable` - Disable the regionalized private endpoint setting for your project. -* :ref:`atlas-privateEndpoints-regionalModes-enable` - Enable the regionalized private endpoint setting for your project. - - -.. toctree:: - :titlesonly: - - describe - disable - enable - diff --git a/docs/command/atlas-privateEndpoints.txt b/docs/command/atlas-privateEndpoints.txt deleted file mode 100644 index 8a05ab2145..0000000000 --- a/docs/command/atlas-privateEndpoints.txt +++ /dev/null @@ -1,65 +0,0 @@ -.. _atlas-privateEndpoints: - -====================== -atlas privateEndpoints -====================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage Atlas private endpoints. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for privateEndpoints - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-privateEndpoints-aws` - Manage AWS Private Endpoints. -* :ref:`atlas-privateEndpoints-azure` - Manage Azure Private Endpoints. -* :ref:`atlas-privateEndpoints-gcp` - Manage GCP private endpoints. -* :ref:`atlas-privateEndpoints-regionalModes` - Manage regionalized private endpoint setting for your Atlas project. - - -.. toctree:: - :titlesonly: - - aws - azure - gcp - regionalModes - diff --git a/docs/command/atlas-processes-describe.txt b/docs/command/atlas-processes-describe.txt deleted file mode 100644 index d96733b374..0000000000 --- a/docs/command/atlas-processes-describe.txt +++ /dev/null @@ -1,101 +0,0 @@ -.. _atlas-processes-describe: - -======================== -atlas processes describe -======================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return the details for the specified MongoDB process for your project. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas processes describe [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - hostname:port - - string - - true - - Hostname and port number of the instance running the Atlas MongoDB process. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for describe - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - ID REPLICA SET NAME SHARD NAME VERSION - - - -Examples --------- - -.. code-block:: - :copyable: false - - # Return the JSON-formatted details for the MongoDB process with hostname and port atlas-lnmtkm-shard-00-00.ajlj3.mongodb.net:27017 - atlas process describe atlas-lnmtkm-shard-00-00.ajlj3.mongodb.net:27017 --output json diff --git a/docs/command/atlas-processes-list.txt b/docs/command/atlas-processes-list.txt deleted file mode 100644 index 6f575dfbeb..0000000000 --- a/docs/command/atlas-processes-list.txt +++ /dev/null @@ -1,92 +0,0 @@ -.. _atlas-processes-list: - -==================== -atlas processes list -==================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return all MongoDB processes for your project. - -To use this command, you must authenticate with a user account or an API key with the Project Read Only role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas processes list [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -c, --compact - - - - false - - Flag that enables the compact array response structure for a json output. The --compact option returns array objects as top-level responses and allows backward compatibility for scripts based on previous CLI versions. Omitting the --compact option for a json output returns array objects within a 'results' sub-array. You must specify --output json to use this option. - * - -h, --help - - - - false - - help for list - * - --limit - - int - - false - - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. - * - --omitCount - - - - false - - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --page - - int - - false - - Page number that specifies a page of results. This value defaults to 1. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - # Return a JSON-formatted list of all MongoDB processes in the project with the ID 5e2211c17a3e5a48f5497de3: - atlas processes list --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-processes.txt b/docs/command/atlas-processes.txt deleted file mode 100644 index 5fd7e81a35..0000000000 --- a/docs/command/atlas-processes.txt +++ /dev/null @@ -1,61 +0,0 @@ -.. _atlas-processes: - -=============== -atlas processes -=============== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage MongoDB processes for your project. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for processes - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-processes-describe` - Return the details for the specified MongoDB process for your project. -* :ref:`atlas-processes-list` - Return all MongoDB processes for your project. - - -.. toctree:: - :titlesonly: - - describe - list - diff --git a/docs/command/atlas-projects-apiKeys-assign.txt b/docs/command/atlas-projects-apiKeys-assign.txt deleted file mode 100644 index 20d5873d49..0000000000 --- a/docs/command/atlas-projects-apiKeys-assign.txt +++ /dev/null @@ -1,108 +0,0 @@ -.. _atlas-projects-apiKeys-assign: - -============================= -atlas projects apiKeys assign -============================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Assign the specified organization API key to your project and modify the API key's roles for the project. - -When you modify the roles for an organization API key with this command, the values you specify overwrite the existing roles assigned to the API key. - -To view possible values for the ID argument, run atlas organizations apiKeys list. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas projects apiKeys assign [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - ID - - string - - true - - Unique 24-digit string that identifies your API key. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for assign - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --role - - strings - - true - - Role or roles that you want to assign to the API key. To assign more than one role, specify each role with a separate role flag or specify all of the roles as a comma-separated list using one role flag. To learn which values the CLI accepts, see the Items Enum for roles in the Atlas API spec: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createProjectApiKey/. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - API Key successfully assigned. - - -Examples --------- - -.. code-block:: - :copyable: false - - # Assign an organization API key with the ID 5f46ae53d58b421fe3edc115 and grant the GROUP_DATA_ACCESS_READ_WRITE role for the project with ID 5e2211c17a3e5a48f5497de3: - atlas projects apiKeys assign 5f46ae53d58b421fe3edc115 --projectId 5e1234c17a3e5a48f5497de3 --role GROUP_DATA_ACCESS_READ_WRITE --output json diff --git a/docs/command/atlas-projects-apiKeys-create.txt b/docs/command/atlas-projects-apiKeys-create.txt deleted file mode 100644 index b959d7ab79..0000000000 --- a/docs/command/atlas-projects-apiKeys-create.txt +++ /dev/null @@ -1,98 +0,0 @@ -.. _atlas-projects-apiKeys-create: - -============================= -atlas projects apiKeys create -============================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create an organization API key and assign it to your project. - -MongoDB returns the private API key only once. After you run this command, immediately copy, save, and secure both the public and private API keys. - -To use this command, you must authenticate with a user account or an API key with the Project User Admin role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas projects apiKeys create [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --desc - - string - - true - - Description of the API key. - * - -h, --help - - - - false - - help for create - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --role - - strings - - true - - Role or roles that you want to assign to the API key. To assign more than one role, specify each role with a separate role flag or specify all of the roles as a comma-separated list using one role flag. To learn which values the CLI accepts, see the Items Enum for roles in the Atlas API spec: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createProjectApiKey/. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - API Key '' created. - Public API Key - Private API Key - - -Examples --------- - -.. code-block:: - :copyable: false - - # Create an organization API key with the GROUP_OWNER role and assign it to the project with ID 5e2211c17a3e5a48f5497de3: - atlas projects apiKeys create --desc "My API key" --projectId 5e1234c17a3e5a48f5497de3 --role GROUP_OWNER --output json diff --git a/docs/command/atlas-projects-apiKeys-delete.txt b/docs/command/atlas-projects-apiKeys-delete.txt deleted file mode 100644 index c2b2fbc72c..0000000000 --- a/docs/command/atlas-projects-apiKeys-delete.txt +++ /dev/null @@ -1,106 +0,0 @@ -.. _atlas-projects-apiKeys-delete: - -============================= -atlas projects apiKeys delete -============================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Remove the specified organization API key from your project. - -The API key still exists at the organization level. To reassign the organization API key to a project, run the atlas projects apiKeys assign command. - -To view possible values for the ID argument, run atlas organizations apiKeys list. - -To use this command, you must authenticate with a user account or an API key with the Project User Admin role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas projects apiKeys delete [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - ID - - string - - true - - Unique 24-digit string that identifies your API key. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --force - - - - false - - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. - * - -h, --help - - - - false - - help for delete - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - API Key '' deleted - - -Examples --------- - -.. code-block:: - :copyable: false - - # Remove an organization API key with the ID 5f46ae53d58b421fe3edc115 from the project with ID 5e2211c17a3e5a48f5497de3: - atlas projects apiKeys delete 5f46ae53d58b421fe3edc115 --projectId 5e1234c17a3e5a48f5497de3 diff --git a/docs/command/atlas-projects-apiKeys-list.txt b/docs/command/atlas-projects-apiKeys-list.txt deleted file mode 100644 index 4f26094679..0000000000 --- a/docs/command/atlas-projects-apiKeys-list.txt +++ /dev/null @@ -1,92 +0,0 @@ -.. _atlas-projects-apiKeys-list: - -=========================== -atlas projects apiKeys list -=========================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return all organization API keys assigned to your project. - -To use this command, you must authenticate with a user account or an API key with the Project User Admin role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas projects apiKeys list [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -c, --compact - - - - false - - Flag that enables the compact array response structure for a json output. The --compact option returns array objects as top-level responses and allows backward compatibility for scripts based on previous CLI versions. Omitting the --compact option for a json output returns array objects within a 'results' sub-array. You must specify --output json to use this option. - * - -h, --help - - - - false - - help for list - * - --limit - - int - - false - - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. - * - --omitCount - - - - false - - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --page - - int - - false - - Page number that specifies a page of results. This value defaults to 1. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - # Return a JSON-formatted list of organization API keys assigned to the project with ID 5e2211c17a3e5a48f5497de3: - atlas projects apiKeys list --projectId 5e1234c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-projects-apiKeys.txt b/docs/command/atlas-projects-apiKeys.txt deleted file mode 100644 index aa4c4c61da..0000000000 --- a/docs/command/atlas-projects-apiKeys.txt +++ /dev/null @@ -1,65 +0,0 @@ -.. _atlas-projects-apiKeys: - -====================== -atlas projects apiKeys -====================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage API Keys for your project. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for apiKeys - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-projects-apiKeys-assign` - Assign the specified organization API key to your project and modify the API key's roles for the project. -* :ref:`atlas-projects-apiKeys-create` - Create an organization API key and assign it to your project. -* :ref:`atlas-projects-apiKeys-delete` - Remove the specified organization API key from your project. -* :ref:`atlas-projects-apiKeys-list` - Return all organization API keys assigned to your project. - - -.. toctree:: - :titlesonly: - - assign - create - delete - list - diff --git a/docs/command/atlas-projects-create.txt b/docs/command/atlas-projects-create.txt deleted file mode 100644 index 2fa91868b6..0000000000 --- a/docs/command/atlas-projects-create.txt +++ /dev/null @@ -1,120 +0,0 @@ -.. _atlas-projects-create: - -===================== -atlas projects create -===================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create a project in your organization. - -Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, and alert settings. - -To use this command, you must authenticate with a user account or an API key with the Project Data Access Read/Write role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas projects create [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - projectName - - string - - true - - Label that identifies the project. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --govCloudRegionsOnly - - - - false - - Flag that designates that the project uses only the AWS GovCloud region. Use this option only for Atlas for Government projects. If unspecified, the project uses only the AWS Standard region for AWS deployments. You can't deploy clusters across AWS GovCloud and AWS Standard regions in the same project. - * - -h, --help - - - - false - - help for create - * - --orgId - - string - - false - - Organization ID to use. This option overrides the settings in the configuration file or environment variable. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --ownerId - - string - - false - - Unique 24-digit string that identifies the Atlas user to be granted the Project Owner role on the specified project. If unspecified, this value defaults to the user ID of the oldest Organization Owner. - * - --tag - - key=value - - false - - List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the project. - * - --withoutDefaultAlertSettings - - - - false - - Flag that creates the new project without the default alert settings enabled. This flag defaults to false. This option is useful if you create projects programmatically and want to create your own alerts instead of using the default alert settings. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Project '' created. - - -Examples --------- - -.. code-block:: - :copyable: false - - # Create a project in the organization with the ID 5e2211c17a3e5a48f5497de3 using default alert settings: - atlas projects create my-project --orgId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-projects-delete.txt b/docs/command/atlas-projects-delete.txt deleted file mode 100644 index 840a40a2fa..0000000000 --- a/docs/command/atlas-projects-delete.txt +++ /dev/null @@ -1,98 +0,0 @@ -.. _atlas-projects-delete: - -===================== -atlas projects delete -===================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Remove the specified project. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas projects delete [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - ID - - string - - true - - Unique 24-digit string that identifies the project. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --force - - - - false - - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. - * - -h, --help - - - - false - - help for delete - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Project '' deleted - - -Examples --------- - -.. code-block:: - :copyable: false - - # Remove the project with the ID 5e2211c17a3e5a48f5497de3: - atlas projects delete 5e2211c17a3e5a48f5497de3 diff --git a/docs/command/atlas-projects-describe.txt b/docs/command/atlas-projects-describe.txt deleted file mode 100644 index 2d32ee6d1b..0000000000 --- a/docs/command/atlas-projects-describe.txt +++ /dev/null @@ -1,99 +0,0 @@ -.. _atlas-projects-describe: - -======================= -atlas projects describe -======================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return the details for the specified project. - -To use this command, you must authenticate with a user account or an API key with the Project Read Only role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas projects describe [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - ID - - string - - true - - Unique 24-digit string that identifies the project. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for describe - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - ID NAME - - - -Examples --------- - -.. code-block:: - :copyable: false - - # Return the JSON-formatted details for the project with the ID 5e2211c17a3e5a48f5497de3: - atlas projects describe 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-projects-list.txt b/docs/command/atlas-projects-list.txt deleted file mode 100644 index d34deeb096..0000000000 --- a/docs/command/atlas-projects-list.txt +++ /dev/null @@ -1,99 +0,0 @@ -.. _atlas-projects-list: - -=================== -atlas projects list -=================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return all projects. - -To use this command, you must authenticate with a user account or an API key with the Project Data Access Read/Write role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas projects list [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for list - * - --limit - - int - - false - - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. - * - --omitCount - - - - false - - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. - * - --orgId - - string - - false - - Organization ID to use. This option overrides the settings in the configuration file or environment variable. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --page - - int - - false - - Page number that specifies a page of results. This value defaults to 1. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - ID NAME - - - -Examples --------- - -.. code-block:: - :copyable: false - - # Return a JSON-formatted list of all projects: - atlas projects list --output json diff --git a/docs/command/atlas-projects-settings-describe.txt b/docs/command/atlas-projects-settings-describe.txt deleted file mode 100644 index e206c5f33c..0000000000 --- a/docs/command/atlas-projects-settings-describe.txt +++ /dev/null @@ -1,85 +0,0 @@ -.. _atlas-projects-settings-describe: - -================================ -atlas projects settings describe -================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Retrieve details for settings to the specified project. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas projects settings describe [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for describe - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - COLLECT DATABASE SPECIFICS STATISTICS ENABLED DATA EXPLORER ENABLED PERFORMANCE ADVISOR ENABLED REALTIME PERFORMANCE PANEL ENABLED SCHEMA ADVISOR ENABLED - - - -Examples --------- - -.. code-block:: - :copyable: false - - # This example uses the profile named "myprofile" for accessing Atlas. - atlas projects settings describe -P myprofile --projectId 5e2211c17a3e5a48f5497de3 diff --git a/docs/command/atlas-projects-settings-update.txt b/docs/command/atlas-projects-settings-update.txt deleted file mode 100644 index d7a431752c..0000000000 --- a/docs/command/atlas-projects-settings-update.txt +++ /dev/null @@ -1,144 +0,0 @@ -.. _atlas-projects-settings-update: - -============================== -atlas projects settings update -============================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Updates settings for a project. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas projects settings update [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --disableCollectDatabaseSpecificsStatistics - - - - false - - Flag that disables the Collect Database Specific Statistics project setting. - - Mutually exclusive with --enableCollectDatabaseSpecificsStatistics. - * - --disableDataExplorer - - - - false - - Flag that disables the Data Explorer project setting. - - Mutually exclusive with --enableDataExplorer. - * - --disablePerformanceAdvisor - - - - false - - Flag that disables the Performance Advisor project setting. - - Mutually exclusive with --enablePerformanceAdvisor. - * - --disableRealtimePerformancePanel - - - - false - - Flag that disables the Real Time Performance Panel project setting. - - Mutually exclusive with --enableRealtimePerformancePanel. - * - --disableSchemaAdvisor - - - - false - - Flag that disables the Schema Advisor project setting. - - Mutually exclusive with --enableSchemaAdvisor. - * - --enableCollectDatabaseSpecificsStatistics - - - - false - - Flag that enables the Collect Database Specific Statistics project setting. - - Mutually exclusive with --disableCollectDatabaseSpecificsStatistics. - * - --enableDataExplorer - - - - false - - Flag that enables the Data Explorer project setting. - - Mutually exclusive with --disableDataExplorer. - * - --enablePerformanceAdvisor - - - - false - - Flag that enables the Performance Advisor project setting. - - Mutually exclusive with --disablePerformanceAdvisor. - * - --enableRealtimePerformancePanel - - - - false - - Flag that enables the Real Time Performance Panel project setting. - - Mutually exclusive with --disableRealtimePerformancePanel. - * - --enableSchemaAdvisor - - - - false - - Flag that enables the Schema Advisor project setting. - - Mutually exclusive with --disableSchemaAdvisor. - * - -h, --help - - - - false - - help for update - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Project settings updated. - - -Examples --------- - -.. code-block:: - :copyable: false - - # This example uses the profile named "myprofile" for accessing Atlas. - atlas projects settings update --disableCollectDatabaseSpecificsStatistics -P myprofile --projectId 5e2211c17a3e5a48f5497de3 diff --git a/docs/command/atlas-projects-settings.txt b/docs/command/atlas-projects-settings.txt deleted file mode 100644 index 8671663757..0000000000 --- a/docs/command/atlas-projects-settings.txt +++ /dev/null @@ -1,63 +0,0 @@ -.. _atlas-projects-settings: - -======================= -atlas projects settings -======================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Settings operations. - -Manage your project settings. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for settings - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-projects-settings-describe` - Retrieve details for settings to the specified project. -* :ref:`atlas-projects-settings-update` - Updates settings for a project. - - -.. toctree:: - :titlesonly: - - describe - update - diff --git a/docs/command/atlas-projects-teams-add.txt b/docs/command/atlas-projects-teams-add.txt deleted file mode 100644 index f8670378f0..0000000000 --- a/docs/command/atlas-projects-teams-add.txt +++ /dev/null @@ -1,108 +0,0 @@ -.. _atlas-projects-teams-add: - -======================== -atlas projects teams add -======================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Add the specified team to your project. - -All members of the team share the same project access. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas projects teams add [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - teamId - - string - - true - - Unique 24-digit string that identifies the team. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for add - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --role - - strings - - true - - User role that applies to all members of the specified team for the associated project. Valid values include GROUP_CLUSTER_MANAGER, GROUP_DATA_ACCESS_ADMIN, GROUP_DATA_ACCESS_READ_ONLY, GROUP_DATA_ACCESS_READ_WRITE, GROUP_OWNER, and GROUP_READ_ONLY. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Team added to the project. - - -Examples --------- - -.. code-block:: - :copyable: false - - # Add the team with the ID 5dd58c647a3e5a6c5bce46c7 to the project with the ID 5e2211c17a3e5a48f5497de3 with GROUP_READ_ONLY project access: - atlas projects teams add 5dd58c647a3e5a6c5bce46c7 --projectId 5e2211c17a3e5a48f5497de3 --role GROUP_READ_ONLY diff --git a/docs/command/atlas-projects-teams-delete.txt b/docs/command/atlas-projects-teams-delete.txt deleted file mode 100644 index 1f5819a10d..0000000000 --- a/docs/command/atlas-projects-teams-delete.txt +++ /dev/null @@ -1,104 +0,0 @@ -.. _atlas-projects-teams-delete: - -=========================== -atlas projects teams delete -=========================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Remove the specified team from your project. - -After you remove a team from your project, the team still exists in the organization in which it was created. - -To use this command, you must authenticate with a user account or an API key with the Project User Admin role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas projects teams delete [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - teamId - - string - - true - - Unique 24-digit string that identifies the team. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --force - - - - false - - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. - * - -h, --help - - - - false - - help for delete - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Team '' deleted - - -Examples --------- - -.. code-block:: - :copyable: false - - # Remove the team with the ID 5dd58c647a3e5a6c5bce46c7 from the project with the ID 5e2211c17a3e5a48f5497de3: - atlas projects teams delete 5dd58c647a3e5a6c5bce46c7 --projectId 5e2211c17a3e5a48f5497de3 diff --git a/docs/command/atlas-projects-teams-list.txt b/docs/command/atlas-projects-teams-list.txt deleted file mode 100644 index 12e530a794..0000000000 --- a/docs/command/atlas-projects-teams-list.txt +++ /dev/null @@ -1,99 +0,0 @@ -.. _atlas-projects-teams-list: - -========================= -atlas projects teams list -========================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return all teams for a project. - -To use this command, you must authenticate with a user account or an API key with the Project Read Only role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas projects teams list [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for list - * - --limit - - int - - false - - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. - * - --omitCount - - - - false - - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --page - - int - - false - - Page number that specifies a page of results. This value defaults to 1. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - ID - - - -Examples --------- - -.. code-block:: - :copyable: false - - # Return a JSON-formatted list of all teams for the project with the ID 5e2211c17a3e5a48f5497de3: - atlas projects teams list --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-projects-teams-update.txt b/docs/command/atlas-projects-teams-update.txt deleted file mode 100644 index 02527e0e2e..0000000000 --- a/docs/command/atlas-projects-teams-update.txt +++ /dev/null @@ -1,106 +0,0 @@ -.. _atlas-projects-teams-update: - -=========================== -atlas projects teams update -=========================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Modify the roles for the specified team for your project. - -To use this command, you must authenticate with a user account or an API key with the Project User Admin role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas projects teams update [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - teamId - - string - - true - - Unique 24-digit string that identifies the team. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for update - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --role - - strings - - true - - User role that applies to all members of the specified team for the associated project. Valid values include GROUP_CLUSTER_MANAGER, GROUP_DATA_ACCESS_ADMIN, GROUP_DATA_ACCESS_READ_ONLY, GROUP_DATA_ACCESS_READ_WRITE, GROUP_OWNER, and GROUP_READ_ONLY. Passing this flag replaces preexisting data. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Team's roles updated. - - -Examples --------- - -.. code-block:: - :copyable: false - - # Modify the roles for the team with the ID 5dd56c847a3e5a1f363d424d to grant GROUP_READ_ONLY access to the project with the ID 5f71e5255afec75a3d0f96dc: - atlas projects teams update 5dd56c847a3e5a1f363d424d --projectId 5f71e5255afec75a3d0f96dc --role GROUP_READ_ONLY --output json diff --git a/docs/command/atlas-projects-teams.txt b/docs/command/atlas-projects-teams.txt deleted file mode 100644 index b215be2184..0000000000 --- a/docs/command/atlas-projects-teams.txt +++ /dev/null @@ -1,65 +0,0 @@ -.. _atlas-projects-teams: - -==================== -atlas projects teams -==================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage your Atlas teams. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for teams - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-projects-teams-add` - Add the specified team to your project. -* :ref:`atlas-projects-teams-delete` - Remove the specified team from your project. -* :ref:`atlas-projects-teams-list` - Return all teams for a project. -* :ref:`atlas-projects-teams-update` - Modify the roles for the specified team for your project. - - -.. toctree:: - :titlesonly: - - add - delete - list - update - diff --git a/docs/command/atlas-projects-update.txt b/docs/command/atlas-projects-update.txt deleted file mode 100644 index 2b771e7f3c..0000000000 --- a/docs/command/atlas-projects-update.txt +++ /dev/null @@ -1,102 +0,0 @@ -.. _atlas-projects-update: - -===================== -atlas projects update -===================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Update a project. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas projects update [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - ID - - string - - true - - ID of the project you want to update. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -f, --file - - string - - true - - Path to the JSON configuration file that defines project configuration settings. To learn more about project configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/project-config-file. - * - -h, --help - - - - false - - help for update - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Project '' updated. - - -Examples --------- - -.. code-block:: - :copyable: false - - # Update a project with the ID 5e2211c17a3e5a48f5497de3 using the JSON file named myProject.json: - atlas projects update 5f4007f327a3bd7b6f4103c5 --file myProject.json --output json diff --git a/docs/command/atlas-projects-users-delete.txt b/docs/command/atlas-projects-users-delete.txt deleted file mode 100644 index 870543b4f6..0000000000 --- a/docs/command/atlas-projects-users-delete.txt +++ /dev/null @@ -1,104 +0,0 @@ -.. _atlas-projects-users-delete: - -=========================== -atlas projects users delete -=========================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Remove the specified user from your project. - -After you remove a user from your project, the user still exists in the organization in which it was created. - -To use this command, you must authenticate with a user account or an API key with the Project User Admin role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas projects users delete [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - ID - - string - - true - - Unique 24-digit string that identifies the user. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --force - - - - false - - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. - * - -h, --help - - - - false - - help for delete - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - User '' deleted from the project - - -Examples --------- - -.. code-block:: - :copyable: false - - # Remove the user with the ID 5dd58c647a3e5a6c5bce46c7 from the project with the ID 5e2211c17a3e5a48f5497de3: - atlas projects users delete 5dd58c647a3e5a6c5bce46c7 --projectId 5e2211c17a3e5a48f5497de3 diff --git a/docs/command/atlas-projects-users-list.txt b/docs/command/atlas-projects-users-list.txt deleted file mode 100644 index fda0542dcb..0000000000 --- a/docs/command/atlas-projects-users-list.txt +++ /dev/null @@ -1,92 +0,0 @@ -.. _atlas-projects-users-list: - -========================= -atlas projects users list -========================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return all users for a project. - -To use this command, you must authenticate with a user account or an API key with the Project Read Only role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas projects users list [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -c, --compact - - - - false - - Flag that enables the compact array response structure for a json output. The --compact option returns array objects as top-level responses and allows backward compatibility for scripts based on previous CLI versions. Omitting the --compact option for a json output returns array objects within a 'results' sub-array. You must specify --output json to use this option. - * - -h, --help - - - - false - - help for list - * - --limit - - int - - false - - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. - * - --omitCount - - - - false - - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --page - - int - - false - - Page number that specifies a page of results. This value defaults to 1. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - # Return a JSON-formatted list of all users for the project with the ID 5e2211c17a3e5a48f5497de3: - atlas projects users list --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-projects-users.txt b/docs/command/atlas-projects-users.txt deleted file mode 100644 index 0292d11497..0000000000 --- a/docs/command/atlas-projects-users.txt +++ /dev/null @@ -1,61 +0,0 @@ -.. _atlas-projects-users: - -==================== -atlas projects users -==================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage users for a project. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for users - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-projects-users-delete` - Remove the specified user from your project. -* :ref:`atlas-projects-users-list` - Return all users for a project. - - -.. toctree:: - :titlesonly: - - delete - list - diff --git a/docs/command/atlas-projects.txt b/docs/command/atlas-projects.txt deleted file mode 100644 index b7e5825090..0000000000 --- a/docs/command/atlas-projects.txt +++ /dev/null @@ -1,77 +0,0 @@ -.. _atlas-projects: - -============== -atlas projects -============== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage your Atlas projects. - -Create, list and manage your MongoDB projects. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for projects - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-projects-apiKeys` - Manage API Keys for your project. -* :ref:`atlas-projects-create` - Create a project in your organization. -* :ref:`atlas-projects-delete` - Remove the specified project. -* :ref:`atlas-projects-describe` - Return the details for the specified project. -* :ref:`atlas-projects-list` - Return all projects. -* :ref:`atlas-projects-settings` - Settings operations. -* :ref:`atlas-projects-teams` - Manage your Atlas teams. -* :ref:`atlas-projects-update` - Update a project. -* :ref:`atlas-projects-users` - Manage users for a project. - - -.. toctree:: - :titlesonly: - - apiKeys - create - delete - describe - list - settings - teams - update - users - diff --git a/docs/command/atlas-security-customerCerts-create.txt b/docs/command/atlas-security-customerCerts-create.txt deleted file mode 100644 index f22030f134..0000000000 --- a/docs/command/atlas-security-customerCerts-create.txt +++ /dev/null @@ -1,92 +0,0 @@ -.. _atlas-security-customerCerts-create: - -=================================== -atlas security customerCerts create -=================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Saves a customer-managed X.509 configuration for your project. - -Saving a customer-managed X.509 configuration triggers a rolling restart. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas security customerCerts create [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --casFile - - string - - true - - Path to a PEM file containing one or more CAs for database user authentication. - * - -h, --help - - - - false - - help for create - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Certificate successfully created. - - -Examples --------- - -.. code-block:: - :copyable: false - - # Save the file named ca.pem stored in the files directory to the project with the ID 5e2211c17a3e5a48f5497de3: - atlas security customerCerts create --casFile files/ca.pem --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-security-customerCerts-describe.txt b/docs/command/atlas-security-customerCerts-describe.txt deleted file mode 100644 index c94b4cad31..0000000000 --- a/docs/command/atlas-security-customerCerts-describe.txt +++ /dev/null @@ -1,76 +0,0 @@ -.. _atlas-security-customerCerts-describe: - -===================================== -atlas security customerCerts describe -===================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return the details for the current customer-managed X.509 configuration for your project. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas security customerCerts describe [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for describe - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - # Return the JSON-formatted details for the customer-managed X.509 configuration in the project with the ID 5e2211c17a3e5a48f5497de3: - atlas security customerCerts describe --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-security-customerCerts-disable.txt b/docs/command/atlas-security-customerCerts-disable.txt deleted file mode 100644 index c45f4712e1..0000000000 --- a/docs/command/atlas-security-customerCerts-disable.txt +++ /dev/null @@ -1,84 +0,0 @@ -.. _atlas-security-customerCerts-disable: - -==================================== -atlas security customerCerts disable -==================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Clear customer-managed X.509 settings on a project, including the uploaded Certificate Authority, and disable self-managed X.509. - -Disabling customer-managed X.509 triggers a rolling restart. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas security customerCerts disable [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for disable - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - X.509 configuration for project was deleted. - - -Examples --------- - -.. code-block:: - :copyable: false - - # Disable the customer-managed X.509 configuration in the project with the ID 5e2211c17a3e5a48f5497de3: - atlas security customerCerts disable --projectId 5e2211c17a3e5a48f5497de3 diff --git a/docs/command/atlas-security-customerCerts.txt b/docs/command/atlas-security-customerCerts.txt deleted file mode 100644 index 9b8a81fb98..0000000000 --- a/docs/command/atlas-security-customerCerts.txt +++ /dev/null @@ -1,63 +0,0 @@ -.. _atlas-security-customerCerts: - -============================ -atlas security customerCerts -============================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage customer x509 certificates for your project. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for customerCerts - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-security-customerCerts-create` - Saves a customer-managed X.509 configuration for your project. -* :ref:`atlas-security-customerCerts-describe` - Return the details for the current customer-managed X.509 configuration for your project. -* :ref:`atlas-security-customerCerts-disable` - Clear customer-managed X.509 settings on a project, including the uploaded Certificate Authority, and disable self-managed X.509. - - -.. toctree:: - :titlesonly: - - create - describe - disable - diff --git a/docs/command/atlas-security-ldap-delete.txt b/docs/command/atlas-security-ldap-delete.txt deleted file mode 100644 index 1a26083803..0000000000 --- a/docs/command/atlas-security-ldap-delete.txt +++ /dev/null @@ -1,86 +0,0 @@ -.. _atlas-security-ldap-delete: - -========================== -atlas security ldap delete -========================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Remove the current LDAP configuration captured in the userToDNMapping document from your project. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas security ldap delete [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --force - - - - false - - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. - * - -h, --help - - - - false - - help for delete - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - LDAP configuration userToDNMapping deleted from project'' - - -Examples --------- - -.. code-block:: - :copyable: false - - # Remove the current LDAP configuration in the project with the ID 5e2211c17a3e5a48f5497de3: - atlas security ldap delete --projectId 5e2211c17a3e5a48f5497de3 diff --git a/docs/command/atlas-security-ldap-get.txt b/docs/command/atlas-security-ldap-get.txt deleted file mode 100644 index 359a0931fc..0000000000 --- a/docs/command/atlas-security-ldap-get.txt +++ /dev/null @@ -1,87 +0,0 @@ -.. _atlas-security-ldap-get: - -======================= -atlas security ldap get -======================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return the current LDAP configuration details for your project. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas security ldap get [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for get - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - HOSTNAME PORT AUTHENTICATION AUTHORIZATION - - - -Examples --------- - -.. code-block:: - :copyable: false - - # Return the JSON-formatted details of the current LDAP configuration in the project with the ID 5e2211c17a3e5a48f5497de3: - atlas security ldap get --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-security-ldap-save.txt b/docs/command/atlas-security-ldap-save.txt deleted file mode 100644 index 8bae744bc4..0000000000 --- a/docs/command/atlas-security-ldap-save.txt +++ /dev/null @@ -1,138 +0,0 @@ -.. _atlas-security-ldap-save: - -======================== -atlas security ldap save -======================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Save an LDAP configuration for your project. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas security ldap save [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --authenticationEnabled - - - - false - - Flag that indicates whether to enable LDAP user authentication. - * - --authorizationEnabled - - - - false - - Flag that indicates whether to enable LDAP user authorization. - * - --authzQueryTemplate - - string - - false - - RFC 4515-formatted or RFC 4516-formatted LDAP query template that Atlas executes to obtain the LDAP authorization groups to which the authenticated user belongs. Use the {USER} placeholder in the URL to substitute the username. The query is relative to the host specified with the hostname. - * - --bindPassword - - string - - false - - Password used to authenticate the bindUsername. - * - --bindUsername - - string - - true - - User distinguished name (DN) that Atlas uses to connect to the LDAP server. You must format LDAP distinguished names according to RFC 2253. - * - --caCertificate - - string - - false - - Certificate Authority (CA) used to verify the identity of the LDAP server. To delete an assigned value, pass an empty string. - * - -h, --help - - - - false - - help for save - * - --hostname - - string - - true - - Hostname or IP address of the LDAP server. - * - --mappingLdapQuery - - string - - false - - RFC 4515-formatted or RFC 4516-formatted LDAP query template that inserts the LDAP name that the regex matches into an LDAP query URI. - - Mutually exclusive with --mappingSubstitution, --mappingSubstitution. - * - --mappingMatch - - string - - false - - ECMAScript-formatted regular expression (regex) to match against a provided username. - * - --mappingSubstitution - - string - - false - - LDAP distinguished name (DN) template that converts the LDAP username that matches the regex specified in the match option into an LDAP DN. - - Mutually exclusive with --mappingLdapQuery, --mappingLdapQuery. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --port - - int - - false - - Port that the LDAP server listens to for client connections. This value defaults to 636. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - HOSTNAME PORT AUTHENTICATION AUTHORIZATION - - - -Examples --------- - -.. code-block:: - :copyable: false - - # Save an LDAP server configuration to authenticate and authorize MongoDB users for the host atlas-ldaps-01.ldap.myteam.com: - atlas security ldap save --authenticationEnabled --authorizationEnabled - --hostname atlas-ldaps-01.ldap.myteam.com --bindUsername - "CN=Administrator,CN=Users,DC=atlas-ldaps-01,DC=myteam,DC=com" - --bindPassword changeMe diff --git a/docs/command/atlas-security-ldap-verify-status-watch.txt b/docs/command/atlas-security-ldap-verify-status-watch.txt deleted file mode 100644 index 8a13c69d21..0000000000 --- a/docs/command/atlas-security-ldap-verify-status-watch.txt +++ /dev/null @@ -1,103 +0,0 @@ -.. _atlas-security-ldap-verify-status-watch: - -======================================= -atlas security ldap verify status watch -======================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Watch for an LDAP configuration request to complete. - -This command checks the LDAP configuration's status periodically until it reaches a SUCCESS or FAILED status. -Once the LDAP configuration reaches the expected status, the command prints "LDAP Configuration request completed." -If you run the command in the terminal, it blocks the terminal session until the resource status succeeds or fails. -You can interrupt the command's polling at any time with CTRL-C. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas security ldap verify status watch [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - requestId - - string - - true - - ID of the request to verify an LDAP configuration. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for watch - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - - LDAP Configuration request completed. - - -Examples --------- - -.. code-block:: - :copyable: false - - atlas security ldap status watch requestIdSample diff --git a/docs/command/atlas-security-ldap-verify-status.txt b/docs/command/atlas-security-ldap-verify-status.txt deleted file mode 100644 index 3458531de3..0000000000 --- a/docs/command/atlas-security-ldap-verify-status.txt +++ /dev/null @@ -1,106 +0,0 @@ -.. _atlas-security-ldap-verify-status: - -================================= -atlas security ldap verify status -================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Get the status of an LDAP configuration request. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas security ldap verify status [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - requestId - - string - - true - - ID of the request to verify an LDAP configuration. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for status - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - REQUEST ID PROJECT ID STATUS - - - -Related Commands ----------------- - -* :ref:`atlas-security-ldap-verify-status-watch` - Watch for an LDAP configuration request to complete. - - -.. toctree:: - :titlesonly: - - watch - diff --git a/docs/command/atlas-security-ldap-verify.txt b/docs/command/atlas-security-ldap-verify.txt deleted file mode 100644 index 1a76e01654..0000000000 --- a/docs/command/atlas-security-ldap-verify.txt +++ /dev/null @@ -1,123 +0,0 @@ -.. _atlas-security-ldap-verify: - -========================== -atlas security ldap verify -========================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Request verification of an LDAP configuration for your project. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas security ldap verify [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --authzQueryTemplate - - string - - false - - RFC 4515-formatted or RFC 4516-formatted LDAP query template that Atlas executes to obtain the LDAP authorization groups to which the authenticated user belongs. Use the {USER} placeholder in the URL to substitute the username. The query is relative to the host specified with the hostname. - * - --bindPassword - - string - - false - - Password used to authenticate the bindUsername. - * - --bindUsername - - string - - true - - User distinguished name (DN) that Atlas uses to connect to the LDAP server. You must format LDAP distinguished names according to RFC 2253. - * - --caCertificate - - string - - false - - Certificate Authority (CA) used to verify the identity of the LDAP server. To delete an assigned value, pass an empty string. - * - -h, --help - - - - false - - help for verify - * - --hostname - - string - - true - - Hostname or IP address of the LDAP server. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --port - - int - - false - - Port that the LDAP server listens to for client connections. This value defaults to 636. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - REQUEST ID PROJECT ID STATUS - - - -Examples --------- - -.. code-block:: - :copyable: false - - # Request the JSON-formatted verification of the LDAP configuration for the atlas-ldaps-01.ldap.myteam.com host in the project with the ID 5e2211c17a3e5a48f5497de3: - atlas security ldap verify --hostname atlas-ldaps-01.ldap.myteam.com --bindUsername "CN=Administrator,CN=Users,DC=atlas-ldaps-01,DC=myteam,DC=com" --bindPassword changeMe --projectId 5e2211c17a3e5a48f5497de3 --output json - -Related Commands ----------------- - -* :ref:`atlas-security-ldap-verify-status` - Get the status of an LDAP configuration request. - - -.. toctree:: - :titlesonly: - - status - diff --git a/docs/command/atlas-security-ldap.txt b/docs/command/atlas-security-ldap.txt deleted file mode 100644 index 20627d1405..0000000000 --- a/docs/command/atlas-security-ldap.txt +++ /dev/null @@ -1,65 +0,0 @@ -.. _atlas-security-ldap: - -=================== -atlas security ldap -=================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -LDAP operations. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for ldap - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-security-ldap-delete` - Remove the current LDAP configuration captured in the userToDNMapping document from your project. -* :ref:`atlas-security-ldap-get` - Return the current LDAP configuration details for your project. -* :ref:`atlas-security-ldap-save` - Save an LDAP configuration for your project. -* :ref:`atlas-security-ldap-verify` - Request verification of an LDAP configuration for your project. - - -.. toctree:: - :titlesonly: - - delete - get - save - verify - diff --git a/docs/command/atlas-security.txt b/docs/command/atlas-security.txt deleted file mode 100644 index 3457b5871d..0000000000 --- a/docs/command/atlas-security.txt +++ /dev/null @@ -1,61 +0,0 @@ -.. _atlas-security: - -============== -atlas security -============== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage security configuration for your project. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for security - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-security-customerCerts` - Manage customer x509 certificates for your project. -* :ref:`atlas-security-ldap` - LDAP operations. - - -.. toctree:: - :titlesonly: - - customerCerts - ldap - diff --git a/docs/command/atlas-serverless-backups-restores-create.txt b/docs/command/atlas-serverless-backups-restores-create.txt deleted file mode 100644 index c63dca378e..0000000000 --- a/docs/command/atlas-serverless-backups-restores-create.txt +++ /dev/null @@ -1,138 +0,0 @@ -.. _atlas-serverless-backups-restores-create: - -======================================== -atlas serverless backups restores create -======================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Start a restore job for your serverless instance. - -If you create an automated or pointInTime restore job, Atlas removes all existing data on the target cluster prior to the restore. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. -Atlas supports this command only for M10+ clusters. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas serverless backups restores create [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --clusterName - - string - - true - - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. - * - --deliveryType - - string - - true - - Type of restore job to create. Valid values include: automated, download, pointInTime. To learn more about types of restore jobs, see https://dochub.mongodb.org/core/backup-restore-cluster-atlas. - * - -h, --help - - - - false - - help for create - * - --oplogInc - - int - - false - - 32-bit incrementing ordinal that represents operations within a given second. When paired with oplogTs, they represent the point in time to which your data will be restored. - * - --oplogTs - - int - - false - - Oplog timestamp given as a timestamp in the number of seconds that have elapsed since the UNIX Epoch. When paired with oplogInc, they represent the point in time to which your data will be restored. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --pointInTimeUTCSeconds - - int - - false - - Timestamp in the number of seconds that have elapsed since the UNIX epoch that represents the point in time to which your data will be restored. This timestamp must be within the last 24 hours of the current time. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --snapshotId - - string - - false - - Unique identifier of the snapshot. - * - --targetClusterName - - string - - false - - Name of the target cluster. For use only with automated restore jobs. You must specify a targetClusterName for automated restores. - * - --targetProjectId - - string - - false - - Unique identifier of the project that contains the destination cluster for the restore job. You must specify a targetProjectId for automated restores. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - # Create an automated restore: - atlas serverless backup restore create \ - --deliveryType automated \ - --clusterName myDemo \ - --snapshotId 5e7e00128f8ce03996a47179 \ - --targetClusterName myDemo2 \ - --targetProjectId 1a2345b67c8e9a12f3456de7 - - -.. code-block:: - :copyable: false - - # Create a point-in-time restore: - atlas serverless backup restore create \ - --deliveryType pointInTime \ - --clusterName myDemo \ - --pointInTimeUTCSeconds 1588523147 \ - --targetClusterName myDemo2 \ - --targetProjectId 1a2345b67c8e9a12f3456de7 - - -.. code-block:: - :copyable: false - - # Create a download restore: - atlas serverless backup restore create \ - --deliveryType download \ - --clusterName myDemo \ - --snapshotId 5e7e00128f8ce03996a47179 diff --git a/docs/command/atlas-serverless-backups-restores-describe.txt b/docs/command/atlas-serverless-backups-restores-describe.txt deleted file mode 100644 index f370cc9295..0000000000 --- a/docs/command/atlas-serverless-backups-restores-describe.txt +++ /dev/null @@ -1,84 +0,0 @@ -.. _atlas-serverless-backups-restores-describe: - -========================================== -atlas serverless backups restores describe -========================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Describe a cloud backup restore job. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas serverless backups restores describe [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --clusterName - - string - - true - - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. - * - -h, --help - - - - false - - help for describe - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --restoreJobId - - string - - true - - Unique identifier that identifies the Restore Job. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - # Return the details for the continuous backup restore job with the ID 507f1f77bcf86cd799439011 for the serverless isntance named Cluster0: - atlas serverless backup restore describe --restoreJobId 507f1f77bcf86cd799439011 --clusterName Cluster0 diff --git a/docs/command/atlas-serverless-backups-restores-list.txt b/docs/command/atlas-serverless-backups-restores-list.txt deleted file mode 100644 index 818f96f99d..0000000000 --- a/docs/command/atlas-serverless-backups-restores-list.txt +++ /dev/null @@ -1,104 +0,0 @@ -.. _atlas-serverless-backups-restores-list: - -====================================== -atlas serverless backups restores list -====================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return all cloud backup restore jobs for the specified serverless instance in your project. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas serverless backups restores list [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - clusterName - - string - - true - - Label that identifies the Atlas serverless instance for which you want to return restore jobs. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for list - * - --limit - - int - - false - - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. - * - --omitCount - - - - false - - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --page - - int - - false - - Page number that specifies a page of results. This value defaults to 1. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - # Return all continuous backup restore jobs for the serverless instance Instance0: - atlas serverless backup restore list Instance0 diff --git a/docs/command/atlas-serverless-backups-restores-watch.txt b/docs/command/atlas-serverless-backups-restores-watch.txt deleted file mode 100644 index 493beab3c0..0000000000 --- a/docs/command/atlas-serverless-backups-restores-watch.txt +++ /dev/null @@ -1,99 +0,0 @@ -.. _atlas-serverless-backups-restores-watch: - -======================================= -atlas serverless backups restores watch -======================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Watch the specified backup restore job until it completes. - -This command checks the restore job's status periodically until it reaches a completed, failed or canceled status. -Command finishes once one of the expected statuses are reached. -If you run the command in the terminal, it blocks the terminal session until the resource status completes or fails. -You can interrupt the command's polling at any time with CTRL-C. -To use this command, you must authenticate with a user account or an API key with the Project Read Only role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas serverless backups restores watch [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --clusterName - - string - - true - - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. - * - -h, --help - - - - false - - help for watch - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --restoreJobId - - string - - true - - Unique identifier that identifies the Restore Job. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - - Restore completed. - - -Examples --------- - -.. code-block:: - :copyable: false - - # Watch the continuous backup restore job with the ID 507f1f77bcf86cd799439011 for the cluster named Cluster0 until it becomes available: - atlas serverless backup restore watch --restoreJobId 507f1f77bcf86cd799439011 --clusterName Cluster0 diff --git a/docs/command/atlas-serverless-backups-restores.txt b/docs/command/atlas-serverless-backups-restores.txt deleted file mode 100644 index 075cb55e82..0000000000 --- a/docs/command/atlas-serverless-backups-restores.txt +++ /dev/null @@ -1,65 +0,0 @@ -.. _atlas-serverless-backups-restores: - -================================= -atlas serverless backups restores -================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage cloud backup restore jobs for your project. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for restores - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-serverless-backups-restores-create` - Start a restore job for your serverless instance. -* :ref:`atlas-serverless-backups-restores-describe` - Describe a cloud backup restore job. -* :ref:`atlas-serverless-backups-restores-list` - Return all cloud backup restore jobs for the specified serverless instance in your project. -* :ref:`atlas-serverless-backups-restores-watch` - Watch the specified backup restore job until it completes. - - -.. toctree:: - :titlesonly: - - create - describe - list - watch - diff --git a/docs/command/atlas-serverless-backups-snapshots-describe.txt b/docs/command/atlas-serverless-backups-snapshots-describe.txt deleted file mode 100644 index 75e99d206c..0000000000 --- a/docs/command/atlas-serverless-backups-snapshots-describe.txt +++ /dev/null @@ -1,95 +0,0 @@ -.. _atlas-serverless-backups-snapshots-describe: - -=========================================== -atlas serverless backups snapshots describe -=========================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return the details for the specified snapshot for your project. - -To use this command, you must authenticate with a user account or an API key with the Project Read Only role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas serverless backups snapshots describe [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --clusterName - - string - - true - - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. - * - -h, --help - - - - false - - help for describe - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --snapshotId - - string - - true - - Unique identifier of the snapshot. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - ID SNAPSHOT TYPE EXPIRES AT - - - -Examples --------- - -.. code-block:: - :copyable: false - - # Return the details for the backup snapshot with the ID 5f4007f327a3bd7b6f4103c5 for the instance named myDemo: - atlas serverless backups snapshots describe --snapshotId 5f4007f327a3bd7b6f4103c5 --clusterName myDemo diff --git a/docs/command/atlas-serverless-backups-snapshots-list.txt b/docs/command/atlas-serverless-backups-snapshots-list.txt deleted file mode 100644 index 32397aaab9..0000000000 --- a/docs/command/atlas-serverless-backups-snapshots-list.txt +++ /dev/null @@ -1,104 +0,0 @@ -.. _atlas-serverless-backups-snapshots-list: - -======================================= -atlas serverless backups snapshots list -======================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return all cloud backup snapshots for the specified serverless instance in your project. - -To use this command, you must authenticate with a user account or an API key with the Project Read Only role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas serverless backups snapshots list [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - clusterName - - string - - true - - Label that identifies the Atlas serverless instance that contains the snapshots you want to return. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for list - * - --limit - - int - - false - - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. - * - --omitCount - - - - false - - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --page - - int - - false - - Page number that specifies a page of results. This value defaults to 1. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - # Return a JSON-formatted list of snapshots for the instance named myDemo - atlas serverless backups snapshots list myDemo --output json diff --git a/docs/command/atlas-serverless-backups-snapshots-watch.txt b/docs/command/atlas-serverless-backups-snapshots-watch.txt deleted file mode 100644 index c9c0833f21..0000000000 --- a/docs/command/atlas-serverless-backups-snapshots-watch.txt +++ /dev/null @@ -1,95 +0,0 @@ -.. _atlas-serverless-backups-snapshots-watch: - -======================================== -atlas serverless backups snapshots watch -======================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Watch the specified snapshot in your project until it reaches a completed or failed status. - -This command checks the snapshot's status periodically until it reaches a completed or failed status. -Command finishes once one of the expected statuses are reached. -If you run the command in the terminal, it blocks the terminal session until the resource status completes or fails. -You can interrupt the command's polling at any time with CTRL-C. -To use this command, you must authenticate with a user account or an API key with the Project Read Only role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas serverless backups snapshots watch [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --clusterName - - string - - true - - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. - * - -h, --help - - - - false - - help for watch - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --snapshotId - - string - - true - - Unique identifier of the snapshot. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - - Snapshot changes completed. - - -Examples --------- - -.. code-block:: - :copyable: false - - # Watch the backup snapshot with the ID 5f4007f327a3bd7b6f4103c5 in the cluster named myDemo until it becomes available: - atlas backups snapshots watch 5f4007f327a3bd7b6f4103c5 --clusterName myDemo diff --git a/docs/command/atlas-serverless-backups-snapshots.txt b/docs/command/atlas-serverless-backups-snapshots.txt deleted file mode 100644 index 4e88777e4c..0000000000 --- a/docs/command/atlas-serverless-backups-snapshots.txt +++ /dev/null @@ -1,63 +0,0 @@ -.. _atlas-serverless-backups-snapshots: - -================================== -atlas serverless backups snapshots -================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage cloud backup snapshots for your project. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for snapshots - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-serverless-backups-snapshots-describe` - Return the details for the specified snapshot for your project. -* :ref:`atlas-serverless-backups-snapshots-list` - Return all cloud backup snapshots for the specified serverless instance in your project. -* :ref:`atlas-serverless-backups-snapshots-watch` - Watch the specified snapshot in your project until it reaches a completed or failed status. - - -.. toctree:: - :titlesonly: - - describe - list - watch - diff --git a/docs/command/atlas-serverless-backups.txt b/docs/command/atlas-serverless-backups.txt deleted file mode 100644 index 897f685a06..0000000000 --- a/docs/command/atlas-serverless-backups.txt +++ /dev/null @@ -1,61 +0,0 @@ -.. _atlas-serverless-backups: - -======================== -atlas serverless backups -======================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage cloud backups for your project. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for backups - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-serverless-backups-restores` - Manage cloud backup restore jobs for your project. -* :ref:`atlas-serverless-backups-snapshots` - Manage cloud backup snapshots for your project. - - -.. toctree:: - :titlesonly: - - restores - snapshots - diff --git a/docs/command/atlas-serverless-create.txt b/docs/command/atlas-serverless-create.txt deleted file mode 100644 index e6513837e1..0000000000 --- a/docs/command/atlas-serverless-create.txt +++ /dev/null @@ -1,114 +0,0 @@ -.. _atlas-serverless-create: - -======================= -atlas serverless create -======================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Creates one serverless instance in the specified project. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas serverless create [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - instanceName - - string - - true - - Human-readable label that identifies your serverless instance. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for create - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --provider - - string - - true - - Cloud service provider that applies to the provisioned serverless instance. - * - --region - - string - - true - - Human-readable label that identifies the physical location of your MongoDB serverless instance. The region you choose can affect network latency for clients accessing your databases. - * - --tag - - key=value - - false - - List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Serverless instance created. - - -Examples --------- - -.. code-block:: - :copyable: false - - # Deploy a serverlessInstance named myInstance for the project with the ID 5e2211c17a3e5a48f5497de3: - atlas serverless create myInstance --provider AWS --region US_EAST_1 --projectId 5e2211c17a3e5a48f5497de3 diff --git a/docs/command/atlas-serverless-delete.txt b/docs/command/atlas-serverless-delete.txt deleted file mode 100644 index ab1996e009..0000000000 --- a/docs/command/atlas-serverless-delete.txt +++ /dev/null @@ -1,108 +0,0 @@ -.. _atlas-serverless-delete: - -======================= -atlas serverless delete -======================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Remove a serverless instance from your project. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas serverless delete [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - instanceName - - string - - true - - Name of the instance to delete. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --force - - - - false - - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. - * - -h, --help - - - - false - - help for delete - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Serverless instance '' deleted - - -Examples --------- - -.. code-block:: - :copyable: false - - # Remove a serverlessInstance named myInstance for the project with the ID 5e2211c17a3e5a48f5497de3: - atlas serverless delete myInstance --projectId 5e2211c17a3e5a48f5497de3 - -.. code-block:: - :copyable: false - - # Remove a serverlessInstance named myInstance for the project with the ID 5e2211c17a3e5a48f5497de3 without requiring confirmation: - atlas serverless delete myInstance --projectId 5e2211c17a3e5a48f5497de3 --force diff --git a/docs/command/atlas-serverless-describe.txt b/docs/command/atlas-serverless-describe.txt deleted file mode 100644 index 1b46e0934e..0000000000 --- a/docs/command/atlas-serverless-describe.txt +++ /dev/null @@ -1,103 +0,0 @@ -.. _atlas-serverless-describe: - -========================= -atlas serverless describe -========================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return one serverless instance in the specified project. - -To use this command, you must authenticate with a user account or an API key with the Project Read Only role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas serverless describe [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - instanceName - - string - - true - - Human-readable label that identifies your serverless instance. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for describe - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - ID NAME MDB VER STATE - - - -Examples --------- - -.. code-block:: - :copyable: false - - # Return the JSON-formatted details for the serverlessInstance named myInstance in the project with the ID 5e2211c17a3e5a48f5497de3: - atlas serverless describe myInstance --projectId 5e2211c17a3e5a48f5497de3 diff --git a/docs/command/atlas-serverless-list.txt b/docs/command/atlas-serverless-list.txt deleted file mode 100644 index c998545fcc..0000000000 --- a/docs/command/atlas-serverless-list.txt +++ /dev/null @@ -1,99 +0,0 @@ -.. _atlas-serverless-list: - -===================== -atlas serverless list -===================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return all serverless instances in the specified project. - -To use this command, you must authenticate with a user account or an API key with the Project Read Only role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas serverless list [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for list - * - --limit - - int - - false - - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. - * - --omitCount - - - - false - - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --page - - int - - false - - Page number that specifies a page of results. This value defaults to 1. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - ID NAME MDB VER STATE - - - -Examples --------- - -.. code-block:: - :copyable: false - - # Return the JSON-formatted list of all serverlessInstances for the project with the ID 5e2211c17a3e5a48f5497de3: - atlas serverless list --projectId 5e2211c17a3e5a48f5497de3 diff --git a/docs/command/atlas-serverless-update.txt b/docs/command/atlas-serverless-update.txt deleted file mode 100644 index 09918c83c1..0000000000 --- a/docs/command/atlas-serverless-update.txt +++ /dev/null @@ -1,122 +0,0 @@ -.. _atlas-serverless-update: - -======================= -atlas serverless update -======================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Updates one serverless instance in the specified project. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas serverless update [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - instanceName - - string - - true - - Human-readable label that identifies your serverless instance. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --disableServerlessContinuousBackup - - - - false - - Disables Serverless Continuous Backup for your serverless instance. If disabled the serverless instance uses Basic Backup. - - Mutually exclusive with --enableServerlessContinuousBackup. - * - --disableTerminationProtection - - - - false - - Disables termination protection for your cluster. You can delete a cluster with termination protection disabled. - - Mutually exclusive with --enableTerminationProtection. - * - --enableServerlessContinuousBackup - - - - false - - Flag that enables Serverless Continuous Backup for your serverless instance. If enabled, the serverless instance does not use Basic Backup. - - Mutually exclusive with --disableServerlessContinuousBackup. - * - --enableTerminationProtection - - - - false - - Enables termination protection for your cluster. You can't delete a cluster with termination protection enabled. - - Mutually exclusive with --disableTerminationProtection. - * - -h, --help - - - - false - - help for update - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --tag - - key=value - - false - - List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance. Passing this flag replaces preexisting data. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Serverless instance updated. - - diff --git a/docs/command/atlas-serverless-watch.txt b/docs/command/atlas-serverless-watch.txt deleted file mode 100644 index a4eb079ee5..0000000000 --- a/docs/command/atlas-serverless-watch.txt +++ /dev/null @@ -1,103 +0,0 @@ -.. _atlas-serverless-watch: - -====================== -atlas serverless watch -====================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Monitor the status of serverless instance. - -This command checks the serverless instance's state periodically until the instance reaches an IDLE state. -Once the instance reaches the expected state, the command prints "Instance available." -If you run the command in the terminal, it blocks the terminal session until the resource becomes idle. -You can interrupt the command's polling at any time with CTRL-C. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas serverless watch [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - instanceName - - string - - true - - Name of the instance to watch. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for watch - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - - Instance available. - - -Examples --------- - -.. code-block:: - :copyable: false - - atlas serverless watch instanceNameSample diff --git a/docs/command/atlas-serverless.txt b/docs/command/atlas-serverless.txt deleted file mode 100644 index 635d8401a1..0000000000 --- a/docs/command/atlas-serverless.txt +++ /dev/null @@ -1,73 +0,0 @@ -.. _atlas-serverless: - -================ -atlas serverless -================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage serverless instances for your project. - -The serverless command provides access to your serverless instance configurations. You can create, edit, and delete serverless instances. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for serverless - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-serverless-backups` - Manage cloud backups for your project. -* :ref:`atlas-serverless-create` - Creates one serverless instance in the specified project. -* :ref:`atlas-serverless-delete` - Remove a serverless instance from your project. -* :ref:`atlas-serverless-describe` - Return one serverless instance in the specified project. -* :ref:`atlas-serverless-list` - Return all serverless instances in the specified project. -* :ref:`atlas-serverless-update` - Updates one serverless instance in the specified project. -* :ref:`atlas-serverless-watch` - Monitor the status of serverless instance. - - -.. toctree:: - :titlesonly: - - backups - create - delete - describe - list - update - watch - diff --git a/docs/command/atlas-setup.txt b/docs/command/atlas-setup.txt deleted file mode 100644 index 302145b0b0..0000000000 --- a/docs/command/atlas-setup.txt +++ /dev/null @@ -1,142 +0,0 @@ -.. _atlas-setup: - -=========== -atlas setup -=========== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Register, authenticate, create, and access an Atlas cluster. - -This command takes you through registration, login, default profile creation, creating your first free tier cluster and connecting to it using MongoDB Shell. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas setup [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --accessListIp - - strings - - false - - IP address to grant access to the deployment. - - Mutually exclusive with --currentIp. - * - --clusterName - - string - - false - - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. - * - --connectWith - - string - - false - - Method for connecting to the cluster. Valid values are compass, mongosh and skip. - - Mutually exclusive with --skipMongosh. - * - --currentIp - - - - false - - Flag that adds the IP address from the host that is currently executing the command to the access list. - - Mutually exclusive with --accessListIp. - * - --enableTerminationProtection - - - - false - - Enables termination protection for your cluster. You can't delete a cluster with termination protection enabled. - * - --force - - - - false - - Flag that indicates whether to skip the request for input and create a cluster with the default settings for any unspecified options. - * - --gov - - - - false - - Register with Atlas for Government. - * - -h, --help - - - - false - - help for setup - * - --mdbVersion - - string - - false - - Major MongoDB version of the deployment. - * - --noBrowser - - - - false - - Don't try to open a browser session. - * - --password - - string - - false - - Password for the user. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --provider - - string - - false - - Name of your cloud service provider. Valid values are AWS, AZURE, or GCP. - * - -r, --region - - string - - false - - Physical location of your MongoDB cluster. For a complete list of supported AWS regions, see: https://dochub.mongodb.org/core/aws-atlas. For a complete list of supported Azure regions, see: https://dochub.mongodb.org/core/azure-atlas. For a complete list of supported GCP regions, see: https://dochub.mongodb.org/core/gcp-atlas. - * - --skipSampleData - - - - false - - Flag that indicates whether to skip loading sample data into your MongoDB cluster. - * - --tag - - key=value - - false - - List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. - * - --tier - - string - - false - - Tier for each data-bearing server in the cluster. To learn more about cluster tiers, see https://dochub.mongodb.org/core/cluster-tier-atlas. This value defaults to "M0". - * - --username - - string - - false - - Username for authenticating to MongoDB. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - # Override default cluster settings like name, provider, or database username by using the command options - atlas setup --clusterName Test --provider GCP --username dbuserTest diff --git a/docs/command/atlas-streams-connections-create.txt b/docs/command/atlas-streams-connections-create.txt deleted file mode 100644 index 1195155ba6..0000000000 --- a/docs/command/atlas-streams-connections-create.txt +++ /dev/null @@ -1,118 +0,0 @@ -.. _atlas-streams-connections-create: - -================================ -atlas streams connections create -================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Creates a connection for an Atlas Stream Processing instance. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas streams connections create [connectionName] [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - connectionName - - string - - false - - Name of the connection - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -f, --file - - string - - true - - Path to a JSON configuration file that defines an Atlas Stream Processing connection. - * - -h, --help - - - - false - - help for create - * - -i, --instance - - string - - true - - Name of your Atlas Stream Processing instance. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Connection created. - - -Examples --------- - -.. code-block:: - :copyable: false - - # create a new connection for Atlas Stream Processing: - atlas streams connection create kafkaprod -i test01 -f kafkaConfig.json - - -.. code-block:: - :copyable: false - - # create a new connection using the name from a cluster configuration file - atlas streams connection create -i test01 -f clusterConfig.json - diff --git a/docs/command/atlas-streams-connections-delete.txt b/docs/command/atlas-streams-connections-delete.txt deleted file mode 100644 index 28a82a8881..0000000000 --- a/docs/command/atlas-streams-connections-delete.txt +++ /dev/null @@ -1,116 +0,0 @@ -.. _atlas-streams-connections-delete: - -================================ -atlas streams connections delete -================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Remove the specified Atlas Stream Processing connection from your project. - -The command prompts you to confirm the operation when you run the command without the --force option. - -Before deleting an Atlas Streams Processing connection, you must first stop all processes associated with it. To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas streams connections delete [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - connectionName - - string - - true - - Name of the connection - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --force - - - - false - - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. - * - -h, --help - - - - false - - help for delete - * - -i, --instance - - string - - true - - Name of your Atlas Stream Processing instance. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Atlas Stream Processing connection '' deleted - - -Examples --------- - -.. code-block:: - :copyable: false - - # deletes connection 'ExampleConnection' from instance 'ExampleInstance': - atlas streams connection delete ExampleConnection --instance ExampleInstance - - -.. code-block:: - :copyable: false - - # deletes connection 'ExampleConnection' from instance 'ExampleInstance' without requiring confirmation: - atlas streams connection delete ExampleConnection --instance ExampleInstance --force - diff --git a/docs/command/atlas-streams-connections-describe.txt b/docs/command/atlas-streams-connections-describe.txt deleted file mode 100644 index 9c0081ac67..0000000000 --- a/docs/command/atlas-streams-connections-describe.txt +++ /dev/null @@ -1,97 +0,0 @@ -.. _atlas-streams-connections-describe: - -================================== -atlas streams connections describe -================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return the details for the specified Atlas Stream Processing connection. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas streams connections describe [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - streamConnectionName - - string - - true - - Name of the Atlas Stream Processing connection. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for describe - * - -i, --instance - - string - - true - - Name of your Atlas Stream Processing instance. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - # retrieves stream connection 'ExampleConnection' in instance 'ExampleInstance': - atlas streams connection describe ExampleConnection --instance ExampleInstance - diff --git a/docs/command/atlas-streams-connections-list.txt b/docs/command/atlas-streams-connections-list.txt deleted file mode 100644 index 3acd0d2a5d..0000000000 --- a/docs/command/atlas-streams-connections-list.txt +++ /dev/null @@ -1,81 +0,0 @@ -.. _atlas-streams-connections-list: - -============================== -atlas streams connections list -============================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns all Atlas Stream Processing connections from your Atlas Stream Processing instance. - -To use this command, you must authenticate with a user account or an API key with the Project Read Only role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas streams connections list [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for list - * - -i, --instance - - string - - true - - Name of your Atlas Stream Processing instance. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - # list all connections within ExampleInstance: - atlas streams connection list --instance ExampleInstance - diff --git a/docs/command/atlas-streams-connections-update.txt b/docs/command/atlas-streams-connections-update.txt deleted file mode 100644 index 4de5931b15..0000000000 --- a/docs/command/atlas-streams-connections-update.txt +++ /dev/null @@ -1,111 +0,0 @@ -.. _atlas-streams-connections-update: - -================================ -atlas streams connections update -================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Modify the details of the specified connection within your Atlas Stream Processing instance. - -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas streams connections update [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - connectionName - - string - - true - - Name of the connection. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -f, --file - - string - - true - - Path to a JSON configuration file that defines an Atlas Stream Processing connection. - * - -h, --help - - - - false - - help for update - * - -i, --instance - - string - - true - - Name of your Atlas Stream Processing instance. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Connection updated. - - -Examples --------- - -.. code-block:: - :copyable: false - - # update an Atlas Stream Processing connection: - atlas streams connection update kafkaprod --instance test01 -f kafkaConfig.json - diff --git a/docs/command/atlas-streams-connections.txt b/docs/command/atlas-streams-connections.txt deleted file mode 100644 index 2c40745051..0000000000 --- a/docs/command/atlas-streams-connections.txt +++ /dev/null @@ -1,69 +0,0 @@ -.. _atlas-streams-connections: - -========================= -atlas streams connections -========================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage Atlas Stream Processing connections. - -Create, list, update and delete your Atlas Stream Processing connections - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for connections - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-streams-connections-create` - Creates a connection for an Atlas Stream Processing instance. -* :ref:`atlas-streams-connections-delete` - Remove the specified Atlas Stream Processing connection from your project. -* :ref:`atlas-streams-connections-describe` - Return the details for the specified Atlas Stream Processing connection. -* :ref:`atlas-streams-connections-list` - Returns all Atlas Stream Processing connections from your Atlas Stream Processing instance. -* :ref:`atlas-streams-connections-update` - Modify the details of the specified connection within your Atlas Stream Processing instance. - - -.. toctree:: - :titlesonly: - - create - delete - describe - list - update - diff --git a/docs/command/atlas-streams-instances-create.txt b/docs/command/atlas-streams-instances-create.txt deleted file mode 100644 index 391e3dc39c..0000000000 --- a/docs/command/atlas-streams-instances-create.txt +++ /dev/null @@ -1,114 +0,0 @@ -.. _atlas-streams-instances-create: - -============================== -atlas streams instances create -============================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create an Atlas Stream Processing instance for your project - -To get started quickly, specify a name, a cloud provider, and a region to configure an Atlas Stream Processing instance.To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas streams instances create [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - name - - string - - true - - Name of the Atlas Stream Processing instance. After creation, you can't change the name of the instance. The name can contain ASCII letters, numbers, and hyphens. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for create - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --provider - - string - - true - - Cloud service provider that applies to the provisioned Atlas Stream Processing instance. This value defaults to "AWS". - * - -r, --region - - string - - true - - Human-readable label that identifies the physical location of your Atlas Stream Processing instance. The region can affect network latency and performance if it is far from your source or sink. - * - --tier - - string - - false - - Tier for your Stream Instance. This value defaults to "SP30". - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Atlas Streams Processor Instance '' successfully created. - - -Examples --------- - -.. code-block:: - :copyable: false - - # Deploy an Atlas Stream Processing instance called myProcessor for the project with the ID 5e2211c17a3e5a48f5497de3: - atlas streams instance create myProcessor --projectId 5e2211c17a3e5a48f5497de3 --provider AWS --region VIRGINIA_USA --tier SP30 diff --git a/docs/command/atlas-streams-instances-delete.txt b/docs/command/atlas-streams-instances-delete.txt deleted file mode 100644 index f7e1a66ae8..0000000000 --- a/docs/command/atlas-streams-instances-delete.txt +++ /dev/null @@ -1,112 +0,0 @@ -.. _atlas-streams-instances-delete: - -============================== -atlas streams instances delete -============================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Delete an Atlas Stream Processing instance. - -The command prompts you to confirm the operation when you run the command without the --force option. - -Before deleting an Atlas Streams Processing instance, you must first stop all processes associated with it. -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas streams instances delete [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - name - - string - - true - - Name of the Atlas Streams instance. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --force - - - - false - - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. - * - -h, --help - - - - false - - help for delete - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Atlas Streams processor instance '' deleted - - -Examples --------- - -.. code-block:: - :copyable: false - - # Remove an Atlas Stream Processing instance after prompting for a confirmation: - atlas streams instance delete myProcessorInstance - - -.. code-block:: - :copyable: false - - # Remove an Atlas Stream Processing instance named myProcessorInstance without requiring confirmation: - atlas streams instance delete myProcessorInstance --force diff --git a/docs/command/atlas-streams-instances-describe.txt b/docs/command/atlas-streams-instances-describe.txt deleted file mode 100644 index e701019c47..0000000000 --- a/docs/command/atlas-streams-instances-describe.txt +++ /dev/null @@ -1,109 +0,0 @@ -.. _atlas-streams-instances-describe: - -================================ -atlas streams instances describe -================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Describe an Atlas Stream Processing instance for your project. - -To use this command, you must authenticate with a user account or an API key with the Project Read Only role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas streams instances describe [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - name - - string - - true - - Name of the Atlas Streams processor instance. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for describe - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - ID NAME CLOUD REGION - - - -Examples --------- - -.. code-block:: - :copyable: false - - # Return an Atlas Stream Processing instance with a specific name: - atlas streams instance describe myProcessor - -.. code-block:: - :copyable: false - - # Return a JSON-formatted Atlas Stream Processing instance with a specific name: - atlas streams instance describe myProcessor --output json diff --git a/docs/command/atlas-streams-instances-download.txt b/docs/command/atlas-streams-instances-download.txt deleted file mode 100644 index 8cee843c81..0000000000 --- a/docs/command/atlas-streams-instances-download.txt +++ /dev/null @@ -1,114 +0,0 @@ -.. _atlas-streams-instances-download: - -================================ -atlas streams instances download -================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Download a compressed file that contains the logs for the specified Atlas Stream Processing instance. - -This command downloads a file with a .gz extension. To use this command, you must authenticate with a user account or an API key with the Project Data Access Read/Write role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas streams instances download [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - tenantName - - string - - true - - Label that identifies the tenant that stores the log files that you want to download. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --end - - int - - false - - Ending date and time for the range of log messages to retrieve, given in UNIX time. Defaults to the start date plus 24 hours, if the start date is set. If start date is not provided, ending time defaults to the current time. - * - --force - - - - false - - Flag that indicates whether to overwrite the destination file. - * - -h, --help - - - - false - - help for download - * - --out - - string - - true - - Output file name. This value defaults to the log name. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --start - - int - - false - - UNIX Epoch-formatted starting date and time for the range of log messages to retrieve. This value defaults to 24 hours prior to the current timestamp. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Download of completed. - - -Examples --------- - -.. code-block:: - :copyable: false - - # Download the audit log file from the instance myProcessor for the project with the ID 5e2211c17a3e5a48f5497de3: - atlas streams instance download myProcessor --projectId 5e2211c17a3e5a48f5497de3 diff --git a/docs/command/atlas-streams-instances-list.txt b/docs/command/atlas-streams-instances-list.txt deleted file mode 100644 index 43620f92c8..0000000000 --- a/docs/command/atlas-streams-instances-list.txt +++ /dev/null @@ -1,95 +0,0 @@ -.. _atlas-streams-instances-list: - -============================ -atlas streams instances list -============================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -List all the Atlas Stream Processing instances for your project. - -To use this command, you must authenticate with a user account or an API key with the Project Read Only role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas streams instances list [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for list - * - --limit - - int - - false - - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --page - - int - - false - - Page number that specifies a page of results. This value defaults to 1. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - ID NAME CLOUD REGION - - - -Examples --------- - -.. code-block:: - :copyable: false - - # Return a JSON-formatted list of all Atlas Stream Processing instances for the project with ID 5e2211c17a3e5a48f5497de3: - atlas streams instance list --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-streams-instances-update.txt b/docs/command/atlas-streams-instances-update.txt deleted file mode 100644 index 43b2e3d521..0000000000 --- a/docs/command/atlas-streams-instances-update.txt +++ /dev/null @@ -1,111 +0,0 @@ -.. _atlas-streams-instances-update: - -============================== -atlas streams instances update -============================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Updates an Atlas Stream Processing instance for your project. - -Before updating an Atlas Streams Processing instance, you must first stop all processes associated with it. -To use this command, you must authenticate with a user account or an API key with the Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas streams instances update [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - name - - string - - true - - Name of the Atlas Stream Processing instance. After creation, you can't change the name of the instance. The name can contain ASCII letters, numbers, and hyphens. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for update - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --provider - - string - - true - - Cloud service provider that applies to the provisioned Atlas Stream Processing instance. This value defaults to "AWS". - * - -r, --region - - string - - true - - Human-readable label that identifies the physical location of your Atlas Stream Processing instance. The region can affect network latency and performance if it is far from your source or sink. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Atlas Streams Processor Instance '' successfully updated. - - -Examples --------- - -.. code-block:: - :copyable: false - - # Modify the Atlas Stream Processing instance configuration with the name MyInstance: - atlas streams instance update MyInstance --provider AWS --region VIRGINIA_USA diff --git a/docs/command/atlas-streams-instances.txt b/docs/command/atlas-streams-instances.txt deleted file mode 100644 index 88cb43a8a5..0000000000 --- a/docs/command/atlas-streams-instances.txt +++ /dev/null @@ -1,71 +0,0 @@ -.. _atlas-streams-instances: - -======================= -atlas streams instances -======================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage Atlas Stream Processing instances. - -Create, list, update and delete your Atlas Stream Processing instances. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for instances - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-streams-instances-create` - Create an Atlas Stream Processing instance for your project -* :ref:`atlas-streams-instances-delete` - Delete an Atlas Stream Processing instance. -* :ref:`atlas-streams-instances-describe` - Describe an Atlas Stream Processing instance for your project. -* :ref:`atlas-streams-instances-download` - Download a compressed file that contains the logs for the specified Atlas Stream Processing instance. -* :ref:`atlas-streams-instances-list` - List all the Atlas Stream Processing instances for your project. -* :ref:`atlas-streams-instances-update` - Updates an Atlas Stream Processing instance for your project. - - -.. toctree:: - :titlesonly: - - create - delete - describe - download - list - update - diff --git a/docs/command/atlas-streams.txt b/docs/command/atlas-streams.txt deleted file mode 100644 index 7c5ce40184..0000000000 --- a/docs/command/atlas-streams.txt +++ /dev/null @@ -1,63 +0,0 @@ -.. _atlas-streams: - -============= -atlas streams -============= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage your Atlas Stream Processing deployments. - -The streams command provides access to your Atlas Stream Processing configurations. You can create, edit, and delete streams, as well as change the connection registry. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for streams - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-streams-connections` - Manage Atlas Stream Processing connections. -* :ref:`atlas-streams-instances` - Manage Atlas Stream Processing instances. - - -.. toctree:: - :titlesonly: - - connections - instances - diff --git a/docs/command/atlas-teams-create.txt b/docs/command/atlas-teams-create.txt deleted file mode 100644 index 9bb807539e..0000000000 --- a/docs/command/atlas-teams-create.txt +++ /dev/null @@ -1,106 +0,0 @@ -.. _atlas-teams-create: - -================== -atlas teams create -================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create a team for your organization. - -To use this command, you must authenticate with a user account or an API key with the Organization Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas teams create [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - name - - string - - true - - Label that identifies the team. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for create - * - --orgId - - string - - false - - Organization ID to use. This option overrides the settings in the configuration file or environment variable. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --username - - strings - - true - - Comma-separated list that contains the valid usernames of the MongoDB users to add to the new team. A team must have at least one user. New users must accept the invitation to join an organization before you can add them to a team. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Team '' created. - - -Examples --------- - -.. code-block:: - :copyable: false - - # Create a team named myTeam in the organization with ID 5e2211c17a3e5a48f5497de3: - atlas teams create myTeam --username user1@example.com,user2@example.com --orgId 5e1234c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-teams-delete.txt b/docs/command/atlas-teams-delete.txt deleted file mode 100644 index 3be0a283e1..0000000000 --- a/docs/command/atlas-teams-delete.txt +++ /dev/null @@ -1,102 +0,0 @@ -.. _atlas-teams-delete: - -================== -atlas teams delete -================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Remove the specified team from your organization. - -To use this command, you must authenticate with a user account or an API key with the Organization User Admin role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas teams delete [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - teamId - - string - - true - - Unique 24-digit string that identifies the team. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --force - - - - false - - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. - * - -h, --help - - - - false - - help for delete - * - --orgId - - string - - false - - Organization ID to use. This option overrides the settings in the configuration file or environment variable. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Team '' deleted - - -Examples --------- - -.. code-block:: - :copyable: false - - # Remove the team with the ID 5e44445ef10fab20b49c0f31 from the organization with ID 5e2211c17a3e5a48f5497de3: - atlas teams delete 5e44445ef10fab20b49c0f31 --orgId 5e1234c17a3e5a48f5497de3 diff --git a/docs/command/atlas-teams-describe.txt b/docs/command/atlas-teams-describe.txt deleted file mode 100644 index a61464ad6d..0000000000 --- a/docs/command/atlas-teams-describe.txt +++ /dev/null @@ -1,104 +0,0 @@ -.. _atlas-teams-describe: - -==================== -atlas teams describe -==================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return the details for the specified team for your organization. - -You can return the details for a team using the team's ID or the team's name. You must specify either the id option or the name option. - -To use this command, you must authenticate with a user account or an API key with the Organization Member role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas teams describe [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for describe - * - --id - - string - - false - - Unique 24-digit string that identifies the team. - * - --name - - string - - false - - Label that identifies the team. - * - --orgId - - string - - false - - Organization ID to use. This option overrides the settings in the configuration file or environment variable. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - ID NAME - - - -Examples --------- - -.. code-block:: - :copyable: false - - # Return the JSON-formatted details for the the team with the ID 5e44445ef10fab20b49c0f31 in the organization with ID 5e2211c17a3e5a48f5497de3: - atlas teams describe --id 5e44445ef10fab20b49c0f31 --projectId 5e1234c17a3e5a48f5497de3 --output json - - -.. code-block:: - :copyable: false - - # Return the JSON-formatted details for the the team with the name myTeam in the organization with ID 5e2211c17a3e5a48f5497de3: - atlas teams describe --name myTeam --projectId 5e1234c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-teams-list.txt b/docs/command/atlas-teams-list.txt deleted file mode 100644 index f454ff6762..0000000000 --- a/docs/command/atlas-teams-list.txt +++ /dev/null @@ -1,92 +0,0 @@ -.. _atlas-teams-list: - -================ -atlas teams list -================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return all teams for your organization. - -To use this command, you must authenticate with a user account or an API key with the Organization Member role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas teams list [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -c, --compact - - - - false - - Flag that enables the compact array response structure for a json output. The --compact option returns array objects as top-level responses and allows backward compatibility for scripts based on previous CLI versions. Omitting the --compact option for a json output returns array objects within a 'results' sub-array. You must specify --output json to use this option. - * - -h, --help - - - - false - - help for list - * - --limit - - int - - false - - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. - * - --omitCount - - - - false - - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. - * - --orgId - - string - - false - - Organization ID to use. This option overrides the settings in the configuration file or environment variable. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --page - - int - - false - - Page number that specifies a page of results. This value defaults to 1. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - # Return a JSON-formatted list of the teams for the organization with ID 5e2211c17a3e5a48f5497de3: - atlas teams list --orgId 5e1234c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-teams-rename.txt b/docs/command/atlas-teams-rename.txt deleted file mode 100644 index 867a75b2f8..0000000000 --- a/docs/command/atlas-teams-rename.txt +++ /dev/null @@ -1,106 +0,0 @@ -.. _atlas-teams-rename: - -================== -atlas teams rename -================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Rename a team in your organization. - -To use this command, you must authenticate with a user account or an API key with the Organization Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas teams rename [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - newName - - string - - true - - New label that identifies the team. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for rename - * - --orgId - - string - - false - - Organization ID to use. This option overrides the settings in the configuration file or environment variable. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --teamId - - string - - true - - Unique 24-digit string that identifies the team. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Team '' updated. - - -Examples --------- - -.. code-block:: - :copyable: false - - # Rename a team in the organization with ID 5e2211c17a3e5a48f5497de3: - atlas teams rename newName --teamId 5e1234c17a3e5a48f5497de3 --orgId 5e1234c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-teams-users-add.txt b/docs/command/atlas-teams-users-add.txt deleted file mode 100644 index eeb6319874..0000000000 --- a/docs/command/atlas-teams-users-add.txt +++ /dev/null @@ -1,108 +0,0 @@ -.. _atlas-teams-users-add: - -===================== -atlas teams users add -===================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Add the specified MongoDB user to a team for your organization. - -You can add users that are part of the organization or users that have been sent an invitation to join the organization. - -To use this command, you must authenticate with a user account or an API key with the Organization User Admin role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas teams users add ... [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - userId - - string - - true - - Unique 24-digit string that identifies the user. You can add more than one user at a time by specifying multiple user IDs separated by a space. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for add - * - --orgId - - string - - false - - Organization ID to use. This option overrides the settings in the configuration file or environment variable. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --teamId - - string - - true - - Unique 24-digit string that identifies the team. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - User(s) added to the team. - - -Examples --------- - -.. code-block:: - :copyable: false - - # Add the users with the IDs 5dd58c647a3e5a6c5bce46c7 and 5dd56c847a3e5a1f363d424d to the team with the ID 5f6a5c6c713184005d72fe6e for the organization with ID 5e2211c17a3e5a48f5497de3: - atlas teams users add 5dd58c647a3e5a6c5bce46c7 5dd56c847a3e5a1f363d424d --teamId 5f6a5c6c713184005d72fe6e --orgId 5e1234c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-teams-users-delete.txt b/docs/command/atlas-teams-users-delete.txt deleted file mode 100644 index 4cd64e07bd..0000000000 --- a/docs/command/atlas-teams-users-delete.txt +++ /dev/null @@ -1,106 +0,0 @@ -.. _atlas-teams-users-delete: - -======================== -atlas teams users delete -======================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Remove the specified user from a team for your organization. - -To use this command, you must authenticate with a user account or an API key with the Organization User Admin role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas teams users delete [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - userId - - string - - true - - Unique 24-digit string that identifies the user. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --force - - - - false - - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. - * - -h, --help - - - - false - - help for delete - * - --orgId - - string - - false - - Organization ID to use. This option overrides the settings in the configuration file or environment variable. - * - --teamId - - string - - true - - Unique 24-digit string that identifies the team. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - User '' deleted from the team - - -Examples --------- - -.. code-block:: - :copyable: false - - # Remove the user with the ID 5dd58c647a3e5a6c5bce46c7 from the team with the ID 5f6a5c6c713184005d72fe6e for the organization with ID 5e2211c17a3e5a48f5497de3: - atlas teams users delete 5dd58c647a3e5a6c5bce46c7 --teamId 5f6a5c6c713184005d72fe6e --orgId 5e1234c17a3e5a48f5497de3 diff --git a/docs/command/atlas-teams-users-list.txt b/docs/command/atlas-teams-users-list.txt deleted file mode 100644 index ae494e0213..0000000000 --- a/docs/command/atlas-teams-users-list.txt +++ /dev/null @@ -1,84 +0,0 @@ -.. _atlas-teams-users-list: - -====================== -atlas teams users list -====================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return all users for a team. - -To use this command, you must authenticate with a user account or an API key with the Organization Member role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas teams users list [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -c, --compact - - - - false - - Flag that enables the compact array response structure for a json output. The --compact option returns array objects as top-level responses and allows backward compatibility for scripts based on previous CLI versions. Omitting the --compact option for a json output returns array objects within a 'results' sub-array. You must specify --output json to use this option. - * - -h, --help - - - - false - - help for list - * - --orgId - - string - - false - - Organization ID to use. This option overrides the settings in the configuration file or environment variable. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --teamId - - string - - true - - Unique 24-digit string that identifies the team. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - # Return a JSON-formatted list of the users for the team with the ID 5f6a5c6c713184005d72fe6e in the organization with ID 5e2211c17a3e5a48f5497de3: - atlas teams users list --teamId 5f6a5c6c713184005d72fe6e --orgId 5e1234c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-teams-users.txt b/docs/command/atlas-teams-users.txt deleted file mode 100644 index d8724b0790..0000000000 --- a/docs/command/atlas-teams-users.txt +++ /dev/null @@ -1,65 +0,0 @@ -.. _atlas-teams-users: - -================= -atlas teams users -================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage your Atlas users. - -Create, list and manage your users. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for users - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-teams-users-add` - Add the specified MongoDB user to a team for your organization. -* :ref:`atlas-teams-users-delete` - Remove the specified user from a team for your organization. -* :ref:`atlas-teams-users-list` - Return all users for a team. - - -.. toctree:: - :titlesonly: - - add - delete - list - diff --git a/docs/command/atlas-teams.txt b/docs/command/atlas-teams.txt deleted file mode 100644 index a32ada2f2b..0000000000 --- a/docs/command/atlas-teams.txt +++ /dev/null @@ -1,71 +0,0 @@ -.. _atlas-teams: - -=========== -atlas teams -=========== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage your Atlas teams. - -Create, list and manage your Atlas teams. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for teams - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-teams-create` - Create a team for your organization. -* :ref:`atlas-teams-delete` - Remove the specified team from your organization. -* :ref:`atlas-teams-describe` - Return the details for the specified team for your organization. -* :ref:`atlas-teams-list` - Return all teams for your organization. -* :ref:`atlas-teams-rename` - Rename a team in your organization. -* :ref:`atlas-teams-users` - Manage your Atlas users. - - -.. toctree:: - :titlesonly: - - create - delete - describe - list - rename - users - diff --git a/docs/command/atlas-users-describe.txt b/docs/command/atlas-users-describe.txt deleted file mode 100644 index 4ec47d18a5..0000000000 --- a/docs/command/atlas-users-describe.txt +++ /dev/null @@ -1,104 +0,0 @@ -.. _atlas-users-describe: - -==================== -atlas users describe -==================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return the details for the specified Atlas user. - -You can specify either the unique 24-digit ID that identifies the Atlas user or the username for the Atlas user. - -User accounts and API keys with any role can run this command. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas users describe [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for describe - * - --id - - string - - false - - Unique 24-digit identifier of the user. - - Mutually exclusive with --username. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --username - - string - - false - - Name that identifies the user. You must specify a valid email address. - - Mutually exclusive with --id. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - ID FIRST NAME LAST NAME USERNAME EMAIL - - - -Examples --------- - -.. code-block:: - :copyable: false - - # Return the JSON-formatted details for the Atlas user with the ID 5dd56c847a3e5a1f363d424d: - atlas users describe --id 5dd56c847a3e5a1f363d424d --output json - - -.. code-block:: - :copyable: false - - # Return the JSON-formatted details for the Atlas user with the username myUser: - atlas users describe --username myUser --output json diff --git a/docs/command/atlas-users-invite.txt b/docs/command/atlas-users-invite.txt deleted file mode 100644 index 7b5ebd3250..0000000000 --- a/docs/command/atlas-users-invite.txt +++ /dev/null @@ -1,126 +0,0 @@ -.. _atlas-users-invite: - -================== -atlas users invite -================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create an Atlas user for your MongoDB Atlas application and invite the Atlas user to your organizations and projects. - -An Atlas user account grants access only to the the MongoDB Atlas application. To grant database access, create a database user with atlas dbusers create. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas users invite [options] - -.. Code end marker, please don't delete this comment - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --country - - string - - true - - ISO 3166-1 alpha two-letter country code of the user's geographic location. The Atlas CLI requires this option. - * - --email - - string - - true - - Email address for the user. - * - --firstName - - string - - true - - First or given name for the user. - * - -h, --help - - - - false - - help for invite - * - --lastName - - string - - true - - Last name, family name, or surname for the user. - * - --mobile - - string - - false - - Mobile phone number for the user. - * - --orgRole - - strings - - false - - Unique 24-digit string that identifies the organization, colon, and the user's role for the organization. Specify this value as orgID:ROLE. Valid values for ROLE include ORG_OWNER, ORG_MEMBER, ORG_GROUP_CREATOR, ORG_BILLING_ADMIN, and ORG_READ_ONLY. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --password - - string - - false - - Password for the user. - * - --projectRole - - strings - - false - - Unique 24-digit string that identifies the project, colon, and the user's role for the project. Specify this value as projectID:ROLE. Valid values for ROLE include GROUP_CLUSTER_MANAGER, GROUP_DATA_ACCESS_ADMIN, GROUP_DATA_ACCESS_READ_ONLY, GROUP_DATA_ACCESS_READ_WRITE, GROUP_OWNER, and GROUP_READ_ONLY. - * - --username - - string - - true - - Name that identifies the user. You must specify a valid email address. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - The user '' has been invited. - Invited users do not have access to the project until they accept the invitation. - - -Examples --------- - -.. code-block:: - :copyable: false - - # Create the Atlas user with the username user@example.com and invite them to the organization with the ID 5dd56c847a3e5a1f363d424d with ORG_OWNER access: - atlas users invite --email user@example.com --username user@example.com --orgRole 5dd56c847a3e5a1f363d424d:ORG_OWNER --firstName Example --lastName User --country US --output json - - -.. code-block:: - :copyable: false - - # Create the Atlas user with the username user@example.com and invite them to the project with the ID 5f71e5255afec75a3d0f96dc with GROUP_READ_ONLY access: - atlas users invite --email user@example.com --username user@example.com --projectRole 5f71e5255afec75a3d0f96dc:GROUP_READ_ONLY --firstName Example --lastName User --country US --output json diff --git a/docs/command/atlas-users.txt b/docs/command/atlas-users.txt deleted file mode 100644 index 7507d266ab..0000000000 --- a/docs/command/atlas-users.txt +++ /dev/null @@ -1,63 +0,0 @@ -.. _atlas-users: - -=========== -atlas users -=========== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage your Atlas users. - -Create and manage your Atlas users. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for users - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Related Commands ----------------- - -* :ref:`atlas-users-describe` - Return the details for the specified Atlas user. -* :ref:`atlas-users-invite` - Create an Atlas user for your MongoDB Atlas application and invite the Atlas user to your organizations and projects. - - -.. toctree:: - :titlesonly: - - describe - invite - diff --git a/docs/command/atlas.txt b/docs/command/atlas.txt deleted file mode 100644 index 5264149bd6..0000000000 --- a/docs/command/atlas.txt +++ /dev/null @@ -1,130 +0,0 @@ -.. _atlas: - -===== -atlas -===== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -CLI tool to manage MongoDB Atlas. - -The Atlas CLI is a command line interface built specifically for MongoDB Atlas. You can manage your Atlas database deployments and Atlas Search from the terminal with short, intuitive commands. - -Use the --help flag with any command for more info on that command. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for atlas - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. - -Examples --------- - -.. code-block:: - :copyable: false - - # Display the help menu for the config command: - atlas config --help - -Related Commands ----------------- - -* :ref:`atlas-accessLists` - Manage the list of IP addresses that can access your Atlas project. -* :ref:`atlas-accessLogs` - Return the access logs for a cluster. -* :ref:`atlas-alerts` - Manage alerts for your project. -* :ref:`atlas-auditing` - Returns database auditing settings for MongoDB Cloud projects. -* :ref:`atlas-auth` - Manage the CLI's authentication state. -* :ref:`atlas-backups` - Manage cloud backups for your project. -* :ref:`atlas-cloudProviders` - Manage cloud provider access in Atlas using AWS IAM roles. -* :ref:`atlas-clusters` - Manage clusters for your project. -* :ref:`atlas-completion` - Generate the autocompletion script for the specified shell -* :ref:`atlas-config` - Configure and manage your user profiles. -* :ref:`atlas-customDbRoles` - Manage custom database roles for your project. -* :ref:`atlas-customDns` - Manage DNS configuration of Atlas project’s clusters deployed to AWS. -* :ref:`atlas-dataFederation` - Data federation. -* :ref:`atlas-dbusers` - Manage database users for your project. -* :ref:`atlas-deployments` - Manage cloud and local deployments. -* :ref:`atlas-events` - Manage events for your organization or project. -* :ref:`atlas-federatedAuthentication` - Manage Atlas Federated Authentication. -* :ref:`atlas-integrations` - Configure third-party integrations for your Atlas project. -* :ref:`atlas-kubernetes` - Manage Kubernetes resources. -* :ref:`atlas-liveMigrations` - Manage a Live Migration to Atlas for your organization. -* :ref:`atlas-logs` - Download host logs for your project. -* :ref:`atlas-maintenanceWindows` - Manage Atlas maintenance windows. -* :ref:`atlas-metrics` - Get metrics on the MongoDB process. -* :ref:`atlas-networking` - Manage or configure network peering for your Atlas project. -* :ref:`atlas-organizations` - Manage your Atlas organizations. -* :ref:`atlas-performanceAdvisor` - Learn more about slow queries and get suggestions to improve database performance. -* :ref:`atlas-plugin` - Manage plugins for the AtlasCLI. -* :ref:`atlas-privateEndpoints` - Manage Atlas private endpoints. -* :ref:`atlas-processes` - Manage MongoDB processes for your project. -* :ref:`atlas-projects` - Manage your Atlas projects. -* :ref:`atlas-security` - Manage security configuration for your project. -* :ref:`atlas-serverless` - Manage serverless instances for your project. -* :ref:`atlas-setup` - Register, authenticate, create, and access an Atlas cluster. -* :ref:`atlas-streams` - Manage your Atlas Stream Processing deployments. -* :ref:`atlas-teams` - Manage your Atlas teams. -* :ref:`atlas-users` - Manage your Atlas users. - - -.. toctree:: - :titlesonly: - - accessLists - accessLogs - alerts - auditing - auth - backups - cloudProviders - clusters - completion - config - customDbRoles - customDns - dataFederation - dbusers - deployments - events - federatedAuthentication - integrations - kubernetes - liveMigrations - logs - maintenanceWindows - metrics - networking - organizations - performanceAdvisor - plugin - privateEndpoints - processes - projects - security - serverless - setup - streams - teams - users - diff --git a/internal/cli/backup/snapshots/download.go b/internal/cli/backup/snapshots/download.go new file mode 100644 index 0000000000..32e4b5db72 --- /dev/null +++ b/internal/cli/backup/snapshots/download.go @@ -0,0 +1,157 @@ +// Copyright 2024 MongoDB Inc +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package snapshots + +import ( + "context" + "errors" + "fmt" + "io" + "net/http" + "strings" + + "github.com/mongodb/mongodb-atlas-cli/atlascli/internal/cli" + "github.com/mongodb/mongodb-atlas-cli/atlascli/internal/cli/require" + "github.com/mongodb/mongodb-atlas-cli/atlascli/internal/config" + "github.com/mongodb/mongodb-atlas-cli/atlascli/internal/flag" + "github.com/mongodb/mongodb-atlas-cli/atlascli/internal/store" + "github.com/mongodb/mongodb-atlas-cli/atlascli/internal/usage" + "github.com/spf13/afero" + "github.com/spf13/cobra" + atlasv2 "go.mongodb.org/atlas-sdk/v20241113002/admin" +) + +type DownloadOpts struct { + cli.ProjectOpts + cli.DownloaderOpts + cli.OutputOpts + store store.SnapshotsDownloader + clusterName string + id string +} + +func (opts *DownloadOpts) initStore(ctx context.Context) func() error { + return func() error { + var err error + opts.store, err = store.New(store.AuthenticatedPreset(config.Default()), store.WithContext(ctx)) + return err + } +} + +var downloadTemplate = "Snapshot '%s' downloaded.\n" +var errEmptyURL = errors.New("'snapshotUrl' is empty") +var errExtNotSupported = errors.New("only the '.tgz' extension is supported") + +func (opts *DownloadOpts) Run() error { + r, err := opts.store.DownloadFlexClusterSnapshot(opts.ConfigProjectID(), opts.clusterName, opts.newFlexBackupSnapshotDownloadCreate()) + if err != nil { + return err + } + + return opts.Download(r.SnapshotUrl) +} + +func (opts *DownloadOpts) newFlexBackupSnapshotDownloadCreate() *atlasv2.FlexBackupSnapshotDownloadCreate20241113 { + return &atlasv2.FlexBackupSnapshotDownloadCreate20241113{ + SnapshotId: opts.id, + } +} + +func (opts *DownloadOpts) Download(url *string) error { + if url == nil { + return errEmptyURL + } + + w, err := opts.NewWriteCloser() + if err != nil { + return err + } + defer w.Close() + + req, err := http.NewRequestWithContext(context.Background(), http.MethodGet, *url, nil) + if err != nil { + return err + } + + resp, err := http.DefaultClient.Do(req) + if err != nil { + return err + } + + defer resp.Body.Close() + if err != nil { + _ = opts.OnError(w) + return err + } + + if _, err := io.Copy(w, resp.Body); err != nil { + _ = opts.OnError(w) + return err + } + + fmt.Printf(downloadTemplate, opts.Out) + return nil +} + +func (opts *DownloadOpts) initDefaultOut() error { + if opts.Out == "" { + opts.Out = opts.id + ".tgz" + } else if strings.Contains(opts.Out, ".tgz") { + return errExtNotSupported + } + + return nil +} + +// DownloadBuilder builds a cobra.Command that can run as: +// atlas backup snapshots download snapshotId --clusterName string [--projectId string] [--out string]. +func DownloadBuilder() *cobra.Command { + opts := &DownloadOpts{} + opts.Fs = afero.NewOsFs() + cmd := &cobra.Command{ + Use: "download ", + Short: "Download one snapshot for the specified flex cluster.", + Long: `You can download a snapshot for an Atlas Flex cluster. +` + fmt.Sprintf("%s\n%s", fmt.Sprintf(usage.RequiredRole, "Project Owner"), "Atlas supports this command only for Flex clusters."), + Args: require.ExactArgs(1), + Annotations: map[string]string{ + "snapshotId": "Unique 24-hexadecimal digit string that identifies the snapshot to download.", + "output": downloadTemplate, + }, + PreRunE: func(cmd *cobra.Command, _ []string) error { + return opts.PreRunE( + opts.ValidateProjectID, + opts.initStore(cmd.Context()), + opts.InitOutput(cmd.OutOrStdout(), createTemplate), + ) + }, + RunE: func(_ *cobra.Command, args []string) error { + opts.id = args[0] + if err := opts.initDefaultOut(); err != nil { + return err + } + return opts.Run() + }, + } + cmd.Flags().StringVar(&opts.clusterName, flag.ClusterName, "", usage.ClusterName) + cmd.Flags().StringVar(&opts.Out, flag.Out, "", usage.SnapshotOut) + + opts.AddProjectOptsFlags(cmd) + opts.AddOutputOptFlags(cmd) + + _ = cmd.MarkFlagRequired(flag.ClusterName) + + return cmd +} diff --git a/internal/cli/backup/snapshots/download_test.go b/internal/cli/backup/snapshots/download_test.go new file mode 100644 index 0000000000..b412a4de27 --- /dev/null +++ b/internal/cli/backup/snapshots/download_test.go @@ -0,0 +1,51 @@ +// Copyright 2024 MongoDB Inc +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package snapshots + +import ( + "testing" + + "github.com/golang/mock/gomock" + "github.com/mongodb/mongodb-atlas-cli/atlascli/internal/mocks" + "github.com/mongodb/mongodb-atlas-cli/atlascli/internal/pointer" + "github.com/spf13/afero" + "github.com/stretchr/testify/require" + atlasv2 "go.mongodb.org/atlas-sdk/v20241113002/admin" +) + +func TestSnapshotDownloadOpts_Run(t *testing.T) { + ctrl := gomock.NewController(t) + mockStore := mocks.NewMockSnapshotsDownloader(ctrl) + + opts := &DownloadOpts{ + id: "test.tgz", + store: mockStore, + clusterName: "test", + } + opts.Out = opts.id + opts.Fs = afero.NewMemMapFs() + + expected := &atlasv2.FlexBackupRestoreJob20241113{ + SnapshotUrl: pointer.Get("test.tgz"), + } + + mockStore. + EXPECT(). + DownloadFlexClusterSnapshot(opts.ConfigProjectID(), opts.clusterName, opts.newFlexBackupSnapshotDownloadCreate()). + Return(expected, nil). + Times(1) + + require.Error(t, opts.Run(), errEmptyURL.Error()) +} diff --git a/internal/cli/backup/snapshots/snapshots.go b/internal/cli/backup/snapshots/snapshots.go index 0883679890..b426daa98c 100644 --- a/internal/cli/backup/snapshots/snapshots.go +++ b/internal/cli/backup/snapshots/snapshots.go @@ -37,6 +37,7 @@ func Builder() *cobra.Command { DescribeBuilder(), WatchBuilder(), DeleteBuilder(), + DownloadBuilder(), ) return cmd diff --git a/internal/store/cloud_provider_backup.go b/internal/store/cloud_provider_backup.go index ad4bce0f30..ee5153e587 100644 --- a/internal/store/cloud_provider_backup.go +++ b/internal/store/cloud_provider_backup.go @@ -177,8 +177,7 @@ func (s *Store) FlexClusterSnapshots(opts *atlasv2.ListFlexBackupsApiParams) (*a return result, err } -// DownloadFlexClusterSnapshots encapsulates the logic to manage different cloud providers. -func (s *Store) DownloadFlexClusterSnapshots(groupID, name string, flexBackupSnapshotDownloadCreate20241113 *atlasv2.FlexBackupSnapshotDownloadCreate20241113) (*atlasv2.FlexBackupRestoreJob20241113, error) { +func (s *Store) DownloadFlexClusterSnapshot(groupID, name string, flexBackupSnapshotDownloadCreate20241113 *atlasv2.FlexBackupSnapshotDownloadCreate20241113) (*atlasv2.FlexBackupRestoreJob20241113, error) { if s.service == config.CloudGovService { return nil, fmt.Errorf("%w: %s", errUnsupportedService, s.service) } diff --git a/internal/usage/usage.go b/internal/usage/usage.go index aff5fd4934..c2fce4b754 100644 --- a/internal/usage/usage.go +++ b/internal/usage/usage.go @@ -92,6 +92,7 @@ dbName and collection are required only for built-in roles.` ForceFile = "Flag that indicates whether to overwrite the destination file." Email = "Email address for the user." LogOut = "Output file name. This value defaults to the log name." + SnapshotOut = "Output file name. This value defaults to the Snapshot id." LogStart = "UNIX Epoch-formatted starting date and time for the range of log messages to retrieve. This value defaults to 24 hours prior to the current timestamp." LogEnd = "Ending date and time for the range of log messages to retrieve, given in UNIX time. Defaults to the start date plus 24 hours, if the start date is set. If start date is not provided, ending time defaults to the current time." MeasurementStart = "ISO 8601-formatted date and time that specifies when to start retrieving measurements. You can't set this parameter and period in the same request." From 3f5f0caec00d75600836bb9dc850d3bea9c3da32 Mon Sep 17 00:00:00 2001 From: andreaangiolillo Date: Thu, 19 Dec 2024 11:09:09 +0000 Subject: [PATCH 2/3] fix --- .../atlas-backups-snapshots-download.txt | 104 ++++++++ docs/command/atlas-backups-snapshots-list.txt | 115 +++++++++ .../command/atlas-backups-snapshots-watch.txt | 108 +++++++++ docs/command/atlas-backups-snapshots.txt | 69 ++++++ docs/command/atlas-backups.txt | 67 ++++++ ...oudProviders-accessRoles-aws-authorize.txt | 96 ++++++++ ...-cloudProviders-accessRoles-aws-create.txt | 80 +++++++ ...dProviders-accessRoles-aws-deauthorize.txt | 94 ++++++++ .../atlas-cloudProviders-accessRoles-aws.txt | 63 +++++ .../atlas-cloudProviders-accessRoles-list.txt | 68 ++++++ .../atlas-cloudProviders-accessRoles.txt | 61 +++++ docs/command/atlas-cloudProviders.txt | 59 +++++ ...las-clusters-advancedSettings-describe.txt | 91 +++++++ ...atlas-clusters-advancedSettings-update.txt | 175 ++++++++++++++ .../atlas-clusters-advancedSettings.txt | 61 +++++ .../atlas-clusters-availableRegions-list.txt | 89 +++++++ .../atlas-clusters-availableRegions.txt | 59 +++++ ...as-clusters-connectionStrings-describe.txt | 96 ++++++++ .../atlas-clusters-connectionStrings.txt | 59 +++++ docs/command/atlas-clusters-create.txt | 222 ++++++++++++++++++ docs/command/atlas-clusters-delete.txt | 120 ++++++++++ docs/command/atlas-clusters-describe.txt | 103 ++++++++ docs/command/atlas-clusters-failover.txt | 102 ++++++++ .../command/atlas-clusters-indexes-create.txt | 135 +++++++++++ docs/command/atlas-clusters-indexes.txt | 59 +++++ docs/command/atlas-clusters-list.txt | 103 ++++++++ .../atlas-clusters-onlineArchives-create.txt | 139 +++++++++++ .../atlas-clusters-onlineArchives-delete.txt | 106 +++++++++ ...atlas-clusters-onlineArchives-describe.txt | 107 +++++++++ .../atlas-clusters-onlineArchives-list.txt | 103 ++++++++ .../atlas-clusters-onlineArchives-pause.txt | 106 +++++++++ .../atlas-clusters-onlineArchives-start.txt | 98 ++++++++ .../atlas-clusters-onlineArchives-update.txt | 124 ++++++++++ .../atlas-clusters-onlineArchives-watch.txt | 107 +++++++++ .../command/atlas-clusters-onlineArchives.txt | 73 ++++++ docs/command/atlas-clusters-pause.txt | 103 ++++++++ .../atlas-clusters-sampleData-describe.txt | 103 ++++++++ .../atlas-clusters-sampleData-load.txt | 102 ++++++++ .../atlas-clusters-sampleData-watch.txt | 103 ++++++++ docs/command/atlas-clusters-sampleData.txt | 65 +++++ .../atlas-clusters-search-indexes-create.txt | 110 +++++++++ .../atlas-clusters-search-indexes-delete.txt | 106 +++++++++ ...atlas-clusters-search-indexes-describe.txt | 107 +++++++++ .../atlas-clusters-search-indexes-list.txt | 99 ++++++++ .../atlas-clusters-search-indexes-update.txt | 110 +++++++++ .../command/atlas-clusters-search-indexes.txt | 67 ++++++ .../atlas-clusters-search-nodes-create.txt | 102 ++++++++ .../atlas-clusters-search-nodes-delete.txt | 92 ++++++++ .../atlas-clusters-search-nodes-list.txt | 91 +++++++ .../atlas-clusters-search-nodes-update.txt | 102 ++++++++ docs/command/atlas-clusters-search-nodes.txt | 65 +++++ docs/command/atlas-clusters-search.txt | 61 +++++ docs/command/atlas-clusters-start.txt | 103 ++++++++ docs/command/atlas-clusters-update.txt | 184 +++++++++++++++ docs/command/atlas-clusters-upgrade.txt | 146 ++++++++++++ docs/command/atlas-clusters-watch.txt | 104 ++++++++ docs/command/atlas-clusters.txt | 93 ++++++++ docs/command/atlas-completion-bash.txt | 76 ++++++ docs/command/atlas-completion-fish.txt | 75 ++++++ docs/command/atlas-completion-powershell.txt | 72 ++++++ docs/command/atlas-completion-zsh.txt | 86 +++++++ docs/command/atlas-completion.txt | 69 ++++++ docs/command/atlas-config-delete.txt | 103 ++++++++ docs/command/atlas-config-describe.txt | 78 ++++++ docs/command/atlas-config-edit.txt | 74 ++++++ docs/command/atlas-config-init.txt | 77 ++++++ docs/command/atlas-config-list.txt | 71 ++++++ docs/command/atlas-config-rename.txt | 86 +++++++ docs/command/atlas-config-set.txt | 87 +++++++ docs/command/atlas-config.txt | 78 ++++++ docs/command/atlas-customDbRoles-create.txt | 131 +++++++++++ docs/command/atlas-customDbRoles-delete.txt | 94 ++++++++ docs/command/atlas-customDbRoles-describe.txt | 84 +++++++ docs/command/atlas-customDbRoles-list.txt | 68 ++++++ docs/command/atlas-customDbRoles-update.txt | 106 +++++++++ docs/command/atlas-customDbRoles.txt | 67 ++++++ docs/command/atlas-customDns-aws-describe.txt | 87 +++++++ docs/command/atlas-customDns-aws-disable.txt | 86 +++++++ docs/command/atlas-customDns-aws-enable.txt | 86 +++++++ docs/command/atlas-customDns-aws.txt | 63 +++++ docs/command/atlas-customDns.txt | 59 +++++ docs/command/atlas-dataFederation-create.txt | 126 ++++++++++ docs/command/atlas-dataFederation-delete.txt | 103 ++++++++ .../command/atlas-dataFederation-describe.txt | 93 ++++++++ docs/command/atlas-dataFederation-list.txt | 81 +++++++ docs/command/atlas-dataFederation-logs.txt | 105 +++++++++ ...dataFederation-privateEndpoints-create.txt | 106 +++++++++ ...dataFederation-privateEndpoints-delete.txt | 103 ++++++++ ...taFederation-privateEndpoints-describe.txt | 93 ++++++++ ...s-dataFederation-privateEndpoints-list.txt | 77 ++++++ .../atlas-dataFederation-privateEndpoints.txt | 65 +++++ ...tlas-dataFederation-queryLimits-create.txt | 114 +++++++++ ...tlas-dataFederation-queryLimits-delete.txt | 107 +++++++++ ...as-dataFederation-queryLimits-describe.txt | 97 ++++++++ .../atlas-dataFederation-queryLimits-list.txt | 81 +++++++ .../atlas-dataFederation-queryLimits.txt | 65 +++++ docs/command/atlas-dataFederation-update.txt | 126 ++++++++++ docs/command/atlas-dataFederation.txt | 73 ++++++ docs/command/atlas-dbusers-certs-create.txt | 94 ++++++++ docs/command/atlas-dbusers-certs-list.txt | 94 ++++++++ docs/command/atlas-dbusers-certs.txt | 61 +++++ docs/command/atlas-dbusers-create.txt | 178 ++++++++++++++ docs/command/atlas-dbusers-delete.txt | 120 ++++++++++ docs/command/atlas-dbusers-describe.txt | 121 ++++++++++ docs/command/atlas-dbusers-list.txt | 92 ++++++++ docs/command/atlas-dbusers-update.txt | 137 +++++++++++ docs/command/atlas-dbusers.txt | 73 ++++++ docs/command/atlas-deployments-connect.txt | 98 ++++++++ docs/command/atlas-deployments-delete.txt | 133 +++++++++++ docs/command/atlas-deployments-list.txt | 73 ++++++ docs/command/atlas-deployments-logs.txt | 94 ++++++++ docs/command/atlas-deployments-pause.txt | 92 ++++++++ ...tlas-deployments-search-indexes-create.txt | 120 ++++++++++ ...tlas-deployments-search-indexes-delete.txt | 111 +++++++++ ...as-deployments-search-indexes-describe.txt | 109 +++++++++ .../atlas-deployments-search-indexes-list.txt | 101 ++++++++ .../atlas-deployments-search-indexes.txt | 65 +++++ docs/command/atlas-deployments-search.txt | 59 +++++ docs/command/atlas-deployments-setup.txt | 154 ++++++++++++ docs/command/atlas-deployments-start.txt | 95 ++++++++ docs/command/atlas-deployments.txt | 73 ++++++ .../atlas-events-organizations-list.txt | 105 +++++++++ docs/command/atlas-events-organizations.txt | 61 +++++ docs/command/atlas-events-projects-list.txt | 105 +++++++++ docs/command/atlas-events-projects.txt | 61 +++++ docs/command/atlas-events.txt | 61 +++++ ...onSettings-connectedOrgConfigs-connect.txt | 93 ++++++++ ...ionSettings-connectedOrgConfigs-delete.txt | 89 +++++++ ...nSettings-connectedOrgConfigs-describe.txt | 85 +++++++ ...ettings-connectedOrgConfigs-disconnect.txt | 102 ++++++++ ...ationSettings-connectedOrgConfigs-list.txt | 87 +++++++ ...ionSettings-connectedOrgConfigs-update.txt | 83 +++++++ ...federationSettings-connectedOrgConfigs.txt | 69 ++++++ ...entication-federationSettings-describe.txt | 87 +++++++ ...nSettings-identityProvider-create-oidc.txt | 141 +++++++++++ ...rationSettings-identityProvider-create.txt | 59 +++++ ...rationSettings-identityProvider-delete.txt | 107 +++++++++ ...tionSettings-identityProvider-describe.txt | 104 ++++++++ ...derationSettings-identityProvider-list.txt | 104 ++++++++ ...ionSettings-identityProvider-revokeJwk.txt | 93 ++++++++ ...nSettings-identityProvider-update-oidc.txt | 141 +++++++++++ ...rationSettings-identityProvider-update.txt | 59 +++++ ...on-federationSettings-identityProvider.txt | 69 ++++++ ...ratedAuthentication-federationSettings.txt | 63 +++++ .../command/atlas-federatedAuthentication.txt | 59 +++++ .../atlas-integrations-create-DATADOG.txt | 100 ++++++++ .../atlas-integrations-create-OPS_GENIE.txt | 96 ++++++++ .../atlas-integrations-create-PAGER_DUTY.txt | 92 ++++++++ .../atlas-integrations-create-VICTOR_OPS.txt | 98 ++++++++ .../atlas-integrations-create-WEBHOOK.txt | 96 ++++++++ docs/command/atlas-integrations-create.txt | 67 ++++++ docs/command/atlas-integrations-delete.txt | 104 ++++++++ docs/command/atlas-integrations-describe.txt | 92 ++++++++ docs/command/atlas-integrations-list.txt | 87 +++++++ docs/command/atlas-integrations.txt | 65 +++++ .../command/atlas-kubernetes-config-apply.txt | 117 +++++++++ .../atlas-kubernetes-config-generate.txt | 142 +++++++++++ docs/command/atlas-kubernetes-config.txt | 63 +++++ .../atlas-kubernetes-operator-install.txt | 164 +++++++++++++ docs/command/atlas-kubernetes-operator.txt | 61 +++++ docs/command/atlas-kubernetes.txt | 63 +++++ docs/command/atlas-liveMigrations-create.txt | 126 ++++++++++ docs/command/atlas-liveMigrations-cutover.txt | 82 +++++++ .../command/atlas-liveMigrations-describe.txt | 62 +++++ .../atlas-liveMigrations-link-create.txt | 82 +++++++ .../atlas-liveMigrations-link-delete.txt | 76 ++++++ docs/command/atlas-liveMigrations-link.txt | 61 +++++ ...atlas-liveMigrations-validation-create.txt | 126 ++++++++++ ...las-liveMigrations-validation-describe.txt | 80 +++++++ .../atlas-liveMigrations-validation.txt | 61 +++++ docs/command/atlas-liveMigrations.txt | 67 ++++++ docs/command/atlas-logs-download.txt | 126 ++++++++++ docs/command/atlas-logs.txt | 59 +++++ .../atlas-maintenanceWindows-clear.txt | 92 ++++++++ .../atlas-maintenanceWindows-defer.txt | 88 +++++++ .../atlas-maintenanceWindows-describe.txt | 89 +++++++ .../atlas-maintenanceWindows-update.txt | 100 ++++++++ docs/command/atlas-maintenanceWindows.txt | 65 +++++ .../atlas-metrics-databases-describe.txt | 131 +++++++++++ docs/command/atlas-metrics-databases-list.txt | 118 ++++++++++ docs/command/atlas-metrics-databases.txt | 61 +++++ docs/command/atlas-metrics-disks-describe.txt | 133 +++++++++++ docs/command/atlas-metrics-disks-list.txt | 118 ++++++++++ docs/command/atlas-metrics-disks.txt | 61 +++++ docs/command/atlas-metrics-processes.txt | 129 ++++++++++ docs/command/atlas-metrics.txt | 63 +++++ .../atlas-networking-containers-delete.txt | 102 ++++++++ .../atlas-networking-containers-list.txt | 92 ++++++++ docs/command/atlas-networking-containers.txt | 61 +++++ .../atlas-networking-peering-create-aws.txt | 110 +++++++++ .../atlas-networking-peering-create-azure.txt | 116 +++++++++ .../atlas-networking-peering-create-gcp.txt | 106 +++++++++ .../atlas-networking-peering-create.txt | 63 +++++ .../atlas-networking-peering-delete.txt | 102 ++++++++ .../command/atlas-networking-peering-list.txt | 92 ++++++++ .../atlas-networking-peering-watch.txt | 108 +++++++++ docs/command/atlas-networking-peering.txt | 65 +++++ docs/command/atlas-networking.txt | 61 +++++ ...ganizations-apiKeys-accessLists-create.txt | 104 ++++++++ ...ganizations-apiKeys-accessLists-delete.txt | 106 +++++++++ ...organizations-apiKeys-accessLists-list.txt | 106 +++++++++ ...tlas-organizations-apiKeys-accessLists.txt | 63 +++++ .../atlas-organizations-apiKeys-assign.txt | 114 +++++++++ .../atlas-organizations-apiKeys-create.txt | 98 ++++++++ .../atlas-organizations-apiKeys-delete.txt | 104 ++++++++ .../atlas-organizations-apiKeys-describe.txt | 105 +++++++++ .../atlas-organizations-apiKeys-list.txt | 92 ++++++++ docs/command/atlas-organizations-apiKeys.txt | 69 ++++++ docs/command/atlas-organizations-create.txt | 104 ++++++++ docs/command/atlas-organizations-delete.txt | 100 ++++++++ docs/command/atlas-organizations-describe.txt | 99 ++++++++ ...atlas-organizations-invitations-delete.txt | 102 ++++++++ ...las-organizations-invitations-describe.txt | 92 ++++++++ ...atlas-organizations-invitations-invite.txt | 120 ++++++++++ .../atlas-organizations-invitations-list.txt | 80 +++++++ ...atlas-organizations-invitations-update.txt | 119 ++++++++++ .../atlas-organizations-invitations.txt | 69 ++++++ docs/command/atlas-organizations-list.txt | 110 +++++++++ .../atlas-organizations-users-list.txt | 99 ++++++++ docs/command/atlas-organizations-users.txt | 59 +++++ docs/command/atlas-organizations.txt | 73 ++++++ ...las-performanceAdvisor-namespaces-list.txt | 92 ++++++++ .../atlas-performanceAdvisor-namespaces.txt | 59 +++++ ...Advisor-slowOperationThreshold-disable.txt | 76 ++++++ ...eAdvisor-slowOperationThreshold-enable.txt | 76 ++++++ ...formanceAdvisor-slowOperationThreshold.txt | 61 +++++ ...-performanceAdvisor-slowQueryLogs-list.txt | 100 ++++++++ ...atlas-performanceAdvisor-slowQueryLogs.txt | 59 +++++ ...rformanceAdvisor-suggestedIndexes-list.txt | 102 ++++++++ ...as-performanceAdvisor-suggestedIndexes.txt | 59 +++++ docs/command/atlas-performanceAdvisor.txt | 65 +++++ docs/command/atlas-plugin-install.txt | 99 ++++++++ docs/command/atlas-plugin-list.txt | 58 +++++ docs/command/atlas-plugin-uninstall.txt | 87 +++++++ docs/command/atlas-plugin-update.txt | 99 ++++++++ docs/command/atlas-plugin.txt | 65 +++++ .../atlas-privateEndpoints-aws-create.txt | 92 ++++++++ .../atlas-privateEndpoints-aws-delete.txt | 102 ++++++++ .../atlas-privateEndpoints-aws-describe.txt | 103 ++++++++ ...privateEndpoints-aws-interfaces-create.txt | 108 +++++++++ ...privateEndpoints-aws-interfaces-delete.txt | 106 +++++++++ ...ivateEndpoints-aws-interfaces-describe.txt | 109 +++++++++ .../atlas-privateEndpoints-aws-interfaces.txt | 63 +++++ .../atlas-privateEndpoints-aws-list.txt | 76 ++++++ .../atlas-privateEndpoints-aws-watch.txt | 104 ++++++++ docs/command/atlas-privateEndpoints-aws.txt | 69 ++++++ .../atlas-privateEndpoints-azure-create.txt | 92 ++++++++ .../atlas-privateEndpoints-azure-delete.txt | 102 ++++++++ .../atlas-privateEndpoints-azure-describe.txt | 103 ++++++++ ...ivateEndpoints-azure-interfaces-create.txt | 113 +++++++++ ...ivateEndpoints-azure-interfaces-delete.txt | 106 +++++++++ ...ateEndpoints-azure-interfaces-describe.txt | 107 +++++++++ ...tlas-privateEndpoints-azure-interfaces.txt | 63 +++++ .../atlas-privateEndpoints-azure-list.txt | 76 ++++++ .../atlas-privateEndpoints-azure-watch.txt | 104 ++++++++ docs/command/atlas-privateEndpoints-azure.txt | 69 ++++++ .../atlas-privateEndpoints-gcp-create.txt | 89 +++++++ .../atlas-privateEndpoints-gcp-delete.txt | 101 ++++++++ .../atlas-privateEndpoints-gcp-describe.txt | 91 +++++++ ...privateEndpoints-gcp-interfaces-create.txt | 116 +++++++++ ...privateEndpoints-gcp-interfaces-delete.txt | 106 +++++++++ ...ivateEndpoints-gcp-interfaces-describe.txt | 107 +++++++++ .../atlas-privateEndpoints-gcp-interfaces.txt | 63 +++++ .../atlas-privateEndpoints-gcp-list.txt | 75 ++++++ .../atlas-privateEndpoints-gcp-watch.txt | 103 ++++++++ docs/command/atlas-privateEndpoints-gcp.txt | 69 ++++++ ...rivateEndpoints-regionalModes-describe.txt | 89 +++++++ ...privateEndpoints-regionalModes-disable.txt | 88 +++++++ ...-privateEndpoints-regionalModes-enable.txt | 88 +++++++ .../atlas-privateEndpoints-regionalModes.txt | 63 +++++ docs/command/atlas-privateEndpoints.txt | 65 +++++ docs/command/atlas-processes-describe.txt | 101 ++++++++ docs/command/atlas-processes-list.txt | 92 ++++++++ docs/command/atlas-processes.txt | 61 +++++ .../command/atlas-projects-apiKeys-assign.txt | 108 +++++++++ .../command/atlas-projects-apiKeys-create.txt | 98 ++++++++ .../command/atlas-projects-apiKeys-delete.txt | 106 +++++++++ docs/command/atlas-projects-apiKeys-list.txt | 92 ++++++++ docs/command/atlas-projects-apiKeys.txt | 65 +++++ docs/command/atlas-projects-create.txt | 120 ++++++++++ docs/command/atlas-projects-delete.txt | 98 ++++++++ docs/command/atlas-projects-describe.txt | 99 ++++++++ docs/command/atlas-projects-list.txt | 99 ++++++++ .../atlas-projects-settings-describe.txt | 85 +++++++ .../atlas-projects-settings-update.txt | 144 ++++++++++++ docs/command/atlas-projects-settings.txt | 63 +++++ docs/command/atlas-projects-teams-add.txt | 108 +++++++++ docs/command/atlas-projects-teams-delete.txt | 104 ++++++++ docs/command/atlas-projects-teams-list.txt | 99 ++++++++ docs/command/atlas-projects-teams-update.txt | 106 +++++++++ docs/command/atlas-projects-teams.txt | 65 +++++ docs/command/atlas-projects-update.txt | 102 ++++++++ docs/command/atlas-projects-users-delete.txt | 104 ++++++++ docs/command/atlas-projects-users-list.txt | 92 ++++++++ docs/command/atlas-projects-users.txt | 61 +++++ docs/command/atlas-projects.txt | 77 ++++++ .../atlas-security-customerCerts-create.txt | 92 ++++++++ .../atlas-security-customerCerts-describe.txt | 76 ++++++ .../atlas-security-customerCerts-disable.txt | 84 +++++++ docs/command/atlas-security-customerCerts.txt | 63 +++++ docs/command/atlas-security-ldap-delete.txt | 86 +++++++ docs/command/atlas-security-ldap-get.txt | 87 +++++++ docs/command/atlas-security-ldap-save.txt | 138 +++++++++++ ...tlas-security-ldap-verify-status-watch.txt | 103 ++++++++ .../atlas-security-ldap-verify-status.txt | 106 +++++++++ docs/command/atlas-security-ldap-verify.txt | 123 ++++++++++ docs/command/atlas-security-ldap.txt | 65 +++++ docs/command/atlas-security.txt | 61 +++++ ...las-serverless-backups-restores-create.txt | 138 +++++++++++ ...s-serverless-backups-restores-describe.txt | 84 +++++++ ...atlas-serverless-backups-restores-list.txt | 104 ++++++++ ...tlas-serverless-backups-restores-watch.txt | 99 ++++++++ .../atlas-serverless-backups-restores.txt | 65 +++++ ...-serverless-backups-snapshots-describe.txt | 95 ++++++++ ...tlas-serverless-backups-snapshots-list.txt | 104 ++++++++ ...las-serverless-backups-snapshots-watch.txt | 95 ++++++++ .../atlas-serverless-backups-snapshots.txt | 63 +++++ docs/command/atlas-serverless-backups.txt | 61 +++++ docs/command/atlas-serverless-create.txt | 114 +++++++++ docs/command/atlas-serverless-delete.txt | 108 +++++++++ docs/command/atlas-serverless-describe.txt | 103 ++++++++ docs/command/atlas-serverless-list.txt | 99 ++++++++ docs/command/atlas-serverless-update.txt | 122 ++++++++++ docs/command/atlas-serverless-watch.txt | 103 ++++++++ docs/command/atlas-serverless.txt | 73 ++++++ docs/command/atlas-setup.txt | 142 +++++++++++ .../atlas-streams-connections-create.txt | 118 ++++++++++ .../atlas-streams-connections-delete.txt | 116 +++++++++ .../atlas-streams-connections-describe.txt | 97 ++++++++ .../atlas-streams-connections-list.txt | 81 +++++++ .../atlas-streams-connections-update.txt | 111 +++++++++ docs/command/atlas-streams-connections.txt | 69 ++++++ .../atlas-streams-instances-create.txt | 114 +++++++++ .../atlas-streams-instances-delete.txt | 112 +++++++++ .../atlas-streams-instances-describe.txt | 109 +++++++++ .../atlas-streams-instances-download.txt | 114 +++++++++ docs/command/atlas-streams-instances-list.txt | 95 ++++++++ .../atlas-streams-instances-update.txt | 111 +++++++++ docs/command/atlas-streams-instances.txt | 71 ++++++ docs/command/atlas-streams.txt | 63 +++++ docs/command/atlas-teams-create.txt | 106 +++++++++ docs/command/atlas-teams-delete.txt | 102 ++++++++ docs/command/atlas-teams-describe.txt | 104 ++++++++ docs/command/atlas-teams-list.txt | 92 ++++++++ docs/command/atlas-teams-rename.txt | 106 +++++++++ docs/command/atlas-teams-users-add.txt | 108 +++++++++ docs/command/atlas-teams-users-delete.txt | 106 +++++++++ docs/command/atlas-teams-users-list.txt | 84 +++++++ docs/command/atlas-teams-users.txt | 65 +++++ docs/command/atlas-teams.txt | 71 ++++++ docs/command/atlas-users-describe.txt | 104 ++++++++ docs/command/atlas-users-invite.txt | 126 ++++++++++ docs/command/atlas-users.txt | 63 +++++ docs/command/atlas.txt | 130 ++++++++++ internal/cli/backup/snapshots/download.go | 6 +- .../cli/backup/snapshots/download_test.go | 2 +- 356 files changed, 32973 insertions(+), 4 deletions(-) create mode 100644 docs/command/atlas-backups-snapshots-list.txt create mode 100644 docs/command/atlas-backups-snapshots-watch.txt create mode 100644 docs/command/atlas-backups-snapshots.txt create mode 100644 docs/command/atlas-backups.txt create mode 100644 docs/command/atlas-cloudProviders-accessRoles-aws-authorize.txt create mode 100644 docs/command/atlas-cloudProviders-accessRoles-aws-create.txt create mode 100644 docs/command/atlas-cloudProviders-accessRoles-aws-deauthorize.txt create mode 100644 docs/command/atlas-cloudProviders-accessRoles-aws.txt create mode 100644 docs/command/atlas-cloudProviders-accessRoles-list.txt create mode 100644 docs/command/atlas-cloudProviders-accessRoles.txt create mode 100644 docs/command/atlas-cloudProviders.txt create mode 100644 docs/command/atlas-clusters-advancedSettings-describe.txt create mode 100644 docs/command/atlas-clusters-advancedSettings-update.txt create mode 100644 docs/command/atlas-clusters-advancedSettings.txt create mode 100644 docs/command/atlas-clusters-availableRegions-list.txt create mode 100644 docs/command/atlas-clusters-availableRegions.txt create mode 100644 docs/command/atlas-clusters-connectionStrings-describe.txt create mode 100644 docs/command/atlas-clusters-connectionStrings.txt create mode 100644 docs/command/atlas-clusters-create.txt create mode 100644 docs/command/atlas-clusters-delete.txt create mode 100644 docs/command/atlas-clusters-describe.txt create mode 100644 docs/command/atlas-clusters-failover.txt create mode 100644 docs/command/atlas-clusters-indexes-create.txt create mode 100644 docs/command/atlas-clusters-indexes.txt create mode 100644 docs/command/atlas-clusters-list.txt create mode 100644 docs/command/atlas-clusters-onlineArchives-create.txt create mode 100644 docs/command/atlas-clusters-onlineArchives-delete.txt create mode 100644 docs/command/atlas-clusters-onlineArchives-describe.txt create mode 100644 docs/command/atlas-clusters-onlineArchives-list.txt create mode 100644 docs/command/atlas-clusters-onlineArchives-pause.txt create mode 100644 docs/command/atlas-clusters-onlineArchives-start.txt create mode 100644 docs/command/atlas-clusters-onlineArchives-update.txt create mode 100644 docs/command/atlas-clusters-onlineArchives-watch.txt create mode 100644 docs/command/atlas-clusters-onlineArchives.txt create mode 100644 docs/command/atlas-clusters-pause.txt create mode 100644 docs/command/atlas-clusters-sampleData-describe.txt create mode 100644 docs/command/atlas-clusters-sampleData-load.txt create mode 100644 docs/command/atlas-clusters-sampleData-watch.txt create mode 100644 docs/command/atlas-clusters-sampleData.txt create mode 100644 docs/command/atlas-clusters-search-indexes-create.txt create mode 100644 docs/command/atlas-clusters-search-indexes-delete.txt create mode 100644 docs/command/atlas-clusters-search-indexes-describe.txt create mode 100644 docs/command/atlas-clusters-search-indexes-list.txt create mode 100644 docs/command/atlas-clusters-search-indexes-update.txt create mode 100644 docs/command/atlas-clusters-search-indexes.txt create mode 100644 docs/command/atlas-clusters-search-nodes-create.txt create mode 100644 docs/command/atlas-clusters-search-nodes-delete.txt create mode 100644 docs/command/atlas-clusters-search-nodes-list.txt create mode 100644 docs/command/atlas-clusters-search-nodes-update.txt create mode 100644 docs/command/atlas-clusters-search-nodes.txt create mode 100644 docs/command/atlas-clusters-search.txt create mode 100644 docs/command/atlas-clusters-start.txt create mode 100644 docs/command/atlas-clusters-update.txt create mode 100644 docs/command/atlas-clusters-upgrade.txt create mode 100644 docs/command/atlas-clusters-watch.txt create mode 100644 docs/command/atlas-clusters.txt create mode 100644 docs/command/atlas-completion-bash.txt create mode 100644 docs/command/atlas-completion-fish.txt create mode 100644 docs/command/atlas-completion-powershell.txt create mode 100644 docs/command/atlas-completion-zsh.txt create mode 100644 docs/command/atlas-completion.txt create mode 100644 docs/command/atlas-config-delete.txt create mode 100644 docs/command/atlas-config-describe.txt create mode 100644 docs/command/atlas-config-edit.txt create mode 100644 docs/command/atlas-config-init.txt create mode 100644 docs/command/atlas-config-list.txt create mode 100644 docs/command/atlas-config-rename.txt create mode 100644 docs/command/atlas-config-set.txt create mode 100644 docs/command/atlas-config.txt create mode 100644 docs/command/atlas-customDbRoles-create.txt create mode 100644 docs/command/atlas-customDbRoles-delete.txt create mode 100644 docs/command/atlas-customDbRoles-describe.txt create mode 100644 docs/command/atlas-customDbRoles-list.txt create mode 100644 docs/command/atlas-customDbRoles-update.txt create mode 100644 docs/command/atlas-customDbRoles.txt create mode 100644 docs/command/atlas-customDns-aws-describe.txt create mode 100644 docs/command/atlas-customDns-aws-disable.txt create mode 100644 docs/command/atlas-customDns-aws-enable.txt create mode 100644 docs/command/atlas-customDns-aws.txt create mode 100644 docs/command/atlas-customDns.txt create mode 100644 docs/command/atlas-dataFederation-create.txt create mode 100644 docs/command/atlas-dataFederation-delete.txt create mode 100644 docs/command/atlas-dataFederation-describe.txt create mode 100644 docs/command/atlas-dataFederation-list.txt create mode 100644 docs/command/atlas-dataFederation-logs.txt create mode 100644 docs/command/atlas-dataFederation-privateEndpoints-create.txt create mode 100644 docs/command/atlas-dataFederation-privateEndpoints-delete.txt create mode 100644 docs/command/atlas-dataFederation-privateEndpoints-describe.txt create mode 100644 docs/command/atlas-dataFederation-privateEndpoints-list.txt create mode 100644 docs/command/atlas-dataFederation-privateEndpoints.txt create mode 100644 docs/command/atlas-dataFederation-queryLimits-create.txt create mode 100644 docs/command/atlas-dataFederation-queryLimits-delete.txt create mode 100644 docs/command/atlas-dataFederation-queryLimits-describe.txt create mode 100644 docs/command/atlas-dataFederation-queryLimits-list.txt create mode 100644 docs/command/atlas-dataFederation-queryLimits.txt create mode 100644 docs/command/atlas-dataFederation-update.txt create mode 100644 docs/command/atlas-dataFederation.txt create mode 100644 docs/command/atlas-dbusers-certs-create.txt create mode 100644 docs/command/atlas-dbusers-certs-list.txt create mode 100644 docs/command/atlas-dbusers-certs.txt create mode 100644 docs/command/atlas-dbusers-create.txt create mode 100644 docs/command/atlas-dbusers-delete.txt create mode 100644 docs/command/atlas-dbusers-describe.txt create mode 100644 docs/command/atlas-dbusers-list.txt create mode 100644 docs/command/atlas-dbusers-update.txt create mode 100644 docs/command/atlas-dbusers.txt create mode 100644 docs/command/atlas-deployments-connect.txt create mode 100644 docs/command/atlas-deployments-delete.txt create mode 100644 docs/command/atlas-deployments-list.txt create mode 100644 docs/command/atlas-deployments-logs.txt create mode 100644 docs/command/atlas-deployments-pause.txt create mode 100644 docs/command/atlas-deployments-search-indexes-create.txt create mode 100644 docs/command/atlas-deployments-search-indexes-delete.txt create mode 100644 docs/command/atlas-deployments-search-indexes-describe.txt create mode 100644 docs/command/atlas-deployments-search-indexes-list.txt create mode 100644 docs/command/atlas-deployments-search-indexes.txt create mode 100644 docs/command/atlas-deployments-search.txt create mode 100644 docs/command/atlas-deployments-setup.txt create mode 100644 docs/command/atlas-deployments-start.txt create mode 100644 docs/command/atlas-deployments.txt create mode 100644 docs/command/atlas-events-organizations-list.txt create mode 100644 docs/command/atlas-events-organizations.txt create mode 100644 docs/command/atlas-events-projects-list.txt create mode 100644 docs/command/atlas-events-projects.txt create mode 100644 docs/command/atlas-events.txt create mode 100644 docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-connect.txt create mode 100644 docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-delete.txt create mode 100644 docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-describe.txt create mode 100644 docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-disconnect.txt create mode 100644 docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-list.txt create mode 100644 docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-update.txt create mode 100644 docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs.txt create mode 100644 docs/command/atlas-federatedAuthentication-federationSettings-describe.txt create mode 100644 docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-create-oidc.txt create mode 100644 docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-create.txt create mode 100644 docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-delete.txt create mode 100644 docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-describe.txt create mode 100644 docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-list.txt create mode 100644 docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-revokeJwk.txt create mode 100644 docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-update-oidc.txt create mode 100644 docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-update.txt create mode 100644 docs/command/atlas-federatedAuthentication-federationSettings-identityProvider.txt create mode 100644 docs/command/atlas-federatedAuthentication-federationSettings.txt create mode 100644 docs/command/atlas-federatedAuthentication.txt create mode 100644 docs/command/atlas-integrations-create-DATADOG.txt create mode 100644 docs/command/atlas-integrations-create-OPS_GENIE.txt create mode 100644 docs/command/atlas-integrations-create-PAGER_DUTY.txt create mode 100644 docs/command/atlas-integrations-create-VICTOR_OPS.txt create mode 100644 docs/command/atlas-integrations-create-WEBHOOK.txt create mode 100644 docs/command/atlas-integrations-create.txt create mode 100644 docs/command/atlas-integrations-delete.txt create mode 100644 docs/command/atlas-integrations-describe.txt create mode 100644 docs/command/atlas-integrations-list.txt create mode 100644 docs/command/atlas-integrations.txt create mode 100644 docs/command/atlas-kubernetes-config-apply.txt create mode 100644 docs/command/atlas-kubernetes-config-generate.txt create mode 100644 docs/command/atlas-kubernetes-config.txt create mode 100644 docs/command/atlas-kubernetes-operator-install.txt create mode 100644 docs/command/atlas-kubernetes-operator.txt create mode 100644 docs/command/atlas-kubernetes.txt create mode 100644 docs/command/atlas-liveMigrations-create.txt create mode 100644 docs/command/atlas-liveMigrations-cutover.txt create mode 100644 docs/command/atlas-liveMigrations-describe.txt create mode 100644 docs/command/atlas-liveMigrations-link-create.txt create mode 100644 docs/command/atlas-liveMigrations-link-delete.txt create mode 100644 docs/command/atlas-liveMigrations-link.txt create mode 100644 docs/command/atlas-liveMigrations-validation-create.txt create mode 100644 docs/command/atlas-liveMigrations-validation-describe.txt create mode 100644 docs/command/atlas-liveMigrations-validation.txt create mode 100644 docs/command/atlas-liveMigrations.txt create mode 100644 docs/command/atlas-logs-download.txt create mode 100644 docs/command/atlas-logs.txt create mode 100644 docs/command/atlas-maintenanceWindows-clear.txt create mode 100644 docs/command/atlas-maintenanceWindows-defer.txt create mode 100644 docs/command/atlas-maintenanceWindows-describe.txt create mode 100644 docs/command/atlas-maintenanceWindows-update.txt create mode 100644 docs/command/atlas-maintenanceWindows.txt create mode 100644 docs/command/atlas-metrics-databases-describe.txt create mode 100644 docs/command/atlas-metrics-databases-list.txt create mode 100644 docs/command/atlas-metrics-databases.txt create mode 100644 docs/command/atlas-metrics-disks-describe.txt create mode 100644 docs/command/atlas-metrics-disks-list.txt create mode 100644 docs/command/atlas-metrics-disks.txt create mode 100644 docs/command/atlas-metrics-processes.txt create mode 100644 docs/command/atlas-metrics.txt create mode 100644 docs/command/atlas-networking-containers-delete.txt create mode 100644 docs/command/atlas-networking-containers-list.txt create mode 100644 docs/command/atlas-networking-containers.txt create mode 100644 docs/command/atlas-networking-peering-create-aws.txt create mode 100644 docs/command/atlas-networking-peering-create-azure.txt create mode 100644 docs/command/atlas-networking-peering-create-gcp.txt create mode 100644 docs/command/atlas-networking-peering-create.txt create mode 100644 docs/command/atlas-networking-peering-delete.txt create mode 100644 docs/command/atlas-networking-peering-list.txt create mode 100644 docs/command/atlas-networking-peering-watch.txt create mode 100644 docs/command/atlas-networking-peering.txt create mode 100644 docs/command/atlas-networking.txt create mode 100644 docs/command/atlas-organizations-apiKeys-accessLists-create.txt create mode 100644 docs/command/atlas-organizations-apiKeys-accessLists-delete.txt create mode 100644 docs/command/atlas-organizations-apiKeys-accessLists-list.txt create mode 100644 docs/command/atlas-organizations-apiKeys-accessLists.txt create mode 100644 docs/command/atlas-organizations-apiKeys-assign.txt create mode 100644 docs/command/atlas-organizations-apiKeys-create.txt create mode 100644 docs/command/atlas-organizations-apiKeys-delete.txt create mode 100644 docs/command/atlas-organizations-apiKeys-describe.txt create mode 100644 docs/command/atlas-organizations-apiKeys-list.txt create mode 100644 docs/command/atlas-organizations-apiKeys.txt create mode 100644 docs/command/atlas-organizations-create.txt create mode 100644 docs/command/atlas-organizations-delete.txt create mode 100644 docs/command/atlas-organizations-describe.txt create mode 100644 docs/command/atlas-organizations-invitations-delete.txt create mode 100644 docs/command/atlas-organizations-invitations-describe.txt create mode 100644 docs/command/atlas-organizations-invitations-invite.txt create mode 100644 docs/command/atlas-organizations-invitations-list.txt create mode 100644 docs/command/atlas-organizations-invitations-update.txt create mode 100644 docs/command/atlas-organizations-invitations.txt create mode 100644 docs/command/atlas-organizations-list.txt create mode 100644 docs/command/atlas-organizations-users-list.txt create mode 100644 docs/command/atlas-organizations-users.txt create mode 100644 docs/command/atlas-organizations.txt create mode 100644 docs/command/atlas-performanceAdvisor-namespaces-list.txt create mode 100644 docs/command/atlas-performanceAdvisor-namespaces.txt create mode 100644 docs/command/atlas-performanceAdvisor-slowOperationThreshold-disable.txt create mode 100644 docs/command/atlas-performanceAdvisor-slowOperationThreshold-enable.txt create mode 100644 docs/command/atlas-performanceAdvisor-slowOperationThreshold.txt create mode 100644 docs/command/atlas-performanceAdvisor-slowQueryLogs-list.txt create mode 100644 docs/command/atlas-performanceAdvisor-slowQueryLogs.txt create mode 100644 docs/command/atlas-performanceAdvisor-suggestedIndexes-list.txt create mode 100644 docs/command/atlas-performanceAdvisor-suggestedIndexes.txt create mode 100644 docs/command/atlas-performanceAdvisor.txt create mode 100644 docs/command/atlas-plugin-install.txt create mode 100644 docs/command/atlas-plugin-list.txt create mode 100644 docs/command/atlas-plugin-uninstall.txt create mode 100644 docs/command/atlas-plugin-update.txt create mode 100644 docs/command/atlas-plugin.txt create mode 100644 docs/command/atlas-privateEndpoints-aws-create.txt create mode 100644 docs/command/atlas-privateEndpoints-aws-delete.txt create mode 100644 docs/command/atlas-privateEndpoints-aws-describe.txt create mode 100644 docs/command/atlas-privateEndpoints-aws-interfaces-create.txt create mode 100644 docs/command/atlas-privateEndpoints-aws-interfaces-delete.txt create mode 100644 docs/command/atlas-privateEndpoints-aws-interfaces-describe.txt create mode 100644 docs/command/atlas-privateEndpoints-aws-interfaces.txt create mode 100644 docs/command/atlas-privateEndpoints-aws-list.txt create mode 100644 docs/command/atlas-privateEndpoints-aws-watch.txt create mode 100644 docs/command/atlas-privateEndpoints-aws.txt create mode 100644 docs/command/atlas-privateEndpoints-azure-create.txt create mode 100644 docs/command/atlas-privateEndpoints-azure-delete.txt create mode 100644 docs/command/atlas-privateEndpoints-azure-describe.txt create mode 100644 docs/command/atlas-privateEndpoints-azure-interfaces-create.txt create mode 100644 docs/command/atlas-privateEndpoints-azure-interfaces-delete.txt create mode 100644 docs/command/atlas-privateEndpoints-azure-interfaces-describe.txt create mode 100644 docs/command/atlas-privateEndpoints-azure-interfaces.txt create mode 100644 docs/command/atlas-privateEndpoints-azure-list.txt create mode 100644 docs/command/atlas-privateEndpoints-azure-watch.txt create mode 100644 docs/command/atlas-privateEndpoints-azure.txt create mode 100644 docs/command/atlas-privateEndpoints-gcp-create.txt create mode 100644 docs/command/atlas-privateEndpoints-gcp-delete.txt create mode 100644 docs/command/atlas-privateEndpoints-gcp-describe.txt create mode 100644 docs/command/atlas-privateEndpoints-gcp-interfaces-create.txt create mode 100644 docs/command/atlas-privateEndpoints-gcp-interfaces-delete.txt create mode 100644 docs/command/atlas-privateEndpoints-gcp-interfaces-describe.txt create mode 100644 docs/command/atlas-privateEndpoints-gcp-interfaces.txt create mode 100644 docs/command/atlas-privateEndpoints-gcp-list.txt create mode 100644 docs/command/atlas-privateEndpoints-gcp-watch.txt create mode 100644 docs/command/atlas-privateEndpoints-gcp.txt create mode 100644 docs/command/atlas-privateEndpoints-regionalModes-describe.txt create mode 100644 docs/command/atlas-privateEndpoints-regionalModes-disable.txt create mode 100644 docs/command/atlas-privateEndpoints-regionalModes-enable.txt create mode 100644 docs/command/atlas-privateEndpoints-regionalModes.txt create mode 100644 docs/command/atlas-privateEndpoints.txt create mode 100644 docs/command/atlas-processes-describe.txt create mode 100644 docs/command/atlas-processes-list.txt create mode 100644 docs/command/atlas-processes.txt create mode 100644 docs/command/atlas-projects-apiKeys-assign.txt create mode 100644 docs/command/atlas-projects-apiKeys-create.txt create mode 100644 docs/command/atlas-projects-apiKeys-delete.txt create mode 100644 docs/command/atlas-projects-apiKeys-list.txt create mode 100644 docs/command/atlas-projects-apiKeys.txt create mode 100644 docs/command/atlas-projects-create.txt create mode 100644 docs/command/atlas-projects-delete.txt create mode 100644 docs/command/atlas-projects-describe.txt create mode 100644 docs/command/atlas-projects-list.txt create mode 100644 docs/command/atlas-projects-settings-describe.txt create mode 100644 docs/command/atlas-projects-settings-update.txt create mode 100644 docs/command/atlas-projects-settings.txt create mode 100644 docs/command/atlas-projects-teams-add.txt create mode 100644 docs/command/atlas-projects-teams-delete.txt create mode 100644 docs/command/atlas-projects-teams-list.txt create mode 100644 docs/command/atlas-projects-teams-update.txt create mode 100644 docs/command/atlas-projects-teams.txt create mode 100644 docs/command/atlas-projects-update.txt create mode 100644 docs/command/atlas-projects-users-delete.txt create mode 100644 docs/command/atlas-projects-users-list.txt create mode 100644 docs/command/atlas-projects-users.txt create mode 100644 docs/command/atlas-projects.txt create mode 100644 docs/command/atlas-security-customerCerts-create.txt create mode 100644 docs/command/atlas-security-customerCerts-describe.txt create mode 100644 docs/command/atlas-security-customerCerts-disable.txt create mode 100644 docs/command/atlas-security-customerCerts.txt create mode 100644 docs/command/atlas-security-ldap-delete.txt create mode 100644 docs/command/atlas-security-ldap-get.txt create mode 100644 docs/command/atlas-security-ldap-save.txt create mode 100644 docs/command/atlas-security-ldap-verify-status-watch.txt create mode 100644 docs/command/atlas-security-ldap-verify-status.txt create mode 100644 docs/command/atlas-security-ldap-verify.txt create mode 100644 docs/command/atlas-security-ldap.txt create mode 100644 docs/command/atlas-security.txt create mode 100644 docs/command/atlas-serverless-backups-restores-create.txt create mode 100644 docs/command/atlas-serverless-backups-restores-describe.txt create mode 100644 docs/command/atlas-serverless-backups-restores-list.txt create mode 100644 docs/command/atlas-serverless-backups-restores-watch.txt create mode 100644 docs/command/atlas-serverless-backups-restores.txt create mode 100644 docs/command/atlas-serverless-backups-snapshots-describe.txt create mode 100644 docs/command/atlas-serverless-backups-snapshots-list.txt create mode 100644 docs/command/atlas-serverless-backups-snapshots-watch.txt create mode 100644 docs/command/atlas-serverless-backups-snapshots.txt create mode 100644 docs/command/atlas-serverless-backups.txt create mode 100644 docs/command/atlas-serverless-create.txt create mode 100644 docs/command/atlas-serverless-delete.txt create mode 100644 docs/command/atlas-serverless-describe.txt create mode 100644 docs/command/atlas-serverless-list.txt create mode 100644 docs/command/atlas-serverless-update.txt create mode 100644 docs/command/atlas-serverless-watch.txt create mode 100644 docs/command/atlas-serverless.txt create mode 100644 docs/command/atlas-setup.txt create mode 100644 docs/command/atlas-streams-connections-create.txt create mode 100644 docs/command/atlas-streams-connections-delete.txt create mode 100644 docs/command/atlas-streams-connections-describe.txt create mode 100644 docs/command/atlas-streams-connections-list.txt create mode 100644 docs/command/atlas-streams-connections-update.txt create mode 100644 docs/command/atlas-streams-connections.txt create mode 100644 docs/command/atlas-streams-instances-create.txt create mode 100644 docs/command/atlas-streams-instances-delete.txt create mode 100644 docs/command/atlas-streams-instances-describe.txt create mode 100644 docs/command/atlas-streams-instances-download.txt create mode 100644 docs/command/atlas-streams-instances-list.txt create mode 100644 docs/command/atlas-streams-instances-update.txt create mode 100644 docs/command/atlas-streams-instances.txt create mode 100644 docs/command/atlas-streams.txt create mode 100644 docs/command/atlas-teams-create.txt create mode 100644 docs/command/atlas-teams-delete.txt create mode 100644 docs/command/atlas-teams-describe.txt create mode 100644 docs/command/atlas-teams-list.txt create mode 100644 docs/command/atlas-teams-rename.txt create mode 100644 docs/command/atlas-teams-users-add.txt create mode 100644 docs/command/atlas-teams-users-delete.txt create mode 100644 docs/command/atlas-teams-users-list.txt create mode 100644 docs/command/atlas-teams-users.txt create mode 100644 docs/command/atlas-teams.txt create mode 100644 docs/command/atlas-users-describe.txt create mode 100644 docs/command/atlas-users-invite.txt create mode 100644 docs/command/atlas-users.txt create mode 100644 docs/command/atlas.txt diff --git a/docs/command/atlas-backups-snapshots-download.txt b/docs/command/atlas-backups-snapshots-download.txt index e69de29bb2..18331b7e97 100644 --- a/docs/command/atlas-backups-snapshots-download.txt +++ b/docs/command/atlas-backups-snapshots-download.txt @@ -0,0 +1,104 @@ +.. _atlas-backups-snapshots-download: + +================================ +atlas backups snapshots download +================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Download one snapshot for the specified flex cluster. + +You can download a snapshot for an Atlas Flex cluster. +To use this command, you must authenticate with a user account or an API key with the Project Owner role. +Atlas supports this command only for Flex clusters. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas backups snapshots download [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - snapshotId + - string + - true + - Unique 24-hexadecimal digit string that identifies the snapshot to download. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --clusterName + - string + - true + - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. + * - -h, --help + - + - false + - help for download + * - --out + - string + - false + - Output file name. This value defaults to the Snapshot id. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Snapshot '' downloaded. + + diff --git a/docs/command/atlas-backups-snapshots-list.txt b/docs/command/atlas-backups-snapshots-list.txt new file mode 100644 index 0000000000..4fee8008ea --- /dev/null +++ b/docs/command/atlas-backups-snapshots-list.txt @@ -0,0 +1,115 @@ +.. _atlas-backups-snapshots-list: + +============================ +atlas backups snapshots list +============================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all cloud backup snapshots for your project and cluster. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas backups snapshots list [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - clusterName + - string + - true + - Name of the Atlas cluster that contains the snapshots you want to retrieve. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - --omitCount + - + - false + - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID TYPE STATUS CREATED AT EXPIRES AT + + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return a JSON-formatted list of snapshots for the cluster named myDemo + atlas backups snapshots list myDemo --output json diff --git a/docs/command/atlas-backups-snapshots-watch.txt b/docs/command/atlas-backups-snapshots-watch.txt new file mode 100644 index 0000000000..f17ed235fc --- /dev/null +++ b/docs/command/atlas-backups-snapshots-watch.txt @@ -0,0 +1,108 @@ +.. _atlas-backups-snapshots-watch: + +============================= +atlas backups snapshots watch +============================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Watch the specified snapshot in your project until it becomes available. + +This command checks the snapshot's status periodically until it reaches a completed or failed status. +Once the snapshot reaches the expected status, the command prints "Snapshot changes completed." +If you run the command in the terminal, it blocks the terminal session until the resource status completes or fails. +You can interrupt the command's polling at any time with CTRL-C. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas backups snapshots watch [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - snapshotId + - string + - true + - Unique identifier of the snapshot you want to watch. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --clusterName + - string + - true + - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. + * - -h, --help + - + - false + - help for watch + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + + Snapshot changes completed. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Watch the backup snapshot with the ID 5f4007f327a3bd7b6f4103c5 in the cluster named myDemo until it becomes available: + atlas backups snapshots watch 5f4007f327a3bd7b6f4103c5 --clusterName myDemo diff --git a/docs/command/atlas-backups-snapshots.txt b/docs/command/atlas-backups-snapshots.txt new file mode 100644 index 0000000000..028c6c021b --- /dev/null +++ b/docs/command/atlas-backups-snapshots.txt @@ -0,0 +1,69 @@ +.. _atlas-backups-snapshots: + +======================= +atlas backups snapshots +======================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage cloud backup snapshots for your project. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for snapshots + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-backups-snapshots-create` - Create a backup snapshot for your project and cluster. +* :ref:`atlas-backups-snapshots-delete` - Remove the specified backup snapshot. +* :ref:`atlas-backups-snapshots-describe` - Return the details for the specified snapshot for your project. +* :ref:`atlas-backups-snapshots-download` - Download one snapshot for the specified flex cluster. +* :ref:`atlas-backups-snapshots-list` - Return all cloud backup snapshots for your project and cluster. +* :ref:`atlas-backups-snapshots-watch` - Watch the specified snapshot in your project until it becomes available. + + +.. toctree:: + :titlesonly: + + create + delete + describe + download + list + watch + diff --git a/docs/command/atlas-backups.txt b/docs/command/atlas-backups.txt new file mode 100644 index 0000000000..c04fe26d41 --- /dev/null +++ b/docs/command/atlas-backups.txt @@ -0,0 +1,67 @@ +.. _atlas-backups: + +============= +atlas backups +============= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage cloud backups for your project. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for backups + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-backups-compliancePolicy` - Manage cloud backup compliance policy for your project. Use "atlas backups compliancepolicy setup" to enable backup compliance policy with a full configuration. Use "atlas backups compliancepolicy enable" to enable backup compliance policy without any configuration. +* :ref:`atlas-backups-exports` - Manage cloud backup export jobs for your project. +* :ref:`atlas-backups-restores` - Manage cloud backup restore jobs for your project. +* :ref:`atlas-backups-schedule` - Return a cloud backup schedule for the cluster you specify. +* :ref:`atlas-backups-snapshots` - Manage cloud backup snapshots for your project. + + +.. toctree:: + :titlesonly: + + compliancePolicy + exports + restores + schedule + snapshots + diff --git a/docs/command/atlas-cloudProviders-accessRoles-aws-authorize.txt b/docs/command/atlas-cloudProviders-accessRoles-aws-authorize.txt new file mode 100644 index 0000000000..63807f8d41 --- /dev/null +++ b/docs/command/atlas-cloudProviders-accessRoles-aws-authorize.txt @@ -0,0 +1,96 @@ +.. _atlas-cloudProviders-accessRoles-aws-authorize: + +============================================== +atlas cloudProviders accessRoles aws authorize +============================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Authorize an AWS IAM role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas cloudProviders accessRoles aws authorize [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - roleId + - string + - true + - Unique ID of the role to authorize. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for authorize + * - --iamAssumedRoleArn + - string + - false + - Role ARN that Atlas assumes to access your AWS account. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + AWS IAM role ' successfully authorized. + + diff --git a/docs/command/atlas-cloudProviders-accessRoles-aws-create.txt b/docs/command/atlas-cloudProviders-accessRoles-aws-create.txt new file mode 100644 index 0000000000..d9d9cc95a5 --- /dev/null +++ b/docs/command/atlas-cloudProviders-accessRoles-aws-create.txt @@ -0,0 +1,80 @@ +.. _atlas-cloudProviders-accessRoles-aws-create: + +=========================================== +atlas cloudProviders accessRoles aws create +=========================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create an AWS IAM role. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas cloudProviders accessRoles aws create [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for create + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + AWS IAM role '' successfully created. + Atlas AWS Account ARN: + Unique External ID: + + diff --git a/docs/command/atlas-cloudProviders-accessRoles-aws-deauthorize.txt b/docs/command/atlas-cloudProviders-accessRoles-aws-deauthorize.txt new file mode 100644 index 0000000000..cdb6f3e25b --- /dev/null +++ b/docs/command/atlas-cloudProviders-accessRoles-aws-deauthorize.txt @@ -0,0 +1,94 @@ +.. _atlas-cloudProviders-accessRoles-aws-deauthorize: + +================================================ +atlas cloudProviders accessRoles aws deauthorize +================================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Deauthorize an AWS IAM role. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas cloudProviders accessRoles aws deauthorize [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - roleId + - string + - true + - Unique ID of the role to authorize. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for deauthorize + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + AWS IAM role successfully deauthorized. + + diff --git a/docs/command/atlas-cloudProviders-accessRoles-aws.txt b/docs/command/atlas-cloudProviders-accessRoles-aws.txt new file mode 100644 index 0000000000..87be4ff42e --- /dev/null +++ b/docs/command/atlas-cloudProviders-accessRoles-aws.txt @@ -0,0 +1,63 @@ +.. _atlas-cloudProviders-accessRoles-aws: + +==================================== +atlas cloudProviders accessRoles aws +==================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage AWS IAM role access in Atlas. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for aws + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-cloudProviders-accessRoles-aws-authorize` - Authorize an AWS IAM role. +* :ref:`atlas-cloudProviders-accessRoles-aws-create` - Create an AWS IAM role. +* :ref:`atlas-cloudProviders-accessRoles-aws-deauthorize` - Deauthorize an AWS IAM role. + + +.. toctree:: + :titlesonly: + + authorize + create + deauthorize + diff --git a/docs/command/atlas-cloudProviders-accessRoles-list.txt b/docs/command/atlas-cloudProviders-accessRoles-list.txt new file mode 100644 index 0000000000..f547b542a0 --- /dev/null +++ b/docs/command/atlas-cloudProviders-accessRoles-list.txt @@ -0,0 +1,68 @@ +.. _atlas-cloudProviders-accessRoles-list: + +===================================== +atlas cloudProviders accessRoles list +===================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +List AWS IAM role access in Atlas. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas cloudProviders accessRoles list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + diff --git a/docs/command/atlas-cloudProviders-accessRoles.txt b/docs/command/atlas-cloudProviders-accessRoles.txt new file mode 100644 index 0000000000..a0d5c04fa9 --- /dev/null +++ b/docs/command/atlas-cloudProviders-accessRoles.txt @@ -0,0 +1,61 @@ +.. _atlas-cloudProviders-accessRoles: + +================================ +atlas cloudProviders accessRoles +================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage AWS IAM role access in Atlas. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for accessRoles + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-cloudProviders-accessRoles-aws` - Manage AWS IAM role access in Atlas. +* :ref:`atlas-cloudProviders-accessRoles-list` - List AWS IAM role access in Atlas. + + +.. toctree:: + :titlesonly: + + aws + list + diff --git a/docs/command/atlas-cloudProviders.txt b/docs/command/atlas-cloudProviders.txt new file mode 100644 index 0000000000..397bdf243d --- /dev/null +++ b/docs/command/atlas-cloudProviders.txt @@ -0,0 +1,59 @@ +.. _atlas-cloudProviders: + +==================== +atlas cloudProviders +==================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage cloud provider access in Atlas using AWS IAM roles. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for cloudProviders + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-cloudProviders-accessRoles` - Manage AWS IAM role access in Atlas. + + +.. toctree:: + :titlesonly: + + accessRoles + diff --git a/docs/command/atlas-clusters-advancedSettings-describe.txt b/docs/command/atlas-clusters-advancedSettings-describe.txt new file mode 100644 index 0000000000..da40aab20e --- /dev/null +++ b/docs/command/atlas-clusters-advancedSettings-describe.txt @@ -0,0 +1,91 @@ +.. _atlas-clusters-advancedSettings-describe: + +======================================== +atlas clusters advancedSettings describe +======================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Retrieve advanced configuration settings for one cluster. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters advancedSettings describe [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - clusterName + - string + - true + - Name of the Atlas cluster for which you want to retrieve configuration settings. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + atlas clusters advancedSettings describe Cluster0 diff --git a/docs/command/atlas-clusters-advancedSettings-update.txt b/docs/command/atlas-clusters-advancedSettings-update.txt new file mode 100644 index 0000000000..5017e010ae --- /dev/null +++ b/docs/command/atlas-clusters-advancedSettings-update.txt @@ -0,0 +1,175 @@ +.. _atlas-clusters-advancedSettings-update: + +====================================== +atlas clusters advancedSettings update +====================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Update advanced configuration settings for one cluster. + +Updates the advanced configuration details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. Advanced configuration details include the read/write concern, index and oplog limits, and other database settings. +Atlas supports this command only for M10+ clusters. + + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters advancedSettings update [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - clusterName + - string + - true + - Name of the cluster to update. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --disableFailIndexKeyTooLong + - + - false + - Flag that disables writing documents that exceed 1024 bytes without indexing. + + Mutually exclusive with --enableFailIndexKeyTooLong. + * - --disableJavascript + - + - false + - Flag that disables the execution of operations that perform server-side executions of JavaScript. + + Mutually exclusive with --enableJavascript. + * - --disableTableScan + - + - false + - Flag that disables executing any query that requires a collection scan to return results. + + Mutually exclusive with --enableTableScan. + * - --enableFailIndexKeyTooLong + - + - false + - Flag that enables writing documents that exceed 1024 bytes without indexing. + + Mutually exclusive with --disableFailIndexKeyTooLong. + * - --enableJavascript + - + - false + - Flag that enables the execution of operations that perform server-side executions of JavaScript. + + Mutually exclusive with --disableJavascript. + * - --enableTableScan + - + - false + - Flag that enables executing any query that requires a collection scan to return results. + + Mutually exclusive with --disableTableScan. + * - -h, --help + - + - false + - help for update + * - --oplogMinRetentionHours + - float + - false + - Minimum retention window for cluster's oplog expressed in hours. + * - --oplogSizeMB + - int + - false + - Storage limit of cluster's oplog expressed in megabytes. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --readConcern + - string + - false + - Default level of acknowledgment requested from MongoDB for read operations set for this cluster. + * - --sampleRefreshIntervalBIConnector + - int + - false + - Interval in seconds at which the mongosqld process re-samples data to create its relational schema. This value defaults to -1. + * - --sampleSizeBIConnector + - int + - false + - Number of documents per database to sample when gathering schema information. This value defaults to -1. + * - --tlsProtocol + - string + - false + - Minimum Transport Layer Security (TLS) version that the cluster accepts for incoming connections. + * - --writeConcern + - string + - false + - Default level of acknowledgment requested from MongoDB for write operations set for this cluster. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Updating advanced configuration settings of your cluster'. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Update the minimum oplog size for a cluster: + atlas cluster advancedSettings update --projectId --oplogSizeMB 1000 + + +.. code-block:: + :copyable: false + + # Update the minimum TLS protocol version for a cluster: + atlas cluster advancedSettings update --projectId --minimumEnabledTLSProtocol "TLS1_2" diff --git a/docs/command/atlas-clusters-advancedSettings.txt b/docs/command/atlas-clusters-advancedSettings.txt new file mode 100644 index 0000000000..206c7620db --- /dev/null +++ b/docs/command/atlas-clusters-advancedSettings.txt @@ -0,0 +1,61 @@ +.. _atlas-clusters-advancedSettings: + +=============================== +atlas clusters advancedSettings +=============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage advanced configuration settings for your cluster. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for advancedSettings + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-clusters-advancedSettings-describe` - Retrieve advanced configuration settings for one cluster. +* :ref:`atlas-clusters-advancedSettings-update` - Update advanced configuration settings for one cluster. + + +.. toctree:: + :titlesonly: + + describe + update + diff --git a/docs/command/atlas-clusters-availableRegions-list.txt b/docs/command/atlas-clusters-availableRegions-list.txt new file mode 100644 index 0000000000..e0adf92e91 --- /dev/null +++ b/docs/command/atlas-clusters-availableRegions-list.txt @@ -0,0 +1,89 @@ +.. _atlas-clusters-availableRegions-list: + +==================================== +atlas clusters availableRegions list +==================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +List available regions that Atlas supports for new deployments. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters availableRegions list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --provider + - string + - false + - Name of your cloud service provider. Valid values are AWS, AZURE, or GCP. + * - --tier + - string + - false + - Tier for each data-bearing server in the cluster. To learn more about cluster tiers, see https://dochub.mongodb.org/core/cluster-tier-atlas. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + # List available regions for a given cloud provider and tier: + atlas cluster availableRegions list --provider AWS --tier M50 + + +.. code-block:: + :copyable: false + + # List available regions by tier for a given provider: + atlas cluster availableRegions list --provider GCP diff --git a/docs/command/atlas-clusters-availableRegions.txt b/docs/command/atlas-clusters-availableRegions.txt new file mode 100644 index 0000000000..56a43e7f4a --- /dev/null +++ b/docs/command/atlas-clusters-availableRegions.txt @@ -0,0 +1,59 @@ +.. _atlas-clusters-availableRegions: + +=============================== +atlas clusters availableRegions +=============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage available regions for your project. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for availableRegions + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-clusters-availableRegions-list` - List available regions that Atlas supports for new deployments. + + +.. toctree:: + :titlesonly: + + list + diff --git a/docs/command/atlas-clusters-connectionStrings-describe.txt b/docs/command/atlas-clusters-connectionStrings-describe.txt new file mode 100644 index 0000000000..92b25f762c --- /dev/null +++ b/docs/command/atlas-clusters-connectionStrings-describe.txt @@ -0,0 +1,96 @@ +.. _atlas-clusters-connectionStrings-describe: + +========================================= +atlas clusters connectionStrings describe +========================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the SRV connection string for the cluster you specify. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters connectionStrings describe [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - clusterName + - string + - true + - Name of the Atlas cluster for which you want to retrieve connection strings. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --type + - string + - false + - Type of connection string. If you specify 'private', this option retrieves the connection string for the network peering endpoint. If you specify 'privateEndpoint', this option retrieves the shard optimized connection strings for the private endpoints. This value defaults to "standard". + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return the JSON-formatted connection strings for the cluster named myCluster: + atlas clusters connectionStrings describe myCluster --output json diff --git a/docs/command/atlas-clusters-connectionStrings.txt b/docs/command/atlas-clusters-connectionStrings.txt new file mode 100644 index 0000000000..0b206d8b56 --- /dev/null +++ b/docs/command/atlas-clusters-connectionStrings.txt @@ -0,0 +1,59 @@ +.. _atlas-clusters-connectionStrings: + +================================ +atlas clusters connectionStrings +================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage MongoDB cluster connection string. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for connectionStrings + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-clusters-connectionStrings-describe` - Return the SRV connection string for the cluster you specify. + + +.. toctree:: + :titlesonly: + + describe + diff --git a/docs/command/atlas-clusters-create.txt b/docs/command/atlas-clusters-create.txt new file mode 100644 index 0000000000..8058282bb3 --- /dev/null +++ b/docs/command/atlas-clusters-create.txt @@ -0,0 +1,222 @@ +.. _atlas-clusters-create: + +===================== +atlas clusters create +===================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create a cluster for your project. + +To get started quickly, specify a name for your cluster, a cloud provider, and a region to deploy a three-member replica set with the latest MongoDB server version. +For full control of your deployment, or to create multi-cloud clusters, provide a JSON configuration file with the --file flag. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters create [name] [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - name + - string + - false + - Name of the cluster. The cluster name cannot be changed after the cluster is created. Cluster name can contain ASCII letters, numbers, and hyphens. You must specify the cluster name argument if you don't use the --file option. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --backup + - + - false + - Flag that enables Continuous Cloud Backup for your deployment. This option is unavailable for clusters smaller than M10. + * - --biConnector + - + - false + - Flag that enables BI Connector for Atlas on the deployment. + + Mutually exclusive with --file. + * - --diskSizeGB + - float + - false + - Capacity, in gigabytes, of the host's root volume. + + Mutually exclusive with --file. This value defaults to 2. + * - --enableTerminationProtection + - + - false + - Enables termination protection for your cluster. You can't delete a cluster with termination protection enabled. + * - -f, --file + - string + - false + - Path to an optional JSON configuration file that defines cluster settings. To learn more about cluster configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/cluster-config-file-atlascli. + + Mutually exclusive with --tier, --provider, --members, --region, --diskSizeGB, --mdbVersion, --biConnector, --type, --shards, --tag. + * - -h, --help + - + - false + - help for create + * - --mdbVersion + - string + - false + - Major MongoDB version of the cluster. + + Mutually exclusive with --file. This value defaults to "8.0". + * - -m, --members + - int + - false + - Number of members in the replica set. + + Mutually exclusive with --file. This value defaults to 3. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --provider + - string + - false + - Name of your cloud service provider. Valid values are AWS, AZURE, or GCP. You must specify the provider option if you don't use the --file option. + + Mutually exclusive with --file. + * - -r, --region + - string + - false + - Physical location of your MongoDB cluster. You must specify the region option if you don't use the --file option. For a complete list of supported AWS regions, see: https://dochub.mongodb.org/core/aws-atlas. For a complete list of supported Azure regions, see: https://dochub.mongodb.org/core/azure-atlas. For a complete list of supported GCP regions, see: https://dochub.mongodb.org/core/gcp-atlas. + + Mutually exclusive with --file. + * - -s, --shards + - int + - false + - Number of shards in the cluster. + + Mutually exclusive with --file. This value defaults to 1. + * - --tag + - key=value + - false + - List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. + + Mutually exclusive with --file. + * - --tier + - string + - false + - Tier for each data-bearing server in the cluster. To learn more about cluster tiers, see https://dochub.mongodb.org/core/cluster-tier-atlas. + + Mutually exclusive with --file. This value defaults to "M2". + * - --type + - string + - false + - Type of the cluster that you want to create. Valid values are REPLICASET or SHARDED. + + Mutually exclusive with --file. This value defaults to "REPLICASET". + * - -w, --watch + - + - false + - Flag that indicates whether to watch the command until it completes its execution or the watch times out. To set the time that the watch times out, use the --watchTimeout option. + * - --watchTimeout + - int + - false + - Time in seconds until a watch times out. After a watch times out, the CLI no longer watches the command. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Cluster '' is being created. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Deploy a free cluster named myCluster for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas cluster create myCluster --projectId 5e2211c17a3e5a48f5497de3 --provider AWS --region US_EAST_1 --tier M0 + + +.. code-block:: + :copyable: false + + # Deploy a free cluster named myCluster for the project with the ID 5e2211c17a3e5a48f5497de3 and tag "env=dev": + atlas cluster create myCluster --projectId 5e2211c17a3e5a48f5497de3 --provider AWS --region US_EAST_1 --tier M0 --tag env=dev + + +.. code-block:: + :copyable: false + + # Deploy a three-member replica set named myRS in AWS for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas cluster create myRS --projectId 5e2211c17a3e5a48f5497de3 --provider AWS --region US_EAST_1 --members 3 --tier M10 --mdbVersion 5.0 --diskSizeGB 10 + + +.. code-block:: + :copyable: false + + # Deploy a three-member replica set named myRS in AZURE for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas cluster create myRS --projectId 5e2211c17a3e5a48f5497de3 --provider AZURE --region US_EAST_2 --members 3 --tier M10 --mdbVersion 5.0 --diskSizeGB 10 + + +.. code-block:: + :copyable: false + + # Deploy a three-member replica set named myRS in GCP for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas cluster create myRS --projectId 5e2211c17a3e5a48f5497de3 --provider GCP --region EASTERN_US --members 3 --tier M10 --mdbVersion 5.0 --diskSizeGB 10 + + +.. code-block:: + :copyable: false + + # Deploy a cluster or a multi-cloud cluster from a JSON configuration file named myfile.json for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas cluster create --projectId --file myfile.json diff --git a/docs/command/atlas-clusters-delete.txt b/docs/command/atlas-clusters-delete.txt new file mode 100644 index 0000000000..cf9404e96d --- /dev/null +++ b/docs/command/atlas-clusters-delete.txt @@ -0,0 +1,120 @@ +.. _atlas-clusters-delete: + +===================== +atlas clusters delete +===================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Remove the specified cluster from your project. + +The command prompts you to confirm the operation when you run the command without the --force option. + +Deleting a cluster also deletes any backup snapshots for that cluster. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters delete [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - clusterName + - string + - true + - Name of the cluster to delete. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - -w, --watch + - + - false + - Flag that indicates whether to watch the command until it completes its execution or the watch times out. To set the time that the watch times out, use the --watchTimeout option. + * - --watchTimeout + - int + - false + - Time in seconds until a watch times out. After a watch times out, the CLI no longer watches the command. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Deleting cluster '' + +Examples +-------- + +.. code-block:: + :copyable: false + + # Remove a cluster named myCluster after prompting for a confirmation: + atlas clusters delete myCluster + + +.. code-block:: + :copyable: false + + # Remove a cluster named myCluster without requiring confirmation: + atlas clusters delete myCluster --force diff --git a/docs/command/atlas-clusters-describe.txt b/docs/command/atlas-clusters-describe.txt new file mode 100644 index 0000000000..859d243f87 --- /dev/null +++ b/docs/command/atlas-clusters-describe.txt @@ -0,0 +1,103 @@ +.. _atlas-clusters-describe: + +======================= +atlas clusters describe +======================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the details for the specified cluster for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters describe [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - clusterName + - string + - true + - Name of the cluster to retrieve. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID NAME MDB VER STATE + + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return the JSON-formatted details for the cluster named myCluster: + atlas clusters describe myCluster --output json diff --git a/docs/command/atlas-clusters-failover.txt b/docs/command/atlas-clusters-failover.txt new file mode 100644 index 0000000000..8d96a5dee8 --- /dev/null +++ b/docs/command/atlas-clusters-failover.txt @@ -0,0 +1,102 @@ +.. _atlas-clusters-failover: + +======================= +atlas clusters failover +======================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Starts a failover test for the specified cluster in the specified project. + +Clusters contain a group of hosts that maintain the same data set. A failover test checks how MongoDB Cloud handles the failure of the cluster's primary node. During the test, MongoDB Cloud shuts down the primary node and elects a new primary. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters failover [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - clusterName + - string + - true + - Human-readable label that identifies the cluster to start a failover test for. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for failover + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Failover test for '' started + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Test failover for a cluster named myCluster: + atlas clusters failover myCluster diff --git a/docs/command/atlas-clusters-indexes-create.txt b/docs/command/atlas-clusters-indexes-create.txt new file mode 100644 index 0000000000..a5316b9fc1 --- /dev/null +++ b/docs/command/atlas-clusters-indexes-create.txt @@ -0,0 +1,135 @@ +.. _atlas-clusters-indexes-create: + +============================= +atlas clusters indexes create +============================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create a rolling index for the specified cluster for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Data Access Admin role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters indexes create [indexName] [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - indexName + - string + - false + - Name of the index. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --clusterName + - string + - true + - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. + * - --collection + - string + - false + - Name of the collection. + + Mutually exclusive with --file. + * - --db + - string + - false + - Name of the database. + + Mutually exclusive with --file. + * - -f, --file + - string + - false + - Path to an optional JSON configuration file that defines index settings. + + Mutually exclusive with --db, --collection, --key. + * - -h, --help + - + - false + - help for create + * - --key + - strings + - false + - Field to be indexed and the type of index in the following format: field:type. + + Mutually exclusive with --file. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --sparse + - + - false + - Flag that creates a sparse index. To learn more, see https://dochub.mongodb.org/core/index-sparse-manual. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + # Create an index named bedrooms_1 on the listings collection of the realestate database: + atlas clusters indexes create bedrooms_1 --clusterName Cluster0 --collection listings --db realestate --key bedrooms:1 + + +.. code-block:: + :copyable: false + + # Create a compound index named property_room_bedrooms on the + listings collection of the realestate database: + atlas clusters indexes create property_room_bedrooms --clusterName Cluster0 --collection listings --db realestate --key property_type:1 --key room_type:1 --key bedrooms:1 + + +.. code-block:: + :copyable: false + + # Create an index named my_index from a JSON configuration file named myfile.json: + atlas clusters indexes create my_index --clusterName Cluster0 --file file.json diff --git a/docs/command/atlas-clusters-indexes.txt b/docs/command/atlas-clusters-indexes.txt new file mode 100644 index 0000000000..2fb07225f6 --- /dev/null +++ b/docs/command/atlas-clusters-indexes.txt @@ -0,0 +1,59 @@ +.. _atlas-clusters-indexes: + +====================== +atlas clusters indexes +====================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage cluster rolling indexes for your project. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for indexes + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-clusters-indexes-create` - Create a rolling index for the specified cluster for your project. + + +.. toctree:: + :titlesonly: + + create + diff --git a/docs/command/atlas-clusters-list.txt b/docs/command/atlas-clusters-list.txt new file mode 100644 index 0000000000..4c6815e5b5 --- /dev/null +++ b/docs/command/atlas-clusters-list.txt @@ -0,0 +1,103 @@ +.. _atlas-clusters-list: + +=================== +atlas clusters list +=================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all clusters for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - --omitCount + - + - false + - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --tier + - string + - false + - Tier for each data-bearing server in the cluster. To learn more about cluster tiers, see https://dochub.mongodb.org/core/cluster-tier-atlas. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID NAME MDB VER STATE + + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return a JSON-formatted list of all clusters for the project with ID 5e2211c17a3e5a48f5497de3: + atlas clusters list --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-clusters-onlineArchives-create.txt b/docs/command/atlas-clusters-onlineArchives-create.txt new file mode 100644 index 0000000000..02f59d6052 --- /dev/null +++ b/docs/command/atlas-clusters-onlineArchives-create.txt @@ -0,0 +1,139 @@ +.. _atlas-clusters-onlineArchives-create: + +==================================== +atlas clusters onlineArchives create +==================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create an online archive for a collection in the specified cluster. + +You can create an online archive for an M10 or larger cluster. + +To learn more about online archives, see https://www.mongodb.com/docs/atlas/online-archive/manage-online-archive/. + +To use this command, you must authenticate with a user account or an API key with the Project Data Access Admin role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters onlineArchives create [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --archiveAfter + - int + - false + - Number of days after which to archive cluster data. + + Mutually exclusive with --file. + * - --clusterName + - string + - true + - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. + * - --collection + - string + - false + - Name of the collection. + + Mutually exclusive with --file. + * - --dateField + - string + - false + - Name of an already indexed date field from the documents. + + Mutually exclusive with --file. + * - --dateFormat + - string + - false + - Date format for the date field. Valid values are "ISODATE", "EPOCH_SECONDS", "EPOCH_MILLIS", or "EPOCH_NANOSECONDS". + + Mutually exclusive with --file. This value defaults to "ISODATE". + * - --db + - string + - false + - Name of the database. + + Mutually exclusive with --file. + * - --expireAfterDays + - int + - false + - Number of days used in the date criteria for nominating documents for deletion. + + Mutually exclusive with --file. + * - --file + - string + - false + - Path to an optional JSON configuration file that defines online archive settings. To learn more about online archive configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-json-online-archive-config. + + Mutually exclusive with --db, --collection, --dateField, --dateFormat, --archiveAfter, --expireAfterDays, --partition. + * - -h, --help + - + - false + - help for create + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --partition + - strings + - false + - Fields to use to partition data. You can specify up to two frequently queried fields separated by a comma. + + Mutually exclusive with --file. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + # Create an online archive for the sample_mflix.movies collection in a cluster named myTestCluster when the current date is greater than the value of released date plus 2 days: + atlas clusters onlineArchive create --clusterName myTestCluster --db sample_mflix --collection movies --dateField released --archiveAfter 2 --output json + + +.. code-block:: + :copyable: false + + # Create an online archive for the sample_mflix.movies collection in a cluster named myTestCluster using a profile named egAtlasProfile when the current date is greater than the value of the released date plus 2 days. Data is partitioned based on the title field, year field, and released field from the documents in the collection: + atlas clusters onlineArchive create --clusterName myTestCluster --db sample_mflix --collection movies --dateField released --archiveAfter 2 --partition title,year --output json -P egAtlasProfile diff --git a/docs/command/atlas-clusters-onlineArchives-delete.txt b/docs/command/atlas-clusters-onlineArchives-delete.txt new file mode 100644 index 0000000000..1565262de1 --- /dev/null +++ b/docs/command/atlas-clusters-onlineArchives-delete.txt @@ -0,0 +1,106 @@ +.. _atlas-clusters-onlineArchives-delete: + +==================================== +atlas clusters onlineArchives delete +==================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Remove the specified online archive from your cluster. + +To use this command, you must authenticate with a user account or an API key with the Project Data Access Admin role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters onlineArchives delete [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - archiveId + - string + - true + - Unique identifier of the online archive to delete. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --clusterName + - string + - true + - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Archive '' deleted + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Remove an online archive with the ID 5f189832e26ec075e10c32d3 for the cluster named myCluster: + atlas clusters onlineArchives delete 5f189832e26ec075e10c32d3 --clusterName myCluster diff --git a/docs/command/atlas-clusters-onlineArchives-describe.txt b/docs/command/atlas-clusters-onlineArchives-describe.txt new file mode 100644 index 0000000000..61d98b1ab0 --- /dev/null +++ b/docs/command/atlas-clusters-onlineArchives-describe.txt @@ -0,0 +1,107 @@ +.. _atlas-clusters-onlineArchives-describe: + +====================================== +atlas clusters onlineArchives describe +====================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the details for the specified online archive for your cluster. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters onlineArchives describe [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - archiveId + - string + - true + - Unique identifier of the online archive to retrieve. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --clusterName + - string + - true + - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID CLUSTER DATABASE COLLECTION STATE + + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return the JSON-formatted details for the online archive with the ID 5f189832e26ec075e10c32d3 for the cluster named myCluster: + atlas clusters onlineArchives describe 5f189832e26ec075e10c32d3 --clusterName myCluster --output json diff --git a/docs/command/atlas-clusters-onlineArchives-list.txt b/docs/command/atlas-clusters-onlineArchives-list.txt new file mode 100644 index 0000000000..31303c36d0 --- /dev/null +++ b/docs/command/atlas-clusters-onlineArchives-list.txt @@ -0,0 +1,103 @@ +.. _atlas-clusters-onlineArchives-list: + +================================== +atlas clusters onlineArchives list +================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all online archives for your cluster. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters onlineArchives list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --clusterName + - string + - true + - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. + * - -h, --help + - + - false + - help for list + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - --omitCount + - + - false + - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID DATABASE COLLECTION STATE + + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return a JSON-formatted list of online archives for the cluster named myCluster: + atlas clusters onlineArchives list --clusterName myCluster --output json diff --git a/docs/command/atlas-clusters-onlineArchives-pause.txt b/docs/command/atlas-clusters-onlineArchives-pause.txt new file mode 100644 index 0000000000..996bf97623 --- /dev/null +++ b/docs/command/atlas-clusters-onlineArchives-pause.txt @@ -0,0 +1,106 @@ +.. _atlas-clusters-onlineArchives-pause: + +=================================== +atlas clusters onlineArchives pause +=================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Pause the specfied online archive for your cluster. + +To use this command, you must authenticate with a user account or an API key with the Project Data Access Admin role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters onlineArchives pause [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - archiveId + - string + - true + - Unique identifier of the online archive to pause. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --clusterName + - string + - true + - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. + * - -h, --help + - + - false + - help for pause + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Online archive '' paused. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Pause the online archive with the ID 5f189832e26ec075e10c32d3 for the cluster named myCluster: + atlas clusters onlineArchives pause 5f189832e26ec075e10c32d3 --clusterName myCluster --output json diff --git a/docs/command/atlas-clusters-onlineArchives-start.txt b/docs/command/atlas-clusters-onlineArchives-start.txt new file mode 100644 index 0000000000..9b9f22efdd --- /dev/null +++ b/docs/command/atlas-clusters-onlineArchives-start.txt @@ -0,0 +1,98 @@ +.. _atlas-clusters-onlineArchives-start: + +=================================== +atlas clusters onlineArchives start +=================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Start a paused online archive from a cluster. + +To use this command, you must authenticate with a user account or an API key with the Project Data Access Admin role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters onlineArchives start [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - archiveId + - string + - true + - Unique identifier of the online archive to start. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --clusterName + - string + - true + - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. + * - -h, --help + - + - false + - help for start + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Online archive '' started. + + diff --git a/docs/command/atlas-clusters-onlineArchives-update.txt b/docs/command/atlas-clusters-onlineArchives-update.txt new file mode 100644 index 0000000000..964cf5e365 --- /dev/null +++ b/docs/command/atlas-clusters-onlineArchives-update.txt @@ -0,0 +1,124 @@ +.. _atlas-clusters-onlineArchives-update: + +==================================== +atlas clusters onlineArchives update +==================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Modify the archiving rule for the specified online archive for a cluster. + +To use this command, you must authenticate with a user account or an API key with the Project Data Access Admin role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters onlineArchives update [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - archiveId + - string + - true + - Unique identifier of the online archive to update. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --archiveAfter + - int + - false + - Number of days after which to archive cluster data. + + Mutually exclusive with --file. + * - --clusterName + - string + - true + - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. + * - --expireAfterDays + - int + - false + - Number of days used in the date criteria for nominating documents for deletion. + + Mutually exclusive with --file. + * - --file + - string + - false + - Path to an optional JSON configuration file that defines online archive settings. To learn more about online archive configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-json-online-archive-config. + + Mutually exclusive with --archiveAfter, --expireAfterDays. + * - -h, --help + - + - false + - help for update + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Online archive '' updated. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Update the archiving rule to archive after 5 days for the online archive with the ID 5f189832e26ec075e10c32d3 for the cluster named myCluster: + atlas clusters onlineArchives update 5f189832e26ec075e10c32d3 --clusterName --archiveAfter 5 myCluster --output json diff --git a/docs/command/atlas-clusters-onlineArchives-watch.txt b/docs/command/atlas-clusters-onlineArchives-watch.txt new file mode 100644 index 0000000000..dd7d016207 --- /dev/null +++ b/docs/command/atlas-clusters-onlineArchives-watch.txt @@ -0,0 +1,107 @@ +.. _atlas-clusters-onlineArchives-watch: + +=================================== +atlas clusters onlineArchives watch +=================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Watch for an archive to be available. + +This command checks the archive's status periodically until it reaches a state different from PENDING or PAUSING. +Once the archive reaches the expected status, the command prints "Online archive available." +If you run the command in the terminal, it blocks the terminal session until the resource status changes to the expected status. +You can interrupt the command's polling at any time with CTRL-C. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters onlineArchives watch [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - archiveId + - string + - true + - Unique identifier of the online archive to watch. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --clusterName + - string + - false + - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. + * - -h, --help + - + - false + - help for watch + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + + Online archive available. + + +Examples +-------- + +.. code-block:: + :copyable: false + + atlas cluster onlineArchive watch archiveIdSample --clusterName clusterNameSample diff --git a/docs/command/atlas-clusters-onlineArchives.txt b/docs/command/atlas-clusters-onlineArchives.txt new file mode 100644 index 0000000000..b689acf59a --- /dev/null +++ b/docs/command/atlas-clusters-onlineArchives.txt @@ -0,0 +1,73 @@ +.. _atlas-clusters-onlineArchives: + +============================= +atlas clusters onlineArchives +============================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage online archives for your cluster. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for onlineArchives + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-clusters-onlineArchives-create` - Create an online archive for a collection in the specified cluster. +* :ref:`atlas-clusters-onlineArchives-delete` - Remove the specified online archive from your cluster. +* :ref:`atlas-clusters-onlineArchives-describe` - Return the details for the specified online archive for your cluster. +* :ref:`atlas-clusters-onlineArchives-list` - Return all online archives for your cluster. +* :ref:`atlas-clusters-onlineArchives-pause` - Pause the specfied online archive for your cluster. +* :ref:`atlas-clusters-onlineArchives-start` - Start a paused online archive from a cluster. +* :ref:`atlas-clusters-onlineArchives-update` - Modify the archiving rule for the specified online archive for a cluster. +* :ref:`atlas-clusters-onlineArchives-watch` - Watch for an archive to be available. + + +.. toctree:: + :titlesonly: + + create + delete + describe + list + pause + start + update + watch + diff --git a/docs/command/atlas-clusters-pause.txt b/docs/command/atlas-clusters-pause.txt new file mode 100644 index 0000000000..6f369603dc --- /dev/null +++ b/docs/command/atlas-clusters-pause.txt @@ -0,0 +1,103 @@ +.. _atlas-clusters-pause: + +==================== +atlas clusters pause +==================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Pause the specified running MongoDB cluster. + +To use this command, you must authenticate with a user account or an API key with the Project Cluster Manager role. +Atlas supports this command only for M10+ clusters. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters pause [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - clusterName + - string + - true + - Name of the cluster to pause. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for pause + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Pausing cluster ''. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Pause the cluster named myCluster for the project with ID 5e2211c17a3e5a48f5497de3: + atlas clusters pause myCluster --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-clusters-sampleData-describe.txt b/docs/command/atlas-clusters-sampleData-describe.txt new file mode 100644 index 0000000000..4582679f53 --- /dev/null +++ b/docs/command/atlas-clusters-sampleData-describe.txt @@ -0,0 +1,103 @@ +.. _atlas-clusters-sampleData-describe: + +================================== +atlas clusters sampleData describe +================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the details for the specified sample data load job. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters sampleData describe [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - id + - string + - true + - Unique identifier of the sample data job. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID CLUSTER NAME STATE + + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return the JSON-formatted details for the sample data load job: + atlas clusters sampleData describe 5e98249d937cfc52efdc2a9f --output json diff --git a/docs/command/atlas-clusters-sampleData-load.txt b/docs/command/atlas-clusters-sampleData-load.txt new file mode 100644 index 0000000000..89f96848c5 --- /dev/null +++ b/docs/command/atlas-clusters-sampleData-load.txt @@ -0,0 +1,102 @@ +.. _atlas-clusters-sampleData-load: + +============================== +atlas clusters sampleData load +============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Load sample data into the specified cluster for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters sampleData load [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - clusterName + - string + - true + - Name of the cluster for which you want to load sample data. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for load + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Sample Data Job created. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Load sample data into the cluster named myCluster: + atlas clusters sampleData load myCluster --output json diff --git a/docs/command/atlas-clusters-sampleData-watch.txt b/docs/command/atlas-clusters-sampleData-watch.txt new file mode 100644 index 0000000000..6999b01897 --- /dev/null +++ b/docs/command/atlas-clusters-sampleData-watch.txt @@ -0,0 +1,103 @@ +.. _atlas-clusters-sampleData-watch: + +=============================== +atlas clusters sampleData watch +=============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Watch the specified sample data job in your cluster until it completes. + +This command checks the sample data job's status periodically until it reaches an COMPLETED state. +If you run the command in the terminal, it blocks the terminal session until the resource state changes to COMPLETED. +You can interrupt the command's polling at any time with CTRL-C. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters sampleData watch [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - id + - string + - true + - Unique identifier of the sample data job. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for watch + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + + Sample data available. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Watch for the sample data job with ID 5e2211c17a3e5a48f5497de3 to complete: + atlas clusters sampledata watch 5e2211c17a3e5a48f5497de3 diff --git a/docs/command/atlas-clusters-sampleData.txt b/docs/command/atlas-clusters-sampleData.txt new file mode 100644 index 0000000000..60fb597813 --- /dev/null +++ b/docs/command/atlas-clusters-sampleData.txt @@ -0,0 +1,65 @@ +.. _atlas-clusters-sampleData: + +========================= +atlas clusters sampleData +========================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage sample data for your cluster. + +The sampleData command provides access to sample data to be loaded onto your cluster. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for sampleData + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-clusters-sampleData-describe` - Return the details for the specified sample data load job. +* :ref:`atlas-clusters-sampleData-load` - Load sample data into the specified cluster for your project. +* :ref:`atlas-clusters-sampleData-watch` - Watch the specified sample data job in your cluster until it completes. + + +.. toctree:: + :titlesonly: + + describe + load + watch + diff --git a/docs/command/atlas-clusters-search-indexes-create.txt b/docs/command/atlas-clusters-search-indexes-create.txt new file mode 100644 index 0000000000..798abf7b66 --- /dev/null +++ b/docs/command/atlas-clusters-search-indexes-create.txt @@ -0,0 +1,110 @@ +.. _atlas-clusters-search-indexes-create: + +==================================== +atlas clusters search indexes create +==================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create a search index for a cluster. + +To use this command, you must authenticate with a user account or an API key with the Project Data Access Admin role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters search indexes create [indexName] [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - indexName + - string + - false + - Name of the index. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --clusterName + - string + - true + - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. + * - -f, --file + - string + - false + - Name of the JSON index configuration file to use. To learn about the Atlas Search and Atlas Vector Search index configuration file, see https://dochub.mongodb.org/core/search-index-config-file-atlascli. To learn about the Atlas Search index syntax and options that you can define in your configuration file, see https://dochub.mongodb.org/core/index-definitions-fts. To learn about the Atlas Vector Search index syntax and options that you can define in your configuration file, see https://dochub.mongodb.org/core/index-definition-avs. + * - -h, --help + - + - false + - help for create + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Index created. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Create a search index for the cluster named myCluster using a JSON index configuration file named search-config.json: + atlas clusters search indexes create --clusterName myCluster --file search-config.json --output json diff --git a/docs/command/atlas-clusters-search-indexes-delete.txt b/docs/command/atlas-clusters-search-indexes-delete.txt new file mode 100644 index 0000000000..7541ce1050 --- /dev/null +++ b/docs/command/atlas-clusters-search-indexes-delete.txt @@ -0,0 +1,106 @@ +.. _atlas-clusters-search-indexes-delete: + +==================================== +atlas clusters search indexes delete +==================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Delete the specified search index from the specified cluster. + +To use this command, you must authenticate with a user account or an API key with the Project Data Access Admin role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters search indexes delete [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - indexId + - string + - true + - ID of the index. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --clusterName + - string + - true + - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Index '' deleted + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Delete the search index with the ID 5f2099cd683fc55fbb30bef6 for the cluster named myCluster without requiring confirmation: + atlas clusters search indexes delete 5f2099cd683fc55fbb30bef6 --clusterName myCluster --force diff --git a/docs/command/atlas-clusters-search-indexes-describe.txt b/docs/command/atlas-clusters-search-indexes-describe.txt new file mode 100644 index 0000000000..eef63fa825 --- /dev/null +++ b/docs/command/atlas-clusters-search-indexes-describe.txt @@ -0,0 +1,107 @@ +.. _atlas-clusters-search-indexes-describe: + +====================================== +atlas clusters search indexes describe +====================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the details for the search index for a cluster. + +To use this command, you must authenticate with a user account or an API key with the Project Data Access Read/Write role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters search indexes describe [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - indexId + - string + - true + - ID of the index. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --clusterName + - string + - true + - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID NAME DATABASE COLLECTION TYPE + + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return the JSON-formatted details for the search index with the ID 5f1f40842f2ac35f49190c20 for the cluster named myCluster: + atlas clusters search indexes describe 5f1f40842f2ac35f49190c20 --clusterName myCluster --output json diff --git a/docs/command/atlas-clusters-search-indexes-list.txt b/docs/command/atlas-clusters-search-indexes-list.txt new file mode 100644 index 0000000000..e17eb4d23a --- /dev/null +++ b/docs/command/atlas-clusters-search-indexes-list.txt @@ -0,0 +1,99 @@ +.. _atlas-clusters-search-indexes-list: + +================================== +atlas clusters search indexes list +================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +List all Atlas Search indexes for a cluster. + +To use this command, you must authenticate with a user account or an API key with the Project Data Access Read/Write role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters search indexes list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --clusterName + - string + - true + - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. + * - --collection + - string + - true + - Name of the collection. + * - --db + - string + - true + - Name of the database. + * - -h, --help + - + - false + - help for list + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID NAME DATABASE COLLECTION TYPE + + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return the JSON-formatted list of Atlas search indexes on the sample_mflix.movies database in the cluster named myCluster: + atlas clusters search indexes list --clusterName myCluster --db sample_mflix --collection movies --output json diff --git a/docs/command/atlas-clusters-search-indexes-update.txt b/docs/command/atlas-clusters-search-indexes-update.txt new file mode 100644 index 0000000000..87c5a17dd3 --- /dev/null +++ b/docs/command/atlas-clusters-search-indexes-update.txt @@ -0,0 +1,110 @@ +.. _atlas-clusters-search-indexes-update: + +==================================== +atlas clusters search indexes update +==================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Modify a search index for a cluster. + +To use this command, you must authenticate with a user account or an API key with the Project Data Access Admin role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters search indexes update [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - indexId + - string + - true + - ID of the index. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --clusterName + - string + - true + - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. + * - -f, --file + - string + - false + - Name of the JSON index configuration file to use. To learn about the Atlas Search and Atlas Vector Search index configuration file, see https://dochub.mongodb.org/core/search-index-config-file-atlascli. To learn about the Atlas Search index syntax and options that you can define in your configuration file, see https://dochub.mongodb.org/core/index-definitions-fts. To learn about the Atlas Vector Search index syntax and options that you can define in your configuration file, see https://dochub.mongodb.org/core/index-definition-avs. + * - -h, --help + - + - false + - help for update + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Index updated. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Modify the search index with the ID 5f2099cd683fc55fbb30bef6 for the cluster named myCluster: + atlas clusters search indexes update 5f2099cd683fc55fbb30bef6 --clusterName myCluster --output json diff --git a/docs/command/atlas-clusters-search-indexes.txt b/docs/command/atlas-clusters-search-indexes.txt new file mode 100644 index 0000000000..160e679678 --- /dev/null +++ b/docs/command/atlas-clusters-search-indexes.txt @@ -0,0 +1,67 @@ +.. _atlas-clusters-search-indexes: + +============================= +atlas clusters search indexes +============================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage Atlas Search indexes for your cluster. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for indexes + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-clusters-search-indexes-create` - Create a search index for a cluster. +* :ref:`atlas-clusters-search-indexes-delete` - Delete the specified search index from the specified cluster. +* :ref:`atlas-clusters-search-indexes-describe` - Return the details for the search index for a cluster. +* :ref:`atlas-clusters-search-indexes-list` - List all Atlas Search indexes for a cluster. +* :ref:`atlas-clusters-search-indexes-update` - Modify a search index for a cluster. + + +.. toctree:: + :titlesonly: + + create + delete + describe + list + update + diff --git a/docs/command/atlas-clusters-search-nodes-create.txt b/docs/command/atlas-clusters-search-nodes-create.txt new file mode 100644 index 0000000000..b60cc0fa92 --- /dev/null +++ b/docs/command/atlas-clusters-search-nodes-create.txt @@ -0,0 +1,102 @@ +.. _atlas-clusters-search-nodes-create: + +================================== +atlas clusters search nodes create +================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create a search node for a cluster. + +To use this command, you must authenticate with a user account or an API key with the Organization Owner or Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters search nodes create [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --clusterName + - string + - true + - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. + * - -f, --file + - string + - true + - Name of the JSON index configuration file to use. To learn about the Atlas Search Nodes configuration file, see https://dochub.mongodb.org/core/search-nodes-config-file-atlascli. + * - -h, --help + - + - false + - help for create + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - -w, --watch + - + - false + - Flag that indicates whether to watch the command until it completes its execution or the watch times out. + * - --watchTimeout + - int + - false + - Time in seconds until a watch times out. After a watch times out, the CLI no longer watches the command. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Search nodes are being created. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Create a search node for the cluster named myCluster using a JSON node spec configuration file named spec.json: + atlas clusters search nodes create --clusterName myCluster --file spec.json --output json diff --git a/docs/command/atlas-clusters-search-nodes-delete.txt b/docs/command/atlas-clusters-search-nodes-delete.txt new file mode 100644 index 0000000000..fff9832631 --- /dev/null +++ b/docs/command/atlas-clusters-search-nodes-delete.txt @@ -0,0 +1,92 @@ +.. _atlas-clusters-search-nodes-delete: + +================================== +atlas clusters search nodes delete +================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Delete a search node for a cluster. + +To use this command, you must authenticate with a user account or an API key with the Organization Owner or Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters search nodes delete [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --clusterName + - string + - true + - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - -w, --watch + - + - false + - Flag that indicates whether to watch the command until it completes its execution or the watch times out. + * - --watchTimeout + - int + - false + - Time in seconds until a watch times out. After a watch times out, the CLI no longer watches the command. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + # Delete a search node for the cluster named myCluster: + atlas clusters search nodes delete --clusterName myCluster diff --git a/docs/command/atlas-clusters-search-nodes-list.txt b/docs/command/atlas-clusters-search-nodes-list.txt new file mode 100644 index 0000000000..c0d3460121 --- /dev/null +++ b/docs/command/atlas-clusters-search-nodes-list.txt @@ -0,0 +1,91 @@ +.. _atlas-clusters-search-nodes-list: + +================================ +atlas clusters search nodes list +================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +List all Atlas Search nodes for a cluster. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters search nodes list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --clusterName + - string + - true + - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. + * - -h, --help + - + - false + - help for list + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID STATE INSTANCE SIZE NODE COUNT{{ $id:=.Id>{{ $state:=.StateName > + {{$id> {{$state> + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return the JSON-formatted list of Atlas search nodes in the cluster named myCluster: + atlas clusters search nodes list --clusterName myCluster --output json diff --git a/docs/command/atlas-clusters-search-nodes-update.txt b/docs/command/atlas-clusters-search-nodes-update.txt new file mode 100644 index 0000000000..bab41d6284 --- /dev/null +++ b/docs/command/atlas-clusters-search-nodes-update.txt @@ -0,0 +1,102 @@ +.. _atlas-clusters-search-nodes-update: + +================================== +atlas clusters search nodes update +================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Update a search node for a cluster. + +To use this command, you must authenticate with a user account or an API key with the Organization Owner or Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters search nodes update [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --clusterName + - string + - true + - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. + * - -f, --file + - string + - true + - Name of the JSON index configuration file to use. To learn about the Atlas Search Nodes configuration file, see https://dochub.mongodb.org/core/search-nodes-config-file-atlascli. + * - -h, --help + - + - false + - help for update + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - -w, --watch + - + - false + - Flag that indicates whether to watch the command until it completes its execution or the watch times out. + * - --watchTimeout + - int + - false + - Time in seconds until a watch times out. After a watch times out, the CLI no longer watches the command. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Started updating search nodes. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Update a search node for the cluster named myCluster using a JSON node spec configuration file named spec.json: + atlas clusters search nodes update --clusterName myCluster --file spec.json --output json diff --git a/docs/command/atlas-clusters-search-nodes.txt b/docs/command/atlas-clusters-search-nodes.txt new file mode 100644 index 0000000000..958a089711 --- /dev/null +++ b/docs/command/atlas-clusters-search-nodes.txt @@ -0,0 +1,65 @@ +.. _atlas-clusters-search-nodes: + +=========================== +atlas clusters search nodes +=========================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage Atlas Search nodes for your cluster. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for nodes + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-clusters-search-nodes-create` - Create a search node for a cluster. +* :ref:`atlas-clusters-search-nodes-delete` - Delete a search node for a cluster. +* :ref:`atlas-clusters-search-nodes-list` - List all Atlas Search nodes for a cluster. +* :ref:`atlas-clusters-search-nodes-update` - Update a search node for a cluster. + + +.. toctree:: + :titlesonly: + + create + delete + list + update + diff --git a/docs/command/atlas-clusters-search.txt b/docs/command/atlas-clusters-search.txt new file mode 100644 index 0000000000..d8ffd2b0ba --- /dev/null +++ b/docs/command/atlas-clusters-search.txt @@ -0,0 +1,61 @@ +.. _atlas-clusters-search: + +===================== +atlas clusters search +===================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage Atlas Search for your cluster. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for search + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-clusters-search-indexes` - Manage Atlas Search indexes for your cluster. +* :ref:`atlas-clusters-search-nodes` - Manage Atlas Search nodes for your cluster. + + +.. toctree:: + :titlesonly: + + indexes + nodes + diff --git a/docs/command/atlas-clusters-start.txt b/docs/command/atlas-clusters-start.txt new file mode 100644 index 0000000000..943c8f079f --- /dev/null +++ b/docs/command/atlas-clusters-start.txt @@ -0,0 +1,103 @@ +.. _atlas-clusters-start: + +==================== +atlas clusters start +==================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Start the specified paused MongoDB cluster. + +To use this command, you must authenticate with a user account or an API key with the Project Cluster Manager role. +Atlas supports this command only for M10+ clusters. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters start [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - clusterName + - string + - true + - Name of the cluster to start. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for start + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Starting cluster ''. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Start a cluster named myCluster for the project with ID 5e2211c17a3e5a48f5497de3: + atlas clusters start myCluster --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-clusters-update.txt b/docs/command/atlas-clusters-update.txt new file mode 100644 index 0000000000..858079e5a8 --- /dev/null +++ b/docs/command/atlas-clusters-update.txt @@ -0,0 +1,184 @@ +.. _atlas-clusters-update: + +===================== +atlas clusters update +===================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Modify the settings of the specified cluster. + +You can specify modifications in a JSON configuration file with the --file flag. + +You can't change the name of the cluster or downgrade the MongoDB version of your cluster. + +You can only update a replica set to a single-shard cluster; you cannot update a replica set to a multi-sharded cluster. To learn more, see https://www.mongodb.com/docs/atlas/scale-cluster/#convert-a-replica-set-to-a-sharded-cluster and https://www.mongodb.com/docs/upcoming/tutorial/convert-replica-set-to-replicated-shard-cluster. + +To use this command, you must authenticate with a user account or an API key with the Project Cluster Manager role. +Atlas supports this command only for M10+ clusters + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters update [clusterName] [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - clusterName + - string + - false + - Name of the cluster to update. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --disableTerminationProtection + - + - false + - Disables termination protection for your cluster. You can delete a cluster with termination protection disabled. + + Mutually exclusive with --enableTerminationProtection, --file. + * - --diskSizeGB + - float + - false + - Capacity, in gigabytes, of the host's root volume. + + Mutually exclusive with --file. + * - --enableTerminationProtection + - + - false + - Enables termination protection for your cluster. You can't delete a cluster with termination protection enabled. + + Mutually exclusive with --disableTerminationProtection, --file. + * - -f, --file + - string + - false + - Path to an optional JSON configuration file that defines cluster settings. To learn more about cluster configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/cluster-config-file-atlascli. + + Mutually exclusive with --tier, --diskSizeGB, --enableTerminationProtection, --disableTerminationProtection, --tag. + * - -h, --help + - + - false + - help for update + * - --mdbVersion + - string + - false + - Major MongoDB version of the cluster. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --tag + - key=value + - false + - List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. Passing this flag replaces preexisting data. + + Mutually exclusive with --file. + * - --tier + - string + - false + - Tier for each data-bearing server in the cluster. To learn more about cluster tiers, see https://dochub.mongodb.org/core/cluster-tier-atlas. + + Mutually exclusive with --file. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Updating cluster ''. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Update the tier for a cluster named myCluster for the project with ID 5e2211c17a3e5a48f5497de3: + atlas cluster update myCluster --projectId 5e2211c17a3e5a48f5497de3 --tier M50 + + +.. code-block:: + :copyable: false + + # Replace tags cluster named myCluster for the project with ID 5e2211c17a3e5a48f5497de3: + atlas cluster update myCluster --projectId 5e2211c17a3e5a48f5497de3 --tag key1=value1 + + +.. code-block:: + :copyable: false + + # Remove all tags from cluster named myCluster for the project with ID 5e2211c17a3e5a48f5497de3: + atlas cluster update myCluster --projectId 5e2211c17a3e5a48f5497de3 --tag = + + +.. code-block:: + :copyable: false + + # Update the disk size for a cluster named myCluster for the project with ID 5e2211c17a3e5a48f5497de3: + atlas cluster update myCluster --projectId 5e2211c17a3e5a48f5497de3 --diskSizeGB 20 + + +.. code-block:: + :copyable: false + + # Update the MongoDB version for a cluster named myCluster for the project with ID 5e2211c17a3e5a48f5497de3: + atlas cluster update myCluster --projectId 5e2211c17a3e5a48f5497de3 --mdbVersion 5.0 + + +.. code-block:: + :copyable: false + + # Use a configuration file named cluster-config.json to update a cluster named myCluster for the project with ID 5e2211c17a3e5a48f5497de3: + atlas cluster update myCluster --projectId 5e2211c17a3e5a48f5497de3 --file cluster-config.json --output json diff --git a/docs/command/atlas-clusters-upgrade.txt b/docs/command/atlas-clusters-upgrade.txt new file mode 100644 index 0000000000..0ad728e87a --- /dev/null +++ b/docs/command/atlas-clusters-upgrade.txt @@ -0,0 +1,146 @@ +.. _atlas-clusters-upgrade: + +====================== +atlas clusters upgrade +====================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Upgrade a shared cluster's tier, disk size, and/or MongoDB version. + +This command is unavailable for dedicated clusters. + +To use this command, you must authenticate with a user account or an API key with the Project Cluster Manager role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters upgrade [clusterName] [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - clusterName + - string + - false + - Name of the cluster to upgrade. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --disableTerminationProtection + - + - false + - Disables termination protection for your cluster. You can delete a cluster with termination protection disabled. + + Mutually exclusive with --enableTerminationProtection, --file. + * - --diskSizeGB + - float + - false + - Capacity, in gigabytes, of the host's root volume. + + Mutually exclusive with --file. + * - --enableTerminationProtection + - + - false + - Enables termination protection for your cluster. You can't delete a cluster with termination protection enabled. + + Mutually exclusive with --disableTerminationProtection, --file. + * - -f, --file + - string + - false + - Path to an optional JSON configuration file that defines cluster settings. To learn more about cluster configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/cluster-config-file-atlascli. + + Mutually exclusive with --tier, --diskSizeGB, --mdbVersion, --enableTerminationProtection, --disableTerminationProtection, --tag. + * - -h, --help + - + - false + - help for upgrade + * - --mdbVersion + - string + - false + - Major MongoDB version of the cluster. + + Mutually exclusive with --file. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --tag + - key=value + - false + - List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. Passing this flag replaces preexisting data. + + Mutually exclusive with --file. + * - --tier + - string + - false + - Tier for each data-bearing server in the cluster. To learn more about cluster tiers, see https://dochub.mongodb.org/core/cluster-tier-atlas. + + Mutually exclusive with --file. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Upgrading cluster ''. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Upgrade the tier, disk size, and MongoDB version for the shared cluster named myCluster in the project with the ID 5e2211c17a3e5a48f5497de3: + atlas cluster upgrade myCluster --projectId 5e2211c17a3e5a48f5497de3 --tier M50 --diskSizeGB 20 --mdbVersion 7.0 --tag env=dev diff --git a/docs/command/atlas-clusters-watch.txt b/docs/command/atlas-clusters-watch.txt new file mode 100644 index 0000000000..9370e54689 --- /dev/null +++ b/docs/command/atlas-clusters-watch.txt @@ -0,0 +1,104 @@ +.. _atlas-clusters-watch: + +==================== +atlas clusters watch +==================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Watch the specified cluster in your project until it becomes available. + +This command checks the cluster's status periodically until it reaches an IDLE state. +Once the cluster reaches the expected state, the command prints "Cluster available." +If you run the command in the terminal, it blocks the terminal session until the resource state changes to IDLE. +You can interrupt the command's polling at any time with CTRL-C. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters watch [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - clusterName + - string + - true + - Name of the cluster to watch. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for watch + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + + Cluster available. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Watch for the cluster named myCluster to become available for the project with ID 5e2211c17a3e5a48f5497de3: + atlas clusters watch myCluster --projectId 5e2211c17a3e5a48f5497de3 diff --git a/docs/command/atlas-clusters.txt b/docs/command/atlas-clusters.txt new file mode 100644 index 0000000000..5f49f0d466 --- /dev/null +++ b/docs/command/atlas-clusters.txt @@ -0,0 +1,93 @@ +.. _atlas-clusters: + +============== +atlas clusters +============== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage clusters for your project. + +The clusters command provides access to your cluster configurations. You can create, edit, and delete clusters. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for clusters + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-clusters-advancedSettings` - Manage advanced configuration settings for your cluster. +* :ref:`atlas-clusters-availableRegions` - Manage available regions for your project. +* :ref:`atlas-clusters-connectionStrings` - Manage MongoDB cluster connection string. +* :ref:`atlas-clusters-create` - Create a cluster for your project. +* :ref:`atlas-clusters-delete` - Remove the specified cluster from your project. +* :ref:`atlas-clusters-describe` - Return the details for the specified cluster for your project. +* :ref:`atlas-clusters-failover` - Starts a failover test for the specified cluster in the specified project. +* :ref:`atlas-clusters-indexes` - Manage cluster rolling indexes for your project. +* :ref:`atlas-clusters-list` - Return all clusters for your project. +* :ref:`atlas-clusters-onlineArchives` - Manage online archives for your cluster. +* :ref:`atlas-clusters-pause` - Pause the specified running MongoDB cluster. +* :ref:`atlas-clusters-sampleData` - Manage sample data for your cluster. +* :ref:`atlas-clusters-search` - Manage Atlas Search for your cluster. +* :ref:`atlas-clusters-start` - Start the specified paused MongoDB cluster. +* :ref:`atlas-clusters-update` - Modify the settings of the specified cluster. +* :ref:`atlas-clusters-upgrade` - Upgrade a shared cluster's tier, disk size, and/or MongoDB version. +* :ref:`atlas-clusters-watch` - Watch the specified cluster in your project until it becomes available. + + +.. toctree:: + :titlesonly: + + advancedSettings + availableRegions + connectionStrings + create + delete + describe + failover + indexes + list + onlineArchives + pause + sampleData + search + start + update + upgrade + watch + diff --git a/docs/command/atlas-completion-bash.txt b/docs/command/atlas-completion-bash.txt new file mode 100644 index 0000000000..14d36aabc8 --- /dev/null +++ b/docs/command/atlas-completion-bash.txt @@ -0,0 +1,76 @@ +.. _atlas-completion-bash: + +===================== +atlas completion bash +===================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Generate the autocompletion script for bash + + +Generate the autocompletion script for the bash shell. +This script depends on the 'bash-completion' package. +If it is not installed already, you can install it via your OS's package manager. +To load completions in your current shell session: +$ source <(atlas completion bash) +To load completions for every new session, execute once: +Linux: +$ atlas completion bash > /etc/bash_completion.d/atlas +MacOS: +$ atlas completion bash > /usr/local/etc/bash_completion.d/atlas +You will need to start a new shell for this setup to take effect. + + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas completion bash + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for bash + * - --no-descriptions + - + - false + - disable completion descriptions + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + diff --git a/docs/command/atlas-completion-fish.txt b/docs/command/atlas-completion-fish.txt new file mode 100644 index 0000000000..cdb18085f7 --- /dev/null +++ b/docs/command/atlas-completion-fish.txt @@ -0,0 +1,75 @@ +.. _atlas-completion-fish: + +===================== +atlas completion fish +===================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Generate the autocompletion script for fish + +Generate the autocompletion script for the fish shell. + +To load completions in your current shell session: + + atlas completion fish | source + +To load completions for every new session, execute once: + + atlas completion fish > ~/.config/fish/completions/atlas.fish + +You will need to start a new shell for this setup to take effect. + + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas completion fish [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for fish + * - --no-descriptions + - + - false + - disable completion descriptions + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + diff --git a/docs/command/atlas-completion-powershell.txt b/docs/command/atlas-completion-powershell.txt new file mode 100644 index 0000000000..4ec9d22b11 --- /dev/null +++ b/docs/command/atlas-completion-powershell.txt @@ -0,0 +1,72 @@ +.. _atlas-completion-powershell: + +=========================== +atlas completion powershell +=========================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Generate the autocompletion script for powershell + +Generate the autocompletion script for powershell. + +To load completions in your current shell session: + + atlas completion powershell | Out-String | Invoke-Expression + +To load completions for every new session, add the output of the above command +to your powershell profile. + + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas completion powershell [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for powershell + * - --no-descriptions + - + - false + - disable completion descriptions + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + diff --git a/docs/command/atlas-completion-zsh.txt b/docs/command/atlas-completion-zsh.txt new file mode 100644 index 0000000000..f5052fa504 --- /dev/null +++ b/docs/command/atlas-completion-zsh.txt @@ -0,0 +1,86 @@ +.. _atlas-completion-zsh: + +==================== +atlas completion zsh +==================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Generate the autocompletion script for zsh + +Generate the autocompletion script for the zsh shell. + +If shell completion is not already enabled in your environment you will need +to enable it. You can execute the following once: + + echo "autoload -U compinit; compinit" >> ~/.zshrc + +To load completions in your current shell session: + + source <(atlas completion zsh) + +To load completions for every new session, execute once: + +#### Linux: + + atlas completion zsh > "${fpath[1]}/_atlas" + +#### macOS: + + atlas completion zsh > $(brew --prefix)/share/zsh/site-functions/_atlas + +You will need to start a new shell for this setup to take effect. + + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas completion zsh [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for zsh + * - --no-descriptions + - + - false + - disable completion descriptions + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + diff --git a/docs/command/atlas-completion.txt b/docs/command/atlas-completion.txt new file mode 100644 index 0000000000..57d74af29c --- /dev/null +++ b/docs/command/atlas-completion.txt @@ -0,0 +1,69 @@ +.. _atlas-completion: + +================ +atlas completion +================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Generate the autocompletion script for the specified shell + +Generate the autocompletion script for atlas for the specified shell. +See each sub-command's help for details on how to use the generated script. + + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for completion + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-completion-bash` - Generate the autocompletion script for bash +* :ref:`atlas-completion-fish` - Generate the autocompletion script for fish +* :ref:`atlas-completion-powershell` - Generate the autocompletion script for powershell +* :ref:`atlas-completion-zsh` - Generate the autocompletion script for zsh + + +.. toctree:: + :titlesonly: + + bash + fish + powershell + zsh + diff --git a/docs/command/atlas-config-delete.txt b/docs/command/atlas-config-delete.txt new file mode 100644 index 0000000000..767cc09906 --- /dev/null +++ b/docs/command/atlas-config-delete.txt @@ -0,0 +1,103 @@ +.. _atlas-config-delete: + +=================== +atlas config delete +=================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Delete a profile. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas config delete [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - name + - string + - true + - Name of the profile. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Profile '' deleted + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Delete the default profile configuration: + atlas config delete default + + +.. code-block:: + :copyable: false + + # Skip the confirmation question and delete the default profile configuration: + atlas config delete default --force diff --git a/docs/command/atlas-config-describe.txt b/docs/command/atlas-config-describe.txt new file mode 100644 index 0000000000..56359f1812 --- /dev/null +++ b/docs/command/atlas-config-describe.txt @@ -0,0 +1,78 @@ +.. _atlas-config-describe: + +===================== +atlas config describe +===================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the profile you specify. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas config describe [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - name + - string + - true + - Label that identifies the profile. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + diff --git a/docs/command/atlas-config-edit.txt b/docs/command/atlas-config-edit.txt new file mode 100644 index 0000000000..3f79872c73 --- /dev/null +++ b/docs/command/atlas-config-edit.txt @@ -0,0 +1,74 @@ +.. _atlas-config-edit: + +================= +atlas config edit +================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Opens the config file with the default text editor. + +Uses the default editor to open the config file. You can use EDITOR or VISUAL envs to change the default. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas config edit [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for edit + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + # To open the config + atlas config edit + + +.. toctree:: + :titlesonly: + + diff --git a/docs/command/atlas-config-init.txt b/docs/command/atlas-config-init.txt new file mode 100644 index 0000000000..5869b38318 --- /dev/null +++ b/docs/command/atlas-config-init.txt @@ -0,0 +1,77 @@ +.. _atlas-config-init: + +================= +atlas config init +================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Configure a profile to store access settings for your MongoDB deployment. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas config init [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --gov + - + - false + - Create a default profile for atlas for gov + * - -h, --help + - + - false + - help for init + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + # To configure the tool to work with Atlas: + atlas config init + + +.. code-block:: + :copyable: false + + # To configure the tool to work with Atlas for Government: + atlas config init --gov diff --git a/docs/command/atlas-config-list.txt b/docs/command/atlas-config-list.txt new file mode 100644 index 0000000000..36cee08ac7 --- /dev/null +++ b/docs/command/atlas-config-list.txt @@ -0,0 +1,71 @@ +.. _atlas-config-list: + +================= +atlas config list +================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return a list of available profiles by name. + +If you did not specify a name for your profile, it displays as the default profile. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas config list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + atlas config ls diff --git a/docs/command/atlas-config-rename.txt b/docs/command/atlas-config-rename.txt new file mode 100644 index 0000000000..cd801e52d7 --- /dev/null +++ b/docs/command/atlas-config-rename.txt @@ -0,0 +1,86 @@ +.. _atlas-config-rename: + +=================== +atlas config rename +=================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Rename a profile. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas config rename [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - oldProfileName + - string + - true + - Name of the profile to rename. + * - newProfileName + - string + - true + - New name of the profile. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for rename + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + # Rename a profile called myProfile to testProfile: + atlas config rename myProfile testProfile diff --git a/docs/command/atlas-config-set.txt b/docs/command/atlas-config-set.txt new file mode 100644 index 0000000000..dd1be889b6 --- /dev/null +++ b/docs/command/atlas-config-set.txt @@ -0,0 +1,87 @@ +.. _atlas-config-set: + +================ +atlas config set +================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Configure specific properties of a profile. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas config set [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - propertyName + - string + - true + - Property to set in the profile. Valid values for Atlas CLI are project_id, org_id, service, public_api_key, private_api_key, output, mongosh_path, skip_update_check, telemetry_enabled, access_token, and refresh_token. + * - value + - string + - true + - Value for the property to set in the profile. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for set + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + + Set the organization ID in the default profile to 5dd5aaef7a3e5a6c5bd12de4: + atlas config set org_id 5dd5aaef7a3e5a6c5bd12de4 diff --git a/docs/command/atlas-config.txt b/docs/command/atlas-config.txt new file mode 100644 index 0000000000..407faf6a3a --- /dev/null +++ b/docs/command/atlas-config.txt @@ -0,0 +1,78 @@ +.. _atlas-config: + +============ +atlas config +============ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Configure and manage your user profiles. + +Configure settings in a user profile. +All settings are optional. You can specify settings individually by running: +$ atlas config set --help + +You can also use environment variables (MONGODB_ATLAS_*) when running the tool. +To find out more, see the documentation: https://dochub.mongodb.org/core/atlas-cli-env-variables. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for config + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-config-delete` - Delete a profile. +* :ref:`atlas-config-describe` - Return the profile you specify. +* :ref:`atlas-config-edit` - Opens the config file with the default text editor. +* :ref:`atlas-config-init` - Configure a profile to store access settings for your MongoDB deployment. +* :ref:`atlas-config-list` - Return a list of available profiles by name. +* :ref:`atlas-config-rename` - Rename a profile. +* :ref:`atlas-config-set` - Configure specific properties of a profile. + + +.. toctree:: + :titlesonly: + + delete + describe + edit + init + list + rename + set + diff --git a/docs/command/atlas-customDbRoles-create.txt b/docs/command/atlas-customDbRoles-create.txt new file mode 100644 index 0000000000..9b8a215906 --- /dev/null +++ b/docs/command/atlas-customDbRoles-create.txt @@ -0,0 +1,131 @@ +.. _atlas-customDbRoles-create: + +========================== +atlas customDbRoles create +========================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create a custom database role for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas customDbRoles create [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - roleName + - string + - true + - Name of the custom role to create. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for create + * - --inheritedRole + - strings + - false + - List of inherited roles and the database on which the role is granted. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --privilege + - strings + - false + - List of actions per database and collection. If no database or collections are provided, cluster scope is assumed. For details on actions specific to clusters, databases, or collections, see https://dochub.mongodb.org/core/privilege-actions. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Custom database role '' successfully created. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Create a custom database role + atlas customDbRoles create customRole --privilege FIND@databaseName,UPDATE@databaseName.collectionName + + +.. code-block:: + :copyable: false + + # Create a custom database role on multiple collections + atlas customDbRoles create customRole --privilege FIND@databaseName,UPDATE@databaseName.firstCollectionName,UPDATE@databaseName.secondCollectionName + + +.. code-block:: + :copyable: false + + # Create a customer database role with granted action on the cluster resource + atlas customDbRoles create customRole --privilege GET_CMD_LINE_OPTS + + +.. code-block:: + :copyable: false + + # Use an inherited role + atlas customDbRoles create customRole --inheritedRole read@databaseName diff --git a/docs/command/atlas-customDbRoles-delete.txt b/docs/command/atlas-customDbRoles-delete.txt new file mode 100644 index 0000000000..15ac1aa8a1 --- /dev/null +++ b/docs/command/atlas-customDbRoles-delete.txt @@ -0,0 +1,94 @@ +.. _atlas-customDbRoles-delete: + +========================== +atlas customDbRoles delete +========================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Remove the specified custom database role from your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas customDbRoles delete [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - roleName + - string + - true + - Name of the custom role to delete. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Custom database role '' deleted + + diff --git a/docs/command/atlas-customDbRoles-describe.txt b/docs/command/atlas-customDbRoles-describe.txt new file mode 100644 index 0000000000..fc55e02673 --- /dev/null +++ b/docs/command/atlas-customDbRoles-describe.txt @@ -0,0 +1,84 @@ +.. _atlas-customDbRoles-describe: + +============================ +atlas customDbRoles describe +============================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return a single custom database role for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas customDbRoles describe [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - roleName + - string + - true + - Name of the custom role to retrieve. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + diff --git a/docs/command/atlas-customDbRoles-list.txt b/docs/command/atlas-customDbRoles-list.txt new file mode 100644 index 0000000000..68e8f8d518 --- /dev/null +++ b/docs/command/atlas-customDbRoles-list.txt @@ -0,0 +1,68 @@ +.. _atlas-customDbRoles-list: + +======================== +atlas customDbRoles list +======================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +List custom database roles for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas customDbRoles list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + diff --git a/docs/command/atlas-customDbRoles-update.txt b/docs/command/atlas-customDbRoles-update.txt new file mode 100644 index 0000000000..eb665640dc --- /dev/null +++ b/docs/command/atlas-customDbRoles-update.txt @@ -0,0 +1,106 @@ +.. _atlas-customDbRoles-update: + +========================== +atlas customDbRoles update +========================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Update a custom database role for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas customDbRoles update [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - roleName + - string + - true + - Name of the custom role to update. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --append + - + - false + - Input action and inheritedRoles to append to the existing role. + * - -h, --help + - + - false + - help for update + * - --inheritedRole + - strings + - false + - List of inherited roles and the database on which the role is granted. Passing this flag replaces preexisting data. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --privilege + - strings + - false + - List of actions per database and collection. If no database or collections are provided, cluster scope is assumed. For details on actions specific to clusters, databases, or collections, see https://dochub.mongodb.org/core/privilege-actions. Passing this flag replaces preexisting data. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Custom database role '' successfully updated. + + diff --git a/docs/command/atlas-customDbRoles.txt b/docs/command/atlas-customDbRoles.txt new file mode 100644 index 0000000000..674eaa626a --- /dev/null +++ b/docs/command/atlas-customDbRoles.txt @@ -0,0 +1,67 @@ +.. _atlas-customDbRoles: + +=================== +atlas customDbRoles +=================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage custom database roles for your project. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for customDbRoles + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-customDbRoles-create` - Create a custom database role for your project. +* :ref:`atlas-customDbRoles-delete` - Remove the specified custom database role from your project. +* :ref:`atlas-customDbRoles-describe` - Return a single custom database role for your project. +* :ref:`atlas-customDbRoles-list` - List custom database roles for your project. +* :ref:`atlas-customDbRoles-update` - Update a custom database role for your project. + + +.. toctree:: + :titlesonly: + + create + delete + describe + list + update + diff --git a/docs/command/atlas-customDns-aws-describe.txt b/docs/command/atlas-customDns-aws-describe.txt new file mode 100644 index 0000000000..f19e00caa6 --- /dev/null +++ b/docs/command/atlas-customDns-aws-describe.txt @@ -0,0 +1,87 @@ +.. _atlas-customDns-aws-describe: + +============================ +atlas customDns aws describe +============================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Describe the custom DNS configuration of an Atlas cluster deployed to AWS in the specified project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas customDns aws describe [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ENABLED + + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return the details for the custom DNS configuration deployed to AWS in the project with ID 618d48e05277a606ed2496fe: + atlas customDns aws describe --projectId 618d48e05277a606ed2496fe diff --git a/docs/command/atlas-customDns-aws-disable.txt b/docs/command/atlas-customDns-aws-disable.txt new file mode 100644 index 0000000000..fe8931480d --- /dev/null +++ b/docs/command/atlas-customDns-aws-disable.txt @@ -0,0 +1,86 @@ +.. _atlas-customDns-aws-disable: + +=========================== +atlas customDns aws disable +=========================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Disable the custom DNS configuration of an Atlas cluster deployed to AWS in the specified project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas customDns aws disable [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for disable + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + DNS configuration disabled. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Disable the custom DNS configuration deployed to AWS in the project with ID 618d48e05277a606ed2496fe: + atlas customDns aws disable --projectId 618d48e05277a606ed2496fe diff --git a/docs/command/atlas-customDns-aws-enable.txt b/docs/command/atlas-customDns-aws-enable.txt new file mode 100644 index 0000000000..7ebf795a8b --- /dev/null +++ b/docs/command/atlas-customDns-aws-enable.txt @@ -0,0 +1,86 @@ +.. _atlas-customDns-aws-enable: + +========================== +atlas customDns aws enable +========================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Enable the custom DNS configuration of an Atlas cluster deployed to AWS in the specified project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas customDns aws enable [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for enable + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + DNS configuration enabled. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Enable the custom DNS configuration deployed to AWS in the project with ID 618d48e05277a606ed2496fe: + atlas customDns aws enable --projectId 618d48e05277a606ed2496fe diff --git a/docs/command/atlas-customDns-aws.txt b/docs/command/atlas-customDns-aws.txt new file mode 100644 index 0000000000..2b385960ad --- /dev/null +++ b/docs/command/atlas-customDns-aws.txt @@ -0,0 +1,63 @@ +.. _atlas-customDns-aws: + +=================== +atlas customDns aws +=================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage DNS configuration of an Atlas project’s cluster deployed to AWS. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for aws + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-customDns-aws-describe` - Describe the custom DNS configuration of an Atlas cluster deployed to AWS in the specified project. +* :ref:`atlas-customDns-aws-disable` - Disable the custom DNS configuration of an Atlas cluster deployed to AWS in the specified project. +* :ref:`atlas-customDns-aws-enable` - Enable the custom DNS configuration of an Atlas cluster deployed to AWS in the specified project. + + +.. toctree:: + :titlesonly: + + describe + disable + enable + diff --git a/docs/command/atlas-customDns.txt b/docs/command/atlas-customDns.txt new file mode 100644 index 0000000000..a613a48d18 --- /dev/null +++ b/docs/command/atlas-customDns.txt @@ -0,0 +1,59 @@ +.. _atlas-customDns: + +=============== +atlas customDns +=============== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage DNS configuration of Atlas project’s clusters deployed to AWS. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for customDns + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-customDns-aws` - Manage DNS configuration of an Atlas project’s cluster deployed to AWS. + + +.. toctree:: + :titlesonly: + + aws + diff --git a/docs/command/atlas-dataFederation-create.txt b/docs/command/atlas-dataFederation-create.txt new file mode 100644 index 0000000000..4459c6c491 --- /dev/null +++ b/docs/command/atlas-dataFederation-create.txt @@ -0,0 +1,126 @@ +.. _atlas-dataFederation-create: + +=========================== +atlas dataFederation create +=========================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Creates a new Data Federation database. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas dataFederation create [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - name + - string + - true + - Name of the data federation database. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --awsRoleId + - string + - false + - Amazon Resource Name (ARN) of the role which Atlas Data Federation uses for accessing the data stores. + + Mutually exclusive with --file. + * - --awsTestS3Bucket + - string + - false + - Name of an Amazon S3 data bucket that Atlas Data Federation uses to validate the provided role. + + Mutually exclusive with --file. + * - -f, --file + - string + - false + - Path to an optional JSON configuration file that defines data federation settings. To learn more about data federation configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-json-data-federation-config. + + Mutually exclusive with --region, --awsRoleId, --awsTestS3Bucket. + * - -h, --help + - + - false + - help for create + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --region + - string + - false + - Name of the region to which Atlas Data Federation routes client connections for data processing. + + Mutually exclusive with --file. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Data federation created. + +Examples +-------- + +.. code-block:: + :copyable: false + + # create data federation database: + atlas dataFederation create DataFederation1 --region us_east_1 --awsRoleId role --awsTestS3Bucket bucket + diff --git a/docs/command/atlas-dataFederation-delete.txt b/docs/command/atlas-dataFederation-delete.txt new file mode 100644 index 0000000000..e382667aa3 --- /dev/null +++ b/docs/command/atlas-dataFederation-delete.txt @@ -0,0 +1,103 @@ +.. _atlas-dataFederation-delete: + +=========================== +atlas dataFederation delete +=========================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Remove the specified data federation database from your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas dataFederation delete [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - name + - string + - true + - Name of the data federation database. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + '' deleted + + +Examples +-------- + +.. code-block:: + :copyable: false + + # deletes data federation 'DataFederation1': + atlas dataFederation delete DataFederation1 + diff --git a/docs/command/atlas-dataFederation-describe.txt b/docs/command/atlas-dataFederation-describe.txt new file mode 100644 index 0000000000..5499f34860 --- /dev/null +++ b/docs/command/atlas-dataFederation-describe.txt @@ -0,0 +1,93 @@ +.. _atlas-dataFederation-describe: + +============================= +atlas dataFederation describe +============================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the details for the specified data federation database for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas dataFederation describe [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - name + - string + - true + - Name of the data federation database. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + # retrieves data federation 'DataFederation1': + atlas dataFederation describe DataFederation1 + diff --git a/docs/command/atlas-dataFederation-list.txt b/docs/command/atlas-dataFederation-list.txt new file mode 100644 index 0000000000..59c6ee9682 --- /dev/null +++ b/docs/command/atlas-dataFederation-list.txt @@ -0,0 +1,81 @@ +.. _atlas-dataFederation-list: + +========================= +atlas dataFederation list +========================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns all data federation databases for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas dataFederation list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --type + - string + - false + - Type of Federated Database Instances to return. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + # list all data federation databases: + atlas dataFederation list + diff --git a/docs/command/atlas-dataFederation-logs.txt b/docs/command/atlas-dataFederation-logs.txt new file mode 100644 index 0000000000..708beaf639 --- /dev/null +++ b/docs/command/atlas-dataFederation-logs.txt @@ -0,0 +1,105 @@ +.. _atlas-dataFederation-logs: + +========================= +atlas dataFederation logs +========================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns logs of the specified data federation database for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas dataFederation logs [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - name + - string + - true + - Name of the data federation database. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --end + - int + - false + - Timestamp in UNIX epoch format when the logs end. + * - --force + - + - false + - Flag that indicates whether to overwrite the destination file. + * - -h, --help + - + - false + - help for logs + * - --out + - string + - true + - Output file name. This value defaults to the log name. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --start + - int + - false + - Timestamp in UNIX epoch format when the logs start. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + # download logs of data federation database 'DataFederation1': + atlas dataFederation logs DataFederation1 + diff --git a/docs/command/atlas-dataFederation-privateEndpoints-create.txt b/docs/command/atlas-dataFederation-privateEndpoints-create.txt new file mode 100644 index 0000000000..92cbbefc52 --- /dev/null +++ b/docs/command/atlas-dataFederation-privateEndpoints-create.txt @@ -0,0 +1,106 @@ +.. _atlas-dataFederation-privateEndpoints-create: + +============================================ +atlas dataFederation privateEndpoints create +============================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Creates a new Data Federation private endpoint. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas dataFederation privateEndpoints create [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - endpointId + - string + - true + - Endpoint identifier of the data federation private endpoint. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --comment + - string + - false + - Optional description or comment for the entry. + * - -h, --help + - + - false + - help for create + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Data federation private endpoint {{(index .Results 0).EndpointId> created. + +Examples +-------- + +.. code-block:: + :copyable: false + + # create data federation private endpoint: + atlas dataFederation privateEndpoints create 507f1f77bcf86cd799439011 --comment "comment" + diff --git a/docs/command/atlas-dataFederation-privateEndpoints-delete.txt b/docs/command/atlas-dataFederation-privateEndpoints-delete.txt new file mode 100644 index 0000000000..b120e76382 --- /dev/null +++ b/docs/command/atlas-dataFederation-privateEndpoints-delete.txt @@ -0,0 +1,103 @@ +.. _atlas-dataFederation-privateEndpoints-delete: + +============================================ +atlas dataFederation privateEndpoints delete +============================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Remove the specified data federation private endpoint from your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas dataFederation privateEndpoints delete [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - endpointId + - string + - true + - Endpoint identifier of the data federation private endpoint. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + '' deleted + + +Examples +-------- + +.. code-block:: + :copyable: false + + # deletes data federation private endpoint '507f1f77bcf86cd799439011': + atlas dataFederation privateEndpoints delete 507f1f77bcf86cd799439011 + diff --git a/docs/command/atlas-dataFederation-privateEndpoints-describe.txt b/docs/command/atlas-dataFederation-privateEndpoints-describe.txt new file mode 100644 index 0000000000..f6c4a32295 --- /dev/null +++ b/docs/command/atlas-dataFederation-privateEndpoints-describe.txt @@ -0,0 +1,93 @@ +.. _atlas-dataFederation-privateEndpoints-describe: + +============================================== +atlas dataFederation privateEndpoints describe +============================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the details for the specified data federation private endpoint for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas dataFederation privateEndpoints describe [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - endpointId + - string + - true + - Endpoint identifier of the data federation private endpoint. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + # retrieves data federation private endpoint '507f1f77bcf86cd799439011': + atlas dataFederation privateEndpoints describe 507f1f77bcf86cd799439011 + diff --git a/docs/command/atlas-dataFederation-privateEndpoints-list.txt b/docs/command/atlas-dataFederation-privateEndpoints-list.txt new file mode 100644 index 0000000000..11c74755fa --- /dev/null +++ b/docs/command/atlas-dataFederation-privateEndpoints-list.txt @@ -0,0 +1,77 @@ +.. _atlas-dataFederation-privateEndpoints-list: + +========================================== +atlas dataFederation privateEndpoints list +========================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns all data federation private endpoints for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas dataFederation privateEndpoints list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + # list all data federation private endpoints: + atlas dataFederation privateEndpoints list + diff --git a/docs/command/atlas-dataFederation-privateEndpoints.txt b/docs/command/atlas-dataFederation-privateEndpoints.txt new file mode 100644 index 0000000000..2bb92609a9 --- /dev/null +++ b/docs/command/atlas-dataFederation-privateEndpoints.txt @@ -0,0 +1,65 @@ +.. _atlas-dataFederation-privateEndpoints: + +===================================== +atlas dataFederation privateEndpoints +===================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Data federation private endpoints. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for privateEndpoints + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-dataFederation-privateEndpoints-create` - Creates a new Data Federation private endpoint. +* :ref:`atlas-dataFederation-privateEndpoints-delete` - Remove the specified data federation private endpoint from your project. +* :ref:`atlas-dataFederation-privateEndpoints-describe` - Return the details for the specified data federation private endpoint for your project. +* :ref:`atlas-dataFederation-privateEndpoints-list` - Returns all data federation private endpoints for your project. + + +.. toctree:: + :titlesonly: + + create + delete + describe + list + diff --git a/docs/command/atlas-dataFederation-queryLimits-create.txt b/docs/command/atlas-dataFederation-queryLimits-create.txt new file mode 100644 index 0000000000..eaa5f1f2cf --- /dev/null +++ b/docs/command/atlas-dataFederation-queryLimits-create.txt @@ -0,0 +1,114 @@ +.. _atlas-dataFederation-queryLimits-create: + +======================================= +atlas dataFederation queryLimits create +======================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Creates a new Data Federation query limit. + +To learn more about the query limits, see https://dochub.mongodb.org/core/adf-query-limits.To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas dataFederation queryLimits create [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - name + - string + - true + - Identifier of the data federation query limit. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --dataFederation + - string + - true + - Identifier of the Federated Database Instance. + * - -h, --help + - + - false + - help for create + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --overrunPolicy + - string + - false + - Action to take when the usage limit is exceeded. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --value + - int + - true + - Value given to the query limit. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Data federation query limit created. + +Examples +-------- + +.. code-block:: + :copyable: false + + # create data federation query limit: + atlas dataFederation queryLimit create bytesProcessed.query --value 1000 --dataFederation DataFederation1 + diff --git a/docs/command/atlas-dataFederation-queryLimits-delete.txt b/docs/command/atlas-dataFederation-queryLimits-delete.txt new file mode 100644 index 0000000000..3291c783d6 --- /dev/null +++ b/docs/command/atlas-dataFederation-queryLimits-delete.txt @@ -0,0 +1,107 @@ +.. _atlas-dataFederation-queryLimits-delete: + +======================================= +atlas dataFederation queryLimits delete +======================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Remove the specified data federation query limit from your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas dataFederation queryLimits delete [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - name + - string + - true + - Identifier of the data federation query limit. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --dataFederation + - string + - true + - Identifier of the Federated Database Instance. + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + '' deleted + + +Examples +-------- + +.. code-block:: + :copyable: false + + # deletes data federation query limits "bytesProcessed.query" for 'DataFederation1': + atlas dataFederation queryLimits delete bytesProcessed.query --tenantName DataFederation1 + diff --git a/docs/command/atlas-dataFederation-queryLimits-describe.txt b/docs/command/atlas-dataFederation-queryLimits-describe.txt new file mode 100644 index 0000000000..63f1b1b213 --- /dev/null +++ b/docs/command/atlas-dataFederation-queryLimits-describe.txt @@ -0,0 +1,97 @@ +.. _atlas-dataFederation-queryLimits-describe: + +========================================= +atlas dataFederation queryLimits describe +========================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the details for the specified data federation query limit for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas dataFederation queryLimits describe [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - name + - string + - true + - Identifier of the data federation query limit. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --dataFederation + - string + - true + - Identifier of the Federated Database Instance. + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + # retrieves data federation query limits "bytesProcessed.query" for 'DataFederation1': + atlas dataFederation queryLimits describe bytesProcessed.query --tenantName DataFederation1 + diff --git a/docs/command/atlas-dataFederation-queryLimits-list.txt b/docs/command/atlas-dataFederation-queryLimits-list.txt new file mode 100644 index 0000000000..9f30232375 --- /dev/null +++ b/docs/command/atlas-dataFederation-queryLimits-list.txt @@ -0,0 +1,81 @@ +.. _atlas-dataFederation-queryLimits-list: + +===================================== +atlas dataFederation queryLimits list +===================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns all data federation query limits for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas dataFederation queryLimits list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --dataFederation + - string + - true + - Identifier of the Federated Database Instance. + * - -h, --help + - + - false + - help for list + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + # list all data federation query limits for the database federated instance "myInstance": + atlas dataFederation queryLimits list --dataFederation myInstance + diff --git a/docs/command/atlas-dataFederation-queryLimits.txt b/docs/command/atlas-dataFederation-queryLimits.txt new file mode 100644 index 0000000000..9667d5ede8 --- /dev/null +++ b/docs/command/atlas-dataFederation-queryLimits.txt @@ -0,0 +1,65 @@ +.. _atlas-dataFederation-queryLimits: + +================================ +atlas dataFederation queryLimits +================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Data federation query limits. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for queryLimits + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-dataFederation-queryLimits-create` - Creates a new Data Federation query limit. +* :ref:`atlas-dataFederation-queryLimits-delete` - Remove the specified data federation query limit from your project. +* :ref:`atlas-dataFederation-queryLimits-describe` - Return the details for the specified data federation query limit for your project. +* :ref:`atlas-dataFederation-queryLimits-list` - Returns all data federation query limits for your project. + + +.. toctree:: + :titlesonly: + + create + delete + describe + list + diff --git a/docs/command/atlas-dataFederation-update.txt b/docs/command/atlas-dataFederation-update.txt new file mode 100644 index 0000000000..d9efdf2fda --- /dev/null +++ b/docs/command/atlas-dataFederation-update.txt @@ -0,0 +1,126 @@ +.. _atlas-dataFederation-update: + +=========================== +atlas dataFederation update +=========================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Modify the details of the specified data federation database for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas dataFederation update [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - name + - string + - true + - Name of the data federation database. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --awsRoleId + - string + - false + - Amazon Resource Name (ARN) of the role which Atlas Data Federation uses for accessing the data stores. + + Mutually exclusive with --file. + * - --awsTestS3Bucket + - string + - false + - Name of an Amazon S3 data bucket that Atlas Data Federation uses to validate the provided role. + + Mutually exclusive with --file. + * - -f, --file + - string + - false + - Path to an optional JSON configuration file that defines data federation settings. To learn more about data federation configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-json-data-federation-config. + + Mutually exclusive with --region, --awsRoleId, --awsTestS3Bucket. + * - -h, --help + - + - false + - help for update + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --region + - string + - false + - Name of the region to which Atlas Data Federation routes client connections for data processing. + + Mutually exclusive with --file. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Pipeline updated. + +Examples +-------- + +.. code-block:: + :copyable: false + + # update data lake pipeline: + atlas dataFederation update DataFederation1 + diff --git a/docs/command/atlas-dataFederation.txt b/docs/command/atlas-dataFederation.txt new file mode 100644 index 0000000000..f548e43470 --- /dev/null +++ b/docs/command/atlas-dataFederation.txt @@ -0,0 +1,73 @@ +.. _atlas-dataFederation: + +==================== +atlas dataFederation +==================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Data federation. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for dataFederation + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-dataFederation-create` - Creates a new Data Federation database. +* :ref:`atlas-dataFederation-delete` - Remove the specified data federation database from your project. +* :ref:`atlas-dataFederation-describe` - Return the details for the specified data federation database for your project. +* :ref:`atlas-dataFederation-list` - Returns all data federation databases for your project. +* :ref:`atlas-dataFederation-logs` - Returns logs of the specified data federation database for your project. +* :ref:`atlas-dataFederation-privateEndpoints` - Data federation private endpoints. +* :ref:`atlas-dataFederation-queryLimits` - Data federation query limits. +* :ref:`atlas-dataFederation-update` - Modify the details of the specified data federation database for your project. + + +.. toctree:: + :titlesonly: + + create + delete + describe + list + logs + privateEndpoints + queryLimits + update + diff --git a/docs/command/atlas-dbusers-certs-create.txt b/docs/command/atlas-dbusers-certs-create.txt new file mode 100644 index 0000000000..a5771b97af --- /dev/null +++ b/docs/command/atlas-dbusers-certs-create.txt @@ -0,0 +1,94 @@ +.. _atlas-dbusers-certs-create: + +========================== +atlas dbusers certs create +========================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create a new Atlas-managed X.509 certificate for the specified database user. + +The user you specify must authenticate using X.509 certificates. You can't use this command to create certificates if you are managing your own Certificate Authority (CA) in self-managed X.509 mode. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas dbusers certs create [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for create + * - --monthsUntilExpiration + - int + - false + - Number of months until the X.509 certificate expires. This value defaults to 3. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --username + - string + - true + - Username of a database user. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + <> + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Create an Atlas-managed X.509 certificate that expires in 5 months for a MongoDB user named dbuser for the project with ID 5e2211c17a3e5a48f5497de3: + atlas dbusers certs create --username dbuser --monthsUntilExpiration 5 --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-dbusers-certs-list.txt b/docs/command/atlas-dbusers-certs-list.txt new file mode 100644 index 0000000000..03952ae8bb --- /dev/null +++ b/docs/command/atlas-dbusers-certs-list.txt @@ -0,0 +1,94 @@ +.. _atlas-dbusers-certs-list: + +======================== +atlas dbusers certs list +======================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all Atlas-managed, unexpired X.509 certificates for the specified database user. + +You can't use this command to return certificates if you are managing your own Certificate Authority (CA) in self-managed X.509 mode. + +The user you specify must authenticate using X.509 certificates. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas dbusers certs list [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - username + - string + - true + - Username of the database user for whom you want to list Atlas-managed certificates. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return a JSON-formatted list of all Atlas-managed X.509 certificates for a MongoDB user named dbuser for the project with ID 5e2211c17a3e5a48f5497de3: + atlas dbusers certs list dbuser --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-dbusers-certs.txt b/docs/command/atlas-dbusers-certs.txt new file mode 100644 index 0000000000..e5cf674a70 --- /dev/null +++ b/docs/command/atlas-dbusers-certs.txt @@ -0,0 +1,61 @@ +.. _atlas-dbusers-certs: + +=================== +atlas dbusers certs +=================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage Atlas x509 certificates for your database users. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for certs + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-dbusers-certs-create` - Create a new Atlas-managed X.509 certificate for the specified database user. +* :ref:`atlas-dbusers-certs-list` - Return all Atlas-managed, unexpired X.509 certificates for the specified database user. + + +.. toctree:: + :titlesonly: + + create + list + diff --git a/docs/command/atlas-dbusers-create.txt b/docs/command/atlas-dbusers-create.txt new file mode 100644 index 0000000000..53cf35d052 --- /dev/null +++ b/docs/command/atlas-dbusers-create.txt @@ -0,0 +1,178 @@ +.. _atlas-dbusers-create: + +==================== +atlas dbusers create +==================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create a database user for your project. + +If you set --ldapType, --x509Type, --oidcType and --awsIAMType to NONE, Atlas authenticates this user through SCRAM-SHA. To learn more, see https://www.mongodb.com/docs/manual/core/security-scram/. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas dbusers create [builtInRole]... [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - builtInRole + - string + - false + - Atlas built-in role that you want to assign to the user. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --awsIAMType + - string + - false + - AWS IAM method by which the provided username is authenticated. Valid values are NONE, USER, or ROLE. If you set this to USER or ROLE, the user authenticates with IAM credentials and doesn't need a password. + + Mutually exclusive with --ldapType, --x509Type, --oidcType. This value defaults to "NONE". + * - --deleteAfter + - string + - false + - Timestamp in ISO 8601 in UTC after which Atlas deletes the user. + * - --desc + - string + - false + - Description of this database user. + * - -h, --help + - + - false + - help for create + * - --ldapType + - string + - false + - LDAP method by which the provided username is authenticated. Valid values are NONE, USER, or GROUP. If you set this to USER or GROUP, the user authenticates with LDAP. + + Mutually exclusive with --awsIAMType, --x509Type, --oidcType. This value defaults to "NONE". + * - --oidcType + - string + - false + - OIDC method by which the provided database user is authenticated. Valid values are NONE, USER, or IDP_GROUP. If you set this to USER or GROUP_ID, the user authenticates with OIDC. + + Mutually exclusive with --awsIAMType, --ldapType, --x509Type, --password. This value defaults to "NONE". + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - -p, --password + - string + - false + - Password for the database user. + + Mutually exclusive with --oidcType. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --role + - strings + - false + - Comma-separated list that specifies the user's roles and the databases or collections on which the roles apply. + The roles format is roleName[@dbName[.collection]]. + roleName can either be a built-in role or a custom role. + dbName and collection are required only for built-in roles. + * - --scope + - strings + - false + - Array of clusters that this user has access to. + * - -u, --username + - string + - true + - Username for authenticating to MongoDB. + * - --x509Type + - string + - false + - X.509 method for authenticating the specified username. Valid values include NONE, MANAGED, and CUSTOMER. If you set this to MANAGED the user authenticates with an Atlas-managed X.509 certificate. If you set this to CUSTOMER, the user authenticates with a self-managed X.509 certificate. + + Mutually exclusive with --awsIAMType, --ldapType, --oidcType. This value defaults to "NONE". + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Database user '' successfully created. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Create an Atlas database admin user named myAdmin for the project with ID 5e2211c17a3e5a48f5497de3: + atlas dbusers create atlasAdmin --username myAdmin --projectId 5e2211c17a3e5a48f5497de3 + + +.. code-block:: + :copyable: false + + # Create a database user named myUser with read/write access to any database for the project with ID 5e2211c17a3e5a48f5497de3: + atlas dbusers create readWriteAnyDatabase --username myUser --projectId 5e2211c17a3e5a48f5497de3 + + +.. code-block:: + :copyable: false + + # Create a database user named myUser with multiple roles for the project with ID 5e2211c17a3e5a48f5497de3: + atlas dbusers create --username myUser --role clusterMonitor,backup --projectId 5e2211c17a3e5a48f5497de3 + + +.. code-block:: + :copyable: false + + # Create a database user named myUser with multiple scopes for the project with ID 5e2211c17a3e5a48f5497de3: + atlas dbusers create --username myUser --role clusterMonitor --scope , --projectId 5e2211c17a3e5a48f5497de3 diff --git a/docs/command/atlas-dbusers-delete.txt b/docs/command/atlas-dbusers-delete.txt new file mode 100644 index 0000000000..78e7aec17f --- /dev/null +++ b/docs/command/atlas-dbusers-delete.txt @@ -0,0 +1,120 @@ +.. _atlas-dbusers-delete: + +==================== +atlas dbusers delete +==================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Remove the specified database user from your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas dbusers delete [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - username + - string + - true + - Username to delete from the MongoDB database. The format of the username depends on the user's method of authentication. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --authDB + - string + - false + - Authentication database name. If the user authenticates with AWS IAM, x.509, or LDAP, this value should be $external. If the user authenticates with SCRAM-SHA, this value should be admin. This value defaults to "admin". + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + DB user '' deleted + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Delete the SCRAM SHA-authenticating database user named dylan for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas dbusers delete dylan --projectId 5e2211c17a3e5a48f5497de3 + + +.. code-block:: + :copyable: false + + # Delete the AWS IAM-authenticating database user with the ARN arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs for the project with ID 5e2211c17a3e5a48f5497de3. Prepend $external with \ to escape the special-use character: + atlas dbusers delete arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs --authDB \$external --projectId 5e2211c17a3e5a48f5497de3 + + +.. code-block:: + :copyable: false + + # Delete the xLDAP-authenticating database user with the RFC 2253 Distinguished Name CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM for the project with ID 5e2211c17a3e5a48f5497de3. Prepend $external with \ to escape the special-use character: + atlas dbusers delete CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM --authDB \$external --projectId 5e2211c17a3e5a48f5497de3 diff --git a/docs/command/atlas-dbusers-describe.txt b/docs/command/atlas-dbusers-describe.txt new file mode 100644 index 0000000000..275db941a8 --- /dev/null +++ b/docs/command/atlas-dbusers-describe.txt @@ -0,0 +1,121 @@ +.. _atlas-dbusers-describe: + +====================== +atlas dbusers describe +====================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the details for the specified database user for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas dbusers describe [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - username + - string + - true + - Username to retrieve from the MongoDB database. The format of the username depends on the user's method of authentication. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --authDB + - string + - false + - Authentication database name. If the user authenticates with AWS IAM, x.509, or LDAP, this value should be $external. If the user authenticates with SCRAM-SHA, this value should be admin. This value defaults to "admin". + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + USERNAME DATABASE + + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return the details for the SCRAM SHA-authenticating database user named myDbUser: + atlas dbuser describe myDbUser --authDB admin --output json + + +.. code-block:: + :copyable: false + + # Return the details for the AWS IAM-authenticating database user with the ARN arn:aws:iam::772401394250:user/my-test-user. Prepend $external with \ to escape the special-use character: + atlas dbuser describe arn:aws:iam::772401394250:user/my-test-user --authDB \$external --output json + + +.. code-block:: + :copyable: false + + # Return the details for the X.509-authenticating database user with the RFC 2253 Distinguished Name CN=ellen@example.com,OU=users,DC=example,DC=com. Prepend $external with \ to escape the special-use character: + atlas dbuser describe CN=ellen@example.com,OU=users,DC=example,DC=com --authDB \$external --output json diff --git a/docs/command/atlas-dbusers-list.txt b/docs/command/atlas-dbusers-list.txt new file mode 100644 index 0000000000..cebb33b69f --- /dev/null +++ b/docs/command/atlas-dbusers-list.txt @@ -0,0 +1,92 @@ +.. _atlas-dbusers-list: + +================== +atlas dbusers list +================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all database users for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas dbusers list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -c, --compact + - + - false + - Flag that enables the compact array response structure for a json output. The --compact option returns array objects as top-level responses and allows backward compatibility for scripts based on previous CLI versions. Omitting the --compact option for a json output returns array objects within a 'results' sub-array. You must specify --output json to use this option. + * - -h, --help + - + - false + - help for list + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - --omitCount + - + - false + - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return a JSON-formatted list of all database users for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas dbusers list --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-dbusers-update.txt b/docs/command/atlas-dbusers-update.txt new file mode 100644 index 0000000000..55583100e8 --- /dev/null +++ b/docs/command/atlas-dbusers-update.txt @@ -0,0 +1,137 @@ +.. _atlas-dbusers-update: + +==================== +atlas dbusers update +==================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Modify the details of a database user in your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas dbusers update [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - username + - string + - true + - Username to update in the MongoDB database. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --authDB + - string + - false + - Authentication database name. If the user authenticates with AWS IAM, x.509, or LDAP, this value should be $external. If the user authenticates with SCRAM-SHA, this value should be admin. + * - --desc + - string + - false + - Description of this database user. + * - -h, --help + - + - false + - help for update + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - -p, --password + - string + - false + - Password for the database user. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --role + - strings + - false + - User's roles and the databases or collections on which the roles apply. Passing this flag replaces preexisting data. + * - --scope + - strings + - false + - Array of clusters that this user has access to. Passing this flag replaces preexisting data. + * - -u, --username + - string + - false + - Username for authenticating to MongoDB. + * - --x509Type + - string + - false + - X.509 method for authenticating the specified username. Valid values include NONE, MANAGED, and CUSTOMER. If you set this to MANAGED the user authenticates with an Atlas-managed X.509 certificate. If you set this to CUSTOMER, the user authenticates with a self-managed X.509 certificate. This value defaults to "NONE". + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Successfully updated database user ''. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Update roles for a database user named myUser for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas dbuser update myUser --role readWriteAnyDatabase --projectId 5e2211c17a3e5a48f5497de3 + + +.. code-block:: + :copyable: false + + # Update scopes for a database user named myUser for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas dbuser update myUser --scope resourceName:resourceType --projectId 5e2211c17a3e5a48f5497de3 diff --git a/docs/command/atlas-dbusers.txt b/docs/command/atlas-dbusers.txt new file mode 100644 index 0000000000..bf2938b99d --- /dev/null +++ b/docs/command/atlas-dbusers.txt @@ -0,0 +1,73 @@ +.. _atlas-dbusers: + +============= +atlas dbusers +============= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage database users for your project. + +The dbusers command retrieves, creates and modifies the MongoDB database users in your project. +Each user has a set of roles that provide access to the project’s databases. +A user’s roles apply to all the clusters in the project. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for dbusers + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-dbusers-certs` - Manage Atlas x509 certificates for your database users. +* :ref:`atlas-dbusers-create` - Create a database user for your project. +* :ref:`atlas-dbusers-delete` - Remove the specified database user from your project. +* :ref:`atlas-dbusers-describe` - Return the details for the specified database user for your project. +* :ref:`atlas-dbusers-list` - Return all database users for your project. +* :ref:`atlas-dbusers-update` - Modify the details of a database user in your project. + + +.. toctree:: + :titlesonly: + + certs + create + delete + describe + list + update + diff --git a/docs/command/atlas-deployments-connect.txt b/docs/command/atlas-deployments-connect.txt new file mode 100644 index 0000000000..dad7db2f13 --- /dev/null +++ b/docs/command/atlas-deployments-connect.txt @@ -0,0 +1,98 @@ +.. _atlas-deployments-connect: + +========================= +atlas deployments connect +========================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Connect to a deployment that is running locally or in Atlas. If the deployment is paused, make sure to run atlas deployments start first. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas deployments connect [deploymentName] [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - deploymentName + - string + - false + - Name of the deployment that you want to connect to. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --connectWith + - string + - false + - Method for connecting to the deployment. Valid values are compass, connectionString and mongosh. + * - --connectionStringType + - string + - false + - Type of connection string. If you specify 'private', this option retrieves the connection string for the network peering endpoint. If you specify 'privateEndpoint', this option retrieves the shard optimized connection strings for the private endpoints. This value defaults to "standard". + * - -h, --help + - + - false + - help for connect + * - --password + - string + - false + - Password for the user. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --type + - string + - false + - Type of deployment. Valid values are ATLAS or LOCAL. + * - --username + - string + - false + - Username for authenticating to MongoDB. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + diff --git a/docs/command/atlas-deployments-delete.txt b/docs/command/atlas-deployments-delete.txt new file mode 100644 index 0000000000..c5045c6a38 --- /dev/null +++ b/docs/command/atlas-deployments-delete.txt @@ -0,0 +1,133 @@ +.. _atlas-deployments-delete: + +======================== +atlas deployments delete +======================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Delete a deployment. + +The command prompts you to confirm the operation when you run the command without the --force option. + +Deleting an Atlas deployment also deletes any backup snapshots for that cluster. +Deleting a Local deployment also deletes any local data volumes. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas deployments delete [deploymentName] [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - deploymentName + - string + - false + - Name of the deployment that you want to delete. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --type + - string + - false + - Type of deployment. Valid values are ATLAS or LOCAL. + * - -w, --watch + - + - false + - Flag that indicates whether to watch the command until it completes its execution or the watch times out. To set the time that the watch times out, use the --watchTimeout option. + * - --watchTimeout + - int + - false + - Time in seconds until a watch times out. After a watch times out, the CLI no longer watches the command. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Deployment '' deleted + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Remove an Atlas deployment named myDeployment after prompting for a confirmation: + atlas deployments delete myDeployment --type ATLAS + + +.. code-block:: + :copyable: false + + # Remove an Atlas deployment named myDeployment without requiring confirmation: + atlas deployments delete myDeployment --type ATLAS --force + + +.. code-block:: + :copyable: false + + # Remove an Local deployment named myDeployment without requiring confirmation: + atlas deployments delete myDeployment --type LOCAL --force diff --git a/docs/command/atlas-deployments-list.txt b/docs/command/atlas-deployments-list.txt new file mode 100644 index 0000000000..6cd4592154 --- /dev/null +++ b/docs/command/atlas-deployments-list.txt @@ -0,0 +1,73 @@ +.. _atlas-deployments-list: + +====================== +atlas deployments list +====================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all deployments. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas deployments list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + NAME TYPE MDB VER STATE + + + diff --git a/docs/command/atlas-deployments-logs.txt b/docs/command/atlas-deployments-logs.txt new file mode 100644 index 0000000000..9d4c889676 --- /dev/null +++ b/docs/command/atlas-deployments-logs.txt @@ -0,0 +1,94 @@ +.. _atlas-deployments-logs: + +====================== +atlas deployments logs +====================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Get deployment logs. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas deployments logs [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --deploymentName + - string + - false + - Name of the deployment. + * - --end + - int + - false + - Ending date and time for the range of log messages to retrieve, given in UNIX time. Defaults to the start date plus 24 hours, if the start date is set. If start date is not provided, ending time defaults to the current time. + * - --force + - + - false + - Flag that indicates whether to overwrite the destination file. + * - -h, --help + - + - false + - help for logs + * - --hostname + - string + - false + - Name of the host that stores the log files that you want to download. + * - --name + - string + - false + - Name of the log file (e.g. mongodb.gz|mongos.gz|mongosqld.gz|mongodb-audit-log.gz|mongos-audit-log.gz). + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --start + - int + - false + - UNIX Epoch-formatted starting date and time for the range of log messages to retrieve. This value defaults to 24 hours prior to the current timestamp. + * - --type + - string + - false + - Type of deployment. Valid values are ATLAS or LOCAL. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + diff --git a/docs/command/atlas-deployments-pause.txt b/docs/command/atlas-deployments-pause.txt new file mode 100644 index 0000000000..0508178d28 --- /dev/null +++ b/docs/command/atlas-deployments-pause.txt @@ -0,0 +1,92 @@ +.. _atlas-deployments-pause: + +======================= +atlas deployments pause +======================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Pause a deployment. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas deployments pause [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - deploymentName + - string + - true + - Name of the deployment. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for pause + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --type + - string + - false + - Type of deployment. Valid values are ATLAS or LOCAL. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Pausing deployment ''. + + diff --git a/docs/command/atlas-deployments-search-indexes-create.txt b/docs/command/atlas-deployments-search-indexes-create.txt new file mode 100644 index 0000000000..6948f1a187 --- /dev/null +++ b/docs/command/atlas-deployments-search-indexes-create.txt @@ -0,0 +1,120 @@ +.. _atlas-deployments-search-indexes-create: + +======================================= +atlas deployments search indexes create +======================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create a search index for the specified deployment. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas deployments search indexes create [indexName] [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - indexName + - string + - false + - Name of the index. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --collection + - string + - false + - Name of the collection. + + Mutually exclusive with --file. + * - --db + - string + - false + - Name of the database. + + Mutually exclusive with --file. + * - --deploymentName + - string + - false + - Name of the deployment. + * - -f, --file + - string + - false + - Name of the JSON index configuration file to use. To learn about the Atlas Search and Atlas Vector Search index configuration file, see https://dochub.mongodb.org/core/search-index-config-file-atlascli. To learn about the Atlas Search index syntax and options that you can define in your configuration file, see https://dochub.mongodb.org/core/index-definitions-fts. To learn about the Atlas Vector Search index syntax and options that you can define in your configuration file, see https://dochub.mongodb.org/core/index-definition-avs. + + Mutually exclusive with --db, --collection. + * - -h, --help + - + - false + - help for create + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --password + - string + - false + - Password for the user. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --type + - string + - false + - Type of deployment. Valid values are ATLAS or LOCAL. + * - --username + - string + - false + - Username for authenticating to MongoDB. + * - -w, --watch + - + - false + - Flag that indicates whether to watch the command until it completes its execution or the watch times out. To set the time that the watch times out, use the --watchTimeout option. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + diff --git a/docs/command/atlas-deployments-search-indexes-delete.txt b/docs/command/atlas-deployments-search-indexes-delete.txt new file mode 100644 index 0000000000..49f5287e6b --- /dev/null +++ b/docs/command/atlas-deployments-search-indexes-delete.txt @@ -0,0 +1,111 @@ +.. _atlas-deployments-search-indexes-delete: + +======================================= +atlas deployments search indexes delete +======================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Delete the specified search index from the specified deployment. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas deployments search indexes delete [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - indexId + - string + - true + - ID of the index. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --deploymentName + - string + - false + - Name of the deployment. + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --password + - string + - false + - Password for the user. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --type + - string + - false + - Type of deployment. Valid values are ATLAS or LOCAL. + * - --username + - string + - false + - Username for authenticating to MongoDB. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Index '' deleted + diff --git a/docs/command/atlas-deployments-search-indexes-describe.txt b/docs/command/atlas-deployments-search-indexes-describe.txt new file mode 100644 index 0000000000..fef7fb2e84 --- /dev/null +++ b/docs/command/atlas-deployments-search-indexes-describe.txt @@ -0,0 +1,109 @@ +.. _atlas-deployments-search-indexes-describe: + +========================================= +atlas deployments search indexes describe +========================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Describe a search index for the specified deployment. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas deployments search indexes describe [indexId] [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - indexId + - string + - false + - ID of the index. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --deploymentName + - string + - false + - Name of the deployment. + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --password + - string + - false + - Password for the user. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --type + - string + - false + - Type of deployment. Valid values are ATLAS or LOCAL. + * - --username + - string + - false + - Username for authenticating to MongoDB. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID NAME DATABASE COLLECTION STATUS TYPE + + + diff --git a/docs/command/atlas-deployments-search-indexes-list.txt b/docs/command/atlas-deployments-search-indexes-list.txt new file mode 100644 index 0000000000..75ba7080a4 --- /dev/null +++ b/docs/command/atlas-deployments-search-indexes-list.txt @@ -0,0 +1,101 @@ +.. _atlas-deployments-search-indexes-list: + +===================================== +atlas deployments search indexes list +===================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +List all Atlas Search indexes for a deployment. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas deployments search indexes list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --collection + - string + - false + - Name of the collection. + * - --db + - string + - false + - Name of the database. + * - --deploymentName + - string + - false + - Name of the deployment. + * - -h, --help + - + - false + - help for list + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --password + - string + - false + - Password for the user. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --type + - string + - false + - Type of deployment. Valid values are ATLAS or LOCAL. + * - --username + - string + - false + - Username for authenticating to MongoDB. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID NAME DATABASE COLLECTION STATUS TYPE + + + diff --git a/docs/command/atlas-deployments-search-indexes.txt b/docs/command/atlas-deployments-search-indexes.txt new file mode 100644 index 0000000000..e585c945e0 --- /dev/null +++ b/docs/command/atlas-deployments-search-indexes.txt @@ -0,0 +1,65 @@ +.. _atlas-deployments-search-indexes: + +================================ +atlas deployments search indexes +================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage cloud and local search indexes. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for indexes + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-deployments-search-indexes-create` - Create a search index for the specified deployment. +* :ref:`atlas-deployments-search-indexes-delete` - Delete the specified search index from the specified deployment. +* :ref:`atlas-deployments-search-indexes-describe` - Describe a search index for the specified deployment. +* :ref:`atlas-deployments-search-indexes-list` - List all Atlas Search indexes for a deployment. + + +.. toctree:: + :titlesonly: + + create + delete + describe + list + diff --git a/docs/command/atlas-deployments-search.txt b/docs/command/atlas-deployments-search.txt new file mode 100644 index 0000000000..dc0b73c8b1 --- /dev/null +++ b/docs/command/atlas-deployments-search.txt @@ -0,0 +1,59 @@ +.. _atlas-deployments-search: + +======================== +atlas deployments search +======================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage search for cloud and local deployments. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for search + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-deployments-search-indexes` - Manage cloud and local search indexes. + + +.. toctree:: + :titlesonly: + + indexes + diff --git a/docs/command/atlas-deployments-setup.txt b/docs/command/atlas-deployments-setup.txt new file mode 100644 index 0000000000..fce53c6e86 --- /dev/null +++ b/docs/command/atlas-deployments-setup.txt @@ -0,0 +1,154 @@ +.. _atlas-deployments-setup: + +======================= +atlas deployments setup +======================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create a local deployment. + +To learn more about local atlas deployments, see https://www.mongodb.com/docs/atlas/cli/current/atlas-cli-deploy-local/ + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas deployments setup [deploymentName] [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - deploymentName + - string + - false + - Name of the deployment that you want to set up. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --accessListIp + - strings + - false + - IP address to grant access to the deployment. + + Mutually exclusive with --currentIp. + * - --bindIpAll + - + - false + - Flag that indicates whether the LOCAL deployment port binding should happen for all IPs or only for the localhost interface 127.0.0.1. + * - --connectWith + - string + - false + - Method for connecting to the deployment. Valid values are compass, mongosh and skip. + + Mutually exclusive with --skipMongosh. + * - --currentIp + - + - false + - Flag that adds the IP address from the host that is currently executing the command to the access list. + + Mutually exclusive with --accessListIp. + * - --enableTerminationProtection + - + - false + - Enables termination protection for your deployment. You can't delete a deployment with termination protection enabled. + * - --force + - + - false + - Flag that indicates whether to skip the request for input and create a deployment with the default settings for any unspecified options. + * - -h, --help + - + - false + - help for setup + * - --initdb + - string + - false + - Flag that uses a folder to be mapped into LOCAL deployment for initialization + * - --mdbVersion + - string + - false + - Major MongoDB version of the deployment. + * - --password + - string + - false + - Password for the user. + * - --port + - int + - false + - Port that the MongoDB server listens to for client connections. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --provider + - string + - false + - Name of your cloud service provider. Valid values are AWS, AZURE, or GCP. + * - -r, --region + - string + - false + - Physical location of your MongoDB deployment. For a complete list of supported AWS regions, see: https://dochub.mongodb.org/core/aws-atlas. For a complete list of supported Azure regions, see: https://dochub.mongodb.org/core/azure-atlas. For a complete list of supported GCP regions, see: https://dochub.mongodb.org/core/gcp-atlas. + * - --skipSampleData + - + - false + - Flag that indicates whether to skip loading sample data into your MongoDB deployment. + * - --tag + - key=value + - false + - List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the deployment. + * - --tier + - string + - false + - Tier for each data-bearing server in the deployment. To learn more about cluster tiers, see https://dochub.mongodb.org/core/cluster-tier-atlas. This value defaults to "M0". + * - --type + - string + - false + - Type of deployment that you want to create. Valid values are ATLAS or LOCAL. + * - --username + - string + - false + - Username for authenticating to MongoDB. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + diff --git a/docs/command/atlas-deployments-start.txt b/docs/command/atlas-deployments-start.txt new file mode 100644 index 0000000000..803e81ada9 --- /dev/null +++ b/docs/command/atlas-deployments-start.txt @@ -0,0 +1,95 @@ +.. _atlas-deployments-start: + +======================= +atlas deployments start +======================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Start a deployment. + +After you stop a machine, it goes into sleep mode, or restarts. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas deployments start [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - deploymentName + - string + - true + - Name of the deployment. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for start + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --type + - string + - false + - Type of deployment. Valid values are ATLAS or LOCAL. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + + Starting deployment ''. + + diff --git a/docs/command/atlas-deployments.txt b/docs/command/atlas-deployments.txt new file mode 100644 index 0000000000..fea6b69c08 --- /dev/null +++ b/docs/command/atlas-deployments.txt @@ -0,0 +1,73 @@ +.. _atlas-deployments: + +================= +atlas deployments +================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage cloud and local deployments. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for deployments + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-deployments-connect` - Connect to a deployment that is running locally or in Atlas. If the deployment is paused, make sure to run atlas deployments start first. +* :ref:`atlas-deployments-delete` - Delete a deployment. +* :ref:`atlas-deployments-list` - Return all deployments. +* :ref:`atlas-deployments-logs` - Get deployment logs. +* :ref:`atlas-deployments-pause` - Pause a deployment. +* :ref:`atlas-deployments-search` - Manage search for cloud and local deployments. +* :ref:`atlas-deployments-setup` - Create a local deployment. +* :ref:`atlas-deployments-start` - Start a deployment. + + +.. toctree:: + :titlesonly: + + connect + delete + list + logs + pause + search + setup + start + diff --git a/docs/command/atlas-events-organizations-list.txt b/docs/command/atlas-events-organizations-list.txt new file mode 100644 index 0000000000..86fc6039d1 --- /dev/null +++ b/docs/command/atlas-events-organizations-list.txt @@ -0,0 +1,105 @@ +.. _atlas-events-organizations-list: + +=============================== +atlas events organizations list +=============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all events for the specified organization. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas events organizations list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - --maxDate + - string + - false + - Maximum created date. This option returns events whose created date is less than or equal to the specified value. This parameter uses the ISO 8601 timestamp format in UTC. + * - --minDate + - string + - false + - Minimum created date. This option returns events whose created date is greater than or equal to the specified value. This parameter uses the ISO 8601 timestamp format in UTC. + * - --omitCount + - + - false + - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. + * - --type + - strings + - false + - Type of event that triggered the alert. To learn which values the CLI accepts, see the Enum for eventTypeName in the Atlas Admin API spec: https://dochub.mongodb.org/core/atlas-event-names. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return a JSON-formatted list of events for the organization with the ID 5dd5a6b6f10fab1d71a58495: + atlas events organizations list --orgId 5dd5a6b6f10fab1d71a58495 --output json + + +.. code-block:: + :copyable: false + + # Return a JSON-formatted list of events between 2024-03-18T14:40:03-0000 and 2024-03-18T15:00:03-0000 and for the project with the ID 5e2211c17a3e5a48f5497de3 + atlas events projects list --output json --projectId 5e2211c17a3e5a48f5497de3 --minDate 2024-03-18T14:40:03-0000 --maxDate 2024-03-18T15:00:03-0000 diff --git a/docs/command/atlas-events-organizations.txt b/docs/command/atlas-events-organizations.txt new file mode 100644 index 0000000000..aca25de921 --- /dev/null +++ b/docs/command/atlas-events-organizations.txt @@ -0,0 +1,61 @@ +.. _atlas-events-organizations: + +========================== +atlas events organizations +========================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Organization operations. + +List organization events. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for organizations + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-events-organizations-list` - Return all events for the specified organization. + + +.. toctree:: + :titlesonly: + + list + diff --git a/docs/command/atlas-events-projects-list.txt b/docs/command/atlas-events-projects-list.txt new file mode 100644 index 0000000000..06ea1ee489 --- /dev/null +++ b/docs/command/atlas-events-projects-list.txt @@ -0,0 +1,105 @@ +.. _atlas-events-projects-list: + +========================== +atlas events projects list +========================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all events for the specified project. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas events projects list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - --maxDate + - string + - false + - Maximum created date. This option returns events whose created date is less than or equal to the specified value. This parameter uses the ISO 8601 timestamp format in UTC. + * - --minDate + - string + - false + - Minimum created date. This option returns events whose created date is greater than or equal to the specified value. This parameter uses the ISO 8601 timestamp format in UTC. + * - --omitCount + - + - false + - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --type + - strings + - false + - Type of event that triggered the alert. To learn which values the CLI accepts, see the Enum for eventTypeName in the Atlas Admin API spec: https://dochub.mongodb.org/core/atlas-event-names. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return a JSON-formatted list of events for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas events projects list --Id 5e2211c17a3e5a48f5497de3 --output json + + +.. code-block:: + :copyable: false + + # Return a JSON-formatted list of events between 2024-03-18T14:40:03-0000 and 2024-03-18T15:00:03-0000 and for the project with the ID 5e2211c17a3e5a48f5497de3 + atlas events projects list --output json --projectId 5e2211c17a3e5a48f5497de3 --minDate 2024-03-18T14:40:03-0000 --maxDate 2024-03-18T15:00:03-0000 diff --git a/docs/command/atlas-events-projects.txt b/docs/command/atlas-events-projects.txt new file mode 100644 index 0000000000..1eeef0b881 --- /dev/null +++ b/docs/command/atlas-events-projects.txt @@ -0,0 +1,61 @@ +.. _atlas-events-projects: + +===================== +atlas events projects +===================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Project operations. + +List projects events. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for projects + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-events-projects-list` - Return all events for the specified project. + + +.. toctree:: + :titlesonly: + + list + diff --git a/docs/command/atlas-events.txt b/docs/command/atlas-events.txt new file mode 100644 index 0000000000..83e44e0a93 --- /dev/null +++ b/docs/command/atlas-events.txt @@ -0,0 +1,61 @@ +.. _atlas-events: + +============ +atlas events +============ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage events for your organization or project. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for events + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-events-organizations` - Organization operations. +* :ref:`atlas-events-projects` - Project operations. + + +.. toctree:: + :titlesonly: + + organizations + projects + diff --git a/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-connect.txt b/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-connect.txt new file mode 100644 index 0000000000..849ea4f68f --- /dev/null +++ b/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-connect.txt @@ -0,0 +1,93 @@ +.. _atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-connect: + +============================================================================ +atlas federatedAuthentication federationSettings connectedOrgConfigs connect +============================================================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Connect an Identity Provider to an Organization. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas federatedAuthentication federationSettings connectedOrgConfigs connect [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --federationSettingsId + - string + - true + - Unique 24-hexadecimal digit string that identifies the federation settings. + * - -h, --help + - + - false + - help for connect + * - --identityProviderId + - string + - true + - Unique identifier of the identity provider. + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --protocol + - string + - false + - Protocol used to authenticate the user. Valid value is OIDC or SAML. This value defaults to "OIDC". + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + # Connect the current profile org to identity provider with ID 7d1113b25a115342acc2d1aa and federationSettingsId 5d1113b25a115342acc2d1aa + atlas federatedAuthentication federationSettings connectedOrgConfigs connect --identityProviderId 7d1113b25a115342acc2d1aa --federationSettingsId 5d1113b25a115342acc2d1aa + +.. code-block:: + :copyable: false + + # Connect the org with ID 7d1113b25a115342acc2d1aa to identity provider with ID 7d1113b25a115342acc2d1aa and federationSettingsId 5d1113b25a115342acc2d1aa + atlas federatedAuthentication federationSettings connectedOrgConfigs connect --orgId 7d1113b25a115342acc2d1aa --identityProviderId 7d1113b25a115342acc2d1aa --federationSettingsId 5d1113b25a115342acc2d1aa + diff --git a/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-delete.txt b/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-delete.txt new file mode 100644 index 0000000000..47ac1a50b4 --- /dev/null +++ b/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-delete.txt @@ -0,0 +1,89 @@ +.. _atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-delete: + +=========================================================================== +atlas federatedAuthentication federationSettings connectedOrgConfigs delete +=========================================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Delete a connected org config Organization. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas federatedAuthentication federationSettings connectedOrgConfigs delete [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --federationSettingsId + - string + - true + - Unique 24-hexadecimal digit string that identifies the federation settings. + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + # Delete a connected org config from the current profile org and federationSettingsId 5d1113b25a115342acc2d1aa + atlas federatedAuthentication federationSettings connectedOrgConfigs delete --federationSettingsId 5d1113b25a115342acc2d1aa + +.. code-block:: + :copyable: false + + # Delete a connected org config from the org with ID 7d1113b25a115342acc2d1aa and federationSettingsId 5d1113b25a115342acc2d1aa + atlas federatedAuthentication federationSettings connectedOrgConfigs delete --orgId 7d1113b25a115342acc2d1aa --federationSettingsId 5d1113b25a115342acc2d1aa + diff --git a/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-describe.txt b/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-describe.txt new file mode 100644 index 0000000000..0986820f52 --- /dev/null +++ b/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-describe.txt @@ -0,0 +1,85 @@ +.. _atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-describe: + +============================================================================= +atlas federatedAuthentication federationSettings connectedOrgConfigs describe +============================================================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Describe a Connected Org Config. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas federatedAuthentication federationSettings connectedOrgConfigs describe [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --federationSettingsId + - string + - true + - Unique 24-hexadecimal digit string that identifies the federation settings. + * - -h, --help + - + - false + - help for describe + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + # Describe a connected org config from the current profile org and federationSettingsId 5d1113b25a115342acc2d1aa + atlas federatedAuthentication federationSettings connectedOrgConfigsConfig describe --federationSettingsId 5d1113b25a115342acc2d1aa + +.. code-block:: + :copyable: false + + # Describe a connected org config from the org with ID 7d1113b25a115342acc2d1aa and federationSettingsId 5d1113b25a115342acc2d1aa + atlas federatedAuthentication federationSettings connectedOrgConfigs describe --orgId 7d1113b25a115342acc2d1aa --federationSettingsId 5d1113b25a115342acc2d1aa + diff --git a/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-disconnect.txt b/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-disconnect.txt new file mode 100644 index 0000000000..aa8916a3f1 --- /dev/null +++ b/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-disconnect.txt @@ -0,0 +1,102 @@ +.. _atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-disconnect: + +=============================================================================== +atlas federatedAuthentication federationSettings connectedOrgConfigs disconnect +=============================================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Connect an Identity Provider to an Organization. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas federatedAuthentication federationSettings connectedOrgConfigs disconnect [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --federationSettingsId + - string + - true + - Unique 24-hexadecimal digit string that identifies the federation settings. + * - -h, --help + - + - false + - help for disconnect + * - --identityProviderId + - string + - true + - Unique identifier of the identity provider. + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --protocol + - string + - false + - Protocol used to authenticate the user. Valid value is OIDC or SAML. This value defaults to "OIDC". + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Org Configs disconnected. + +Examples +-------- + +.. code-block:: + :copyable: false + + # Disconnect the current profile org from identity provider with ID 5d1113b25a115342acc2d1aa and federationSettingsId 7d1113b25a115342acc2d1aa + atlas federatedAuthentication federationSettings connectedOrgConfigs disconnect --identityProviderId 5d1113b25a115342acc2d1aa --federationSettingsId 7d1113b25a115342acc2d1aa + +.. code-block:: + :copyable: false + + # Disconnect the org with ID 7d1113b25a115342acc2d1aa to identity provider with ID 5d1113b25a115342acc2d1aa and federationSettingsId 7d1113b25a115342acc2d1aa + atlas federatedAuthentication federationSettings connectedOrgConfigs disconnect --orgId 7d1113b25a115342acc2d1aa --identityProviderId 5d1113b25a115342acc2d1aa --federationSettingsId 7d1113b25a115342acc2d1aa + diff --git a/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-list.txt b/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-list.txt new file mode 100644 index 0000000000..7093c3112f --- /dev/null +++ b/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-list.txt @@ -0,0 +1,87 @@ +.. _atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-list: + +========================================================================= +atlas federatedAuthentication federationSettings connectedOrgConfigs list +========================================================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Describe a Connected Org Config. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas federatedAuthentication federationSettings connectedOrgConfigs list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --federationSettingsId + - string + - true + - Unique 24-hexadecimal digit string that identifies the federation settings. + * - -h, --help + - + - false + - help for list + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + # List all connected org config with federationSettingsId 5d1113b25a115342acc2d1aa + atlas federatedAuthentication federationSettings connectedOrgsConfig list --federationSettingsId 5d1113b25a115342acc2d1aa + diff --git a/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-update.txt b/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-update.txt new file mode 100644 index 0000000000..bb07cefed4 --- /dev/null +++ b/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-update.txt @@ -0,0 +1,83 @@ +.. _atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-update: + +=========================================================================== +atlas federatedAuthentication federationSettings connectedOrgConfigs update +=========================================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Update One Org Config Connected to One Federation Setting. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas federatedAuthentication federationSettings connectedOrgConfigs update [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --federationSettingsId + - string + - true + - Unique 24-hexadecimal digit string that identifies the federation settings. + * - --file + - string + - true + - Path to a JSON configuration file that defines connected orgs configurations. To learn more about connected org configuration file format, see the request body in https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/updateConnectedOrgConfig. + * - -h, --help + - + - false + - help for update + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + # Update the connected orgs config with the current profile org and federationSettingsId 5d1113b25a115342acc2d1aa using the JSON configuration file config.json + atlas federatedAuthentication federationSettings connectedOrgConfigs update --federationSettingsId 5d1113b25a115342acc2d1aa --file config.json + diff --git a/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs.txt b/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs.txt new file mode 100644 index 0000000000..5f21f5853f --- /dev/null +++ b/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs.txt @@ -0,0 +1,69 @@ +.. _atlas-federatedAuthentication-federationSettings-connectedOrgConfigs: + +==================================================================== +atlas federatedAuthentication federationSettings connectedOrgConfigs +==================================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage Atlas Federated Authentication Connected Orgs Config + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for connectedOrgConfigs + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-connect` - Connect an Identity Provider to an Organization. +* :ref:`atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-delete` - Delete a connected org config Organization. +* :ref:`atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-describe` - Describe a Connected Org Config. +* :ref:`atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-disconnect` - Connect an Identity Provider to an Organization. +* :ref:`atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-list` - Describe a Connected Org Config. +* :ref:`atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-update` - Update One Org Config Connected to One Federation Setting. + + +.. toctree:: + :titlesonly: + + connect + delete + describe + disconnect + list + update + diff --git a/docs/command/atlas-federatedAuthentication-federationSettings-describe.txt b/docs/command/atlas-federatedAuthentication-federationSettings-describe.txt new file mode 100644 index 0000000000..faa2be9d24 --- /dev/null +++ b/docs/command/atlas-federatedAuthentication-federationSettings-describe.txt @@ -0,0 +1,87 @@ +.. _atlas-federatedAuthentication-federationSettings-describe: + +========================================================= +atlas federatedAuthentication federationSettings describe +========================================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the Federation Settings details for the specified organization. + +To use this command, you must authenticate with a user account or an API key with the Organization Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas federatedAuthentication federationSettings describe [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID IDENTITY PROVIDER ID IDENTITY PROVIDER STATUS + + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return the JSON-formatted Federation Settings details: + atlas federatedAuthentication federationSettings describe --orgId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-create-oidc.txt b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-create-oidc.txt new file mode 100644 index 0000000000..c7b34f68d1 --- /dev/null +++ b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-create-oidc.txt @@ -0,0 +1,141 @@ +.. _atlas-federatedAuthentication-federationSettings-identityProvider-create-oidc: + +============================================================================= +atlas federatedAuthentication federationSettings identityProvider create oidc +============================================================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create an OIDC identity provider. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas federatedAuthentication federationSettings identityProvider create oidc [displayName] [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - displayName + - string + - false + - The Identity Provider display name. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --associatedDomain + - strings + - false + - List of domains associated with the Identity Provider. + * - --audience + - string + - true + - Identifier of the intended recipient of the token. + * - --authorizationType + - string + - true + - Type of authorization. Valid values are NONE, JWT, or SAML. + * - --clientId + - string + - false + - Client identifier that is assigned to an application by the Identity Provider. + * - --desc + - string + - true + - Description of the Identity Provider. + * - --federationSettingsId + - string + - true + - Unique 24-hexadecimal digit string that identifies the federation settings. + * - --groupsClaim + - string + - true + - Identifier of the claim which contains IdP Group IDs in the token. + * - -h, --help + - + - false + - help for oidc + * - --idpType + - string + - true + - Type of Identity Provider. Valid values are WORKFORCE or WORKLOAD. + * - --issuerUri + - string + - true + - Unique string that identifies the issuer of the OIDC metadata/discovery document URL. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --requestedScope + - strings + - false + - Scopes that MongoDB applications will request from the authorization endpoint. + * - --userClaim + - string + - true + - Identifier of the claim which contains the user ID in the token. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Identity provider '' created. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Create an identity provider with name IDPName and from your federation settings with federationSettingsId 5d1113b25a115342acc2d1aa. + atlas federatedAuthentication federationSettings identityProvider create oidc IDPName --audience "audience" --authorizationType "GROUP" --clientId clientId --desc "IDPName test" --federationSettingsId "5d1113b25a115342acc2d1aa" --groupsClaim "groups" --idpType "WORKLOAD" --issuerUri uri" --userClaim "user" --associatedDomain "domain" + diff --git a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-create.txt b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-create.txt new file mode 100644 index 0000000000..58d31e6349 --- /dev/null +++ b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-create.txt @@ -0,0 +1,59 @@ +.. _atlas-federatedAuthentication-federationSettings-identityProvider-create: + +======================================================================== +atlas federatedAuthentication federationSettings identityProvider create +======================================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create Federated Authentication Identity Providers. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for create + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-federatedAuthentication-federationSettings-identityProvider-create-oidc` - Create an OIDC identity provider. + + +.. toctree:: + :titlesonly: + + oidc + diff --git a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-delete.txt b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-delete.txt new file mode 100644 index 0000000000..c0aaad11b2 --- /dev/null +++ b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-delete.txt @@ -0,0 +1,107 @@ +.. _atlas-federatedAuthentication-federationSettings-identityProvider-delete: + +======================================================================== +atlas federatedAuthentication federationSettings identityProvider delete +======================================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Remove the specified identity provider from your federation settings. + +To use this command, you must authenticate with a user account or an API key with the Org Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas federatedAuthentication federationSettings identityProvider delete [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - identityProviderId + - string + - true + - ID of the identityProvider. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --federationSettingsId + - string + - true + - Unique 24-hexadecimal digit string that identifies the federation settings. + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Identity provider '' deleted + + +Examples +-------- + +.. code-block:: + :copyable: false + + # elete the identity provider with ID aa2223b25a115342acc1f108 from your federation settings with federationSettingsId 5d1113b25a115342acc2d1aa. + atlas federatedAuthentication federationSettings identityProvider delete aa2223b25a115342acc1f108 --federationSettingsId 5d1113b25a115342acc2d1aa + diff --git a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-describe.txt b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-describe.txt new file mode 100644 index 0000000000..1977c6cda7 --- /dev/null +++ b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-describe.txt @@ -0,0 +1,104 @@ +.. _atlas-federatedAuthentication-federationSettings-identityProvider-describe: + +========================================================================== +atlas federatedAuthentication federationSettings identityProvider describe +========================================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Describe the specified identity provider from your federation settings. + +To use this command, you must authenticate with a user account or an API key with the Org Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas federatedAuthentication federationSettings identityProvider describe [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - identityProviderId + - string + - true + - ID of the identityProvider. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --federationSettingsId + - string + - true + - Unique 24-hexadecimal digit string that identifies the federation settings. + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID DISPLAY NAME ISSUER URI CLIENT ID IDP TYPE + + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Describe the identity provider with ID aa2223b25a115342acc1f108 with federationSettingsId 5d1113b25a115342acc2d1aa. + atlas federatedAuthentication federationSettings identityProvider describe aa2223b25a115342acc1f108 --federationSettingsId 5d1113b25a115342acc2d1aa + diff --git a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-list.txt b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-list.txt new file mode 100644 index 0000000000..e0a92bbcd7 --- /dev/null +++ b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-list.txt @@ -0,0 +1,104 @@ +.. _atlas-federatedAuthentication-federationSettings-identityProvider-list: + +====================================================================== +atlas federatedAuthentication federationSettings identityProvider list +====================================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +List the identity providers from your federation settings. + +To use this command, you must authenticate with a user account or an API key with the Org Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas federatedAuthentication federationSettings identityProvider list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --federationSettingsId + - string + - true + - Unique 24-hexadecimal digit string that identifies the federation settings. + * - -h, --help + - + - false + - help for list + * - --idpType + - string + - false + - Type of Identity Provider. Valid values are WORKFORCE or WORKLOAD. This value defaults to "WORKFORCE". + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. + * - --protocol + - string + - false + - Protocol used to authenticate the user. Valid value is OIDC or SAML. This value defaults to "OIDC". + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID DISPLAY NAME ISSUER URI CLIENT ID IDP TYPE + + + +Examples +-------- + +.. code-block:: + :copyable: false + + # List the identity providers from your federation settings with federationSettingsId 5d1113b25a115342acc2d1aa and idpType WORKLOAD + atlas federatedAuthentication federationSettings identityProvider list --federationSettingsId 5d1113b25a115342acc2d1aa --idpType WORKLOAD + diff --git a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-revokeJwk.txt b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-revokeJwk.txt new file mode 100644 index 0000000000..99f29fd56a --- /dev/null +++ b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-revokeJwk.txt @@ -0,0 +1,93 @@ +.. _atlas-federatedAuthentication-federationSettings-identityProvider-revokeJwk: + +=========================================================================== +atlas federatedAuthentication federationSettings identityProvider revokeJwk +=========================================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Revoke the JWK token from the specified identity provider from your federation settings. + +To use this command, you must authenticate with a user account or an API key with the Org Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas federatedAuthentication federationSettings identityProvider revokeJwk [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - identityProviderId + - string + - true + - ID of the identityProvider. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --federationSettingsId + - string + - true + - Unique 24-hexadecimal digit string that identifies the federation settings. + * - -h, --help + - + - false + - help for revokeJwk + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + # Revoke the Jwk from the identity provider with ID aa2223b25a115342acc1f108 and federation settings with federationSettingsId 5d1113b25a115342acc2d1aa. + atlas federatedAuthentication federationSettings identityProvider revokeJwk aa2223b25a115342acc1f108 --federationSettingsId 5d1113b25a115342acc2d1aa + diff --git a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-update-oidc.txt b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-update-oidc.txt new file mode 100644 index 0000000000..f760448046 --- /dev/null +++ b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-update-oidc.txt @@ -0,0 +1,141 @@ +.. _atlas-federatedAuthentication-federationSettings-identityProvider-update-oidc: + +============================================================================= +atlas federatedAuthentication federationSettings identityProvider update oidc +============================================================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Update an OIDC identity provider. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas federatedAuthentication federationSettings identityProvider update oidc [identityProviderId] [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - identityProviderId + - string + - false + - The Identity Provider ID. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --associatedDomain + - strings + - false + - List of domains associated with the Identity Provider. + * - --audience + - string + - false + - Identifier of the intended recipient of the token. + * - --authorizationType + - string + - false + - Type of authorization. Valid values are NONE, JWT, or SAML. + * - --clientId + - string + - false + - Client identifier that is assigned to an application by the Identity Provider. + * - --desc + - string + - false + - Description of the Identity Provider. + * - --federationSettingsId + - string + - true + - Unique 24-hexadecimal digit string that identifies the federation settings. + * - --groupsClaim + - string + - false + - Identifier of the claim which contains IdP Group IDs in the token. + * - -h, --help + - + - false + - help for oidc + * - --idpType + - string + - true + - Type of Identity Provider. Valid values are WORKFORCE or WORKLOAD. + * - --issuerUri + - string + - false + - Unique string that identifies the issuer of the OIDC metadata/discovery document URL. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --requestedScope + - strings + - false + - Scopes that MongoDB applications will request from the authorization endpoint. + * - --userClaim + - string + - false + - Identifier of the claim which contains the user ID in the token. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Identity provider '' updated. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Update the audience of the identity provider with ID aa2223b25a115342acc1f108 and from your federation settings with federationSettingsId 5d1113b25a115342acc2d1aa with IdpType WORKFORCE + atlas federatedAuthentication federationSettings identityProvider update aa2223b25a115342acc1f108 --federationSettingsId 5d1113b25a115342acc2d1aa --idpType WORKFORCE --audience newAudience + diff --git a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-update.txt b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-update.txt new file mode 100644 index 0000000000..9ced3f51a8 --- /dev/null +++ b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-update.txt @@ -0,0 +1,59 @@ +.. _atlas-federatedAuthentication-federationSettings-identityProvider-update: + +======================================================================== +atlas federatedAuthentication federationSettings identityProvider update +======================================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Update Federated Authentication Identity Providers. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for update + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-federatedAuthentication-federationSettings-identityProvider-update-oidc` - Update an OIDC identity provider. + + +.. toctree:: + :titlesonly: + + oidc + diff --git a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider.txt b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider.txt new file mode 100644 index 0000000000..26ea30cb0a --- /dev/null +++ b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider.txt @@ -0,0 +1,69 @@ +.. _atlas-federatedAuthentication-federationSettings-identityProvider: + +================================================================= +atlas federatedAuthentication federationSettings identityProvider +================================================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage Federated Authentication Identity Providers. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for identityProvider + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-federatedAuthentication-federationSettings-identityProvider-create` - Create Federated Authentication Identity Providers. +* :ref:`atlas-federatedAuthentication-federationSettings-identityProvider-delete` - Remove the specified identity provider from your federation settings. +* :ref:`atlas-federatedAuthentication-federationSettings-identityProvider-describe` - Describe the specified identity provider from your federation settings. +* :ref:`atlas-federatedAuthentication-federationSettings-identityProvider-list` - List the identity providers from your federation settings. +* :ref:`atlas-federatedAuthentication-federationSettings-identityProvider-revokeJwk` - Revoke the JWK token from the specified identity provider from your federation settings. +* :ref:`atlas-federatedAuthentication-federationSettings-identityProvider-update` - Update Federated Authentication Identity Providers. + + +.. toctree:: + :titlesonly: + + create + delete + describe + list + revokeJwk + update + diff --git a/docs/command/atlas-federatedAuthentication-federationSettings.txt b/docs/command/atlas-federatedAuthentication-federationSettings.txt new file mode 100644 index 0000000000..65ff2f3863 --- /dev/null +++ b/docs/command/atlas-federatedAuthentication-federationSettings.txt @@ -0,0 +1,63 @@ +.. _atlas-federatedAuthentication-federationSettings: + +================================================ +atlas federatedAuthentication federationSettings +================================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage Atlas Federated Authentication Federation Settings + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for federationSettings + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-federatedAuthentication-federationSettings-connectedOrgConfigs` - Manage Atlas Federated Authentication Connected Orgs Config +* :ref:`atlas-federatedAuthentication-federationSettings-describe` - Return the Federation Settings details for the specified organization. +* :ref:`atlas-federatedAuthentication-federationSettings-identityProvider` - Manage Federated Authentication Identity Providers. + + +.. toctree:: + :titlesonly: + + connectedOrgConfigs + describe + identityProvider + diff --git a/docs/command/atlas-federatedAuthentication.txt b/docs/command/atlas-federatedAuthentication.txt new file mode 100644 index 0000000000..20e4ac2898 --- /dev/null +++ b/docs/command/atlas-federatedAuthentication.txt @@ -0,0 +1,59 @@ +.. _atlas-federatedAuthentication: + +============================= +atlas federatedAuthentication +============================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage Atlas Federated Authentication. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for federatedAuthentication + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-federatedAuthentication-federationSettings` - Manage Atlas Federated Authentication Federation Settings + + +.. toctree:: + :titlesonly: + + federationSettings + diff --git a/docs/command/atlas-integrations-create-DATADOG.txt b/docs/command/atlas-integrations-create-DATADOG.txt new file mode 100644 index 0000000000..4ff69b54d8 --- /dev/null +++ b/docs/command/atlas-integrations-create-DATADOG.txt @@ -0,0 +1,100 @@ +.. _atlas-integrations-create-DATADOG: + +================================= +atlas integrations create DATADOG +================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create or update a Datadog integration for your project. + +The requesting API key must have the Organization Owner or Project Owner role to configure an integration with Datadog. + +After you integrate with Datadog, you can send metric data about your project to your Datadog dashboard. To learn more about the metrics available to Datadog, see https://www.mongodb.com/docs/atlas/tutorial/datadog-integration/. + +Datadog integration is available only for M10+ clusters. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas integrations create DATADOG [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --apiKey + - string + - true + - Datadog API key that allows Atlas to access your Datadog account. + * - -h, --help + - + - false + - help for DATADOG + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --region + - string + - false + - Code that indicates which regional URL MongoDB uses to access the Datadog API. Valid values are US, EU, US3, US5, and AP1. This value defaults to "US". + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Datadog integration configured. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Integrate Datadog with Atlas for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas integrations create DATADOG --apiKey a1a23bcdef45ghijk6789 --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-integrations-create-OPS_GENIE.txt b/docs/command/atlas-integrations-create-OPS_GENIE.txt new file mode 100644 index 0000000000..f379cf6c82 --- /dev/null +++ b/docs/command/atlas-integrations-create-OPS_GENIE.txt @@ -0,0 +1,96 @@ +.. _atlas-integrations-create-OPS_GENIE: + +=================================== +atlas integrations create OPS_GENIE +=================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create or update an Opsgenie integration for your project. + +The requesting API key must have the Organization Owner or Project Owner role to configure an integration with Opsgenie. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas integrations create OPS_GENIE [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --apiKey + - string + - true + - Opsgenie API key that allows Atlas to access your Opsgenie account. + * - -h, --help + - + - false + - help for OPS_GENIE + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --region + - string + - false + - Code that indicates which regional URL MongoDB uses to access the third-party API. Valid values are US and EU. This value defaults to "US". + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Ops Genie integration configured. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Integrate Opsgenie with Atlas for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas integrations create OPS_GENIE --apiKey a1a23bcdef45ghijk6789 --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-integrations-create-PAGER_DUTY.txt b/docs/command/atlas-integrations-create-PAGER_DUTY.txt new file mode 100644 index 0000000000..4772a69a43 --- /dev/null +++ b/docs/command/atlas-integrations-create-PAGER_DUTY.txt @@ -0,0 +1,92 @@ +.. _atlas-integrations-create-PAGER_DUTY: + +==================================== +atlas integrations create PAGER_DUTY +==================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create or update a PagerDuty integration for your project. + +The requesting API key must have the Organization Owner or Project Owner role to configure an integration with PagerDuty. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas integrations create PAGER_DUTY [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for PAGER_DUTY + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --serviceKey + - string + - true + - Service key associated with your PagerDuty account. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Pager Duty integration configured. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Integrate PagerDuty with Atlas for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas integrations create PAGER_DUTY --serviceKey a1a23bcdef45ghijk6789 --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-integrations-create-VICTOR_OPS.txt b/docs/command/atlas-integrations-create-VICTOR_OPS.txt new file mode 100644 index 0000000000..8c7bf304a2 --- /dev/null +++ b/docs/command/atlas-integrations-create-VICTOR_OPS.txt @@ -0,0 +1,98 @@ +.. _atlas-integrations-create-VICTOR_OPS: + +==================================== +atlas integrations create VICTOR_OPS +==================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create or update a Splunk On-Call integration for your project. + +VictorOps is now Splunk On-Call. + +The requesting API key must have the Organization Owner or Project Owner role to configure an integration with Splunk On-Call. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas integrations create VICTOR_OPS [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --apiKey + - string + - true + - Splunk On-Call API key that allows Atlas to access your Splunk On-Call account. + * - -h, --help + - + - false + - help for VICTOR_OPS + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --routingKey + - string + - true + - Routing key associated with your Splunk On-Call account. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Victor Ops integration configured. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Integrate Splunk On-Call with Atlas using the routing key operations for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas integrations create VICTOR_OPS --apiKey a1a23bcdef45ghijk6789 --routingKey operations --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-integrations-create-WEBHOOK.txt b/docs/command/atlas-integrations-create-WEBHOOK.txt new file mode 100644 index 0000000000..32dccd71c0 --- /dev/null +++ b/docs/command/atlas-integrations-create-WEBHOOK.txt @@ -0,0 +1,96 @@ +.. _atlas-integrations-create-WEBHOOK: + +================================= +atlas integrations create WEBHOOK +================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create or update a webhook integration for your project. + +The requesting API key must have the Organization Owner or Project Owner role to configure a webhook integration. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas integrations create WEBHOOK [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for WEBHOOK + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --secret + - string + - true + - Secret that secures your webhook. + * - --url + - string + - true + - Endpoint web address to which Atlas sends notifications. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Webhook integration configured. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Integrate a webhook with Atlas that uses the secret mySecret for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas integrations create WEBHOOK --url http://9b4ac7aa.abc.io/payload --secret mySecret --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-integrations-create.txt b/docs/command/atlas-integrations-create.txt new file mode 100644 index 0000000000..85048bcdb1 --- /dev/null +++ b/docs/command/atlas-integrations-create.txt @@ -0,0 +1,67 @@ +.. _atlas-integrations-create: + +========================= +atlas integrations create +========================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create operations. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for create + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-integrations-create-DATADOG` - Create or update a Datadog integration for your project. +* :ref:`atlas-integrations-create-OPS_GENIE` - Create or update an Opsgenie integration for your project. +* :ref:`atlas-integrations-create-PAGER_DUTY` - Create or update a PagerDuty integration for your project. +* :ref:`atlas-integrations-create-VICTOR_OPS` - Create or update a Splunk On-Call integration for your project. +* :ref:`atlas-integrations-create-WEBHOOK` - Create or update a webhook integration for your project. + + +.. toctree:: + :titlesonly: + + DATADOG + OPS_GENIE + PAGER_DUTY + VICTOR_OPS + WEBHOOK + diff --git a/docs/command/atlas-integrations-delete.txt b/docs/command/atlas-integrations-delete.txt new file mode 100644 index 0000000000..63239e640e --- /dev/null +++ b/docs/command/atlas-integrations-delete.txt @@ -0,0 +1,104 @@ +.. _atlas-integrations-delete: + +========================= +atlas integrations delete +========================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Remove the specified third-party integration from your project. + +Deleting an integration from a project removes that integration configuration only for that project. This does not affect any other project or organization's configured integrations. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas integrations delete [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - integrationType + - string + - true + - Human-readable label that identifies the service integration to delete. Valid values are PAGER_DUTY, MICROSOFT_TEAMS, SLACK, DATADOG, NEW_RELIC, OPS_GENIE, VICTOR_OPS, WEBHOOK, PROMETHEUS. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Integration '' deleted + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Remove the Datadog integration for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas integrations delete DATADOG --projectId 5e2211c17a3e5a48f5497de3 diff --git a/docs/command/atlas-integrations-describe.txt b/docs/command/atlas-integrations-describe.txt new file mode 100644 index 0000000000..8d00468824 --- /dev/null +++ b/docs/command/atlas-integrations-describe.txt @@ -0,0 +1,92 @@ +.. _atlas-integrations-describe: + +=========================== +atlas integrations describe +=========================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the details for the specified third-party integration for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas integrations describe [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - integrationType + - string + - true + - Human-readable label that identifies the integrated service. Valid values are PAGER_DUTY, MICROSOFT_TEAMS, SLACK, DATADOG, NEW_RELIC, OPS_GENIE, VICTOR_OPS, WEBHOOK, PROMETHEUS. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return the JSON-formatted details for the Datadog integration for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas integrations describe DATADOG --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-integrations-list.txt b/docs/command/atlas-integrations-list.txt new file mode 100644 index 0000000000..46aefedf60 --- /dev/null +++ b/docs/command/atlas-integrations-list.txt @@ -0,0 +1,87 @@ +.. _atlas-integrations-list: + +======================= +atlas integrations list +======================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all active third-party integrations for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas integrations list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + TYPE + + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return a JSON-formatted list of active third-party integrations for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas integrations list --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-integrations.txt b/docs/command/atlas-integrations.txt new file mode 100644 index 0000000000..5324838902 --- /dev/null +++ b/docs/command/atlas-integrations.txt @@ -0,0 +1,65 @@ +.. _atlas-integrations: + +================== +atlas integrations +================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Configure third-party integrations for your Atlas project. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for integrations + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-integrations-create` - Create operations. +* :ref:`atlas-integrations-delete` - Remove the specified third-party integration from your project. +* :ref:`atlas-integrations-describe` - Return the details for the specified third-party integration for your project. +* :ref:`atlas-integrations-list` - Return all active third-party integrations for your project. + + +.. toctree:: + :titlesonly: + + create + delete + describe + list + diff --git a/docs/command/atlas-kubernetes-config-apply.txt b/docs/command/atlas-kubernetes-config-apply.txt new file mode 100644 index 0000000000..ca9d805e03 --- /dev/null +++ b/docs/command/atlas-kubernetes-config-apply.txt @@ -0,0 +1,117 @@ +.. _atlas-kubernetes-config-apply: + +============================= +atlas kubernetes config apply +============================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Generate and apply Kubernetes configuration resources for use with Atlas Kubernetes Operator. + +This command exports configurations for Atlas objects including projects, deployments, and users directly into Kubernetes, allowing you to manage these resources using the Atlas Kubernetes Operator. For more information, see https://www.mongodb.com/docs/atlas/atlas-operator/. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas kubernetes config apply [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --clusterName + - strings + - false + - One or more comma separated cluster names to import + * - -h, --help + - + - false + - help for apply + * - --kubeContext + - string + - false + - Name of the kubeconfig context to use. + * - --kubeconfig + - string + - false + - Path to the kubeconfig file to use for CLI requests. + * - --operatorVersion + - string + - false + - Version of Atlas Kubernetes Operator to generate resources for. + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --targetNamespace + - string + - false + - Namespaces to use for generated kubernetes entities + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + # Export and apply all supported resources of a specific project: + atlas kubernetes config apply --projectId= + + +.. code-block:: + :copyable: false + + # Export and apply all supported resources of a specific project and to a specific namespace: + atlas kubernetes config apply --projectId= --targetNamespace= + + +.. code-block:: + :copyable: false + + # Export and apply all supported Project resource, and only the described Deployment resources of a specific project to a specific namespace: + atlas kubernetes config apply --projectId= --clusterName= --targetNamespace= + + +.. code-block:: + :copyable: false + + # Export and apply all supported resources of a specific project to a specific namespace restricting the version of the Atlas Kubernetes Operator: + atlas kubernetes config apply --projectId= --targetNamespace= --operatorVersion=1.5.1 diff --git a/docs/command/atlas-kubernetes-config-generate.txt b/docs/command/atlas-kubernetes-config-generate.txt new file mode 100644 index 0000000000..b51afc6575 --- /dev/null +++ b/docs/command/atlas-kubernetes-config-generate.txt @@ -0,0 +1,142 @@ +.. _atlas-kubernetes-config-generate: + +================================ +atlas kubernetes config generate +================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Generate Kubernetes configuration resources for use with Atlas Kubernetes Operator. + +This command exports configurations for Atlas objects including projects, deployments, and users in a Kubernetes-compatible format, allowing you to manage these resources using the Atlas Kubernetes Operator. For more information, see https://www.mongodb.com/docs/atlas/atlas-operator/ + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas kubernetes config generate [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --clusterName + - strings + - false + - One or more comma separated cluster names to import + * - --dataFederationName + - strings + - false + - One or more comma separated data federation names to import + * - -h, --help + - + - false + - help for generate + * - --includeSecrets + - + - false + - Flag that generates kubernetes secrets with data for projects, users, deployments entities. + * - --independentResources + - + - false + - Flag that makes the generated resources that support independent usage, to use external IDs rather than Kubernetes references. + * - --operatorVersion + - string + - false + - Version of Atlas Kubernetes Operator to generate resources for. This value defaults to "2.5.0". + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --targetNamespace + - string + - false + - Namespaces to use for generated kubernetes entities + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + # Export Project, DatabaseUsers, Deployments resources for a specific project without connection and integration secrets: + atlas kubernetes config generate --projectId= + + +.. code-block:: + :copyable: false + + # Export Project, DatabaseUsers, Deployments resources for a specific project, but use external IDs where supported: + atlas kubernetes config generate --projectId= --independentResources + + +.. code-block:: + :copyable: false + + # Export Project, DatabaseUsers, Deployments resources for a specific project including connection and integration secrets: + atlas kubernetes config generate --projectId= --includeSecrets + + +.. code-block:: + :copyable: false + + # Export Project, DatabaseUsers, Deployments resources for a specific project including connection and integration secrets to a specific namespace: + atlas kubernetes config generate --projectId= --includeSecrets --targetNamespace= + + +.. code-block:: + :copyable: false + + # Export Project, DatabaseUsers, DataFederations and specific Deployment resources for a specific project including connection and integration secrets to a specific namespace: + atlas kubernetes config generate --projectId= --clusterName= --includeSecrets --targetNamespace= + + +.. code-block:: + :copyable: false + + # Export resources for a specific version of the Atlas Kubernetes Operator: + atlas kubernetes config generate --projectId= --targetNamespace= --operatorVersion=1.5.1 + + +.. code-block:: + :copyable: false + + # Export Project, DatabaseUsers, Clusters and specific DataFederation resources for a specific project to a specific namespace: + atlas kubernetes config generate --projectId= --dataFederationName= --targetNamespace= diff --git a/docs/command/atlas-kubernetes-config.txt b/docs/command/atlas-kubernetes-config.txt new file mode 100644 index 0000000000..78d1adf7a0 --- /dev/null +++ b/docs/command/atlas-kubernetes-config.txt @@ -0,0 +1,63 @@ +.. _atlas-kubernetes-config: + +======================= +atlas kubernetes config +======================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage Kubernetes configuration resources. + +This command provides your Kubernetes configuration access to Atlas. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for config + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-kubernetes-config-apply` - Generate and apply Kubernetes configuration resources for use with Atlas Kubernetes Operator. +* :ref:`atlas-kubernetes-config-generate` - Generate Kubernetes configuration resources for use with Atlas Kubernetes Operator. + + +.. toctree:: + :titlesonly: + + apply + generate + diff --git a/docs/command/atlas-kubernetes-operator-install.txt b/docs/command/atlas-kubernetes-operator-install.txt new file mode 100644 index 0000000000..881f335a6e --- /dev/null +++ b/docs/command/atlas-kubernetes-operator-install.txt @@ -0,0 +1,164 @@ +.. _atlas-kubernetes-operator-install: + +================================= +atlas kubernetes operator install +================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Install Atlas Kubernetes Operator to a cluster. + +This command installs a supported version of Atlas Kubernetes Operator to an existing cluster, and optionally imports Atlas resources that are managed by the operator. + +This command creates an API key for the Operator and adds it to Kubernetes as a secret, which the Operator then uses to make Atlas Admin API calls. +The key is scoped to the project when you specify the --projectName option and to the organization when you omit the --projectName option. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas kubernetes operator install [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --atlasGov + - + - false + - Flag that indicates whether to configure Atlas for Government as a target of the operator. + * - -h, --help + - + - false + - help for install + * - --import + - + - false + - Flag that indicates whether to import existing Atlas resources into the cluster for the operator to manage. + * - --kubeContext + - string + - false + - Name of the kubeconfig context to use. + * - --kubeconfig + - string + - false + - Path to the kubeconfig file to use for CLI requests. + * - --operatorVersion + - string + - false + - Version of the operator to install. + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + * - --projectName + - string + - false + - Name of the project to create or use with the installed operator. + * - --resourceDeletionProtection + - + - false + - Toggle atlas operator deletion protection for resources like Projects, Deployments, etc. Read more: https://dochub.mongodb.org/core/ako-deletion-protection This value defaults to true. + * - --subresourceDeletionProtection + - + - false + - Toggle atlas operator deletion protection for subresources like Alerts, Integrations, etc. Read more: https://dochub.mongodb.org/core/ako-deletion-protection This value defaults to true. + * - --targetNamespace + - string + - false + - Namespace where to install the operator. + * - --watchNamespace + - strings + - false + - List that contains namespaces that the operator will listen to. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + # Install latest version of the operator into the default namespace: + atlas kubernetes operator install + + +.. code-block:: + :copyable: false + + # Install the latest version of the operator targeting Atlas for Government instead of regular commercial Atlas: + atlas kubernetes operator install --atlasGov + + +.. code-block:: + :copyable: false + + # Install a specific version of the operator: + atlas kubernetes operator install --operatorVersion=1.7.0 + + +.. code-block:: + :copyable: false + + # Install a specific version of the operator to a namespace and watch only this namespace and a second one: + atlas kubernetes operator install --operatorVersion=1.7.0 --targetNamespace= --watchNamespace=, + + +.. code-block:: + :copyable: false + + # Install and import all objects from an organization: + atlas kubernetes operator install --targetNamespace= --orgID --import + + +.. code-block:: + :copyable: false + + # Install and import objects from a specific project: + atlas kubernetes operator install --targetNamespace= --orgID --projectName --import + + +.. code-block:: + :copyable: false + + # Install the operator and disable deletion protection: + atlas kubernetes operator install --resourceDeletionProtection=false + + +.. code-block:: + :copyable: false + + # Install the operator and disable deletion protection for sub-resources (Atlas project integrations, private endpoints, etc.): + atlas kubernetes operator install --subresourceDeletionProtection=false diff --git a/docs/command/atlas-kubernetes-operator.txt b/docs/command/atlas-kubernetes-operator.txt new file mode 100644 index 0000000000..47d7302cf7 --- /dev/null +++ b/docs/command/atlas-kubernetes-operator.txt @@ -0,0 +1,61 @@ +.. _atlas-kubernetes-operator: + +========================= +atlas kubernetes operator +========================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage Atlas Kubernetes Operator. + +This command manages the Atlas Kubernetes Operator. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for operator + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-kubernetes-operator-install` - Install Atlas Kubernetes Operator to a cluster. + + +.. toctree:: + :titlesonly: + + install + diff --git a/docs/command/atlas-kubernetes.txt b/docs/command/atlas-kubernetes.txt new file mode 100644 index 0000000000..5c8586c12c --- /dev/null +++ b/docs/command/atlas-kubernetes.txt @@ -0,0 +1,63 @@ +.. _atlas-kubernetes: + +================ +atlas kubernetes +================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage Kubernetes resources. + +This command provides access to Kubernetes features within Atlas. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for kubernetes + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-kubernetes-config` - Manage Kubernetes configuration resources. +* :ref:`atlas-kubernetes-operator` - Manage Atlas Kubernetes Operator. + + +.. toctree:: + :titlesonly: + + config + operator + diff --git a/docs/command/atlas-liveMigrations-create.txt b/docs/command/atlas-liveMigrations-create.txt new file mode 100644 index 0000000000..dbdd664ecd --- /dev/null +++ b/docs/command/atlas-liveMigrations-create.txt @@ -0,0 +1,126 @@ +.. _atlas-liveMigrations-create: + +=========================== +atlas liveMigrations create +=========================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create a new push live migration. + +To migrate using scripts, use mongomirror instead of the Atlas CLI. To learn more about mongomirror, see https://www.mongodb.com/docs/atlas/reference/mongomirror/. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas liveMigrations create [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --clusterName + - string + - true + - Human-readable label that identifies the Atlas destination cluster. + * - --drop + - + - false + - Flag that indicates whether this process should drop existing collections from the destination (Atlas) cluster given in --destinationClusterName before starting the migration of data from the source cluster. + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for create + * - --migrationHost + - strings + - true + - List of hosts running the MongoDB Agent that can transfer your MongoDB data from the source (Cloud Manager or Ops Manager) to destination (Atlas) deployments. Each live migration process uses its own dedicated migration host. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --sourceCACertificatePath + - string + - false + - Path to the CA certificate that signed TLS certificates use to authenticate to the source Cloud Manager or Ops Manager cluster. Omit this value if --sourceSSL is not passed. + * - --sourceClusterName + - string + - true + - Human-readable label that identifies the source Cloud Manager or Ops Manager cluster. + * - --sourceManagedAuthentication + - + - false + - Flag that indicates whether MongoDB Automation manages authentication to the source Cloud Manager or Ops Manager cluster. If you set this to true, don't provide values for --sourceUsername and --sourcePassword. + + Mutually exclusive with --sourceUsername. + * - -p, --sourcePassword + - string + - false + - Password that authenticates the username to the source Cloud Manager or Ops Manager cluster. Omit this value if --sourceManagedAuthentication is passed. + * - --sourceProjectId + - string + - true + - Unique 24-hexadecimal digit string that identifies the source project. + * - --sourceSsl + - + - false + - Flag that indicates whether data source has TLS enabled. + * - -u, --sourceUsername + - string + - false + - Human-readable label that identifies the SCRAM-SHA user that connects to the source Cloud Manager or Ops Manager cluster. Omit this value if --sourceManagedAuthentication is set. + + Mutually exclusive with --sourceManagedAuthentication. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID LAGTIME READY FOR CUTOVER STATUS + + diff --git a/docs/command/atlas-liveMigrations-cutover.txt b/docs/command/atlas-liveMigrations-cutover.txt new file mode 100644 index 0000000000..b52d4f9ee8 --- /dev/null +++ b/docs/command/atlas-liveMigrations-cutover.txt @@ -0,0 +1,82 @@ +.. _atlas-liveMigrations-cutover: + +============================ +atlas liveMigrations cutover +============================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Start the cutover for a push live migration and confirm when the cutover completes. When the cutover completes, the application completes the live migration process and stops synchronizing with the source cluster. + +To migrate using scripts, use mongomirror instead of the Atlas CLI. To learn more about mongomirror, see https://www.mongodb.com/docs/atlas/reference/mongomirror/. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas liveMigrations cutover [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for cutover + * - --liveMigrationId + - string + - true + - Unique 24-hexadecimal digit string that identifies the live migration job. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Cutover process successfully started. + + diff --git a/docs/command/atlas-liveMigrations-describe.txt b/docs/command/atlas-liveMigrations-describe.txt new file mode 100644 index 0000000000..2798a01192 --- /dev/null +++ b/docs/command/atlas-liveMigrations-describe.txt @@ -0,0 +1,62 @@ +.. _atlas-liveMigrations-describe: + +============================= +atlas liveMigrations describe +============================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return a push live migration job. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas liveMigrations describe [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - --liveMigrationId + - string + - true + - Unique 24-hexadecimal digit string that identifies the live migration job. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + diff --git a/docs/command/atlas-liveMigrations-link-create.txt b/docs/command/atlas-liveMigrations-link-create.txt new file mode 100644 index 0000000000..e736135d52 --- /dev/null +++ b/docs/command/atlas-liveMigrations-link-create.txt @@ -0,0 +1,82 @@ +.. _atlas-liveMigrations-link-create: + +================================ +atlas liveMigrations link create +================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create a new link-token for a push live migration. + +To migrate using scripts, use mongomirror instead of the Atlas CLI. To learn more about mongomirror, see https://www.mongodb.com/docs/atlas/reference/mongomirror/. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas liveMigrations link create [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --accessListIp + - strings + - false + - IP address access list entries that are associated with the link-token. + * - -h, --help + - + - false + - help for create + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Link-token '' successfully created. + + diff --git a/docs/command/atlas-liveMigrations-link-delete.txt b/docs/command/atlas-liveMigrations-link-delete.txt new file mode 100644 index 0000000000..5b4573824a --- /dev/null +++ b/docs/command/atlas-liveMigrations-link-delete.txt @@ -0,0 +1,76 @@ +.. _atlas-liveMigrations-link-delete: + +================================ +atlas liveMigrations link delete +================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Delete one link-token. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas liveMigrations link delete [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Link-token successfully deleted + + diff --git a/docs/command/atlas-liveMigrations-link.txt b/docs/command/atlas-liveMigrations-link.txt new file mode 100644 index 0000000000..7d81d1f085 --- /dev/null +++ b/docs/command/atlas-liveMigrations-link.txt @@ -0,0 +1,61 @@ +.. _atlas-liveMigrations-link: + +========================= +atlas liveMigrations link +========================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage the link-token for your organization. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for link + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-liveMigrations-link-create` - Create a new link-token for a push live migration. +* :ref:`atlas-liveMigrations-link-delete` - Delete one link-token. + + +.. toctree:: + :titlesonly: + + create + delete + diff --git a/docs/command/atlas-liveMigrations-validation-create.txt b/docs/command/atlas-liveMigrations-validation-create.txt new file mode 100644 index 0000000000..f47530b581 --- /dev/null +++ b/docs/command/atlas-liveMigrations-validation-create.txt @@ -0,0 +1,126 @@ +.. _atlas-liveMigrations-validation-create: + +====================================== +atlas liveMigrations validation create +====================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create a new validation request for a push live migration. + +To migrate using scripts, use mongomirror instead of the Atlas CLI. To learn more about mongomirror, see https://www.mongodb.com/docs/atlas/reference/mongomirror/. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas liveMigrations validation create [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --clusterName + - string + - true + - Human-readable label that identifies the Atlas destination cluster. + * - --drop + - + - false + - Flag that indicates whether this process should drop existing collections from the destination (Atlas) cluster given in --destinationClusterName before starting the migration of data from the source cluster. + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for create + * - --migrationHost + - strings + - true + - List of hosts running the MongoDB Agent that can transfer your MongoDB data from the source (Cloud Manager or Ops Manager) to destination (Atlas) deployments. Each live migration process uses its own dedicated migration host. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --sourceCACertificatePath + - string + - false + - Path to the CA certificate that signed TLS certificates use to authenticate to the source Cloud Manager or Ops Manager cluster. Omit this value if --sourceSSL is not passed. + * - --sourceClusterName + - string + - true + - Human-readable label that identifies the source Cloud Manager or Ops Manager cluster. + * - --sourceManagedAuthentication + - + - false + - Flag that indicates whether MongoDB Automation manages authentication to the source Cloud Manager or Ops Manager cluster. If you set this to true, don't provide values for --sourceUsername and --sourcePassword. + + Mutually exclusive with --sourceUsername. + * - -p, --sourcePassword + - string + - false + - Password that authenticates the username to the source Cloud Manager or Ops Manager cluster. Omit this value if --sourceManagedAuthentication is passed. + * - --sourceProjectId + - string + - true + - Unique 24-hexadecimal digit string that identifies the source project. + * - --sourceSsl + - + - false + - Flag that indicates whether data source has TLS enabled. + * - -u, --sourceUsername + - string + - false + - Human-readable label that identifies the SCRAM-SHA user that connects to the source Cloud Manager or Ops Manager cluster. Omit this value if --sourceManagedAuthentication is set. + + Mutually exclusive with --sourceManagedAuthentication. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID PROJECT ID SOURCE PROJECT ID STATUS + + diff --git a/docs/command/atlas-liveMigrations-validation-describe.txt b/docs/command/atlas-liveMigrations-validation-describe.txt new file mode 100644 index 0000000000..85cf8225b7 --- /dev/null +++ b/docs/command/atlas-liveMigrations-validation-describe.txt @@ -0,0 +1,80 @@ +.. _atlas-liveMigrations-validation-describe: + +======================================== +atlas liveMigrations validation describe +======================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return one validation job. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas liveMigrations validation describe [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --validationId + - string + - false + - Unique 24-hexadecimal digit string that identifies the validation job. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID PROJECT ID SOURCE PROJECT ID STATUS + + diff --git a/docs/command/atlas-liveMigrations-validation.txt b/docs/command/atlas-liveMigrations-validation.txt new file mode 100644 index 0000000000..e0e174761c --- /dev/null +++ b/docs/command/atlas-liveMigrations-validation.txt @@ -0,0 +1,61 @@ +.. _atlas-liveMigrations-validation: + +=============================== +atlas liveMigrations validation +=============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage a Live Migration validation job for your project. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for validation + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-liveMigrations-validation-create` - Create a new validation request for a push live migration. +* :ref:`atlas-liveMigrations-validation-describe` - Return one validation job. + + +.. toctree:: + :titlesonly: + + create + describe + diff --git a/docs/command/atlas-liveMigrations.txt b/docs/command/atlas-liveMigrations.txt new file mode 100644 index 0000000000..015e14547d --- /dev/null +++ b/docs/command/atlas-liveMigrations.txt @@ -0,0 +1,67 @@ +.. _atlas-liveMigrations: + +==================== +atlas liveMigrations +==================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage a Live Migration to Atlas for your organization. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for liveMigrations + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-liveMigrations-create` - Create a new push live migration. +* :ref:`atlas-liveMigrations-cutover` - Start the cutover for a push live migration and confirm when the cutover completes. When the cutover completes, the application completes the live migration process and stops synchronizing with the source cluster. +* :ref:`atlas-liveMigrations-describe` - Return a push live migration job. +* :ref:`atlas-liveMigrations-link` - Manage the link-token for your organization. +* :ref:`atlas-liveMigrations-validation` - Manage a Live Migration validation job for your project. + + +.. toctree:: + :titlesonly: + + create + cutover + describe + link + validation + diff --git a/docs/command/atlas-logs-download.txt b/docs/command/atlas-logs-download.txt new file mode 100644 index 0000000000..576714f0de --- /dev/null +++ b/docs/command/atlas-logs-download.txt @@ -0,0 +1,126 @@ +.. _atlas-logs-download: + +=================== +atlas logs download +=================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Download a compressed file that contains the MongoDB logs for the specified host. + +This command downloads a file with a .gz extension. + +To find the hostnames for an Atlas project, use the process list command. + +To use this command, you must authenticate with a user account or an API key with the Project Data Access Read/Write role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas logs download [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - hostname + - string + - true + - Label that identifies the host that stores the log files that you want to download. + * - mongodb.gz|mongos.gz|mongosqld.gz|mongodb-audit-log.gz|mongos-audit-log.gz + - string + - true + - Log file that you want to return. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -d, --decompress + - + - false + - Flag that indicates whether to decompress the log files. + * - --end + - int + - false + - Ending date and time for the range of log messages to retrieve, given in UNIX time. Defaults to the start date plus 24 hours, if the start date is set. If start date is not provided, ending time defaults to the current time. + * - --force + - + - false + - Flag that indicates whether to overwrite the destination file. + * - -h, --help + - + - false + - help for download + * - --out + - string + - false + - Output file name. This value defaults to the log name. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --start + - int + - false + - UNIX Epoch-formatted starting date and time for the range of log messages to retrieve. This value defaults to 24 hours prior to the current timestamp. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Download of completed. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Download the mongodb log file from the host atlas-123abc-shard-00-00.111xx.mongodb.net for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas logs download atlas-123abc-shard-00-00.111xx.mongodb.net mongodb.gz --projectId 5e2211c17a3e5a48f5497de3 diff --git a/docs/command/atlas-logs.txt b/docs/command/atlas-logs.txt new file mode 100644 index 0000000000..36035a512e --- /dev/null +++ b/docs/command/atlas-logs.txt @@ -0,0 +1,59 @@ +.. _atlas-logs: + +========== +atlas logs +========== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Download host logs for your project. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for logs + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-logs-download` - Download a compressed file that contains the MongoDB logs for the specified host. + + +.. toctree:: + :titlesonly: + + download + diff --git a/docs/command/atlas-maintenanceWindows-clear.txt b/docs/command/atlas-maintenanceWindows-clear.txt new file mode 100644 index 0000000000..300aafbd30 --- /dev/null +++ b/docs/command/atlas-maintenanceWindows-clear.txt @@ -0,0 +1,92 @@ +.. _atlas-maintenanceWindows-clear: + +============================== +atlas maintenanceWindows clear +============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Clear the current maintenance window setting for your project. + +To learn more about maintenance windows, see https://www.mongodb.com/docs/atlas/tutorial/cluster-maintenance-window/. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas maintenanceWindows clear [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for clear + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Maintenance window removed. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Clear the current maintenance window for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas maintenanceWindows clear --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-maintenanceWindows-defer.txt b/docs/command/atlas-maintenanceWindows-defer.txt new file mode 100644 index 0000000000..f586ce1e7e --- /dev/null +++ b/docs/command/atlas-maintenanceWindows-defer.txt @@ -0,0 +1,88 @@ +.. _atlas-maintenanceWindows-defer: + +============================== +atlas maintenanceWindows defer +============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Defer scheduled maintenance for your project for one week. + +To learn more about maintenance windows, see https://www.mongodb.com/docs/atlas/tutorial/cluster-maintenance-window/. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas maintenanceWindows defer [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for defer + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Maintenance window deferred. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Defer scheduled maintenance for one week for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas maintenanceWindows defer --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-maintenanceWindows-describe.txt b/docs/command/atlas-maintenanceWindows-describe.txt new file mode 100644 index 0000000000..2401651d5e --- /dev/null +++ b/docs/command/atlas-maintenanceWindows-describe.txt @@ -0,0 +1,89 @@ +.. _atlas-maintenanceWindows-describe: + +================================= +atlas maintenanceWindows describe +================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the maintenance window details for your project. + +To learn more about maintenance windows, see https://www.mongodb.com/docs/atlas/tutorial/cluster-maintenance-window/. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas maintenanceWindows describe [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + DAY OF THE WEEK HOUR OF DAY START ASAP + + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return the maintenance window for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas maintenanceWindows describe --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-maintenanceWindows-update.txt b/docs/command/atlas-maintenanceWindows-update.txt new file mode 100644 index 0000000000..affa97dd2f --- /dev/null +++ b/docs/command/atlas-maintenanceWindows-update.txt @@ -0,0 +1,100 @@ +.. _atlas-maintenanceWindows-update: + +=============================== +atlas maintenanceWindows update +=============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Modify the maintenance window for your project. + +To learn more about maintenance windows, see https://www.mongodb.com/docs/atlas/tutorial/cluster-maintenance-window/. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas maintenanceWindows update [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --dayOfWeek + - int + - false + - Day of the week that you want the maintenance window to start, as a 1-based integer. Use 1 for Sunday, 2 for Monday, 3 for Tuesday, 4 for Wednesday, 5 for Thursday, 6 for Friday, or 7 for Saturday. + * - -h, --help + - + - false + - help for update + * - --hourOfDay + - int + - false + - Hour of the day that you want the maintenance window to start according to a 24-hour clock. Use 0 for midnight and 12 for noon. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --startASAP + - + - false + - Flag that starts maintenance immediately upon receiving this request. This flag resets to false after Atlas completes maintenance. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Maintenance window updated. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Update the maintenance window to midnight on Saturdays for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas maintenanceWindows update --dayOfWeek 7 --hourOfDay 0 --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-maintenanceWindows.txt b/docs/command/atlas-maintenanceWindows.txt new file mode 100644 index 0000000000..fa4ee9c2d8 --- /dev/null +++ b/docs/command/atlas-maintenanceWindows.txt @@ -0,0 +1,65 @@ +.. _atlas-maintenanceWindows: + +======================== +atlas maintenanceWindows +======================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage Atlas maintenance windows. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for maintenanceWindows + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-maintenanceWindows-clear` - Clear the current maintenance window setting for your project. +* :ref:`atlas-maintenanceWindows-defer` - Defer scheduled maintenance for your project for one week. +* :ref:`atlas-maintenanceWindows-describe` - Return the maintenance window details for your project. +* :ref:`atlas-maintenanceWindows-update` - Modify the maintenance window for your project. + + +.. toctree:: + :titlesonly: + + clear + defer + describe + update + diff --git a/docs/command/atlas-metrics-databases-describe.txt b/docs/command/atlas-metrics-databases-describe.txt new file mode 100644 index 0000000000..74def3d321 --- /dev/null +++ b/docs/command/atlas-metrics-databases-describe.txt @@ -0,0 +1,131 @@ +.. _atlas-metrics-databases-describe: + +================================ +atlas metrics databases describe +================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the measurements of a database on the specified host. + +To return the hostname and port needed for this command, run +atlas process list + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas metrics databases describe [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - hostname:port + - string + - true + - Hostname and port number of the instance running the MongoDB process. + * - databaseName + - string + - true + - Label that identifies the database from which you want to retrieve metrics. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --end + - string + - false + - ISO 8601-formatted date and time that specifies when to stop retrieving measurements. You can't set this parameter and period in the same request. + + Mutually exclusive with --period. + * - --granularity + - string + - true + - ISO 8601-formatted duration that specifies the interval between measurement data points. Only the following subset of ISO 8601-formatted time periods are supported: PT10S, PT1M, PT5M, PT1H, P1D. When you specify granularity, you must specify either period or start and end. + * - -h, --help + - + - false + - help for describe + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. + * - --period + - string + - false + - ISO 8601-formatted time period that specifies the length of time in the past to query. You can't set this parameter and the start or end parameter in the same request. + + Mutually exclusive with --start, --end. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --start + - string + - false + - ISO 8601-formatted date and time that specifies when to start retrieving measurements. You can't set this parameter and period in the same request. + + Mutually exclusive with --period. + * - --type + - strings + - false + - Measurements to return. This option returns all measurements by default. Valid values include DATABASE_AVERAGE_OBJECT_SIZE, DATABASE_COLLECTION_COUNT, DATABASE_DATA_SIZE, DATABASE_STORAGE_SIZE, DATABASE_INDEX_SIZE, DATABASE_INDEX_COUNT, DATABASE_EXTENT_COUNT, DATABASE_OBJECT_COUNT, and DATABASE_VIEW_COUNT + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return the JSON-formatted database metrics from the last 36 hours with 5-minute granularity for the database named testDB in the host atlas-lnmtkm-shard-00-00.ajlj3.mongodb.net:27017 + atlas metrics databases describe atlas-lnmtkm-shard-00-00.ajlj3.mongodb.net:27017 testDB --granularity PT1M --period P1DT12H --output json diff --git a/docs/command/atlas-metrics-databases-list.txt b/docs/command/atlas-metrics-databases-list.txt new file mode 100644 index 0000000000..b3cc899445 --- /dev/null +++ b/docs/command/atlas-metrics-databases-list.txt @@ -0,0 +1,118 @@ +.. _atlas-metrics-databases-list: + +============================ +atlas metrics databases list +============================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all databases running on the specified host for your project. + +To return the hostname and port needed for this command, run +atlas processes list + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas metrics databases list [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - hostname:port + - string + - true + - Hostname and port number of the instance running the MongoDB process. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - --omitCount + - + - false + - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + DATABASE NAME + + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return a JSON-formatted list of available databases for the host atlas-lnmtkm-shard-00-00.ajlj3.mongodb.net:27017 + atlas metrics databases list atlas-lnmtkm-shard-00-00.ajlj3.mongodb.net:27017 --output json diff --git a/docs/command/atlas-metrics-databases.txt b/docs/command/atlas-metrics-databases.txt new file mode 100644 index 0000000000..2db0e1a894 --- /dev/null +++ b/docs/command/atlas-metrics-databases.txt @@ -0,0 +1,61 @@ +.. _atlas-metrics-databases: + +======================= +atlas metrics databases +======================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +List available databases or database metrics for a given host. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for databases + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-metrics-databases-describe` - Return the measurements of a database on the specified host. +* :ref:`atlas-metrics-databases-list` - Return all databases running on the specified host for your project. + + +.. toctree:: + :titlesonly: + + describe + list + diff --git a/docs/command/atlas-metrics-disks-describe.txt b/docs/command/atlas-metrics-disks-describe.txt new file mode 100644 index 0000000000..3e20344122 --- /dev/null +++ b/docs/command/atlas-metrics-disks-describe.txt @@ -0,0 +1,133 @@ +.. _atlas-metrics-disks-describe: + +============================ +atlas metrics disks describe +============================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the measurements of a disk or partition on the specified host. + +To return the hostname and port needed for this command, run +atlas processes list + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas metrics disks describe [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - hostname:port + - string + - true + - Hostname and port number of the instance running the MongoDB process. + * - diskName + - string + - true + - Label that identifies the disk or partition from which you want to retrieve metrics. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --end + - string + - false + - ISO 8601-formatted date and time that specifies when to stop retrieving measurements. You can't set this parameter and period in the same request. + + Mutually exclusive with --period. + * - --granularity + - string + - true + - ISO 8601-formatted duration that specifies the interval between measurement data points. Only the following subset of ISO 8601-formatted time periods are supported: PT10S, PT1M, PT5M, PT1H, P1D. When you specify granularity, you must specify either period or start and end. + * - -h, --help + - + - false + - help for describe + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. + * - --period + - string + - false + - ISO 8601-formatted time period that specifies the length of time in the past to query. You can't set this parameter and the start or end parameter in the same request. + + Mutually exclusive with --start, --end. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --start + - string + - false + - ISO 8601-formatted date and time that specifies when to start retrieving measurements. You can't set this parameter and period in the same request. + + Mutually exclusive with --period. + * - --type + - strings + - false + - Measurements to return. This option returns all measurements by default. Valid values include DATABASE_AVERAGE_OBJECT_SIZE, DATABASE_COLLECTION_COUNT, DATABASE_DATA_SIZE, DATABASE_STORAGE_SIZE, DATABASE_INDEX_SIZE, DATABASE_INDEX_COUNT, DATABASE_EXTENT_COUNT, DATABASE_OBJECT_COUNT, and DATABASE_VIEW_COUNT + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return the JSON-formatted disk metrics from the last 36 hours with 5-minute granularity for the database named testDB in the host atlas-lnmtkm-shard-00-00.ajlj3.mongodb.net:27017 + atlas metrics disks describe atlas-lnmtkm-shard-00-00.ajlj3.mongodb.net:27017 testDB --granularity PT1M --period P1DT12H --output json diff --git a/docs/command/atlas-metrics-disks-list.txt b/docs/command/atlas-metrics-disks-list.txt new file mode 100644 index 0000000000..d541f41a04 --- /dev/null +++ b/docs/command/atlas-metrics-disks-list.txt @@ -0,0 +1,118 @@ +.. _atlas-metrics-disks-list: + +======================== +atlas metrics disks list +======================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all disks or disk partitions on the specified host for your project. + +To return the hostname and port needed for this command, run: +$ atlas processes list + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas metrics disks list [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - hostname:port + - string + - true + - Hostname and port number of the instance running the MongoDB process. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - --omitCount + - + - false + - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + PARTITION NAME + + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return a JSON-formatted list of disks and partitions for the host atlas-lnmtkm-shard-00-00.ajlj3.mongodb.net:27017 + atlas metrics disks list atlas-lnmtkm-shard-00-00.ajlj3.mongodb.net:27017 --output json diff --git a/docs/command/atlas-metrics-disks.txt b/docs/command/atlas-metrics-disks.txt new file mode 100644 index 0000000000..42bd8f2120 --- /dev/null +++ b/docs/command/atlas-metrics-disks.txt @@ -0,0 +1,61 @@ +.. _atlas-metrics-disks: + +=================== +atlas metrics disks +=================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +List available disks or disk metrics for a given host. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for disks + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-metrics-disks-describe` - Return the measurements of a disk or partition on the specified host. +* :ref:`atlas-metrics-disks-list` - Return all disks or disk partitions on the specified host for your project. + + +.. toctree:: + :titlesonly: + + describe + list + diff --git a/docs/command/atlas-metrics-processes.txt b/docs/command/atlas-metrics-processes.txt new file mode 100644 index 0000000000..62cc60519f --- /dev/null +++ b/docs/command/atlas-metrics-processes.txt @@ -0,0 +1,129 @@ +.. _atlas-metrics-processes: + +======================= +atlas metrics processes +======================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the process measurements for the specified host. + +To return the hostname and port needed for this command, run +atlas processes list + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas metrics processes [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - hostname:port + - string + - true + - Hostname and port number of the instance running the MongoDB process. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --end + - string + - false + - ISO 8601-formatted date and time that specifies when to stop retrieving measurements. You can't set this parameter and period in the same request. + + Mutually exclusive with --period. + * - --granularity + - string + - true + - ISO 8601-formatted duration that specifies the interval between measurement data points. Only the following subset of ISO 8601-formatted time periods are supported: PT10S, PT1M, PT5M, PT1H, P1D. When you specify granularity, you must specify either period or start and end. + * - -h, --help + - + - false + - help for processes + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. + * - --period + - string + - false + - ISO 8601-formatted time period that specifies the length of time in the past to query. You can't set this parameter and the start or end parameter in the same request. + + Mutually exclusive with --start, --end. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --start + - string + - false + - ISO 8601-formatted date and time that specifies when to start retrieving measurements. You can't set this parameter and period in the same request. + + Mutually exclusive with --period. + * - --type + - strings + - false + - Measurements to return. This option returns all measurements by default. To learn which values the CLI accepts, see the Items Enum for m in the Atlas API spec: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/#tag/Monitoring-and-Logs/operation/getHostMeasurements/. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return the JSON-formatted process metrics for the host atlas-lnmtkm-shard-00-00.ajlj3.mongodb.net:27017 + atlas metrics processes atlas-lnmtkm-shard-00-00.ajlj3.mongodb.net:27017 --output json diff --git a/docs/command/atlas-metrics.txt b/docs/command/atlas-metrics.txt new file mode 100644 index 0000000000..a1c5aadc66 --- /dev/null +++ b/docs/command/atlas-metrics.txt @@ -0,0 +1,63 @@ +.. _atlas-metrics: + +============= +atlas metrics +============= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Get metrics on the MongoDB process. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for metrics + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-metrics-databases` - List available databases or database metrics for a given host. +* :ref:`atlas-metrics-disks` - List available disks or disk metrics for a given host. +* :ref:`atlas-metrics-processes` - Return the process measurements for the specified host. + + +.. toctree:: + :titlesonly: + + databases + disks + processes + diff --git a/docs/command/atlas-networking-containers-delete.txt b/docs/command/atlas-networking-containers-delete.txt new file mode 100644 index 0000000000..689524ce53 --- /dev/null +++ b/docs/command/atlas-networking-containers-delete.txt @@ -0,0 +1,102 @@ +.. _atlas-networking-containers-delete: + +================================== +atlas networking containers delete +================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Remove the specified network peering container from your project before creating any clusters. Don't run this command if you have clusters in your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas networking containers delete [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - containerId + - string + - true + - Unique 24-hexadecimal digit string that identifies the network container that you want to remove. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Network peering container '' deleted + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Remove the network peering container with the ID 5e44103f8d614b2f0b6530d8 from the project with the ID 5e2211c17a3e5a48f5497de3: + atlas networking containers delete 5e44103f8d614b2f0b6530d8 --projectId 5e2211c17a3e5a48f5497de3 diff --git a/docs/command/atlas-networking-containers-list.txt b/docs/command/atlas-networking-containers-list.txt new file mode 100644 index 0000000000..a8750b67d6 --- /dev/null +++ b/docs/command/atlas-networking-containers-list.txt @@ -0,0 +1,92 @@ +.. _atlas-networking-containers-list: + +================================ +atlas networking containers list +================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all network peering containers for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas networking containers list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - --omitCount + - + - false + - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --provider + - string + - false + - Name of your cloud service provider. Valid values are AWS, AZURE, or GCP. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return a JSON-formatted list of network peering containers in the project with the ID 5e2211c17a3e5a48f5497de3: + atlas networking containers list --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-networking-containers.txt b/docs/command/atlas-networking-containers.txt new file mode 100644 index 0000000000..6756369132 --- /dev/null +++ b/docs/command/atlas-networking-containers.txt @@ -0,0 +1,61 @@ +.. _atlas-networking-containers: + +=========================== +atlas networking containers +=========================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage Network Peering containers. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for containers + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-networking-containers-delete` - Remove the specified network peering container from your project before creating any clusters. Don't run this command if you have clusters in your project. +* :ref:`atlas-networking-containers-list` - Return all network peering containers for your project. + + +.. toctree:: + :titlesonly: + + delete + list + diff --git a/docs/command/atlas-networking-peering-create-aws.txt b/docs/command/atlas-networking-peering-create-aws.txt new file mode 100644 index 0000000000..111a3de4cc --- /dev/null +++ b/docs/command/atlas-networking-peering-create-aws.txt @@ -0,0 +1,110 @@ +.. _atlas-networking-peering-create-aws: + +=================================== +atlas networking peering create aws +=================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create a network peering connection between the Atlas VPC and your AWS VPC. + +The network peering create command checks if a VPC exists in the region you specify for your Atlas project. If one exists, this command creates the peering connection between that VPC and your VPC. If an Atlas VPC doesn't exist, this command creates one and creates a connection between it and your VPC. + +To learn more about network peering connections, see https://www.mongodb.com/docs/atlas/security-vpc-peering/. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas networking peering create aws [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --accountId + - string + - true + - Unique twelve-digit AWS account ID that owns the peer VPC. + * - --atlasCidrBlock + - string + - false + - CIDR block that Atlas uses for all network peering connections created in the project. This option is required only if you do not already have an Atlas VPC. To learn more, see the Atlas UI tab at https://dochub.mongodb.org/core/peering-connection-atlas. + * - -h, --help + - + - false + - help for aws + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --region + - string + - true + - Cloud provider region where the VPC that you peered with the Atlas VPC resides. + * - --routeTableCidrBlock + - string + - true + - Peer VPC CIDR block or subnet. + * - --vpcId + - string + - true + - Unique identifier of the peer VPC. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Network peering connection '' created. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Create a network peering connection between the Atlas VPC in CIDR block 192.168.0.0/24 and your AWS VPC in CIDR block 10.0.0.0/24 for AWS account number 854333054055: + atlas networking peering create aws --accountId 854333054055 --atlasCidrBlock 192.168.0.0/24 --region us-east-1 --routeTableCidrBlock 10.0.0.0/24 --vpcId vpc-078ac381aa90e1e63 diff --git a/docs/command/atlas-networking-peering-create-azure.txt b/docs/command/atlas-networking-peering-create-azure.txt new file mode 100644 index 0000000000..714d7b51a0 --- /dev/null +++ b/docs/command/atlas-networking-peering-create-azure.txt @@ -0,0 +1,116 @@ +.. _atlas-networking-peering-create-azure: + +===================================== +atlas networking peering create azure +===================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create a network peering connection between the Atlas VPC and your Azure VNet. + +Before you create an Azure network peering connection, complete the prerequisites listed here: https://www.mongodb.com/docs/atlas/reference/api/vpc-create-peering-connection/#prerequisites. + +The network peering create command checks if a VNet exists in the region you specify for your Atlas project. If one exists, this command creates the peering connection between that VNet and your VPC. If an Atlas VPC does not exist, this command creates one and creates a connection between it and your VNet. + +To learn more about network peering connections, see https://www.mongodb.com/docs/atlas/security-vpc-peering/. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas networking peering create azure [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --atlasCidrBlock + - string + - false + - CIDR block that Atlas uses for all network peering connections created in the project. This option is required only if you do not already have an Atlas VPC. To learn more, see the Atlas UI tab at https://dochub.mongodb.org/core/peering-connection-atlas. + * - --directoryId + - string + - true + - Unique identifier for an Azure AD directory. + * - -h, --help + - + - false + - help for azure + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --region + - string + - true + - Cloud provider region where the VPC that you peered with the Atlas VPC resides. + * - --resourceGroup + - string + - true + - Name of your Azure resource group. + * - --subscriptionId + - string + - true + - Unique identifier of the Azure subscription in which the VNet resides. + * - --vnet + - string + - true + - Name of your Azure VNet. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Network peering connection '' created. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Create a network peering connection between the Atlas VPC in CIDR block 192.168.0.0/24 and your Azure VNet named atlascli-test in in US_EAST_2: + atlas networking peering create azure --atlasCidrBlock 192.168.0.0/24 --directoryId 56657fdb-ca45-40dc-fr56-77fd8b6d2b37 --subscriptionId 345654f3-77cf-4084-9e06-8943a079ed75 --resourceGroup atlascli-test --region US_EAST_2 --vnet atlascli-test diff --git a/docs/command/atlas-networking-peering-create-gcp.txt b/docs/command/atlas-networking-peering-create-gcp.txt new file mode 100644 index 0000000000..6110e4fcd2 --- /dev/null +++ b/docs/command/atlas-networking-peering-create-gcp.txt @@ -0,0 +1,106 @@ +.. _atlas-networking-peering-create-gcp: + +=================================== +atlas networking peering create gcp +=================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create a network peering connection between the Atlas VPC and your Google Cloud VPC. + +The network peering create command checks if a VPC exists in the region you specify for your Atlas project. If one exists, this command creates the peering connection between that VPC and your VPC. If an Atlas VPC doesn't exist, this command creates one and creates a connection between it and your VPC. + +To learn more about network peering connections, see https://www.mongodb.com/docs/atlas/security-vpc-peering/. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas networking peering create gcp [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --atlasCidrBlock + - string + - true + - CIDR block that Atlas uses for all network peering connections created in the project. This option is required only if you do not already have an Atlas VPC. To learn more, see the Atlas UI tab at https://dochub.mongodb.org/core/peering-connection-atlas. + * - --gcpProjectId + - string + - false + - Unique identifier of the GCP project in which the network peer resides. + * - -h, --help + - + - false + - help for gcp + * - --network + - string + - false + - Unique identifier of the Network Peering connection in the Atlas project. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --region + - strings + - false + - List of Atlas regions where the container resides. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Network peering connection '' created. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Create a network peering connection between the Atlas VPC in CIDR block 192.168.0.0/24 and your GCP VPC with the GCP project ID grandiose-branch-256701 in the network named cli-test: + atlas networking peering create gcp --atlasCidrBlock 192.168.0.0/24 --gcpProjectId grandiose-branch-256701 --network cli-test --output json diff --git a/docs/command/atlas-networking-peering-create.txt b/docs/command/atlas-networking-peering-create.txt new file mode 100644 index 0000000000..fbe947b7b4 --- /dev/null +++ b/docs/command/atlas-networking-peering-create.txt @@ -0,0 +1,63 @@ +.. _atlas-networking-peering-create: + +=============================== +atlas networking peering create +=============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create a connection with AWS, Azure and Google Cloud. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for create + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-networking-peering-create-aws` - Create a network peering connection between the Atlas VPC and your AWS VPC. +* :ref:`atlas-networking-peering-create-azure` - Create a network peering connection between the Atlas VPC and your Azure VNet. +* :ref:`atlas-networking-peering-create-gcp` - Create a network peering connection between the Atlas VPC and your Google Cloud VPC. + + +.. toctree:: + :titlesonly: + + aws + azure + gcp + diff --git a/docs/command/atlas-networking-peering-delete.txt b/docs/command/atlas-networking-peering-delete.txt new file mode 100644 index 0000000000..ec44e2d033 --- /dev/null +++ b/docs/command/atlas-networking-peering-delete.txt @@ -0,0 +1,102 @@ +.. _atlas-networking-peering-delete: + +=============================== +atlas networking peering delete +=============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Remove the specified peering connection from your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas networking peering delete [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - peerId + - string + - true + - Unique ID of the network peering connection that you want to delete. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Peering connection '' deleted + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Remove the network peering connection with the ID 5f60c5bd0948295c093565ba in the project with the ID 5e2211c17a3e5a48f5497de3: + atlas networking peering delete 5f60c5bd0948295c093565ba --projectId 5e2211c17a3e5a48f5497de3 diff --git a/docs/command/atlas-networking-peering-list.txt b/docs/command/atlas-networking-peering-list.txt new file mode 100644 index 0000000000..e47c6e0848 --- /dev/null +++ b/docs/command/atlas-networking-peering-list.txt @@ -0,0 +1,92 @@ +.. _atlas-networking-peering-list: + +============================= +atlas networking peering list +============================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the details for all network peering connections for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas networking peering list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - --omitCount + - + - false + - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --provider + - string + - false + - Name of your cloud service provider. Valid values are AWS, AZURE, or GCP. This value defaults to "AWS". + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return the JSON-formatted details for all network peering connections in the project with the ID 5e2211c17a3e5a48f5497de3: + atlas networking peering list --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-networking-peering-watch.txt b/docs/command/atlas-networking-peering-watch.txt new file mode 100644 index 0000000000..7c8e3ec7af --- /dev/null +++ b/docs/command/atlas-networking-peering-watch.txt @@ -0,0 +1,108 @@ +.. _atlas-networking-peering-watch: + +============================== +atlas networking peering watch +============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Watch the specified peering connection in your project until it becomes available. + +This command checks the peering connection's status periodically until it becomes available. +Once it reaches the expected state, the command prints "Network peering changes completed." +If you run the command in the terminal, it blocks the terminal session until the resource is available. +You can interrupt the command's polling at any time with CTRL-C. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas networking peering watch [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - peerId + - string + - true + - Unique ID of the network peering connection that you want to watch. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for watch + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + + Network peering changes completed. + + +Examples +-------- + +.. code-block:: + :copyable: false + + Watch for the network peering connection with the ID 5f621dc701240c5b7c3a888e to become available in the project with the ID 5e2211c17a3e5a48f5497de3: + atlas networking peering watch 5f621dc701240c5b7c3a888e --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-networking-peering.txt b/docs/command/atlas-networking-peering.txt new file mode 100644 index 0000000000..fdeb3a8f5f --- /dev/null +++ b/docs/command/atlas-networking-peering.txt @@ -0,0 +1,65 @@ +.. _atlas-networking-peering: + +======================== +atlas networking peering +======================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage Network Peering connections. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for peering + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-networking-peering-create` - Create a connection with AWS, Azure and Google Cloud. +* :ref:`atlas-networking-peering-delete` - Remove the specified peering connection from your project. +* :ref:`atlas-networking-peering-list` - Return the details for all network peering connections for your project. +* :ref:`atlas-networking-peering-watch` - Watch the specified peering connection in your project until it becomes available. + + +.. toctree:: + :titlesonly: + + create + delete + list + watch + diff --git a/docs/command/atlas-networking.txt b/docs/command/atlas-networking.txt new file mode 100644 index 0000000000..e98acb29b2 --- /dev/null +++ b/docs/command/atlas-networking.txt @@ -0,0 +1,61 @@ +.. _atlas-networking: + +================ +atlas networking +================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage or configure network peering for your Atlas project. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for networking + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-networking-containers` - Manage Network Peering containers. +* :ref:`atlas-networking-peering` - Manage Network Peering connections. + + +.. toctree:: + :titlesonly: + + containers + peering + diff --git a/docs/command/atlas-organizations-apiKeys-accessLists-create.txt b/docs/command/atlas-organizations-apiKeys-accessLists-create.txt new file mode 100644 index 0000000000..7ba279eced --- /dev/null +++ b/docs/command/atlas-organizations-apiKeys-accessLists-create.txt @@ -0,0 +1,104 @@ +.. _atlas-organizations-apiKeys-accessLists-create: + +============================================== +atlas organizations apiKeys accessLists create +============================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create an IP access list entry for your API Key. + +To view possible values for the apiKey option, run atlas organizations apiKeys list. + +To use this command, you must authenticate with a user account or an API key with the Read Write role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas organizations apiKeys accessLists create [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --apiKey + - string + - true + - Unique 24-digit ID that identifies your API key. + * - --cidr + - strings + - false + - Access list entry in CIDR notation to be added for your API key. To add more than one entry, you can specify each entry with a separate cidr flag or specify all the entries as a comma-separated list using one cidr flag. You can't set both cidr and ip in the same command. + * - --currentIp + - + - false + - Flag that adds the IP address from the host that is currently executing the command to the access list. Only applicable for type ipAddress entries. You don't need the entry argument when you use the currentIp option. + * - -h, --help + - + - false + - help for create + * - --ip + - strings + - false + - IP address to add to the access list for your API key. To add more than one IP address, specify each address with a separate ip flag or specify all addresses as a comma-separated list using one ip flag. You can't set both ip and cidr in the same command. + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Created new access list entry(s). + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Create access list entries for two IP addresses for the API key with the ID 5f24084d8dbffa3ad3f21234 in the organization with the ID 5a1b39eec902201990f12345: + atlas organizations apiKeys accessLists create --apiKey 5f24084d8dbffa3ad3f21234 --cidr 192.0.2.0/24,198.51.100.0/24 --orgId 5a1b39eec902201990f12345 --output json diff --git a/docs/command/atlas-organizations-apiKeys-accessLists-delete.txt b/docs/command/atlas-organizations-apiKeys-accessLists-delete.txt new file mode 100644 index 0000000000..76735790d6 --- /dev/null +++ b/docs/command/atlas-organizations-apiKeys-accessLists-delete.txt @@ -0,0 +1,106 @@ +.. _atlas-organizations-apiKeys-accessLists-delete: + +============================================== +atlas organizations apiKeys accessLists delete +============================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Remove the specified IP access list entry from your API Key. + +To use this command, you must authenticate with a user account or an API key with the Read Write role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas organizations apiKeys accessLists delete [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - entry + - string + - true + - IP or CIDR address that you want to remove from the access list. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --apiKey + - string + - false + - Unique 24-digit ID that identifies your API key. + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Access list entry '' deleted + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Remove the IP address 192.0.2.0 from the access list for the API key with the ID 5f24084d8dbffa3ad3f21234 in the organization with the ID 5a1b39eec902201990f12345: + atlas organizations apiKeys accessLists delete 192.0.2.0 --apiKey 5f24084d8dbffa3ad3f21234 --orgId 5a1b39eec902201990f12345 diff --git a/docs/command/atlas-organizations-apiKeys-accessLists-list.txt b/docs/command/atlas-organizations-apiKeys-accessLists-list.txt new file mode 100644 index 0000000000..b18ee729a7 --- /dev/null +++ b/docs/command/atlas-organizations-apiKeys-accessLists-list.txt @@ -0,0 +1,106 @@ +.. _atlas-organizations-apiKeys-accessLists-list: + +============================================ +atlas organizations apiKeys accessLists list +============================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all IP access list entries for your API Key. + +To view possible values for the apiKeyID argument, run atlas organizations apiKeys list. + +To use this command, you must authenticate with a user account or an API key with the Organization Member role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas organizations apiKeys accessLists list [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - apiKeyID + - string + - true + - Unique 24-digit string that identifies your API key. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - --omitCount + - + - false + - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return a JSON-formatted list of access list entries for the API key with the ID 5f24084d8dbffa3ad3f21234 in the organization with the ID 5a1b39eec902201990f12345: + atlas organizations apiKeys accessLists list --apiKey 5f24084d8dbffa3ad3f21234 --orgId 5a1b39eec902201990f12345 --output json diff --git a/docs/command/atlas-organizations-apiKeys-accessLists.txt b/docs/command/atlas-organizations-apiKeys-accessLists.txt new file mode 100644 index 0000000000..93b1ff2009 --- /dev/null +++ b/docs/command/atlas-organizations-apiKeys-accessLists.txt @@ -0,0 +1,63 @@ +.. _atlas-organizations-apiKeys-accessLists: + +======================================= +atlas organizations apiKeys accessLists +======================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage the IP access list for your API Key. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for accessLists + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-organizations-apiKeys-accessLists-create` - Create an IP access list entry for your API Key. +* :ref:`atlas-organizations-apiKeys-accessLists-delete` - Remove the specified IP access list entry from your API Key. +* :ref:`atlas-organizations-apiKeys-accessLists-list` - Return all IP access list entries for your API Key. + + +.. toctree:: + :titlesonly: + + create + delete + list + diff --git a/docs/command/atlas-organizations-apiKeys-assign.txt b/docs/command/atlas-organizations-apiKeys-assign.txt new file mode 100644 index 0000000000..2104f5681b --- /dev/null +++ b/docs/command/atlas-organizations-apiKeys-assign.txt @@ -0,0 +1,114 @@ +.. _atlas-organizations-apiKeys-assign: + +================================== +atlas organizations apiKeys assign +================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Modify the roles or description for the specified organization API key. + +When you modify the roles for an organization API key with this command, the values you specify overwrite the existing roles assigned to the API key. + +To view possible values for the apiKeyId argument, run atlas organizations apiKeys list. + +To use this command, you must authenticate with a user account or an API key with the Organization User Admin role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas organizations apiKeys assign [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - apiKeyId + - string + - true + - Unique 24-digit string that identifies your API key. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --desc + - string + - false + - Description of the API key. + * - -h, --help + - + - false + - help for assign + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --role + - strings + - false + - Role or roles that you want to assign to the API key. To assign more than one role, specify each role with a separate role flag or specify all of the roles as a comma-separated list using one role flag. To learn which values the CLI accepts, see the Items Enum for roles in the Atlas API spec: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createApiKey/. Passing this flag replaces preexisting data. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + API Key '' successfully updated. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Modify the role and description for the API key with the ID 5f24084d8dbffa3ad3f21234 for the organization with the ID 5a1b39eec902201990f12345: + atlas organizations apiKeys assign 5f24084d8dbffa3ad3f21234 --role ORG_MEMBER --desc "User1 Member Key" --orgId 5a1b39eec902201990f12345 --output json diff --git a/docs/command/atlas-organizations-apiKeys-create.txt b/docs/command/atlas-organizations-apiKeys-create.txt new file mode 100644 index 0000000000..03523c1e46 --- /dev/null +++ b/docs/command/atlas-organizations-apiKeys-create.txt @@ -0,0 +1,98 @@ +.. _atlas-organizations-apiKeys-create: + +================================== +atlas organizations apiKeys create +================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create an API Key for your organization. + +MongoDB returns the private API key only once. After you run this command, immediately copy, save, and secure both the public and private API keys. + +To use this command, you must authenticate with a user account or an API key with the Organization User Admin role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas organizations apiKeys create [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --desc + - string + - true + - Description of the API key. + * - -h, --help + - + - false + - help for create + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --role + - strings + - true + - Role or roles that you want to assign to the API key. To assign more than one role, specify each role with a separate role flag or specify all of the roles as a comma-separated list using one role flag. To learn which values the CLI accepts, see the Items Enum for roles in the Atlas API spec: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createApiKey/. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + API Key '' created. + Public API Key + Private API Key + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Create an organization API key with organization owner access in the organization with the ID 5a1b39eec902201990f12345: + atlas organizations apiKeys create --role ORG_OWNER --desc "My API Key" --orgId 5a1b39eec902201990f12345 --output json diff --git a/docs/command/atlas-organizations-apiKeys-delete.txt b/docs/command/atlas-organizations-apiKeys-delete.txt new file mode 100644 index 0000000000..37edd780fe --- /dev/null +++ b/docs/command/atlas-organizations-apiKeys-delete.txt @@ -0,0 +1,104 @@ +.. _atlas-organizations-apiKeys-delete: + +================================== +atlas organizations apiKeys delete +================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Remove the specified API key for your organization. + +To view possible values for the ID argument, run atlas organizations apiKeys list. + +To use this command, you must authenticate with a user account or an API key with the Organization User Admin role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas organizations apiKeys delete [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - ID + - string + - true + - Unique 24-digit string that identifies the organization's API key. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + API Key '' deleted + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Remove the organization API key with the ID 5f24084d8dbffa3ad3f21234 for the organization with the ID 5a1b39eec902201990f12345: + atlas organizations apiKeys delete 5f24084d8dbffa3ad3f21234 --orgId 5a1b39eec902201990f12345 diff --git a/docs/command/atlas-organizations-apiKeys-describe.txt b/docs/command/atlas-organizations-apiKeys-describe.txt new file mode 100644 index 0000000000..19b24d2cd3 --- /dev/null +++ b/docs/command/atlas-organizations-apiKeys-describe.txt @@ -0,0 +1,105 @@ +.. _atlas-organizations-apiKeys-describe: + +==================================== +atlas organizations apiKeys describe +==================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the details for the specified API key for your organization. + +To view possible values for the ID argument, run atlas organizations apiKeys list. + +To use this command, you must authenticate with a user account or an API key with the Organization Member role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas organizations apiKeys describe [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - ID + - string + - true + - Unique 24-digit string that identifies your API key. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID DESCRIPTION PUBLIC KEY PRIVATE KEY + + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return the JSON-formatted details for the organization API key with the ID 5f24084d8dbffa3ad3f21234 for the organization with the ID 5a1b39eec902201990f12345: + atlas organizations apiKeys describe 5f24084d8dbffa3ad3f21234 --orgId 5a1b39eec902201990f12345 -output json diff --git a/docs/command/atlas-organizations-apiKeys-list.txt b/docs/command/atlas-organizations-apiKeys-list.txt new file mode 100644 index 0000000000..5c6d5e5410 --- /dev/null +++ b/docs/command/atlas-organizations-apiKeys-list.txt @@ -0,0 +1,92 @@ +.. _atlas-organizations-apiKeys-list: + +================================ +atlas organizations apiKeys list +================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all API keys for your organization. + +To use this command, you must authenticate with a user account or an API key with the Organization Member role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas organizations apiKeys list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -c, --compact + - + - false + - Flag that enables the compact array response structure for a json output. The --compact option returns array objects as top-level responses and allows backward compatibility for scripts based on previous CLI versions. Omitting the --compact option for a json output returns array objects within a 'results' sub-array. You must specify --output json to use this option. + * - -h, --help + - + - false + - help for list + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - --omitCount + - + - false + - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return a JSON-formatted list of organization API keys for the organization with the ID 5a1b39eec902201990f12345: + atlas organizations apiKeys list --orgId 5a1b39eec902201990f12345 --output json diff --git a/docs/command/atlas-organizations-apiKeys.txt b/docs/command/atlas-organizations-apiKeys.txt new file mode 100644 index 0000000000..d4af319a1e --- /dev/null +++ b/docs/command/atlas-organizations-apiKeys.txt @@ -0,0 +1,69 @@ +.. _atlas-organizations-apiKeys: + +=========================== +atlas organizations apiKeys +=========================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Organization API Keys operations. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for apiKeys + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-organizations-apiKeys-accessLists` - Manage the IP access list for your API Key. +* :ref:`atlas-organizations-apiKeys-assign` - Modify the roles or description for the specified organization API key. +* :ref:`atlas-organizations-apiKeys-create` - Create an API Key for your organization. +* :ref:`atlas-organizations-apiKeys-delete` - Remove the specified API key for your organization. +* :ref:`atlas-organizations-apiKeys-describe` - Return the details for the specified API key for your organization. +* :ref:`atlas-organizations-apiKeys-list` - Return all API keys for your organization. + + +.. toctree:: + :titlesonly: + + accessLists + assign + create + delete + describe + list + diff --git a/docs/command/atlas-organizations-create.txt b/docs/command/atlas-organizations-create.txt new file mode 100644 index 0000000000..f427a5093a --- /dev/null +++ b/docs/command/atlas-organizations-create.txt @@ -0,0 +1,104 @@ +.. _atlas-organizations-create: + +========================== +atlas organizations create +========================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create an organization. + +When authenticating using API keys, the organization to which the API keys belong must have cross-organization billing enabled. The resulting org will be linked to the paying org. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas organizations create [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - name + - string + - true + - Label that identifies the organization. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --apiKeyDescription + - string + - false + - Description of the API key.Required when creating organizations authenticated with API Keys. + * - --apiKeyRole + - strings + - false + - Role or roles that you want to assign to the API key. To assign more than one role, specify each role with a separate role flag or specify all of the roles as a comma-separated list using one role flag. To learn which values the CLI accepts, see the Items Enum for roles in the Atlas API spec: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createApiKey/.Required when creating organizations authenticated with API Keys. + * - --federationSettingsId + - string + - false + - Unique 24-hexadecimal digit string that identifies the federation settings. + * - -h, --help + - + - false + - help for create + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --ownerId + - string + - false + - Unique 24-digit string that identifies the Atlas user to be granted the Org Owner role on the specified organization. Required if using API keys. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + # Create an Atlas organization with the name myOrg: + atlas organizations create myOrg --output json diff --git a/docs/command/atlas-organizations-delete.txt b/docs/command/atlas-organizations-delete.txt new file mode 100644 index 0000000000..1f6a6afc13 --- /dev/null +++ b/docs/command/atlas-organizations-delete.txt @@ -0,0 +1,100 @@ +.. _atlas-organizations-delete: + +========================== +atlas organizations delete +========================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Remove the specified organization. + +Organizations with active projects can't be removed. + +To use this command, you must authenticate with a user account or an API key with the Organization Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas organizations delete [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - ID + - string + - true + - Unique 24-digit string that identifies the organization. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Organization '' deleted + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Remove the organization with the ID 5e2211c17a3e5a48f5497de3: + atlas organizations delete 5e2211c17a3e5a48f5497de3 diff --git a/docs/command/atlas-organizations-describe.txt b/docs/command/atlas-organizations-describe.txt new file mode 100644 index 0000000000..52b0e108ea --- /dev/null +++ b/docs/command/atlas-organizations-describe.txt @@ -0,0 +1,99 @@ +.. _atlas-organizations-describe: + +============================ +atlas organizations describe +============================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the details for the specified organizations. + +To use this command, you must authenticate with a user account or an API key with the Organization Member role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas organizations describe [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - ID + - string + - true + - Unique 24-digit string that identifies the organization. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID NAME + + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return the JSON-formatted details for the organization with the ID 5e2211c17a3e5a48f5497de3: + atlas organizations describe 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-organizations-invitations-delete.txt b/docs/command/atlas-organizations-invitations-delete.txt new file mode 100644 index 0000000000..ebd795ec8b --- /dev/null +++ b/docs/command/atlas-organizations-invitations-delete.txt @@ -0,0 +1,102 @@ +.. _atlas-organizations-invitations-delete: + +====================================== +atlas organizations invitations delete +====================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Remove the specified pending invitation to your organization. + +To use this command, you must authenticate with a user account or an API key with the Organization User Admin role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas organizations invitations delete [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - invitationId + - string + - true + - Unique 24-digit string that identifies the invitation. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Invitation '' deleted + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Remove the pending invitation with the ID 5dd56c847a3e5a1f363d424d from the organization with the ID 5f71e5255afec75a3d0f96dc: + atlas organizations invitations delete 5dd56c847a3e5a1f363d424d --orgId 5f71e5255afec75a3d0f96dc diff --git a/docs/command/atlas-organizations-invitations-describe.txt b/docs/command/atlas-organizations-invitations-describe.txt new file mode 100644 index 0000000000..c842a75fb8 --- /dev/null +++ b/docs/command/atlas-organizations-invitations-describe.txt @@ -0,0 +1,92 @@ +.. _atlas-organizations-invitations-describe: + +======================================== +atlas organizations invitations describe +======================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the details for the specified pending invitation to your organization. + +To use this command, you must authenticate with a user account or an API key with the Organization User Admin role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas organizations invitations describe [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - invitationId + - string + - true + - Unique 24-digit string that identifies the invitation. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return the JSON-formatted details of the pending invitation with the ID 5dd56c847a3e5a1f363d424d for the organization with the ID 5f71e5255afec75a3d0f96dc: + atlas organizations invitations describe 5dd56c847a3e5a1f363d424d --orgId 5f71e5255afec75a3d0f96dc --output json diff --git a/docs/command/atlas-organizations-invitations-invite.txt b/docs/command/atlas-organizations-invitations-invite.txt new file mode 100644 index 0000000000..43707f830f --- /dev/null +++ b/docs/command/atlas-organizations-invitations-invite.txt @@ -0,0 +1,120 @@ +.. _atlas-organizations-invitations-invite: + +====================================== +atlas organizations invitations invite +====================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Invite the specified MongoDB user to your organization. + +To use this command, you must authenticate with a user account or an API key with the Organization User Admin role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas organizations invitations invite [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - email + - string + - true + - Email address that belongs to the user that you want to invite to the organization. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -f, --file + - string + - false + - Path to an optional JSON configuration file that defines invitation settings. To learn more about invitation configuration files for the Atlas CLI, see https://XXX. + + Mutually exclusive with --role, --teamId. + * - -h, --help + - + - false + - help for invite + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --role + - strings + - false + - User's roles for the associated organization. Valid values include ORG_OWNER, ORG_MEMBER, ORG_GROUP_CREATOR, ORG_BILLING_ADMIN, and ORG_READ_ONLY. + + Mutually exclusive with --file. + * - --teamId + - strings + - false + - Unique 24-digit string that identifies the team. + + Mutually exclusive with --file. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + User '' invited. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Invite the MongoDB user with the email user@example.com to the organization with the ID 5f71e5255afec75a3d0f96dc with ORG_OWNER access: + atlas organizations invitations invite user@example.com --orgId 5f71e5255afec75a3d0f96dc --role ORG_OWNER --output json diff --git a/docs/command/atlas-organizations-invitations-list.txt b/docs/command/atlas-organizations-invitations-list.txt new file mode 100644 index 0000000000..074015dd98 --- /dev/null +++ b/docs/command/atlas-organizations-invitations-list.txt @@ -0,0 +1,80 @@ +.. _atlas-organizations-invitations-list: + +==================================== +atlas organizations invitations list +==================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all pending invitations to your organization. + +To use this command, you must authenticate with a user account or an API key with the Organization User Admin role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas organizations invitations list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --email + - string + - false + - Email address for the user. + * - -h, --help + - + - false + - help for list + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return a JSON-formatted list of pending invitations to the organization with the ID 5f71e5255afec75a3d0f96dc: + atlas organizations invitations list --orgId 5f71e5255afec75a3d0f96dc --output json diff --git a/docs/command/atlas-organizations-invitations-update.txt b/docs/command/atlas-organizations-invitations-update.txt new file mode 100644 index 0000000000..ad54295d85 --- /dev/null +++ b/docs/command/atlas-organizations-invitations-update.txt @@ -0,0 +1,119 @@ +.. _atlas-organizations-invitations-update: + +====================================== +atlas organizations invitations update +====================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Modifies the details of the specified pending invitation to your organization. + +You can use either the invitation ID or the user's email address to specify the invitation. + +To use this command, you must authenticate with a user account or an API key with the Organization Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas organizations invitations update [invitationId] [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - invitationId + - string + - false + - Unique 24-digit string that identifies the invitation. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --email + - string + - false + - Email address for the user. + * - -h, --help + - + - false + - help for update + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --role + - strings + - true + - User's roles for the associated organization. Valid values include ORG_OWNER, ORG_MEMBER, ORG_GROUP_CREATOR, ORG_BILLING_ADMIN, and ORG_READ_ONLY. Passing this flag replaces preexisting data. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Invitation updated. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Modify the pending invitation with the ID 5dd56c847a3e5a1f363d424d to grant ORG_OWNER access the organization with the ID 5f71e5255afec75a3d0f96dc: + atlas organizations invitations update 5dd56c847a3e5a1f363d424d --orgId 5f71e5255afec75a3d0f96dc --role ORG_OWNER --output json + + +.. code-block:: + :copyable: false + + # Modify the invitation for the user with the email address user@example.com to grant ORG_OWNER access the organization with the ID 5f71e5255afec75a3d0f96dc: + atlas organizations invitations update --email user@example.com --orgId 5f71e5255afec75a3d0f96dc --role ORG_OWNER --output json diff --git a/docs/command/atlas-organizations-invitations.txt b/docs/command/atlas-organizations-invitations.txt new file mode 100644 index 0000000000..0135c98693 --- /dev/null +++ b/docs/command/atlas-organizations-invitations.txt @@ -0,0 +1,69 @@ +.. _atlas-organizations-invitations: + +=============================== +atlas organizations invitations +=============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Invitation operations. + +Create, list and manage your MongoDB organization invites. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for invitations + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-organizations-invitations-delete` - Remove the specified pending invitation to your organization. +* :ref:`atlas-organizations-invitations-describe` - Return the details for the specified pending invitation to your organization. +* :ref:`atlas-organizations-invitations-invite` - Invite the specified MongoDB user to your organization. +* :ref:`atlas-organizations-invitations-list` - Return all pending invitations to your organization. +* :ref:`atlas-organizations-invitations-update` - Modifies the details of the specified pending invitation to your organization. + + +.. toctree:: + :titlesonly: + + delete + describe + invite + list + update + diff --git a/docs/command/atlas-organizations-list.txt b/docs/command/atlas-organizations-list.txt new file mode 100644 index 0000000000..5248147670 --- /dev/null +++ b/docs/command/atlas-organizations-list.txt @@ -0,0 +1,110 @@ +.. _atlas-organizations-list: + +======================== +atlas organizations list +======================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all organizations. + +To use this command, you must authenticate with a user account or an API key with the Organization Member role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas organizations list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - --includeDeleted + - + - false + - Flag that indicates whether to include deleted organizations in the list. This option applies only to Ops Manager organizations. You can't return deleted Atlas or Cloud Manager organizations. + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - --name + - string + - false + - Organization name to perform a case-insensitive search for. + * - --omitCount + - + - false + - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID NAME + + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return a JSON-formatted list of all organizations: + atlas organizations list --output json + + +.. code-block:: + :copyable: false + + # Return a JSON-formatted list that includes the organizations named org1 and Org1, but doesn't return org123: + atlas organizations list --name org1 --output json diff --git a/docs/command/atlas-organizations-users-list.txt b/docs/command/atlas-organizations-users-list.txt new file mode 100644 index 0000000000..94299faa64 --- /dev/null +++ b/docs/command/atlas-organizations-users-list.txt @@ -0,0 +1,99 @@ +.. _atlas-organizations-users-list: + +============================== +atlas organizations users list +============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all users for an organization. + +To use this command, you must authenticate with a user account or an API key with the Organization Member role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas organizations users list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - --omitCount + - + - false + - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID FIRST NAME LAST NAME USERNAME + + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return a JSON-formatted list of all users for the organization with the ID 5e2211c17a3e5a48f5497de3: + atlas organizations users list --orgId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-organizations-users.txt b/docs/command/atlas-organizations-users.txt new file mode 100644 index 0000000000..928a8825e1 --- /dev/null +++ b/docs/command/atlas-organizations-users.txt @@ -0,0 +1,59 @@ +.. _atlas-organizations-users: + +========================= +atlas organizations users +========================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage your Atlas users. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for users + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-organizations-users-list` - Return all users for an organization. + + +.. toctree:: + :titlesonly: + + list + diff --git a/docs/command/atlas-organizations.txt b/docs/command/atlas-organizations.txt new file mode 100644 index 0000000000..fa2ee1e599 --- /dev/null +++ b/docs/command/atlas-organizations.txt @@ -0,0 +1,73 @@ +.. _atlas-organizations: + +=================== +atlas organizations +=================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage your Atlas organizations. + +Create, list and manage your MongoDB organizations. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for organizations + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-organizations-apiKeys` - Organization API Keys operations. +* :ref:`atlas-organizations-create` - Create an organization. +* :ref:`atlas-organizations-delete` - Remove the specified organization. +* :ref:`atlas-organizations-describe` - Return the details for the specified organizations. +* :ref:`atlas-organizations-invitations` - Invitation operations. +* :ref:`atlas-organizations-list` - Return all organizations. +* :ref:`atlas-organizations-users` - Manage your Atlas users. + + +.. toctree:: + :titlesonly: + + apiKeys + create + delete + describe + invitations + list + users + diff --git a/docs/command/atlas-performanceAdvisor-namespaces-list.txt b/docs/command/atlas-performanceAdvisor-namespaces-list.txt new file mode 100644 index 0000000000..19b5659d0d --- /dev/null +++ b/docs/command/atlas-performanceAdvisor-namespaces-list.txt @@ -0,0 +1,92 @@ +.. _atlas-performanceAdvisor-namespaces-list: + +======================================== +atlas performanceAdvisor namespaces list +======================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return up to 20 namespaces for collections experiencing slow queries on the specified host. + +Namespaces appear in the following format: {database}.{collection}. + +If you don't set the duration option or the since option, this command returns data from the last 24 hours. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas performanceAdvisor namespaces list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --duration + - int + - false + - Length of time in milliseconds for which you want to return results. If you specify the since option, the duration starts at the date and time specified. If you don't set the since option, this command returns data from the duration before the current time. + * - -h, --help + - + - false + - help for list + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --processName + - string + - true + - Unique identifier for the host of a MongoDB process in the following format: {hostname}:{port}. You can obtain a list of possible values from the 'id' field when you run the 'atlas processes list' command. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --since + - int + - false + - Date and time from which the query retrieves the suggested indexes. Specify this value as the number of seconds that have elapsed since the UNIX epoch. If you don't set the duration option, this command returns data from the since value to the current time. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return a JSON-formatted list of namespaces for collections with slow queries for the atlas-111ggi-shard-00-00.111xx.mongodb.net:27017 host in the project with the ID 5e2211c17a3e5a48f5497de3: + atlas performanceAdvisor namespaces list --processName atlas-111ggi-shard-00-00.111xx.mongodb.net:27017 --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-performanceAdvisor-namespaces.txt b/docs/command/atlas-performanceAdvisor-namespaces.txt new file mode 100644 index 0000000000..e05970fbc6 --- /dev/null +++ b/docs/command/atlas-performanceAdvisor-namespaces.txt @@ -0,0 +1,59 @@ +.. _atlas-performanceAdvisor-namespaces: + +=================================== +atlas performanceAdvisor namespaces +=================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Retrieve namespaces for collections experiencing slow queries + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for namespaces + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-performanceAdvisor-namespaces-list` - Return up to 20 namespaces for collections experiencing slow queries on the specified host. + + +.. toctree:: + :titlesonly: + + list + diff --git a/docs/command/atlas-performanceAdvisor-slowOperationThreshold-disable.txt b/docs/command/atlas-performanceAdvisor-slowOperationThreshold-disable.txt new file mode 100644 index 0000000000..09b64bb4cf --- /dev/null +++ b/docs/command/atlas-performanceAdvisor-slowOperationThreshold-disable.txt @@ -0,0 +1,76 @@ +.. _atlas-performanceAdvisor-slowOperationThreshold-disable: + +======================================================= +atlas performanceAdvisor slowOperationThreshold disable +======================================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Disable the application-managed slow operation threshold for your project. + +The slow operation threshold determines which operations are flagged by the Performance Advisor and Query Profiler. When disabled, the application considers any operation that takes longer than 100 milliseconds to be slow. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas performanceAdvisor slowOperationThreshold disable [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for disable + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Atlas management of the slow operation disabled + + diff --git a/docs/command/atlas-performanceAdvisor-slowOperationThreshold-enable.txt b/docs/command/atlas-performanceAdvisor-slowOperationThreshold-enable.txt new file mode 100644 index 0000000000..c47613c480 --- /dev/null +++ b/docs/command/atlas-performanceAdvisor-slowOperationThreshold-enable.txt @@ -0,0 +1,76 @@ +.. _atlas-performanceAdvisor-slowOperationThreshold-enable: + +====================================================== +atlas performanceAdvisor slowOperationThreshold enable +====================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Enable the application-managed slow operation threshold for your project. + +The slow operation threshold determines which operations are flagged by the Performance Advisor and Query Profiler. When enabled, the application uses the average execution time for operations on your cluster to determine slow-running queries. As a result, the threshold is more pertinent to your cluster workload. Application-managed slow operation threshold is enabled by default for dedicated clusters (M10+). + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas performanceAdvisor slowOperationThreshold enable [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for enable + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Atlas management of the slow operation enabled + + diff --git a/docs/command/atlas-performanceAdvisor-slowOperationThreshold.txt b/docs/command/atlas-performanceAdvisor-slowOperationThreshold.txt new file mode 100644 index 0000000000..a5ad1e3e3e --- /dev/null +++ b/docs/command/atlas-performanceAdvisor-slowOperationThreshold.txt @@ -0,0 +1,61 @@ +.. _atlas-performanceAdvisor-slowOperationThreshold: + +=============================================== +atlas performanceAdvisor slowOperationThreshold +=============================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Enable or disable management of the slow operation threshold for your cluster. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for slowOperationThreshold + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-performanceAdvisor-slowOperationThreshold-disable` - Disable the application-managed slow operation threshold for your project. +* :ref:`atlas-performanceAdvisor-slowOperationThreshold-enable` - Enable the application-managed slow operation threshold for your project. + + +.. toctree:: + :titlesonly: + + disable + enable + diff --git a/docs/command/atlas-performanceAdvisor-slowQueryLogs-list.txt b/docs/command/atlas-performanceAdvisor-slowQueryLogs-list.txt new file mode 100644 index 0000000000..52ad8c405e --- /dev/null +++ b/docs/command/atlas-performanceAdvisor-slowQueryLogs-list.txt @@ -0,0 +1,100 @@ +.. _atlas-performanceAdvisor-slowQueryLogs-list: + +=========================================== +atlas performanceAdvisor slowQueryLogs list +=========================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return log lines for slow queries that the Performance Advisor and Query Profiler identified. + +The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. The threshold for slow queries varies based on the average time of operations on your cluster to provide recommendations pertinent to your workload. + +If you don't set the duration option or the since option, this command returns data from the last 24 hours. + +To use this command, you must authenticate with a user account or an API key with the Project Data Access Read/Write role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas performanceAdvisor slowQueryLogs list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --duration + - int + - false + - Length of time in milliseconds for which you want to return results. If you specify the since option, the duration starts at the date and time specified. If you don't set the since option, this command returns data from the duration before the current time. + * - -h, --help + - + - false + - help for list + * - --nLog + - int + - false + - Maximum number of log lines to return. This value defaults to 20000. + * - --namespaces + - strings + - false + - Namespaces from which to retrieve suggested slow query logs formatted as .. Omit this parameter to return results for all namespaces. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --processName + - string + - true + - Unique identifier for the host of a MongoDB process in the following format: {hostname}:{port}. You can obtain a list of possible values from the 'id' field when you run the 'atlas processes list' command. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --since + - int + - false + - Date and time from which the query retrieves the suggested indexes. Specify this value as the number of seconds that have elapsed since the UNIX epoch. If you don't set the duration option, this command returns data from the since value to the current time. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return a JSON-formatted list of log lines for collections with slow queries for the atlas-111ggi-shard-00-00.111xx.mongodb.net:27017 host in the project with the ID 5e2211c17a3e5a48f5497de3: + atlas performanceAdvisor slowQueryLogs list --processName atlas-111ggi-shard-00-00.111xx.mongodb.net:27017 --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-performanceAdvisor-slowQueryLogs.txt b/docs/command/atlas-performanceAdvisor-slowQueryLogs.txt new file mode 100644 index 0000000000..55a1fb2c0d --- /dev/null +++ b/docs/command/atlas-performanceAdvisor-slowQueryLogs.txt @@ -0,0 +1,59 @@ +.. _atlas-performanceAdvisor-slowQueryLogs: + +====================================== +atlas performanceAdvisor slowQueryLogs +====================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Get log lines for slow queries for a specified host + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for slowQueryLogs + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-performanceAdvisor-slowQueryLogs-list` - Return log lines for slow queries that the Performance Advisor and Query Profiler identified. + + +.. toctree:: + :titlesonly: + + list + diff --git a/docs/command/atlas-performanceAdvisor-suggestedIndexes-list.txt b/docs/command/atlas-performanceAdvisor-suggestedIndexes-list.txt new file mode 100644 index 0000000000..bcf0b527fd --- /dev/null +++ b/docs/command/atlas-performanceAdvisor-suggestedIndexes-list.txt @@ -0,0 +1,102 @@ +.. _atlas-performanceAdvisor-suggestedIndexes-list: + +============================================== +atlas performanceAdvisor suggestedIndexes list +============================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the suggested indexes for collections experiencing slow queries. + +The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas performanceAdvisor suggestedIndexes list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --duration + - int + - false + - Length of time in milliseconds for which you want to return results. If you specify the since option, the duration starts at the date and time specified. If you don't set the since option, this command returns data from the duration before the current time. + * - -h, --help + - + - false + - help for list + * - --nExamples + - int + - false + - Maximum number of example queries to provide that a suggested index will improve. + * - --nIndexes + - int + - false + - Maximum number of indexes to suggest. + * - --namespaces + - strings + - false + - Namespaces from which to retrieve suggested indexes. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --processName + - string + - true + - Unique identifier for the host of a MongoDB process in the following format: {hostname}:{port}. You can obtain a list of possible values from the 'id' field when you run the 'atlas processes list' command. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --since + - int + - false + - Date and time from which the query retrieves the suggested indexes. Specify this value as the number of seconds that have elapsed since the UNIX epoch. If you don't set the duration option, this command returns data from the since value to the current time. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return a JSON-formatted list of suggested indexes for the atlas-111ggi-shard-00-00.111xx.mongodb.net:27017 host in the project with the ID 5e2211c17a3e5a48f5497de3: + atlas performanceAdvisor suggestedIndexes list --processName atlas-111ggi-shard-00-00.111xx.mongodb.net:27017 --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-performanceAdvisor-suggestedIndexes.txt b/docs/command/atlas-performanceAdvisor-suggestedIndexes.txt new file mode 100644 index 0000000000..b765cf2ebd --- /dev/null +++ b/docs/command/atlas-performanceAdvisor-suggestedIndexes.txt @@ -0,0 +1,59 @@ +.. _atlas-performanceAdvisor-suggestedIndexes: + +========================================= +atlas performanceAdvisor suggestedIndexes +========================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Get suggested indexes for collections experiencing slow queries + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for suggestedIndexes + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-performanceAdvisor-suggestedIndexes-list` - Return the suggested indexes for collections experiencing slow queries. + + +.. toctree:: + :titlesonly: + + list + diff --git a/docs/command/atlas-performanceAdvisor.txt b/docs/command/atlas-performanceAdvisor.txt new file mode 100644 index 0000000000..4428b2f1ea --- /dev/null +++ b/docs/command/atlas-performanceAdvisor.txt @@ -0,0 +1,65 @@ +.. _atlas-performanceAdvisor: + +======================== +atlas performanceAdvisor +======================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Learn more about slow queries and get suggestions to improve database performance. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for performanceAdvisor + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-performanceAdvisor-namespaces` - Retrieve namespaces for collections experiencing slow queries +* :ref:`atlas-performanceAdvisor-slowOperationThreshold` - Enable or disable management of the slow operation threshold for your cluster. +* :ref:`atlas-performanceAdvisor-slowQueryLogs` - Get log lines for slow queries for a specified host +* :ref:`atlas-performanceAdvisor-suggestedIndexes` - Get suggested indexes for collections experiencing slow queries + + +.. toctree:: + :titlesonly: + + namespaces + slowOperationThreshold + slowQueryLogs + suggestedIndexes + diff --git a/docs/command/atlas-plugin-install.txt b/docs/command/atlas-plugin-install.txt new file mode 100644 index 0000000000..fa57e08fbc --- /dev/null +++ b/docs/command/atlas-plugin-install.txt @@ -0,0 +1,99 @@ +.. _atlas-plugin-install: + +==================== +atlas plugin install +==================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Install Atlas CLI plugin from a GitHub repository. + +Install an Atlas CLI plugin from a GitHub repository. +You can specify a GitHub repository using either the "/" format or a full URL. +When you install the plugin, its latest release on GitHub is used by default. +To install a specific version of the plugin, append the version number directly to the plugin name using the @ symbol. + +MongoDB provides an example plugin: https://github.com/mongodb/atlas-cli-plugin-example + + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas plugin install [/] [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - / + - string + - false + - Repository identifier. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for install + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + # Install the latest version of the plugin: + atlas plugin install mongodb/atlas-cli-plugin-example + atlas plugin install https://github.com/mongodb/atlas-cli-plugin-example + + +.. code-block:: + :copyable: false + + # Install a specific version of the plugin: + atlas plugin install mongodb/atlas-cli-plugin-example@1.0.4 + atlas plugin install https://github.com/mongodb/atlas-cli-plugin-example/@v1.2.3 diff --git a/docs/command/atlas-plugin-list.txt b/docs/command/atlas-plugin-list.txt new file mode 100644 index 0000000000..eced103a63 --- /dev/null +++ b/docs/command/atlas-plugin-list.txt @@ -0,0 +1,58 @@ +.. _atlas-plugin-list: + +================= +atlas plugin list +================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns a list of all installed plugins. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas plugin list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + diff --git a/docs/command/atlas-plugin-uninstall.txt b/docs/command/atlas-plugin-uninstall.txt new file mode 100644 index 0000000000..6117d6b567 --- /dev/null +++ b/docs/command/atlas-plugin-uninstall.txt @@ -0,0 +1,87 @@ +.. _atlas-plugin-uninstall: + +====================== +atlas plugin uninstall +====================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Uninstall Atlas CLI plugin. + +Uninstall an Atlas CLI plugin. +You can specify a plugin to uninstall using either the "/" format or the plugin name. + + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas plugin uninstall [plugin] [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - plugin + - string + - false + - Plugin identifier. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for uninstall + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + # Uninstall a plugin: + atlas plugin uninstall mongodb/atlas-cli-plugin-example + atlas plugin uninstall atlas-cli-plugin-example diff --git a/docs/command/atlas-plugin-update.txt b/docs/command/atlas-plugin-update.txt new file mode 100644 index 0000000000..e91b656145 --- /dev/null +++ b/docs/command/atlas-plugin-update.txt @@ -0,0 +1,99 @@ +.. _atlas-plugin-update: + +=================== +atlas plugin update +=================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Update Atlas CLI plugin. + +Update an Atlas CLI plugin. +You can specify a plugin to update using either the "/" format or the plugin name. +Additionally, you can use the "--all" flag to update all plugins. + + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas plugin update [plugin] [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - plugin + - string + - false + - Plugin identifier. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --all + - + - false + - update all plugins + * - -h, --help + - + - false + - help for update + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + # Update a plugin: + atlas plugin update mongodb/atlas-cli-plugin-example + atlas plugin update atlas-cli-plugin-example + + +.. code-block:: + :copyable: false + + # Update all plugins + atlas plugin update --all diff --git a/docs/command/atlas-plugin.txt b/docs/command/atlas-plugin.txt new file mode 100644 index 0000000000..c3c489f453 --- /dev/null +++ b/docs/command/atlas-plugin.txt @@ -0,0 +1,65 @@ +.. _atlas-plugin: + +============ +atlas plugin +============ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage plugins for the AtlasCLI. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for plugin + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-plugin-install` - Install Atlas CLI plugin from a GitHub repository. +* :ref:`atlas-plugin-list` - Returns a list of all installed plugins. +* :ref:`atlas-plugin-uninstall` - Uninstall Atlas CLI plugin. +* :ref:`atlas-plugin-update` - Update Atlas CLI plugin. + + +.. toctree:: + :titlesonly: + + install + list + uninstall + update + diff --git a/docs/command/atlas-privateEndpoints-aws-create.txt b/docs/command/atlas-privateEndpoints-aws-create.txt new file mode 100644 index 0000000000..3dc0a82304 --- /dev/null +++ b/docs/command/atlas-privateEndpoints-aws-create.txt @@ -0,0 +1,92 @@ +.. _atlas-privateEndpoints-aws-create: + +================================= +atlas privateEndpoints aws create +================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create a new AWS private endpoint for your project. + +To learn more about how to set up private endpoints with the Atlas CLI, see the tutorial on the Atlas CLI tab here: https://www.mongodb.com/docs/atlas/security-cluster-private-endpoint/. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas privateEndpoints aws create [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for create + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --region + - string + - true + - Cloud provider region in which you want to create the private endpoint connection. For a complete list of supported AWS regions, see: https://dochub.mongodb.org/core/aws-atlas. For a complete list of supported Azure regions, see: https://dochub.mongodb.org/core/azure-atlas. For a complete list of supported GCP regions, see: https://dochub.mongodb.org/core/gcp-atlas. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Private endpoint '' created. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Create a private endpoint connection for AWS in the us-east-1 region for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas privateEndpoints aws create --region us-east-1 --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-privateEndpoints-aws-delete.txt b/docs/command/atlas-privateEndpoints-aws-delete.txt new file mode 100644 index 0000000000..99afb3ecc3 --- /dev/null +++ b/docs/command/atlas-privateEndpoints-aws-delete.txt @@ -0,0 +1,102 @@ +.. _atlas-privateEndpoints-aws-delete: + +================================= +atlas privateEndpoints aws delete +================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Remove the specified AWS private endpoint from your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas privateEndpoints aws delete [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - privateEndpointId + - string + - true + - Unique 24-character alphanumeric string that identifies the private endpoint in Atlas. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Private endpoint '' deleted + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Remove the AWS private endpoint with the ID 5f4fc14da2b47835a58c63a2 from the project with the ID 5e2211c17a3e5a48f5497de3: + atlas privateEndpoints aws delete 5f4fc14da2b47835a58c63a2 --projectId 5e2211c17a3e5a48f5497de3 diff --git a/docs/command/atlas-privateEndpoints-aws-describe.txt b/docs/command/atlas-privateEndpoints-aws-describe.txt new file mode 100644 index 0000000000..73d6bc46c0 --- /dev/null +++ b/docs/command/atlas-privateEndpoints-aws-describe.txt @@ -0,0 +1,103 @@ +.. _atlas-privateEndpoints-aws-describe: + +=================================== +atlas privateEndpoints aws describe +=================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the details for the specified AWS private endpoints for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas privateEndpoints aws describe [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - privateEndpointId + - string + - true + - Unique 24-character alphanumeric string that identifies the private endpoint in Atlas. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID ENDPOINT SERVICE STATUS ERROR + + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return the JSON-formatted details for the AWS private endpoint connection with the ID 5f4fc81c1f03a835c2728ff7 for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas privateEndpoints aws describe 5f4fc81c1f03a835c2728ff7 --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-privateEndpoints-aws-interfaces-create.txt b/docs/command/atlas-privateEndpoints-aws-interfaces-create.txt new file mode 100644 index 0000000000..fcaeafe85a --- /dev/null +++ b/docs/command/atlas-privateEndpoints-aws-interfaces-create.txt @@ -0,0 +1,108 @@ +.. _atlas-privateEndpoints-aws-interfaces-create: + +============================================ +atlas privateEndpoints aws interfaces create +============================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create a new interface for the specified AWS private endpoint. + +To learn more about how to set up private endpoints with the Atlas CLI, see the tutorial on the Atlas CLI tab here: https://www.mongodb.com/docs/atlas/security-cluster-private-endpoint/. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas privateEndpoints aws interfaces create [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - endpointServiceId + - string + - true + - Unique 24-character alphanumeric string that identifies the private endpoint in Atlas. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for create + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --privateEndpointId + - string + - true + - Unique 22-character alphanumeric string that identifies the AWS PrivateLink connection in AWS. You can find this value on the AWS VPC Dashboard under Endpoints > VPC ID. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Interface endpoint '' created. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Create a new interface for an AWS private endpoint with the ID 5f4fc14da2b47835a58c63a2 in Atlas and the ID vpce-00713b5e644e830a3 in AWS for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas privateEndpoints aws interfaces create 5f4fc14da2b47835a58c63a2 --privateEndpointId vpce-00713b5e644e830a3 --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-privateEndpoints-aws-interfaces-delete.txt b/docs/command/atlas-privateEndpoints-aws-interfaces-delete.txt new file mode 100644 index 0000000000..11f4b27f9e --- /dev/null +++ b/docs/command/atlas-privateEndpoints-aws-interfaces-delete.txt @@ -0,0 +1,106 @@ +.. _atlas-privateEndpoints-aws-interfaces-delete: + +============================================ +atlas privateEndpoints aws interfaces delete +============================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Remove the specified AWS private endpoint interface and related service from your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas privateEndpoints aws interfaces delete [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - interfaceEndpointId + - string + - true + - Unique string that identifies the AWS private endpoint interface in AWS. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --endpointServiceId + - string + - false + - Unique 24-character alphanumeric string that identifies the private endpoint in Atlas. + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Interface endpoint '' deleted + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Remove the AWS private endpoint interface with the ID vpce-00713b5e644e830a3 in AWS from the project with the ID 5e2211c17a3e5a48f5497de3: + atlas privateEndpoints aws interfaces delete vpce-00713b5e644e830a3 --projectId 5e2211c17a3e5a48f5497de3 diff --git a/docs/command/atlas-privateEndpoints-aws-interfaces-describe.txt b/docs/command/atlas-privateEndpoints-aws-interfaces-describe.txt new file mode 100644 index 0000000000..4c42cf4c27 --- /dev/null +++ b/docs/command/atlas-privateEndpoints-aws-interfaces-describe.txt @@ -0,0 +1,109 @@ +.. _atlas-privateEndpoints-aws-interfaces-describe: + +============================================== +atlas privateEndpoints aws interfaces describe +============================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the details for the specified AWS private endpoint interface for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas privateEndpoints aws interfaces describe [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - interfaceEndpointId + - string + - true + - Unique string that identifies the AWS private endpoint interface in AWS. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --endpointServiceId + - string + - true + - Unique 24-character alphanumeric string that identifies the private endpoint in Atlas. + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID STATUS ERROR + + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return the JSON-formatted details of the AWS private endpoint interface with the ID + vpce-00713b5e644e830a3 in AWS for an AWS private endpoint with the ID 5f4fc14da2b47835a58c63a2 in Atlas: + atlas privateEndpoints aws interfaces describe + vpce-00713b5e644e830a3 --endpointServiceId 5f4fc14da2b47835a58c63a2 diff --git a/docs/command/atlas-privateEndpoints-aws-interfaces.txt b/docs/command/atlas-privateEndpoints-aws-interfaces.txt new file mode 100644 index 0000000000..eefb55825a --- /dev/null +++ b/docs/command/atlas-privateEndpoints-aws-interfaces.txt @@ -0,0 +1,63 @@ +.. _atlas-privateEndpoints-aws-interfaces: + +===================================== +atlas privateEndpoints aws interfaces +===================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage Atlas AWS private endpoint interfaces. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for interfaces + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-privateEndpoints-aws-interfaces-create` - Create a new interface for the specified AWS private endpoint. +* :ref:`atlas-privateEndpoints-aws-interfaces-delete` - Remove the specified AWS private endpoint interface and related service from your project. +* :ref:`atlas-privateEndpoints-aws-interfaces-describe` - Return the details for the specified AWS private endpoint interface for your project. + + +.. toctree:: + :titlesonly: + + create + delete + describe + diff --git a/docs/command/atlas-privateEndpoints-aws-list.txt b/docs/command/atlas-privateEndpoints-aws-list.txt new file mode 100644 index 0000000000..d73ffa7d70 --- /dev/null +++ b/docs/command/atlas-privateEndpoints-aws-list.txt @@ -0,0 +1,76 @@ +.. _atlas-privateEndpoints-aws-list: + +=============================== +atlas privateEndpoints aws list +=============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all AWS private endpoints for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas privateEndpoints aws list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return a JSON-formatted list of all AWS private endpoints for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas privateEndpoints aws list --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-privateEndpoints-aws-watch.txt b/docs/command/atlas-privateEndpoints-aws-watch.txt new file mode 100644 index 0000000000..2882272d4d --- /dev/null +++ b/docs/command/atlas-privateEndpoints-aws-watch.txt @@ -0,0 +1,104 @@ +.. _atlas-privateEndpoints-aws-watch: + +================================ +atlas privateEndpoints aws watch +================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Watch the specified AWS private endpoint in your project until it becomes available. + +This command checks the endpoint's state periodically until the endpoint reaches an AVAILABLE or FAILED state. +Once the endpoint reaches the expected state, the command prints "Private endpoint changes completed." +If you run the command in the terminal, it blocks the terminal session until the resource becomes available or fails. +You can interrupt the command's polling at any time with CTRL-C. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas privateEndpoints aws watch [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - privateEndpointId + - string + - true + - Unique 24-character alphanumeric string that identifies the private endpoint in Atlas. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for watch + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + + Private endpoint changes completed. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Watch for the AWS private endpoint with the ID 5f4fc14da2b47835a58c63a2 to become available in the project with the ID 5e2211c17a3e5a48f5497de3: + atlas privateEndpoints aws watch 5f4fc14da2b47835a58c63a2 --projectId 5e2211c17a3e5a48f5497de3 diff --git a/docs/command/atlas-privateEndpoints-aws.txt b/docs/command/atlas-privateEndpoints-aws.txt new file mode 100644 index 0000000000..d761c7a4ed --- /dev/null +++ b/docs/command/atlas-privateEndpoints-aws.txt @@ -0,0 +1,69 @@ +.. _atlas-privateEndpoints-aws: + +========================== +atlas privateEndpoints aws +========================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage AWS Private Endpoints. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for aws + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-privateEndpoints-aws-create` - Create a new AWS private endpoint for your project. +* :ref:`atlas-privateEndpoints-aws-delete` - Remove the specified AWS private endpoint from your project. +* :ref:`atlas-privateEndpoints-aws-describe` - Return the details for the specified AWS private endpoints for your project. +* :ref:`atlas-privateEndpoints-aws-interfaces` - Manage Atlas AWS private endpoint interfaces. +* :ref:`atlas-privateEndpoints-aws-list` - Return all AWS private endpoints for your project. +* :ref:`atlas-privateEndpoints-aws-watch` - Watch the specified AWS private endpoint in your project until it becomes available. + + +.. toctree:: + :titlesonly: + + create + delete + describe + interfaces + list + watch + diff --git a/docs/command/atlas-privateEndpoints-azure-create.txt b/docs/command/atlas-privateEndpoints-azure-create.txt new file mode 100644 index 0000000000..70c1bb7a91 --- /dev/null +++ b/docs/command/atlas-privateEndpoints-azure-create.txt @@ -0,0 +1,92 @@ +.. _atlas-privateEndpoints-azure-create: + +=================================== +atlas privateEndpoints azure create +=================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create a new Azure private endpoint for your project. + +To learn more about how to set up private endpoints with the Atlas CLI, see the tutorial on the Atlas CLI tab here: https://www.mongodb.com/docs/atlas/security-cluster-private-endpoint/. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas privateEndpoints azure create [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for create + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --region + - string + - true + - Cloud provider region in which you want to create the private endpoint connection. For a complete list of supported AWS regions, see: https://dochub.mongodb.org/core/aws-atlas. For a complete list of supported Azure regions, see: https://dochub.mongodb.org/core/azure-atlas. For a complete list of supported GCP regions, see: https://dochub.mongodb.org/core/gcp-atlas. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Private endpoint '' created. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Create a private endpoint connection for Azure in the eastus region for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas privateEndpoints azure create --region eastus --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-privateEndpoints-azure-delete.txt b/docs/command/atlas-privateEndpoints-azure-delete.txt new file mode 100644 index 0000000000..d450ade535 --- /dev/null +++ b/docs/command/atlas-privateEndpoints-azure-delete.txt @@ -0,0 +1,102 @@ +.. _atlas-privateEndpoints-azure-delete: + +=================================== +atlas privateEndpoints azure delete +=================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Remove the specified Azure private endpoint from your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas privateEndpoints azure delete [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - privateEndpointId + - string + - true + - Unique 24-character alphanumeric string that identifies the private endpoint in Atlas. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Private endpoint '' deleted + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Remove the Azure private endpoint with the ID 5f4fc14da2b47835a58c63a2 from the project with the ID 5e2211c17a3e5a48f5497de3: + atlas privateEndpoints azure delete 5f4fc14da2b47835a58c63a2 --projectId 5e2211c17a3e5a48f5497de3 diff --git a/docs/command/atlas-privateEndpoints-azure-describe.txt b/docs/command/atlas-privateEndpoints-azure-describe.txt new file mode 100644 index 0000000000..08ea40362d --- /dev/null +++ b/docs/command/atlas-privateEndpoints-azure-describe.txt @@ -0,0 +1,103 @@ +.. _atlas-privateEndpoints-azure-describe: + +===================================== +atlas privateEndpoints azure describe +===================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the details for the specified Azure private endpoint for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas privateEndpoints azure describe [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - privateEndpointId + - string + - true + - Unique 24-character alphanumeric string that identifies the private endpoint in Atlas. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID ENDPOINT SERVICE STATUS ERROR + + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return the JSON-formatted details for the Azure private endpoint connection with the ID 5f4fc81c1f03a835c2728ff7 for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas privateEndpoints azure describe 5f4fc81c1f03a835c2728ff7 --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-privateEndpoints-azure-interfaces-create.txt b/docs/command/atlas-privateEndpoints-azure-interfaces-create.txt new file mode 100644 index 0000000000..78aaaa4164 --- /dev/null +++ b/docs/command/atlas-privateEndpoints-azure-interfaces-create.txt @@ -0,0 +1,113 @@ +.. _atlas-privateEndpoints-azure-interfaces-create: + +============================================== +atlas privateEndpoints azure interfaces create +============================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create a new interface for the specified Azure private endpoint. + +To learn more about how to set up private endpoints with the Atlas CLI, see the tutorial on the Atlas CLI tab here: https://www.mongodb.com/docs/atlas/security-cluster-private-endpoint/. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas privateEndpoints azure interfaces create [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - endpointServiceId + - string + - true + - Unique 24-character alphanumeric string that identifies the private endpoint in Atlas. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for create + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --privateEndpointId + - string + - true + - Unique string that identifies the Azure private endpoint in Azure. The Properties page for your private endpoint on your Azure dashboard displays this property in the Resource ID field. + * - --privateEndpointIpAddress + - string + - true + - Private IP address of the private endpoint network interface you created in your Azure VNet. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Interface endpoint '' created. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Create a new interface for an Azure private endpoint with the ID 5f4fc14da2b47835a58c63a2 in Atlas and the ID /subscriptions/4e133d35-e734-4385-a565-c0945567ae346/resourceGroups/rg_95847a959b876e255dbb9b33_dfragd7w/providers/Microsoft.Network/privateEndpoints/test-endpoint in Azure for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas privateEndpoints azure interfaces create 5f4fc14da2b47835a58c63a2 --privateEndpointId /subscriptions/4e133d35-e734-4385-a565-c0945567ae346/resourceGroups/rg_95847a959b876e255dbb9b33_dfragd7w/providers/Microsoft.Network/privateEndpoints/test-endpoint --projectId 5e2211c17a3e5a48f5497de3 --privateEndpointIpAddress 192.0.2.5 + --output json diff --git a/docs/command/atlas-privateEndpoints-azure-interfaces-delete.txt b/docs/command/atlas-privateEndpoints-azure-interfaces-delete.txt new file mode 100644 index 0000000000..f09ff091c7 --- /dev/null +++ b/docs/command/atlas-privateEndpoints-azure-interfaces-delete.txt @@ -0,0 +1,106 @@ +.. _atlas-privateEndpoints-azure-interfaces-delete: + +============================================== +atlas privateEndpoints azure interfaces delete +============================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Remove the specified Azure private endpoint interface and related service from your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas privateEndpoints azure interfaces delete [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - privateEndpointResourceId + - string + - true + - Unique string that identifies the Azure private endpoint interface in Azure. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --endpointServiceId + - string + - false + - Unique 24-character alphanumeric string that identifies the private endpoint in Atlas. + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Interface endpoint '' deleted + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Remove the Azure private endpoint interface with the ID /subscriptions/4e133d35-e734-4385-a565-c0945567ae346/resourceGroups/rg_95847a959b876e255dbb9b33_dfragd7w/providers/Microsoft.Network/privateEndpoints/cli-test in Azure from the project with the ID 5e2211c17a3e5a48f5497de3: + atlas privateEndpoints azure interfaces delete /subscriptions/4e133d35-e734-4385-a565-c0945567ae346/resourceGroups/rg_95847a959b876e255dbb9b33_dfragd7w/providers/Microsoft.Network/privateEndpoints/cli-test --projectId 5e2211c17a3e5a48f5497de3 diff --git a/docs/command/atlas-privateEndpoints-azure-interfaces-describe.txt b/docs/command/atlas-privateEndpoints-azure-interfaces-describe.txt new file mode 100644 index 0000000000..bd17506aa5 --- /dev/null +++ b/docs/command/atlas-privateEndpoints-azure-interfaces-describe.txt @@ -0,0 +1,107 @@ +.. _atlas-privateEndpoints-azure-interfaces-describe: + +================================================ +atlas privateEndpoints azure interfaces describe +================================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the details for the specified Azure private endpoint interface for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas privateEndpoints azure interfaces describe [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - privateEndpointResourceId + - string + - true + - Unique string that identifies the Azure private endpoint interface in Azure. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --endpointServiceId + - string + - true + - Unique 24-character alphanumeric string that identifies the private endpoint in Atlas. + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID IP ADDRESS STATUS ERROR + + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return the JSON-formatted details of the Azure private endpoint interface with the ID /subscriptions/4e133d35-e734-4385-a565-c0945567ae346/resourceGroups/rg_95847a959b876e255dbb9b33_dfragd7w/providers/Microsoft.Network/privateEndpoints/cli-test in Azure for an AWS private endpoint with the ID 5f4fc14da2b47835a58c63a2 in Atlas: + atlas privateEndpoints azure interfaces describe /subscriptions/4e133d35-e734-4385-a565-c0945567ae346/resourceGroups/rg_95847a959b876e255dbb9b33_dfragd7w/providers/Microsoft.Network/privateEndpoints/cli-test --endpointServiceId 5f4fc14da2b47835a58c63a2 diff --git a/docs/command/atlas-privateEndpoints-azure-interfaces.txt b/docs/command/atlas-privateEndpoints-azure-interfaces.txt new file mode 100644 index 0000000000..937d2aacae --- /dev/null +++ b/docs/command/atlas-privateEndpoints-azure-interfaces.txt @@ -0,0 +1,63 @@ +.. _atlas-privateEndpoints-azure-interfaces: + +======================================= +atlas privateEndpoints azure interfaces +======================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage Atlas Azure private endpoint interfaces. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for interfaces + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-privateEndpoints-azure-interfaces-create` - Create a new interface for the specified Azure private endpoint. +* :ref:`atlas-privateEndpoints-azure-interfaces-delete` - Remove the specified Azure private endpoint interface and related service from your project. +* :ref:`atlas-privateEndpoints-azure-interfaces-describe` - Return the details for the specified Azure private endpoint interface for your project. + + +.. toctree:: + :titlesonly: + + create + delete + describe + diff --git a/docs/command/atlas-privateEndpoints-azure-list.txt b/docs/command/atlas-privateEndpoints-azure-list.txt new file mode 100644 index 0000000000..3564976b5a --- /dev/null +++ b/docs/command/atlas-privateEndpoints-azure-list.txt @@ -0,0 +1,76 @@ +.. _atlas-privateEndpoints-azure-list: + +================================= +atlas privateEndpoints azure list +================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all Azure private endpoints for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas privateEndpoints azure list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return a JSON-formatted list of all Azure private endpoints for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas privateEndpoints azure list --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-privateEndpoints-azure-watch.txt b/docs/command/atlas-privateEndpoints-azure-watch.txt new file mode 100644 index 0000000000..fa8ad3dec8 --- /dev/null +++ b/docs/command/atlas-privateEndpoints-azure-watch.txt @@ -0,0 +1,104 @@ +.. _atlas-privateEndpoints-azure-watch: + +================================== +atlas privateEndpoints azure watch +================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Watch the specified Azure private endpoint in your project until it becomes available. + +This command checks the endpoint's state periodically until the endpoint reaches an AVAILABLE or FAILED state. +Once the endpoint reaches the expected state, the command prints "Private endpoint changes completed." +If you run the command in the terminal, it blocks the terminal session until the resource becomes available or fails. +You can interrupt the command's polling at any time with CTRL-C. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas privateEndpoints azure watch [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - privateEndpointId + - string + - true + - Unique 24-character alphanumeric string that identifies the private endpoint in Atlas. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for watch + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + + Private endpoint changes completed. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Watch for the Azure private endpoint with the ID 5f4fc14da2b47835a58c63a2 to become available in the project with the ID 5e2211c17a3e5a48f5497de3: + atlas privateEndpoints azure watch 5f4fc14da2b47835a58c63a2 --projectId 5e2211c17a3e5a48f5497de3 diff --git a/docs/command/atlas-privateEndpoints-azure.txt b/docs/command/atlas-privateEndpoints-azure.txt new file mode 100644 index 0000000000..23b7368dd2 --- /dev/null +++ b/docs/command/atlas-privateEndpoints-azure.txt @@ -0,0 +1,69 @@ +.. _atlas-privateEndpoints-azure: + +============================ +atlas privateEndpoints azure +============================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage Azure Private Endpoints. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for azure + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-privateEndpoints-azure-create` - Create a new Azure private endpoint for your project. +* :ref:`atlas-privateEndpoints-azure-delete` - Remove the specified Azure private endpoint from your project. +* :ref:`atlas-privateEndpoints-azure-describe` - Return the details for the specified Azure private endpoint for your project. +* :ref:`atlas-privateEndpoints-azure-interfaces` - Manage Atlas Azure private endpoint interfaces. +* :ref:`atlas-privateEndpoints-azure-list` - Return all Azure private endpoints for your project. +* :ref:`atlas-privateEndpoints-azure-watch` - Watch the specified Azure private endpoint in your project until it becomes available. + + +.. toctree:: + :titlesonly: + + create + delete + describe + interfaces + list + watch + diff --git a/docs/command/atlas-privateEndpoints-gcp-create.txt b/docs/command/atlas-privateEndpoints-gcp-create.txt new file mode 100644 index 0000000000..9da00080e5 --- /dev/null +++ b/docs/command/atlas-privateEndpoints-gcp-create.txt @@ -0,0 +1,89 @@ +.. _atlas-privateEndpoints-gcp-create: + +================================= +atlas privateEndpoints gcp create +================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create a new GCP private endpoint for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas privateEndpoints gcp create [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for create + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --region + - string + - true + - Cloud provider region in which you want to create the private endpoint connection. For a complete list of supported AWS regions, see: https://dochub.mongodb.org/core/aws-atlas. For a complete list of supported Azure regions, see: https://dochub.mongodb.org/core/azure-atlas. For a complete list of supported GCP regions, see: https://dochub.mongodb.org/core/gcp-atlas. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Private endpoint '' created. + + +Examples +-------- + +.. code-block:: + :copyable: false + + atlas privateEndpoints gcp create --region CENTRAL_US diff --git a/docs/command/atlas-privateEndpoints-gcp-delete.txt b/docs/command/atlas-privateEndpoints-gcp-delete.txt new file mode 100644 index 0000000000..a9f0a42728 --- /dev/null +++ b/docs/command/atlas-privateEndpoints-gcp-delete.txt @@ -0,0 +1,101 @@ +.. _atlas-privateEndpoints-gcp-delete: + +================================= +atlas privateEndpoints gcp delete +================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Delete a GCP private endpoint for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas privateEndpoints gcp delete [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - privateEndpointId + - string + - true + - Unique 22-character alphanumeric string that identifies the private endpoint. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Private endpoint '' deleted + + +Examples +-------- + +.. code-block:: + :copyable: false + + atlas privateEndpoint gcp delete tester-1 --force diff --git a/docs/command/atlas-privateEndpoints-gcp-describe.txt b/docs/command/atlas-privateEndpoints-gcp-describe.txt new file mode 100644 index 0000000000..aa00926e04 --- /dev/null +++ b/docs/command/atlas-privateEndpoints-gcp-describe.txt @@ -0,0 +1,91 @@ +.. _atlas-privateEndpoints-gcp-describe: + +=================================== +atlas privateEndpoints gcp describe +=================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return a specific GCP private endpoint for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas privateEndpoints gcp describe [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - privateEndpointId + - string + - true + - Unique 22-character alphanumeric string that identifies the private endpoint. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + atlas privateEndpoint gcp describe tester-1 diff --git a/docs/command/atlas-privateEndpoints-gcp-interfaces-create.txt b/docs/command/atlas-privateEndpoints-gcp-interfaces-create.txt new file mode 100644 index 0000000000..c88a72796d --- /dev/null +++ b/docs/command/atlas-privateEndpoints-gcp-interfaces-create.txt @@ -0,0 +1,116 @@ +.. _atlas-privateEndpoints-gcp-interfaces-create: + +============================================ +atlas privateEndpoints gcp interfaces create +============================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create a GCP private endpoint interface. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas privateEndpoints gcp interfaces create [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - endpointGroupId + - string + - true + - Unique identifier for the endpoint group. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --endpoint + - strings + - false + - List of GCP endpoints in the group separated by commas, such as: endpointName1@ipAddress1,...,endpointNameN@ipAddressN + * - --endpointServiceId + - string + - true + - Unique 24-character alphanumeric string that identifies the private endpoint in Atlas. + * - --gcpProjectId + - string + - true + - Unique identifier of the GCP project in which the network peer resides. + * - -h, --help + - + - false + - help for create + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Interface endpoint '' created. + + +Examples +-------- + +.. code-block:: + :copyable: false + + atlas privateEndpoints gcp interfaces create endpoint-1 \ + --endpointServiceId 61eaca605af86411903de1dd \ + --gcpProjectId mcli-private-endpoints \ + --endpoint endpoint-0@10.142.0.2,endpoint-1@10.142.0.3,endpoint-2@10.142.0.4,endpoint-3@10.142.0.5,endpoint-4@10.142.0.6,endpoint-5@10.142.0.7 diff --git a/docs/command/atlas-privateEndpoints-gcp-interfaces-delete.txt b/docs/command/atlas-privateEndpoints-gcp-interfaces-delete.txt new file mode 100644 index 0000000000..f9513ead7f --- /dev/null +++ b/docs/command/atlas-privateEndpoints-gcp-interfaces-delete.txt @@ -0,0 +1,106 @@ +.. _atlas-privateEndpoints-gcp-interfaces-delete: + +============================================ +atlas privateEndpoints gcp interfaces delete +============================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Delete a specific GCP private endpoint interface for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas privateEndpoints gcp interfaces delete [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - id + - string + - true + - Unique identifier for the endpoint group. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --endpointServiceId + - string + - true + - Unique 24-character alphanumeric string that identifies the private endpoint in Atlas. + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Interface endpoint '' deleted + + +Examples +-------- + +.. code-block:: + :copyable: false + + atlas privateEndpoints gcp interfaces delete endpoint-1 \ + --endpointServiceId 61eaca605af86411903de1dd diff --git a/docs/command/atlas-privateEndpoints-gcp-interfaces-describe.txt b/docs/command/atlas-privateEndpoints-gcp-interfaces-describe.txt new file mode 100644 index 0000000000..db04731d9a --- /dev/null +++ b/docs/command/atlas-privateEndpoints-gcp-interfaces-describe.txt @@ -0,0 +1,107 @@ +.. _atlas-privateEndpoints-gcp-interfaces-describe: + +============================================== +atlas privateEndpoints gcp interfaces describe +============================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return a specific GCP private endpoint interface for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas privateEndpoints gcp interfaces describe [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - id + - string + - true + - Unique identifier of the private endpoint you want to retrieve. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --endpointServiceId + - string + - true + - Unique 24-character alphanumeric string that identifies the private endpoint in Atlas. + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ENDPOINT STATUS DELETE REQUESTED + + + +Examples +-------- + +.. code-block:: + :copyable: false + + atlas privateEndpoints gcp interfaces describe endpoint-1 \ + --endpointServiceId 61eaca605af86411903de1dd diff --git a/docs/command/atlas-privateEndpoints-gcp-interfaces.txt b/docs/command/atlas-privateEndpoints-gcp-interfaces.txt new file mode 100644 index 0000000000..ec3ec345fc --- /dev/null +++ b/docs/command/atlas-privateEndpoints-gcp-interfaces.txt @@ -0,0 +1,63 @@ +.. _atlas-privateEndpoints-gcp-interfaces: + +===================================== +atlas privateEndpoints gcp interfaces +===================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage Atlas GCP private endpoint interfaces. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for interfaces + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-privateEndpoints-gcp-interfaces-create` - Create a GCP private endpoint interface. +* :ref:`atlas-privateEndpoints-gcp-interfaces-delete` - Delete a specific GCP private endpoint interface for your project. +* :ref:`atlas-privateEndpoints-gcp-interfaces-describe` - Return a specific GCP private endpoint interface for your project. + + +.. toctree:: + :titlesonly: + + create + delete + describe + diff --git a/docs/command/atlas-privateEndpoints-gcp-list.txt b/docs/command/atlas-privateEndpoints-gcp-list.txt new file mode 100644 index 0000000000..26f48fd754 --- /dev/null +++ b/docs/command/atlas-privateEndpoints-gcp-list.txt @@ -0,0 +1,75 @@ +.. _atlas-privateEndpoints-gcp-list: + +=============================== +atlas privateEndpoints gcp list +=============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +List GCP private endpoints for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas privateEndpoints gcp list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + atlas privateEndpoint gcp ls diff --git a/docs/command/atlas-privateEndpoints-gcp-watch.txt b/docs/command/atlas-privateEndpoints-gcp-watch.txt new file mode 100644 index 0000000000..5741d695f6 --- /dev/null +++ b/docs/command/atlas-privateEndpoints-gcp-watch.txt @@ -0,0 +1,103 @@ +.. _atlas-privateEndpoints-gcp-watch: + +================================ +atlas privateEndpoints gcp watch +================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Watch the specified GCP private endpoint to detect changes in the endpoint's state. + +This command checks the endpoint's state periodically until the endpoint reaches an AVAILABLE or FAILED state. +Once the endpoint reaches the expected state, the command prints "GCP Private endpoint changes completed." +If you run the command in the terminal, it blocks the terminal session until the resource becomes available or fails. +You can interrupt the command's polling at any time with CTRL-C. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas privateEndpoints gcp watch [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - privateEndpointId + - string + - true + - Unique 22-character alphanumeric string that identifies the private endpoint. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for watch + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + + GCP Private endpoint changes completed. + + +Examples +-------- + +.. code-block:: + :copyable: false + + atlas privateEndpoint gcp watch tester-1 diff --git a/docs/command/atlas-privateEndpoints-gcp.txt b/docs/command/atlas-privateEndpoints-gcp.txt new file mode 100644 index 0000000000..29405adf0f --- /dev/null +++ b/docs/command/atlas-privateEndpoints-gcp.txt @@ -0,0 +1,69 @@ +.. _atlas-privateEndpoints-gcp: + +========================== +atlas privateEndpoints gcp +========================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage GCP private endpoints. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for gcp + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-privateEndpoints-gcp-create` - Create a new GCP private endpoint for your project. +* :ref:`atlas-privateEndpoints-gcp-delete` - Delete a GCP private endpoint for your project. +* :ref:`atlas-privateEndpoints-gcp-describe` - Return a specific GCP private endpoint for your project. +* :ref:`atlas-privateEndpoints-gcp-interfaces` - Manage Atlas GCP private endpoint interfaces. +* :ref:`atlas-privateEndpoints-gcp-list` - List GCP private endpoints for your project. +* :ref:`atlas-privateEndpoints-gcp-watch` - Watch the specified GCP private endpoint to detect changes in the endpoint's state. + + +.. toctree:: + :titlesonly: + + create + delete + describe + interfaces + list + watch + diff --git a/docs/command/atlas-privateEndpoints-regionalModes-describe.txt b/docs/command/atlas-privateEndpoints-regionalModes-describe.txt new file mode 100644 index 0000000000..f378aad693 --- /dev/null +++ b/docs/command/atlas-privateEndpoints-regionalModes-describe.txt @@ -0,0 +1,89 @@ +.. _atlas-privateEndpoints-regionalModes-describe: + +============================================= +atlas privateEndpoints regionalModes describe +============================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the regionalized private endpoint setting for your project. + +Use this command to check whether you can create multiple private resources per region. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas privateEndpoints regionalModes describe [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ENABLED + + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return the regionalized private endpoint setting for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas privateEndpoints regionalModes describe --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-privateEndpoints-regionalModes-disable.txt b/docs/command/atlas-privateEndpoints-regionalModes-disable.txt new file mode 100644 index 0000000000..22b38a3e8b --- /dev/null +++ b/docs/command/atlas-privateEndpoints-regionalModes-disable.txt @@ -0,0 +1,88 @@ +.. _atlas-privateEndpoints-regionalModes-disable: + +============================================ +atlas privateEndpoints regionalModes disable +============================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Disable the regionalized private endpoint setting for your project. + +This disables the ability to create multiple private resources per region in all cloud service providers for this project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas privateEndpoints regionalModes disable [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for disable + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Regionalized private endpoint setting disabled. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Disable the regionalied private endpoint setting in the project with the ID 5e2211c17a3e5a48f5497de3: + atlas privateEndpoints regionalModes disable --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-privateEndpoints-regionalModes-enable.txt b/docs/command/atlas-privateEndpoints-regionalModes-enable.txt new file mode 100644 index 0000000000..e7caddbbe0 --- /dev/null +++ b/docs/command/atlas-privateEndpoints-regionalModes-enable.txt @@ -0,0 +1,88 @@ +.. _atlas-privateEndpoints-regionalModes-enable: + +=========================================== +atlas privateEndpoints regionalModes enable +=========================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Enable the regionalized private endpoint setting for your project. + +This enables the ability to create multiple private resources per region in all cloud service providers for this project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas privateEndpoints regionalModes enable [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for enable + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Regionalized private endpoint setting enabled. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Enable the regionalied private endpoint setting in the project with the ID 5e2211c17a3e5a48f5497de3: + atlas privateEndpoints regionalModes enable --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-privateEndpoints-regionalModes.txt b/docs/command/atlas-privateEndpoints-regionalModes.txt new file mode 100644 index 0000000000..87c8064d9b --- /dev/null +++ b/docs/command/atlas-privateEndpoints-regionalModes.txt @@ -0,0 +1,63 @@ +.. _atlas-privateEndpoints-regionalModes: + +==================================== +atlas privateEndpoints regionalModes +==================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage regionalized private endpoint setting for your Atlas project. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for regionalModes + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-privateEndpoints-regionalModes-describe` - Return the regionalized private endpoint setting for your project. +* :ref:`atlas-privateEndpoints-regionalModes-disable` - Disable the regionalized private endpoint setting for your project. +* :ref:`atlas-privateEndpoints-regionalModes-enable` - Enable the regionalized private endpoint setting for your project. + + +.. toctree:: + :titlesonly: + + describe + disable + enable + diff --git a/docs/command/atlas-privateEndpoints.txt b/docs/command/atlas-privateEndpoints.txt new file mode 100644 index 0000000000..8a05ab2145 --- /dev/null +++ b/docs/command/atlas-privateEndpoints.txt @@ -0,0 +1,65 @@ +.. _atlas-privateEndpoints: + +====================== +atlas privateEndpoints +====================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage Atlas private endpoints. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for privateEndpoints + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-privateEndpoints-aws` - Manage AWS Private Endpoints. +* :ref:`atlas-privateEndpoints-azure` - Manage Azure Private Endpoints. +* :ref:`atlas-privateEndpoints-gcp` - Manage GCP private endpoints. +* :ref:`atlas-privateEndpoints-regionalModes` - Manage regionalized private endpoint setting for your Atlas project. + + +.. toctree:: + :titlesonly: + + aws + azure + gcp + regionalModes + diff --git a/docs/command/atlas-processes-describe.txt b/docs/command/atlas-processes-describe.txt new file mode 100644 index 0000000000..d96733b374 --- /dev/null +++ b/docs/command/atlas-processes-describe.txt @@ -0,0 +1,101 @@ +.. _atlas-processes-describe: + +======================== +atlas processes describe +======================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the details for the specified MongoDB process for your project. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas processes describe [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - hostname:port + - string + - true + - Hostname and port number of the instance running the Atlas MongoDB process. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID REPLICA SET NAME SHARD NAME VERSION + + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return the JSON-formatted details for the MongoDB process with hostname and port atlas-lnmtkm-shard-00-00.ajlj3.mongodb.net:27017 + atlas process describe atlas-lnmtkm-shard-00-00.ajlj3.mongodb.net:27017 --output json diff --git a/docs/command/atlas-processes-list.txt b/docs/command/atlas-processes-list.txt new file mode 100644 index 0000000000..6f575dfbeb --- /dev/null +++ b/docs/command/atlas-processes-list.txt @@ -0,0 +1,92 @@ +.. _atlas-processes-list: + +==================== +atlas processes list +==================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all MongoDB processes for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas processes list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -c, --compact + - + - false + - Flag that enables the compact array response structure for a json output. The --compact option returns array objects as top-level responses and allows backward compatibility for scripts based on previous CLI versions. Omitting the --compact option for a json output returns array objects within a 'results' sub-array. You must specify --output json to use this option. + * - -h, --help + - + - false + - help for list + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - --omitCount + - + - false + - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return a JSON-formatted list of all MongoDB processes in the project with the ID 5e2211c17a3e5a48f5497de3: + atlas processes list --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-processes.txt b/docs/command/atlas-processes.txt new file mode 100644 index 0000000000..5fd7e81a35 --- /dev/null +++ b/docs/command/atlas-processes.txt @@ -0,0 +1,61 @@ +.. _atlas-processes: + +=============== +atlas processes +=============== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage MongoDB processes for your project. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for processes + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-processes-describe` - Return the details for the specified MongoDB process for your project. +* :ref:`atlas-processes-list` - Return all MongoDB processes for your project. + + +.. toctree:: + :titlesonly: + + describe + list + diff --git a/docs/command/atlas-projects-apiKeys-assign.txt b/docs/command/atlas-projects-apiKeys-assign.txt new file mode 100644 index 0000000000..20d5873d49 --- /dev/null +++ b/docs/command/atlas-projects-apiKeys-assign.txt @@ -0,0 +1,108 @@ +.. _atlas-projects-apiKeys-assign: + +============================= +atlas projects apiKeys assign +============================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Assign the specified organization API key to your project and modify the API key's roles for the project. + +When you modify the roles for an organization API key with this command, the values you specify overwrite the existing roles assigned to the API key. + +To view possible values for the ID argument, run atlas organizations apiKeys list. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas projects apiKeys assign [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - ID + - string + - true + - Unique 24-digit string that identifies your API key. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for assign + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --role + - strings + - true + - Role or roles that you want to assign to the API key. To assign more than one role, specify each role with a separate role flag or specify all of the roles as a comma-separated list using one role flag. To learn which values the CLI accepts, see the Items Enum for roles in the Atlas API spec: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createProjectApiKey/. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + API Key successfully assigned. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Assign an organization API key with the ID 5f46ae53d58b421fe3edc115 and grant the GROUP_DATA_ACCESS_READ_WRITE role for the project with ID 5e2211c17a3e5a48f5497de3: + atlas projects apiKeys assign 5f46ae53d58b421fe3edc115 --projectId 5e1234c17a3e5a48f5497de3 --role GROUP_DATA_ACCESS_READ_WRITE --output json diff --git a/docs/command/atlas-projects-apiKeys-create.txt b/docs/command/atlas-projects-apiKeys-create.txt new file mode 100644 index 0000000000..b959d7ab79 --- /dev/null +++ b/docs/command/atlas-projects-apiKeys-create.txt @@ -0,0 +1,98 @@ +.. _atlas-projects-apiKeys-create: + +============================= +atlas projects apiKeys create +============================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create an organization API key and assign it to your project. + +MongoDB returns the private API key only once. After you run this command, immediately copy, save, and secure both the public and private API keys. + +To use this command, you must authenticate with a user account or an API key with the Project User Admin role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas projects apiKeys create [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --desc + - string + - true + - Description of the API key. + * - -h, --help + - + - false + - help for create + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --role + - strings + - true + - Role or roles that you want to assign to the API key. To assign more than one role, specify each role with a separate role flag or specify all of the roles as a comma-separated list using one role flag. To learn which values the CLI accepts, see the Items Enum for roles in the Atlas API spec: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createProjectApiKey/. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + API Key '' created. + Public API Key + Private API Key + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Create an organization API key with the GROUP_OWNER role and assign it to the project with ID 5e2211c17a3e5a48f5497de3: + atlas projects apiKeys create --desc "My API key" --projectId 5e1234c17a3e5a48f5497de3 --role GROUP_OWNER --output json diff --git a/docs/command/atlas-projects-apiKeys-delete.txt b/docs/command/atlas-projects-apiKeys-delete.txt new file mode 100644 index 0000000000..c2b2fbc72c --- /dev/null +++ b/docs/command/atlas-projects-apiKeys-delete.txt @@ -0,0 +1,106 @@ +.. _atlas-projects-apiKeys-delete: + +============================= +atlas projects apiKeys delete +============================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Remove the specified organization API key from your project. + +The API key still exists at the organization level. To reassign the organization API key to a project, run the atlas projects apiKeys assign command. + +To view possible values for the ID argument, run atlas organizations apiKeys list. + +To use this command, you must authenticate with a user account or an API key with the Project User Admin role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas projects apiKeys delete [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - ID + - string + - true + - Unique 24-digit string that identifies your API key. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + API Key '' deleted + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Remove an organization API key with the ID 5f46ae53d58b421fe3edc115 from the project with ID 5e2211c17a3e5a48f5497de3: + atlas projects apiKeys delete 5f46ae53d58b421fe3edc115 --projectId 5e1234c17a3e5a48f5497de3 diff --git a/docs/command/atlas-projects-apiKeys-list.txt b/docs/command/atlas-projects-apiKeys-list.txt new file mode 100644 index 0000000000..4f26094679 --- /dev/null +++ b/docs/command/atlas-projects-apiKeys-list.txt @@ -0,0 +1,92 @@ +.. _atlas-projects-apiKeys-list: + +=========================== +atlas projects apiKeys list +=========================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all organization API keys assigned to your project. + +To use this command, you must authenticate with a user account or an API key with the Project User Admin role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas projects apiKeys list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -c, --compact + - + - false + - Flag that enables the compact array response structure for a json output. The --compact option returns array objects as top-level responses and allows backward compatibility for scripts based on previous CLI versions. Omitting the --compact option for a json output returns array objects within a 'results' sub-array. You must specify --output json to use this option. + * - -h, --help + - + - false + - help for list + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - --omitCount + - + - false + - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return a JSON-formatted list of organization API keys assigned to the project with ID 5e2211c17a3e5a48f5497de3: + atlas projects apiKeys list --projectId 5e1234c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-projects-apiKeys.txt b/docs/command/atlas-projects-apiKeys.txt new file mode 100644 index 0000000000..aa4c4c61da --- /dev/null +++ b/docs/command/atlas-projects-apiKeys.txt @@ -0,0 +1,65 @@ +.. _atlas-projects-apiKeys: + +====================== +atlas projects apiKeys +====================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage API Keys for your project. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for apiKeys + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-projects-apiKeys-assign` - Assign the specified organization API key to your project and modify the API key's roles for the project. +* :ref:`atlas-projects-apiKeys-create` - Create an organization API key and assign it to your project. +* :ref:`atlas-projects-apiKeys-delete` - Remove the specified organization API key from your project. +* :ref:`atlas-projects-apiKeys-list` - Return all organization API keys assigned to your project. + + +.. toctree:: + :titlesonly: + + assign + create + delete + list + diff --git a/docs/command/atlas-projects-create.txt b/docs/command/atlas-projects-create.txt new file mode 100644 index 0000000000..2fa91868b6 --- /dev/null +++ b/docs/command/atlas-projects-create.txt @@ -0,0 +1,120 @@ +.. _atlas-projects-create: + +===================== +atlas projects create +===================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create a project in your organization. + +Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, and alert settings. + +To use this command, you must authenticate with a user account or an API key with the Project Data Access Read/Write role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas projects create [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - projectName + - string + - true + - Label that identifies the project. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --govCloudRegionsOnly + - + - false + - Flag that designates that the project uses only the AWS GovCloud region. Use this option only for Atlas for Government projects. If unspecified, the project uses only the AWS Standard region for AWS deployments. You can't deploy clusters across AWS GovCloud and AWS Standard regions in the same project. + * - -h, --help + - + - false + - help for create + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --ownerId + - string + - false + - Unique 24-digit string that identifies the Atlas user to be granted the Project Owner role on the specified project. If unspecified, this value defaults to the user ID of the oldest Organization Owner. + * - --tag + - key=value + - false + - List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the project. + * - --withoutDefaultAlertSettings + - + - false + - Flag that creates the new project without the default alert settings enabled. This flag defaults to false. This option is useful if you create projects programmatically and want to create your own alerts instead of using the default alert settings. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Project '' created. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Create a project in the organization with the ID 5e2211c17a3e5a48f5497de3 using default alert settings: + atlas projects create my-project --orgId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-projects-delete.txt b/docs/command/atlas-projects-delete.txt new file mode 100644 index 0000000000..840a40a2fa --- /dev/null +++ b/docs/command/atlas-projects-delete.txt @@ -0,0 +1,98 @@ +.. _atlas-projects-delete: + +===================== +atlas projects delete +===================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Remove the specified project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas projects delete [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - ID + - string + - true + - Unique 24-digit string that identifies the project. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Project '' deleted + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Remove the project with the ID 5e2211c17a3e5a48f5497de3: + atlas projects delete 5e2211c17a3e5a48f5497de3 diff --git a/docs/command/atlas-projects-describe.txt b/docs/command/atlas-projects-describe.txt new file mode 100644 index 0000000000..2d32ee6d1b --- /dev/null +++ b/docs/command/atlas-projects-describe.txt @@ -0,0 +1,99 @@ +.. _atlas-projects-describe: + +======================= +atlas projects describe +======================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the details for the specified project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas projects describe [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - ID + - string + - true + - Unique 24-digit string that identifies the project. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID NAME + + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return the JSON-formatted details for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas projects describe 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-projects-list.txt b/docs/command/atlas-projects-list.txt new file mode 100644 index 0000000000..d34deeb096 --- /dev/null +++ b/docs/command/atlas-projects-list.txt @@ -0,0 +1,99 @@ +.. _atlas-projects-list: + +=================== +atlas projects list +=================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all projects. + +To use this command, you must authenticate with a user account or an API key with the Project Data Access Read/Write role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas projects list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - --omitCount + - + - false + - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID NAME + + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return a JSON-formatted list of all projects: + atlas projects list --output json diff --git a/docs/command/atlas-projects-settings-describe.txt b/docs/command/atlas-projects-settings-describe.txt new file mode 100644 index 0000000000..e206c5f33c --- /dev/null +++ b/docs/command/atlas-projects-settings-describe.txt @@ -0,0 +1,85 @@ +.. _atlas-projects-settings-describe: + +================================ +atlas projects settings describe +================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Retrieve details for settings to the specified project. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas projects settings describe [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + COLLECT DATABASE SPECIFICS STATISTICS ENABLED DATA EXPLORER ENABLED PERFORMANCE ADVISOR ENABLED REALTIME PERFORMANCE PANEL ENABLED SCHEMA ADVISOR ENABLED + + + +Examples +-------- + +.. code-block:: + :copyable: false + + # This example uses the profile named "myprofile" for accessing Atlas. + atlas projects settings describe -P myprofile --projectId 5e2211c17a3e5a48f5497de3 diff --git a/docs/command/atlas-projects-settings-update.txt b/docs/command/atlas-projects-settings-update.txt new file mode 100644 index 0000000000..d7a431752c --- /dev/null +++ b/docs/command/atlas-projects-settings-update.txt @@ -0,0 +1,144 @@ +.. _atlas-projects-settings-update: + +============================== +atlas projects settings update +============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Updates settings for a project. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas projects settings update [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --disableCollectDatabaseSpecificsStatistics + - + - false + - Flag that disables the Collect Database Specific Statistics project setting. + + Mutually exclusive with --enableCollectDatabaseSpecificsStatistics. + * - --disableDataExplorer + - + - false + - Flag that disables the Data Explorer project setting. + + Mutually exclusive with --enableDataExplorer. + * - --disablePerformanceAdvisor + - + - false + - Flag that disables the Performance Advisor project setting. + + Mutually exclusive with --enablePerformanceAdvisor. + * - --disableRealtimePerformancePanel + - + - false + - Flag that disables the Real Time Performance Panel project setting. + + Mutually exclusive with --enableRealtimePerformancePanel. + * - --disableSchemaAdvisor + - + - false + - Flag that disables the Schema Advisor project setting. + + Mutually exclusive with --enableSchemaAdvisor. + * - --enableCollectDatabaseSpecificsStatistics + - + - false + - Flag that enables the Collect Database Specific Statistics project setting. + + Mutually exclusive with --disableCollectDatabaseSpecificsStatistics. + * - --enableDataExplorer + - + - false + - Flag that enables the Data Explorer project setting. + + Mutually exclusive with --disableDataExplorer. + * - --enablePerformanceAdvisor + - + - false + - Flag that enables the Performance Advisor project setting. + + Mutually exclusive with --disablePerformanceAdvisor. + * - --enableRealtimePerformancePanel + - + - false + - Flag that enables the Real Time Performance Panel project setting. + + Mutually exclusive with --disableRealtimePerformancePanel. + * - --enableSchemaAdvisor + - + - false + - Flag that enables the Schema Advisor project setting. + + Mutually exclusive with --disableSchemaAdvisor. + * - -h, --help + - + - false + - help for update + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Project settings updated. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # This example uses the profile named "myprofile" for accessing Atlas. + atlas projects settings update --disableCollectDatabaseSpecificsStatistics -P myprofile --projectId 5e2211c17a3e5a48f5497de3 diff --git a/docs/command/atlas-projects-settings.txt b/docs/command/atlas-projects-settings.txt new file mode 100644 index 0000000000..8671663757 --- /dev/null +++ b/docs/command/atlas-projects-settings.txt @@ -0,0 +1,63 @@ +.. _atlas-projects-settings: + +======================= +atlas projects settings +======================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Settings operations. + +Manage your project settings. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for settings + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-projects-settings-describe` - Retrieve details for settings to the specified project. +* :ref:`atlas-projects-settings-update` - Updates settings for a project. + + +.. toctree:: + :titlesonly: + + describe + update + diff --git a/docs/command/atlas-projects-teams-add.txt b/docs/command/atlas-projects-teams-add.txt new file mode 100644 index 0000000000..f8670378f0 --- /dev/null +++ b/docs/command/atlas-projects-teams-add.txt @@ -0,0 +1,108 @@ +.. _atlas-projects-teams-add: + +======================== +atlas projects teams add +======================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Add the specified team to your project. + +All members of the team share the same project access. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas projects teams add [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - teamId + - string + - true + - Unique 24-digit string that identifies the team. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for add + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --role + - strings + - true + - User role that applies to all members of the specified team for the associated project. Valid values include GROUP_CLUSTER_MANAGER, GROUP_DATA_ACCESS_ADMIN, GROUP_DATA_ACCESS_READ_ONLY, GROUP_DATA_ACCESS_READ_WRITE, GROUP_OWNER, and GROUP_READ_ONLY. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Team added to the project. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Add the team with the ID 5dd58c647a3e5a6c5bce46c7 to the project with the ID 5e2211c17a3e5a48f5497de3 with GROUP_READ_ONLY project access: + atlas projects teams add 5dd58c647a3e5a6c5bce46c7 --projectId 5e2211c17a3e5a48f5497de3 --role GROUP_READ_ONLY diff --git a/docs/command/atlas-projects-teams-delete.txt b/docs/command/atlas-projects-teams-delete.txt new file mode 100644 index 0000000000..1f5819a10d --- /dev/null +++ b/docs/command/atlas-projects-teams-delete.txt @@ -0,0 +1,104 @@ +.. _atlas-projects-teams-delete: + +=========================== +atlas projects teams delete +=========================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Remove the specified team from your project. + +After you remove a team from your project, the team still exists in the organization in which it was created. + +To use this command, you must authenticate with a user account or an API key with the Project User Admin role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas projects teams delete [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - teamId + - string + - true + - Unique 24-digit string that identifies the team. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Team '' deleted + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Remove the team with the ID 5dd58c647a3e5a6c5bce46c7 from the project with the ID 5e2211c17a3e5a48f5497de3: + atlas projects teams delete 5dd58c647a3e5a6c5bce46c7 --projectId 5e2211c17a3e5a48f5497de3 diff --git a/docs/command/atlas-projects-teams-list.txt b/docs/command/atlas-projects-teams-list.txt new file mode 100644 index 0000000000..12e530a794 --- /dev/null +++ b/docs/command/atlas-projects-teams-list.txt @@ -0,0 +1,99 @@ +.. _atlas-projects-teams-list: + +========================= +atlas projects teams list +========================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all teams for a project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas projects teams list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - --omitCount + - + - false + - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID + + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return a JSON-formatted list of all teams for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas projects teams list --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-projects-teams-update.txt b/docs/command/atlas-projects-teams-update.txt new file mode 100644 index 0000000000..02527e0e2e --- /dev/null +++ b/docs/command/atlas-projects-teams-update.txt @@ -0,0 +1,106 @@ +.. _atlas-projects-teams-update: + +=========================== +atlas projects teams update +=========================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Modify the roles for the specified team for your project. + +To use this command, you must authenticate with a user account or an API key with the Project User Admin role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas projects teams update [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - teamId + - string + - true + - Unique 24-digit string that identifies the team. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for update + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --role + - strings + - true + - User role that applies to all members of the specified team for the associated project. Valid values include GROUP_CLUSTER_MANAGER, GROUP_DATA_ACCESS_ADMIN, GROUP_DATA_ACCESS_READ_ONLY, GROUP_DATA_ACCESS_READ_WRITE, GROUP_OWNER, and GROUP_READ_ONLY. Passing this flag replaces preexisting data. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Team's roles updated. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Modify the roles for the team with the ID 5dd56c847a3e5a1f363d424d to grant GROUP_READ_ONLY access to the project with the ID 5f71e5255afec75a3d0f96dc: + atlas projects teams update 5dd56c847a3e5a1f363d424d --projectId 5f71e5255afec75a3d0f96dc --role GROUP_READ_ONLY --output json diff --git a/docs/command/atlas-projects-teams.txt b/docs/command/atlas-projects-teams.txt new file mode 100644 index 0000000000..b215be2184 --- /dev/null +++ b/docs/command/atlas-projects-teams.txt @@ -0,0 +1,65 @@ +.. _atlas-projects-teams: + +==================== +atlas projects teams +==================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage your Atlas teams. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for teams + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-projects-teams-add` - Add the specified team to your project. +* :ref:`atlas-projects-teams-delete` - Remove the specified team from your project. +* :ref:`atlas-projects-teams-list` - Return all teams for a project. +* :ref:`atlas-projects-teams-update` - Modify the roles for the specified team for your project. + + +.. toctree:: + :titlesonly: + + add + delete + list + update + diff --git a/docs/command/atlas-projects-update.txt b/docs/command/atlas-projects-update.txt new file mode 100644 index 0000000000..2b771e7f3c --- /dev/null +++ b/docs/command/atlas-projects-update.txt @@ -0,0 +1,102 @@ +.. _atlas-projects-update: + +===================== +atlas projects update +===================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Update a project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas projects update [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - ID + - string + - true + - ID of the project you want to update. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -f, --file + - string + - true + - Path to the JSON configuration file that defines project configuration settings. To learn more about project configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/project-config-file. + * - -h, --help + - + - false + - help for update + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Project '' updated. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Update a project with the ID 5e2211c17a3e5a48f5497de3 using the JSON file named myProject.json: + atlas projects update 5f4007f327a3bd7b6f4103c5 --file myProject.json --output json diff --git a/docs/command/atlas-projects-users-delete.txt b/docs/command/atlas-projects-users-delete.txt new file mode 100644 index 0000000000..870543b4f6 --- /dev/null +++ b/docs/command/atlas-projects-users-delete.txt @@ -0,0 +1,104 @@ +.. _atlas-projects-users-delete: + +=========================== +atlas projects users delete +=========================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Remove the specified user from your project. + +After you remove a user from your project, the user still exists in the organization in which it was created. + +To use this command, you must authenticate with a user account or an API key with the Project User Admin role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas projects users delete [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - ID + - string + - true + - Unique 24-digit string that identifies the user. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + User '' deleted from the project + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Remove the user with the ID 5dd58c647a3e5a6c5bce46c7 from the project with the ID 5e2211c17a3e5a48f5497de3: + atlas projects users delete 5dd58c647a3e5a6c5bce46c7 --projectId 5e2211c17a3e5a48f5497de3 diff --git a/docs/command/atlas-projects-users-list.txt b/docs/command/atlas-projects-users-list.txt new file mode 100644 index 0000000000..fda0542dcb --- /dev/null +++ b/docs/command/atlas-projects-users-list.txt @@ -0,0 +1,92 @@ +.. _atlas-projects-users-list: + +========================= +atlas projects users list +========================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all users for a project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas projects users list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -c, --compact + - + - false + - Flag that enables the compact array response structure for a json output. The --compact option returns array objects as top-level responses and allows backward compatibility for scripts based on previous CLI versions. Omitting the --compact option for a json output returns array objects within a 'results' sub-array. You must specify --output json to use this option. + * - -h, --help + - + - false + - help for list + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - --omitCount + - + - false + - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return a JSON-formatted list of all users for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas projects users list --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-projects-users.txt b/docs/command/atlas-projects-users.txt new file mode 100644 index 0000000000..0292d11497 --- /dev/null +++ b/docs/command/atlas-projects-users.txt @@ -0,0 +1,61 @@ +.. _atlas-projects-users: + +==================== +atlas projects users +==================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage users for a project. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for users + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-projects-users-delete` - Remove the specified user from your project. +* :ref:`atlas-projects-users-list` - Return all users for a project. + + +.. toctree:: + :titlesonly: + + delete + list + diff --git a/docs/command/atlas-projects.txt b/docs/command/atlas-projects.txt new file mode 100644 index 0000000000..b7e5825090 --- /dev/null +++ b/docs/command/atlas-projects.txt @@ -0,0 +1,77 @@ +.. _atlas-projects: + +============== +atlas projects +============== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage your Atlas projects. + +Create, list and manage your MongoDB projects. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for projects + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-projects-apiKeys` - Manage API Keys for your project. +* :ref:`atlas-projects-create` - Create a project in your organization. +* :ref:`atlas-projects-delete` - Remove the specified project. +* :ref:`atlas-projects-describe` - Return the details for the specified project. +* :ref:`atlas-projects-list` - Return all projects. +* :ref:`atlas-projects-settings` - Settings operations. +* :ref:`atlas-projects-teams` - Manage your Atlas teams. +* :ref:`atlas-projects-update` - Update a project. +* :ref:`atlas-projects-users` - Manage users for a project. + + +.. toctree:: + :titlesonly: + + apiKeys + create + delete + describe + list + settings + teams + update + users + diff --git a/docs/command/atlas-security-customerCerts-create.txt b/docs/command/atlas-security-customerCerts-create.txt new file mode 100644 index 0000000000..f22030f134 --- /dev/null +++ b/docs/command/atlas-security-customerCerts-create.txt @@ -0,0 +1,92 @@ +.. _atlas-security-customerCerts-create: + +=================================== +atlas security customerCerts create +=================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Saves a customer-managed X.509 configuration for your project. + +Saving a customer-managed X.509 configuration triggers a rolling restart. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas security customerCerts create [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --casFile + - string + - true + - Path to a PEM file containing one or more CAs for database user authentication. + * - -h, --help + - + - false + - help for create + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Certificate successfully created. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Save the file named ca.pem stored in the files directory to the project with the ID 5e2211c17a3e5a48f5497de3: + atlas security customerCerts create --casFile files/ca.pem --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-security-customerCerts-describe.txt b/docs/command/atlas-security-customerCerts-describe.txt new file mode 100644 index 0000000000..c94b4cad31 --- /dev/null +++ b/docs/command/atlas-security-customerCerts-describe.txt @@ -0,0 +1,76 @@ +.. _atlas-security-customerCerts-describe: + +===================================== +atlas security customerCerts describe +===================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the details for the current customer-managed X.509 configuration for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas security customerCerts describe [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return the JSON-formatted details for the customer-managed X.509 configuration in the project with the ID 5e2211c17a3e5a48f5497de3: + atlas security customerCerts describe --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-security-customerCerts-disable.txt b/docs/command/atlas-security-customerCerts-disable.txt new file mode 100644 index 0000000000..c45f4712e1 --- /dev/null +++ b/docs/command/atlas-security-customerCerts-disable.txt @@ -0,0 +1,84 @@ +.. _atlas-security-customerCerts-disable: + +==================================== +atlas security customerCerts disable +==================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Clear customer-managed X.509 settings on a project, including the uploaded Certificate Authority, and disable self-managed X.509. + +Disabling customer-managed X.509 triggers a rolling restart. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas security customerCerts disable [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for disable + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + X.509 configuration for project was deleted. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Disable the customer-managed X.509 configuration in the project with the ID 5e2211c17a3e5a48f5497de3: + atlas security customerCerts disable --projectId 5e2211c17a3e5a48f5497de3 diff --git a/docs/command/atlas-security-customerCerts.txt b/docs/command/atlas-security-customerCerts.txt new file mode 100644 index 0000000000..9b8a81fb98 --- /dev/null +++ b/docs/command/atlas-security-customerCerts.txt @@ -0,0 +1,63 @@ +.. _atlas-security-customerCerts: + +============================ +atlas security customerCerts +============================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage customer x509 certificates for your project. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for customerCerts + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-security-customerCerts-create` - Saves a customer-managed X.509 configuration for your project. +* :ref:`atlas-security-customerCerts-describe` - Return the details for the current customer-managed X.509 configuration for your project. +* :ref:`atlas-security-customerCerts-disable` - Clear customer-managed X.509 settings on a project, including the uploaded Certificate Authority, and disable self-managed X.509. + + +.. toctree:: + :titlesonly: + + create + describe + disable + diff --git a/docs/command/atlas-security-ldap-delete.txt b/docs/command/atlas-security-ldap-delete.txt new file mode 100644 index 0000000000..1a26083803 --- /dev/null +++ b/docs/command/atlas-security-ldap-delete.txt @@ -0,0 +1,86 @@ +.. _atlas-security-ldap-delete: + +========================== +atlas security ldap delete +========================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Remove the current LDAP configuration captured in the userToDNMapping document from your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas security ldap delete [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + LDAP configuration userToDNMapping deleted from project'' + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Remove the current LDAP configuration in the project with the ID 5e2211c17a3e5a48f5497de3: + atlas security ldap delete --projectId 5e2211c17a3e5a48f5497de3 diff --git a/docs/command/atlas-security-ldap-get.txt b/docs/command/atlas-security-ldap-get.txt new file mode 100644 index 0000000000..359a0931fc --- /dev/null +++ b/docs/command/atlas-security-ldap-get.txt @@ -0,0 +1,87 @@ +.. _atlas-security-ldap-get: + +======================= +atlas security ldap get +======================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the current LDAP configuration details for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas security ldap get [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for get + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + HOSTNAME PORT AUTHENTICATION AUTHORIZATION + + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return the JSON-formatted details of the current LDAP configuration in the project with the ID 5e2211c17a3e5a48f5497de3: + atlas security ldap get --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-security-ldap-save.txt b/docs/command/atlas-security-ldap-save.txt new file mode 100644 index 0000000000..8bae744bc4 --- /dev/null +++ b/docs/command/atlas-security-ldap-save.txt @@ -0,0 +1,138 @@ +.. _atlas-security-ldap-save: + +======================== +atlas security ldap save +======================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Save an LDAP configuration for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas security ldap save [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --authenticationEnabled + - + - false + - Flag that indicates whether to enable LDAP user authentication. + * - --authorizationEnabled + - + - false + - Flag that indicates whether to enable LDAP user authorization. + * - --authzQueryTemplate + - string + - false + - RFC 4515-formatted or RFC 4516-formatted LDAP query template that Atlas executes to obtain the LDAP authorization groups to which the authenticated user belongs. Use the {USER} placeholder in the URL to substitute the username. The query is relative to the host specified with the hostname. + * - --bindPassword + - string + - false + - Password used to authenticate the bindUsername. + * - --bindUsername + - string + - true + - User distinguished name (DN) that Atlas uses to connect to the LDAP server. You must format LDAP distinguished names according to RFC 2253. + * - --caCertificate + - string + - false + - Certificate Authority (CA) used to verify the identity of the LDAP server. To delete an assigned value, pass an empty string. + * - -h, --help + - + - false + - help for save + * - --hostname + - string + - true + - Hostname or IP address of the LDAP server. + * - --mappingLdapQuery + - string + - false + - RFC 4515-formatted or RFC 4516-formatted LDAP query template that inserts the LDAP name that the regex matches into an LDAP query URI. + + Mutually exclusive with --mappingSubstitution, --mappingSubstitution. + * - --mappingMatch + - string + - false + - ECMAScript-formatted regular expression (regex) to match against a provided username. + * - --mappingSubstitution + - string + - false + - LDAP distinguished name (DN) template that converts the LDAP username that matches the regex specified in the match option into an LDAP DN. + + Mutually exclusive with --mappingLdapQuery, --mappingLdapQuery. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --port + - int + - false + - Port that the LDAP server listens to for client connections. This value defaults to 636. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + HOSTNAME PORT AUTHENTICATION AUTHORIZATION + + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Save an LDAP server configuration to authenticate and authorize MongoDB users for the host atlas-ldaps-01.ldap.myteam.com: + atlas security ldap save --authenticationEnabled --authorizationEnabled + --hostname atlas-ldaps-01.ldap.myteam.com --bindUsername + "CN=Administrator,CN=Users,DC=atlas-ldaps-01,DC=myteam,DC=com" + --bindPassword changeMe diff --git a/docs/command/atlas-security-ldap-verify-status-watch.txt b/docs/command/atlas-security-ldap-verify-status-watch.txt new file mode 100644 index 0000000000..8a13c69d21 --- /dev/null +++ b/docs/command/atlas-security-ldap-verify-status-watch.txt @@ -0,0 +1,103 @@ +.. _atlas-security-ldap-verify-status-watch: + +======================================= +atlas security ldap verify status watch +======================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Watch for an LDAP configuration request to complete. + +This command checks the LDAP configuration's status periodically until it reaches a SUCCESS or FAILED status. +Once the LDAP configuration reaches the expected status, the command prints "LDAP Configuration request completed." +If you run the command in the terminal, it blocks the terminal session until the resource status succeeds or fails. +You can interrupt the command's polling at any time with CTRL-C. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas security ldap verify status watch [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - requestId + - string + - true + - ID of the request to verify an LDAP configuration. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for watch + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + + LDAP Configuration request completed. + + +Examples +-------- + +.. code-block:: + :copyable: false + + atlas security ldap status watch requestIdSample diff --git a/docs/command/atlas-security-ldap-verify-status.txt b/docs/command/atlas-security-ldap-verify-status.txt new file mode 100644 index 0000000000..3458531de3 --- /dev/null +++ b/docs/command/atlas-security-ldap-verify-status.txt @@ -0,0 +1,106 @@ +.. _atlas-security-ldap-verify-status: + +================================= +atlas security ldap verify status +================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Get the status of an LDAP configuration request. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas security ldap verify status [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - requestId + - string + - true + - ID of the request to verify an LDAP configuration. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for status + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + REQUEST ID PROJECT ID STATUS + + + +Related Commands +---------------- + +* :ref:`atlas-security-ldap-verify-status-watch` - Watch for an LDAP configuration request to complete. + + +.. toctree:: + :titlesonly: + + watch + diff --git a/docs/command/atlas-security-ldap-verify.txt b/docs/command/atlas-security-ldap-verify.txt new file mode 100644 index 0000000000..1a76e01654 --- /dev/null +++ b/docs/command/atlas-security-ldap-verify.txt @@ -0,0 +1,123 @@ +.. _atlas-security-ldap-verify: + +========================== +atlas security ldap verify +========================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Request verification of an LDAP configuration for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas security ldap verify [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --authzQueryTemplate + - string + - false + - RFC 4515-formatted or RFC 4516-formatted LDAP query template that Atlas executes to obtain the LDAP authorization groups to which the authenticated user belongs. Use the {USER} placeholder in the URL to substitute the username. The query is relative to the host specified with the hostname. + * - --bindPassword + - string + - false + - Password used to authenticate the bindUsername. + * - --bindUsername + - string + - true + - User distinguished name (DN) that Atlas uses to connect to the LDAP server. You must format LDAP distinguished names according to RFC 2253. + * - --caCertificate + - string + - false + - Certificate Authority (CA) used to verify the identity of the LDAP server. To delete an assigned value, pass an empty string. + * - -h, --help + - + - false + - help for verify + * - --hostname + - string + - true + - Hostname or IP address of the LDAP server. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --port + - int + - false + - Port that the LDAP server listens to for client connections. This value defaults to 636. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + REQUEST ID PROJECT ID STATUS + + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Request the JSON-formatted verification of the LDAP configuration for the atlas-ldaps-01.ldap.myteam.com host in the project with the ID 5e2211c17a3e5a48f5497de3: + atlas security ldap verify --hostname atlas-ldaps-01.ldap.myteam.com --bindUsername "CN=Administrator,CN=Users,DC=atlas-ldaps-01,DC=myteam,DC=com" --bindPassword changeMe --projectId 5e2211c17a3e5a48f5497de3 --output json + +Related Commands +---------------- + +* :ref:`atlas-security-ldap-verify-status` - Get the status of an LDAP configuration request. + + +.. toctree:: + :titlesonly: + + status + diff --git a/docs/command/atlas-security-ldap.txt b/docs/command/atlas-security-ldap.txt new file mode 100644 index 0000000000..20627d1405 --- /dev/null +++ b/docs/command/atlas-security-ldap.txt @@ -0,0 +1,65 @@ +.. _atlas-security-ldap: + +=================== +atlas security ldap +=================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +LDAP operations. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for ldap + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-security-ldap-delete` - Remove the current LDAP configuration captured in the userToDNMapping document from your project. +* :ref:`atlas-security-ldap-get` - Return the current LDAP configuration details for your project. +* :ref:`atlas-security-ldap-save` - Save an LDAP configuration for your project. +* :ref:`atlas-security-ldap-verify` - Request verification of an LDAP configuration for your project. + + +.. toctree:: + :titlesonly: + + delete + get + save + verify + diff --git a/docs/command/atlas-security.txt b/docs/command/atlas-security.txt new file mode 100644 index 0000000000..3457b5871d --- /dev/null +++ b/docs/command/atlas-security.txt @@ -0,0 +1,61 @@ +.. _atlas-security: + +============== +atlas security +============== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage security configuration for your project. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for security + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-security-customerCerts` - Manage customer x509 certificates for your project. +* :ref:`atlas-security-ldap` - LDAP operations. + + +.. toctree:: + :titlesonly: + + customerCerts + ldap + diff --git a/docs/command/atlas-serverless-backups-restores-create.txt b/docs/command/atlas-serverless-backups-restores-create.txt new file mode 100644 index 0000000000..c63dca378e --- /dev/null +++ b/docs/command/atlas-serverless-backups-restores-create.txt @@ -0,0 +1,138 @@ +.. _atlas-serverless-backups-restores-create: + +======================================== +atlas serverless backups restores create +======================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Start a restore job for your serverless instance. + +If you create an automated or pointInTime restore job, Atlas removes all existing data on the target cluster prior to the restore. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. +Atlas supports this command only for M10+ clusters. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas serverless backups restores create [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --clusterName + - string + - true + - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. + * - --deliveryType + - string + - true + - Type of restore job to create. Valid values include: automated, download, pointInTime. To learn more about types of restore jobs, see https://dochub.mongodb.org/core/backup-restore-cluster-atlas. + * - -h, --help + - + - false + - help for create + * - --oplogInc + - int + - false + - 32-bit incrementing ordinal that represents operations within a given second. When paired with oplogTs, they represent the point in time to which your data will be restored. + * - --oplogTs + - int + - false + - Oplog timestamp given as a timestamp in the number of seconds that have elapsed since the UNIX Epoch. When paired with oplogInc, they represent the point in time to which your data will be restored. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --pointInTimeUTCSeconds + - int + - false + - Timestamp in the number of seconds that have elapsed since the UNIX epoch that represents the point in time to which your data will be restored. This timestamp must be within the last 24 hours of the current time. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --snapshotId + - string + - false + - Unique identifier of the snapshot. + * - --targetClusterName + - string + - false + - Name of the target cluster. For use only with automated restore jobs. You must specify a targetClusterName for automated restores. + * - --targetProjectId + - string + - false + - Unique identifier of the project that contains the destination cluster for the restore job. You must specify a targetProjectId for automated restores. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + # Create an automated restore: + atlas serverless backup restore create \ + --deliveryType automated \ + --clusterName myDemo \ + --snapshotId 5e7e00128f8ce03996a47179 \ + --targetClusterName myDemo2 \ + --targetProjectId 1a2345b67c8e9a12f3456de7 + + +.. code-block:: + :copyable: false + + # Create a point-in-time restore: + atlas serverless backup restore create \ + --deliveryType pointInTime \ + --clusterName myDemo \ + --pointInTimeUTCSeconds 1588523147 \ + --targetClusterName myDemo2 \ + --targetProjectId 1a2345b67c8e9a12f3456de7 + + +.. code-block:: + :copyable: false + + # Create a download restore: + atlas serverless backup restore create \ + --deliveryType download \ + --clusterName myDemo \ + --snapshotId 5e7e00128f8ce03996a47179 diff --git a/docs/command/atlas-serverless-backups-restores-describe.txt b/docs/command/atlas-serverless-backups-restores-describe.txt new file mode 100644 index 0000000000..f370cc9295 --- /dev/null +++ b/docs/command/atlas-serverless-backups-restores-describe.txt @@ -0,0 +1,84 @@ +.. _atlas-serverless-backups-restores-describe: + +========================================== +atlas serverless backups restores describe +========================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Describe a cloud backup restore job. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas serverless backups restores describe [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --clusterName + - string + - true + - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --restoreJobId + - string + - true + - Unique identifier that identifies the Restore Job. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return the details for the continuous backup restore job with the ID 507f1f77bcf86cd799439011 for the serverless isntance named Cluster0: + atlas serverless backup restore describe --restoreJobId 507f1f77bcf86cd799439011 --clusterName Cluster0 diff --git a/docs/command/atlas-serverless-backups-restores-list.txt b/docs/command/atlas-serverless-backups-restores-list.txt new file mode 100644 index 0000000000..818f96f99d --- /dev/null +++ b/docs/command/atlas-serverless-backups-restores-list.txt @@ -0,0 +1,104 @@ +.. _atlas-serverless-backups-restores-list: + +====================================== +atlas serverless backups restores list +====================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all cloud backup restore jobs for the specified serverless instance in your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas serverless backups restores list [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - clusterName + - string + - true + - Label that identifies the Atlas serverless instance for which you want to return restore jobs. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - --omitCount + - + - false + - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return all continuous backup restore jobs for the serverless instance Instance0: + atlas serverless backup restore list Instance0 diff --git a/docs/command/atlas-serverless-backups-restores-watch.txt b/docs/command/atlas-serverless-backups-restores-watch.txt new file mode 100644 index 0000000000..493beab3c0 --- /dev/null +++ b/docs/command/atlas-serverless-backups-restores-watch.txt @@ -0,0 +1,99 @@ +.. _atlas-serverless-backups-restores-watch: + +======================================= +atlas serverless backups restores watch +======================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Watch the specified backup restore job until it completes. + +This command checks the restore job's status periodically until it reaches a completed, failed or canceled status. +Command finishes once one of the expected statuses are reached. +If you run the command in the terminal, it blocks the terminal session until the resource status completes or fails. +You can interrupt the command's polling at any time with CTRL-C. +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas serverless backups restores watch [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --clusterName + - string + - true + - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. + * - -h, --help + - + - false + - help for watch + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --restoreJobId + - string + - true + - Unique identifier that identifies the Restore Job. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + + Restore completed. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Watch the continuous backup restore job with the ID 507f1f77bcf86cd799439011 for the cluster named Cluster0 until it becomes available: + atlas serverless backup restore watch --restoreJobId 507f1f77bcf86cd799439011 --clusterName Cluster0 diff --git a/docs/command/atlas-serverless-backups-restores.txt b/docs/command/atlas-serverless-backups-restores.txt new file mode 100644 index 0000000000..075cb55e82 --- /dev/null +++ b/docs/command/atlas-serverless-backups-restores.txt @@ -0,0 +1,65 @@ +.. _atlas-serverless-backups-restores: + +================================= +atlas serverless backups restores +================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage cloud backup restore jobs for your project. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for restores + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-serverless-backups-restores-create` - Start a restore job for your serverless instance. +* :ref:`atlas-serverless-backups-restores-describe` - Describe a cloud backup restore job. +* :ref:`atlas-serverless-backups-restores-list` - Return all cloud backup restore jobs for the specified serverless instance in your project. +* :ref:`atlas-serverless-backups-restores-watch` - Watch the specified backup restore job until it completes. + + +.. toctree:: + :titlesonly: + + create + describe + list + watch + diff --git a/docs/command/atlas-serverless-backups-snapshots-describe.txt b/docs/command/atlas-serverless-backups-snapshots-describe.txt new file mode 100644 index 0000000000..75e99d206c --- /dev/null +++ b/docs/command/atlas-serverless-backups-snapshots-describe.txt @@ -0,0 +1,95 @@ +.. _atlas-serverless-backups-snapshots-describe: + +=========================================== +atlas serverless backups snapshots describe +=========================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the details for the specified snapshot for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas serverless backups snapshots describe [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --clusterName + - string + - true + - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --snapshotId + - string + - true + - Unique identifier of the snapshot. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID SNAPSHOT TYPE EXPIRES AT + + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return the details for the backup snapshot with the ID 5f4007f327a3bd7b6f4103c5 for the instance named myDemo: + atlas serverless backups snapshots describe --snapshotId 5f4007f327a3bd7b6f4103c5 --clusterName myDemo diff --git a/docs/command/atlas-serverless-backups-snapshots-list.txt b/docs/command/atlas-serverless-backups-snapshots-list.txt new file mode 100644 index 0000000000..32397aaab9 --- /dev/null +++ b/docs/command/atlas-serverless-backups-snapshots-list.txt @@ -0,0 +1,104 @@ +.. _atlas-serverless-backups-snapshots-list: + +======================================= +atlas serverless backups snapshots list +======================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all cloud backup snapshots for the specified serverless instance in your project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas serverless backups snapshots list [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - clusterName + - string + - true + - Label that identifies the Atlas serverless instance that contains the snapshots you want to return. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - --omitCount + - + - false + - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return a JSON-formatted list of snapshots for the instance named myDemo + atlas serverless backups snapshots list myDemo --output json diff --git a/docs/command/atlas-serverless-backups-snapshots-watch.txt b/docs/command/atlas-serverless-backups-snapshots-watch.txt new file mode 100644 index 0000000000..c9c0833f21 --- /dev/null +++ b/docs/command/atlas-serverless-backups-snapshots-watch.txt @@ -0,0 +1,95 @@ +.. _atlas-serverless-backups-snapshots-watch: + +======================================== +atlas serverless backups snapshots watch +======================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Watch the specified snapshot in your project until it reaches a completed or failed status. + +This command checks the snapshot's status periodically until it reaches a completed or failed status. +Command finishes once one of the expected statuses are reached. +If you run the command in the terminal, it blocks the terminal session until the resource status completes or fails. +You can interrupt the command's polling at any time with CTRL-C. +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas serverless backups snapshots watch [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --clusterName + - string + - true + - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. + * - -h, --help + - + - false + - help for watch + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --snapshotId + - string + - true + - Unique identifier of the snapshot. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + + Snapshot changes completed. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Watch the backup snapshot with the ID 5f4007f327a3bd7b6f4103c5 in the cluster named myDemo until it becomes available: + atlas backups snapshots watch 5f4007f327a3bd7b6f4103c5 --clusterName myDemo diff --git a/docs/command/atlas-serverless-backups-snapshots.txt b/docs/command/atlas-serverless-backups-snapshots.txt new file mode 100644 index 0000000000..4e88777e4c --- /dev/null +++ b/docs/command/atlas-serverless-backups-snapshots.txt @@ -0,0 +1,63 @@ +.. _atlas-serverless-backups-snapshots: + +================================== +atlas serverless backups snapshots +================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage cloud backup snapshots for your project. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for snapshots + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-serverless-backups-snapshots-describe` - Return the details for the specified snapshot for your project. +* :ref:`atlas-serverless-backups-snapshots-list` - Return all cloud backup snapshots for the specified serverless instance in your project. +* :ref:`atlas-serverless-backups-snapshots-watch` - Watch the specified snapshot in your project until it reaches a completed or failed status. + + +.. toctree:: + :titlesonly: + + describe + list + watch + diff --git a/docs/command/atlas-serverless-backups.txt b/docs/command/atlas-serverless-backups.txt new file mode 100644 index 0000000000..897f685a06 --- /dev/null +++ b/docs/command/atlas-serverless-backups.txt @@ -0,0 +1,61 @@ +.. _atlas-serverless-backups: + +======================== +atlas serverless backups +======================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage cloud backups for your project. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for backups + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-serverless-backups-restores` - Manage cloud backup restore jobs for your project. +* :ref:`atlas-serverless-backups-snapshots` - Manage cloud backup snapshots for your project. + + +.. toctree:: + :titlesonly: + + restores + snapshots + diff --git a/docs/command/atlas-serverless-create.txt b/docs/command/atlas-serverless-create.txt new file mode 100644 index 0000000000..e6513837e1 --- /dev/null +++ b/docs/command/atlas-serverless-create.txt @@ -0,0 +1,114 @@ +.. _atlas-serverless-create: + +======================= +atlas serverless create +======================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Creates one serverless instance in the specified project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas serverless create [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - instanceName + - string + - true + - Human-readable label that identifies your serverless instance. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for create + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --provider + - string + - true + - Cloud service provider that applies to the provisioned serverless instance. + * - --region + - string + - true + - Human-readable label that identifies the physical location of your MongoDB serverless instance. The region you choose can affect network latency for clients accessing your databases. + * - --tag + - key=value + - false + - List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Serverless instance created. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Deploy a serverlessInstance named myInstance for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas serverless create myInstance --provider AWS --region US_EAST_1 --projectId 5e2211c17a3e5a48f5497de3 diff --git a/docs/command/atlas-serverless-delete.txt b/docs/command/atlas-serverless-delete.txt new file mode 100644 index 0000000000..ab1996e009 --- /dev/null +++ b/docs/command/atlas-serverless-delete.txt @@ -0,0 +1,108 @@ +.. _atlas-serverless-delete: + +======================= +atlas serverless delete +======================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Remove a serverless instance from your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas serverless delete [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - instanceName + - string + - true + - Name of the instance to delete. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Serverless instance '' deleted + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Remove a serverlessInstance named myInstance for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas serverless delete myInstance --projectId 5e2211c17a3e5a48f5497de3 + +.. code-block:: + :copyable: false + + # Remove a serverlessInstance named myInstance for the project with the ID 5e2211c17a3e5a48f5497de3 without requiring confirmation: + atlas serverless delete myInstance --projectId 5e2211c17a3e5a48f5497de3 --force diff --git a/docs/command/atlas-serverless-describe.txt b/docs/command/atlas-serverless-describe.txt new file mode 100644 index 0000000000..1b46e0934e --- /dev/null +++ b/docs/command/atlas-serverless-describe.txt @@ -0,0 +1,103 @@ +.. _atlas-serverless-describe: + +========================= +atlas serverless describe +========================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return one serverless instance in the specified project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas serverless describe [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - instanceName + - string + - true + - Human-readable label that identifies your serverless instance. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID NAME MDB VER STATE + + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return the JSON-formatted details for the serverlessInstance named myInstance in the project with the ID 5e2211c17a3e5a48f5497de3: + atlas serverless describe myInstance --projectId 5e2211c17a3e5a48f5497de3 diff --git a/docs/command/atlas-serverless-list.txt b/docs/command/atlas-serverless-list.txt new file mode 100644 index 0000000000..c998545fcc --- /dev/null +++ b/docs/command/atlas-serverless-list.txt @@ -0,0 +1,99 @@ +.. _atlas-serverless-list: + +===================== +atlas serverless list +===================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all serverless instances in the specified project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas serverless list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - --omitCount + - + - false + - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID NAME MDB VER STATE + + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return the JSON-formatted list of all serverlessInstances for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas serverless list --projectId 5e2211c17a3e5a48f5497de3 diff --git a/docs/command/atlas-serverless-update.txt b/docs/command/atlas-serverless-update.txt new file mode 100644 index 0000000000..09918c83c1 --- /dev/null +++ b/docs/command/atlas-serverless-update.txt @@ -0,0 +1,122 @@ +.. _atlas-serverless-update: + +======================= +atlas serverless update +======================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Updates one serverless instance in the specified project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas serverless update [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - instanceName + - string + - true + - Human-readable label that identifies your serverless instance. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --disableServerlessContinuousBackup + - + - false + - Disables Serverless Continuous Backup for your serverless instance. If disabled the serverless instance uses Basic Backup. + + Mutually exclusive with --enableServerlessContinuousBackup. + * - --disableTerminationProtection + - + - false + - Disables termination protection for your cluster. You can delete a cluster with termination protection disabled. + + Mutually exclusive with --enableTerminationProtection. + * - --enableServerlessContinuousBackup + - + - false + - Flag that enables Serverless Continuous Backup for your serverless instance. If enabled, the serverless instance does not use Basic Backup. + + Mutually exclusive with --disableServerlessContinuousBackup. + * - --enableTerminationProtection + - + - false + - Enables termination protection for your cluster. You can't delete a cluster with termination protection enabled. + + Mutually exclusive with --disableTerminationProtection. + * - -h, --help + - + - false + - help for update + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --tag + - key=value + - false + - List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance. Passing this flag replaces preexisting data. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Serverless instance updated. + + diff --git a/docs/command/atlas-serverless-watch.txt b/docs/command/atlas-serverless-watch.txt new file mode 100644 index 0000000000..a4eb079ee5 --- /dev/null +++ b/docs/command/atlas-serverless-watch.txt @@ -0,0 +1,103 @@ +.. _atlas-serverless-watch: + +====================== +atlas serverless watch +====================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Monitor the status of serverless instance. + +This command checks the serverless instance's state periodically until the instance reaches an IDLE state. +Once the instance reaches the expected state, the command prints "Instance available." +If you run the command in the terminal, it blocks the terminal session until the resource becomes idle. +You can interrupt the command's polling at any time with CTRL-C. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas serverless watch [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - instanceName + - string + - true + - Name of the instance to watch. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for watch + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + + Instance available. + + +Examples +-------- + +.. code-block:: + :copyable: false + + atlas serverless watch instanceNameSample diff --git a/docs/command/atlas-serverless.txt b/docs/command/atlas-serverless.txt new file mode 100644 index 0000000000..635d8401a1 --- /dev/null +++ b/docs/command/atlas-serverless.txt @@ -0,0 +1,73 @@ +.. _atlas-serverless: + +================ +atlas serverless +================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage serverless instances for your project. + +The serverless command provides access to your serverless instance configurations. You can create, edit, and delete serverless instances. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for serverless + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-serverless-backups` - Manage cloud backups for your project. +* :ref:`atlas-serverless-create` - Creates one serverless instance in the specified project. +* :ref:`atlas-serverless-delete` - Remove a serverless instance from your project. +* :ref:`atlas-serverless-describe` - Return one serverless instance in the specified project. +* :ref:`atlas-serverless-list` - Return all serverless instances in the specified project. +* :ref:`atlas-serverless-update` - Updates one serverless instance in the specified project. +* :ref:`atlas-serverless-watch` - Monitor the status of serverless instance. + + +.. toctree:: + :titlesonly: + + backups + create + delete + describe + list + update + watch + diff --git a/docs/command/atlas-setup.txt b/docs/command/atlas-setup.txt new file mode 100644 index 0000000000..302145b0b0 --- /dev/null +++ b/docs/command/atlas-setup.txt @@ -0,0 +1,142 @@ +.. _atlas-setup: + +=========== +atlas setup +=========== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Register, authenticate, create, and access an Atlas cluster. + +This command takes you through registration, login, default profile creation, creating your first free tier cluster and connecting to it using MongoDB Shell. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas setup [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --accessListIp + - strings + - false + - IP address to grant access to the deployment. + + Mutually exclusive with --currentIp. + * - --clusterName + - string + - false + - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. + * - --connectWith + - string + - false + - Method for connecting to the cluster. Valid values are compass, mongosh and skip. + + Mutually exclusive with --skipMongosh. + * - --currentIp + - + - false + - Flag that adds the IP address from the host that is currently executing the command to the access list. + + Mutually exclusive with --accessListIp. + * - --enableTerminationProtection + - + - false + - Enables termination protection for your cluster. You can't delete a cluster with termination protection enabled. + * - --force + - + - false + - Flag that indicates whether to skip the request for input and create a cluster with the default settings for any unspecified options. + * - --gov + - + - false + - Register with Atlas for Government. + * - -h, --help + - + - false + - help for setup + * - --mdbVersion + - string + - false + - Major MongoDB version of the deployment. + * - --noBrowser + - + - false + - Don't try to open a browser session. + * - --password + - string + - false + - Password for the user. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --provider + - string + - false + - Name of your cloud service provider. Valid values are AWS, AZURE, or GCP. + * - -r, --region + - string + - false + - Physical location of your MongoDB cluster. For a complete list of supported AWS regions, see: https://dochub.mongodb.org/core/aws-atlas. For a complete list of supported Azure regions, see: https://dochub.mongodb.org/core/azure-atlas. For a complete list of supported GCP regions, see: https://dochub.mongodb.org/core/gcp-atlas. + * - --skipSampleData + - + - false + - Flag that indicates whether to skip loading sample data into your MongoDB cluster. + * - --tag + - key=value + - false + - List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. + * - --tier + - string + - false + - Tier for each data-bearing server in the cluster. To learn more about cluster tiers, see https://dochub.mongodb.org/core/cluster-tier-atlas. This value defaults to "M0". + * - --username + - string + - false + - Username for authenticating to MongoDB. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + # Override default cluster settings like name, provider, or database username by using the command options + atlas setup --clusterName Test --provider GCP --username dbuserTest diff --git a/docs/command/atlas-streams-connections-create.txt b/docs/command/atlas-streams-connections-create.txt new file mode 100644 index 0000000000..1195155ba6 --- /dev/null +++ b/docs/command/atlas-streams-connections-create.txt @@ -0,0 +1,118 @@ +.. _atlas-streams-connections-create: + +================================ +atlas streams connections create +================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Creates a connection for an Atlas Stream Processing instance. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas streams connections create [connectionName] [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - connectionName + - string + - false + - Name of the connection + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -f, --file + - string + - true + - Path to a JSON configuration file that defines an Atlas Stream Processing connection. + * - -h, --help + - + - false + - help for create + * - -i, --instance + - string + - true + - Name of your Atlas Stream Processing instance. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Connection created. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # create a new connection for Atlas Stream Processing: + atlas streams connection create kafkaprod -i test01 -f kafkaConfig.json + + +.. code-block:: + :copyable: false + + # create a new connection using the name from a cluster configuration file + atlas streams connection create -i test01 -f clusterConfig.json + diff --git a/docs/command/atlas-streams-connections-delete.txt b/docs/command/atlas-streams-connections-delete.txt new file mode 100644 index 0000000000..28a82a8881 --- /dev/null +++ b/docs/command/atlas-streams-connections-delete.txt @@ -0,0 +1,116 @@ +.. _atlas-streams-connections-delete: + +================================ +atlas streams connections delete +================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Remove the specified Atlas Stream Processing connection from your project. + +The command prompts you to confirm the operation when you run the command without the --force option. + +Before deleting an Atlas Streams Processing connection, you must first stop all processes associated with it. To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas streams connections delete [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - connectionName + - string + - true + - Name of the connection + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - -i, --instance + - string + - true + - Name of your Atlas Stream Processing instance. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Atlas Stream Processing connection '' deleted + + +Examples +-------- + +.. code-block:: + :copyable: false + + # deletes connection 'ExampleConnection' from instance 'ExampleInstance': + atlas streams connection delete ExampleConnection --instance ExampleInstance + + +.. code-block:: + :copyable: false + + # deletes connection 'ExampleConnection' from instance 'ExampleInstance' without requiring confirmation: + atlas streams connection delete ExampleConnection --instance ExampleInstance --force + diff --git a/docs/command/atlas-streams-connections-describe.txt b/docs/command/atlas-streams-connections-describe.txt new file mode 100644 index 0000000000..9c0081ac67 --- /dev/null +++ b/docs/command/atlas-streams-connections-describe.txt @@ -0,0 +1,97 @@ +.. _atlas-streams-connections-describe: + +================================== +atlas streams connections describe +================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the details for the specified Atlas Stream Processing connection. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas streams connections describe [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - streamConnectionName + - string + - true + - Name of the Atlas Stream Processing connection. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - -i, --instance + - string + - true + - Name of your Atlas Stream Processing instance. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + # retrieves stream connection 'ExampleConnection' in instance 'ExampleInstance': + atlas streams connection describe ExampleConnection --instance ExampleInstance + diff --git a/docs/command/atlas-streams-connections-list.txt b/docs/command/atlas-streams-connections-list.txt new file mode 100644 index 0000000000..3acd0d2a5d --- /dev/null +++ b/docs/command/atlas-streams-connections-list.txt @@ -0,0 +1,81 @@ +.. _atlas-streams-connections-list: + +============================== +atlas streams connections list +============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns all Atlas Stream Processing connections from your Atlas Stream Processing instance. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas streams connections list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - -i, --instance + - string + - true + - Name of your Atlas Stream Processing instance. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + # list all connections within ExampleInstance: + atlas streams connection list --instance ExampleInstance + diff --git a/docs/command/atlas-streams-connections-update.txt b/docs/command/atlas-streams-connections-update.txt new file mode 100644 index 0000000000..4de5931b15 --- /dev/null +++ b/docs/command/atlas-streams-connections-update.txt @@ -0,0 +1,111 @@ +.. _atlas-streams-connections-update: + +================================ +atlas streams connections update +================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Modify the details of the specified connection within your Atlas Stream Processing instance. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas streams connections update [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - connectionName + - string + - true + - Name of the connection. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -f, --file + - string + - true + - Path to a JSON configuration file that defines an Atlas Stream Processing connection. + * - -h, --help + - + - false + - help for update + * - -i, --instance + - string + - true + - Name of your Atlas Stream Processing instance. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Connection updated. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # update an Atlas Stream Processing connection: + atlas streams connection update kafkaprod --instance test01 -f kafkaConfig.json + diff --git a/docs/command/atlas-streams-connections.txt b/docs/command/atlas-streams-connections.txt new file mode 100644 index 0000000000..2c40745051 --- /dev/null +++ b/docs/command/atlas-streams-connections.txt @@ -0,0 +1,69 @@ +.. _atlas-streams-connections: + +========================= +atlas streams connections +========================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage Atlas Stream Processing connections. + +Create, list, update and delete your Atlas Stream Processing connections + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for connections + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-streams-connections-create` - Creates a connection for an Atlas Stream Processing instance. +* :ref:`atlas-streams-connections-delete` - Remove the specified Atlas Stream Processing connection from your project. +* :ref:`atlas-streams-connections-describe` - Return the details for the specified Atlas Stream Processing connection. +* :ref:`atlas-streams-connections-list` - Returns all Atlas Stream Processing connections from your Atlas Stream Processing instance. +* :ref:`atlas-streams-connections-update` - Modify the details of the specified connection within your Atlas Stream Processing instance. + + +.. toctree:: + :titlesonly: + + create + delete + describe + list + update + diff --git a/docs/command/atlas-streams-instances-create.txt b/docs/command/atlas-streams-instances-create.txt new file mode 100644 index 0000000000..391e3dc39c --- /dev/null +++ b/docs/command/atlas-streams-instances-create.txt @@ -0,0 +1,114 @@ +.. _atlas-streams-instances-create: + +============================== +atlas streams instances create +============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create an Atlas Stream Processing instance for your project + +To get started quickly, specify a name, a cloud provider, and a region to configure an Atlas Stream Processing instance.To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas streams instances create [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - name + - string + - true + - Name of the Atlas Stream Processing instance. After creation, you can't change the name of the instance. The name can contain ASCII letters, numbers, and hyphens. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for create + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --provider + - string + - true + - Cloud service provider that applies to the provisioned Atlas Stream Processing instance. This value defaults to "AWS". + * - -r, --region + - string + - true + - Human-readable label that identifies the physical location of your Atlas Stream Processing instance. The region can affect network latency and performance if it is far from your source or sink. + * - --tier + - string + - false + - Tier for your Stream Instance. This value defaults to "SP30". + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Atlas Streams Processor Instance '' successfully created. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Deploy an Atlas Stream Processing instance called myProcessor for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas streams instance create myProcessor --projectId 5e2211c17a3e5a48f5497de3 --provider AWS --region VIRGINIA_USA --tier SP30 diff --git a/docs/command/atlas-streams-instances-delete.txt b/docs/command/atlas-streams-instances-delete.txt new file mode 100644 index 0000000000..f7e1a66ae8 --- /dev/null +++ b/docs/command/atlas-streams-instances-delete.txt @@ -0,0 +1,112 @@ +.. _atlas-streams-instances-delete: + +============================== +atlas streams instances delete +============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Delete an Atlas Stream Processing instance. + +The command prompts you to confirm the operation when you run the command without the --force option. + +Before deleting an Atlas Streams Processing instance, you must first stop all processes associated with it. +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas streams instances delete [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - name + - string + - true + - Name of the Atlas Streams instance. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Atlas Streams processor instance '' deleted + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Remove an Atlas Stream Processing instance after prompting for a confirmation: + atlas streams instance delete myProcessorInstance + + +.. code-block:: + :copyable: false + + # Remove an Atlas Stream Processing instance named myProcessorInstance without requiring confirmation: + atlas streams instance delete myProcessorInstance --force diff --git a/docs/command/atlas-streams-instances-describe.txt b/docs/command/atlas-streams-instances-describe.txt new file mode 100644 index 0000000000..e701019c47 --- /dev/null +++ b/docs/command/atlas-streams-instances-describe.txt @@ -0,0 +1,109 @@ +.. _atlas-streams-instances-describe: + +================================ +atlas streams instances describe +================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Describe an Atlas Stream Processing instance for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas streams instances describe [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - name + - string + - true + - Name of the Atlas Streams processor instance. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID NAME CLOUD REGION + + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return an Atlas Stream Processing instance with a specific name: + atlas streams instance describe myProcessor + +.. code-block:: + :copyable: false + + # Return a JSON-formatted Atlas Stream Processing instance with a specific name: + atlas streams instance describe myProcessor --output json diff --git a/docs/command/atlas-streams-instances-download.txt b/docs/command/atlas-streams-instances-download.txt new file mode 100644 index 0000000000..8cee843c81 --- /dev/null +++ b/docs/command/atlas-streams-instances-download.txt @@ -0,0 +1,114 @@ +.. _atlas-streams-instances-download: + +================================ +atlas streams instances download +================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Download a compressed file that contains the logs for the specified Atlas Stream Processing instance. + +This command downloads a file with a .gz extension. To use this command, you must authenticate with a user account or an API key with the Project Data Access Read/Write role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas streams instances download [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - tenantName + - string + - true + - Label that identifies the tenant that stores the log files that you want to download. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --end + - int + - false + - Ending date and time for the range of log messages to retrieve, given in UNIX time. Defaults to the start date plus 24 hours, if the start date is set. If start date is not provided, ending time defaults to the current time. + * - --force + - + - false + - Flag that indicates whether to overwrite the destination file. + * - -h, --help + - + - false + - help for download + * - --out + - string + - true + - Output file name. This value defaults to the log name. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --start + - int + - false + - UNIX Epoch-formatted starting date and time for the range of log messages to retrieve. This value defaults to 24 hours prior to the current timestamp. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Download of completed. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Download the audit log file from the instance myProcessor for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas streams instance download myProcessor --projectId 5e2211c17a3e5a48f5497de3 diff --git a/docs/command/atlas-streams-instances-list.txt b/docs/command/atlas-streams-instances-list.txt new file mode 100644 index 0000000000..43620f92c8 --- /dev/null +++ b/docs/command/atlas-streams-instances-list.txt @@ -0,0 +1,95 @@ +.. _atlas-streams-instances-list: + +============================ +atlas streams instances list +============================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +List all the Atlas Stream Processing instances for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas streams instances list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID NAME CLOUD REGION + + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return a JSON-formatted list of all Atlas Stream Processing instances for the project with ID 5e2211c17a3e5a48f5497de3: + atlas streams instance list --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-streams-instances-update.txt b/docs/command/atlas-streams-instances-update.txt new file mode 100644 index 0000000000..43b2e3d521 --- /dev/null +++ b/docs/command/atlas-streams-instances-update.txt @@ -0,0 +1,111 @@ +.. _atlas-streams-instances-update: + +============================== +atlas streams instances update +============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Updates an Atlas Stream Processing instance for your project. + +Before updating an Atlas Streams Processing instance, you must first stop all processes associated with it. +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas streams instances update [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - name + - string + - true + - Name of the Atlas Stream Processing instance. After creation, you can't change the name of the instance. The name can contain ASCII letters, numbers, and hyphens. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for update + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --provider + - string + - true + - Cloud service provider that applies to the provisioned Atlas Stream Processing instance. This value defaults to "AWS". + * - -r, --region + - string + - true + - Human-readable label that identifies the physical location of your Atlas Stream Processing instance. The region can affect network latency and performance if it is far from your source or sink. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Atlas Streams Processor Instance '' successfully updated. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Modify the Atlas Stream Processing instance configuration with the name MyInstance: + atlas streams instance update MyInstance --provider AWS --region VIRGINIA_USA diff --git a/docs/command/atlas-streams-instances.txt b/docs/command/atlas-streams-instances.txt new file mode 100644 index 0000000000..88cb43a8a5 --- /dev/null +++ b/docs/command/atlas-streams-instances.txt @@ -0,0 +1,71 @@ +.. _atlas-streams-instances: + +======================= +atlas streams instances +======================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage Atlas Stream Processing instances. + +Create, list, update and delete your Atlas Stream Processing instances. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for instances + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-streams-instances-create` - Create an Atlas Stream Processing instance for your project +* :ref:`atlas-streams-instances-delete` - Delete an Atlas Stream Processing instance. +* :ref:`atlas-streams-instances-describe` - Describe an Atlas Stream Processing instance for your project. +* :ref:`atlas-streams-instances-download` - Download a compressed file that contains the logs for the specified Atlas Stream Processing instance. +* :ref:`atlas-streams-instances-list` - List all the Atlas Stream Processing instances for your project. +* :ref:`atlas-streams-instances-update` - Updates an Atlas Stream Processing instance for your project. + + +.. toctree:: + :titlesonly: + + create + delete + describe + download + list + update + diff --git a/docs/command/atlas-streams.txt b/docs/command/atlas-streams.txt new file mode 100644 index 0000000000..7c5ce40184 --- /dev/null +++ b/docs/command/atlas-streams.txt @@ -0,0 +1,63 @@ +.. _atlas-streams: + +============= +atlas streams +============= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage your Atlas Stream Processing deployments. + +The streams command provides access to your Atlas Stream Processing configurations. You can create, edit, and delete streams, as well as change the connection registry. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for streams + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-streams-connections` - Manage Atlas Stream Processing connections. +* :ref:`atlas-streams-instances` - Manage Atlas Stream Processing instances. + + +.. toctree:: + :titlesonly: + + connections + instances + diff --git a/docs/command/atlas-teams-create.txt b/docs/command/atlas-teams-create.txt new file mode 100644 index 0000000000..9bb807539e --- /dev/null +++ b/docs/command/atlas-teams-create.txt @@ -0,0 +1,106 @@ +.. _atlas-teams-create: + +================== +atlas teams create +================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create a team for your organization. + +To use this command, you must authenticate with a user account or an API key with the Organization Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas teams create [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - name + - string + - true + - Label that identifies the team. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for create + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --username + - strings + - true + - Comma-separated list that contains the valid usernames of the MongoDB users to add to the new team. A team must have at least one user. New users must accept the invitation to join an organization before you can add them to a team. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Team '' created. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Create a team named myTeam in the organization with ID 5e2211c17a3e5a48f5497de3: + atlas teams create myTeam --username user1@example.com,user2@example.com --orgId 5e1234c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-teams-delete.txt b/docs/command/atlas-teams-delete.txt new file mode 100644 index 0000000000..3be0a283e1 --- /dev/null +++ b/docs/command/atlas-teams-delete.txt @@ -0,0 +1,102 @@ +.. _atlas-teams-delete: + +================== +atlas teams delete +================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Remove the specified team from your organization. + +To use this command, you must authenticate with a user account or an API key with the Organization User Admin role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas teams delete [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - teamId + - string + - true + - Unique 24-digit string that identifies the team. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Team '' deleted + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Remove the team with the ID 5e44445ef10fab20b49c0f31 from the organization with ID 5e2211c17a3e5a48f5497de3: + atlas teams delete 5e44445ef10fab20b49c0f31 --orgId 5e1234c17a3e5a48f5497de3 diff --git a/docs/command/atlas-teams-describe.txt b/docs/command/atlas-teams-describe.txt new file mode 100644 index 0000000000..a61464ad6d --- /dev/null +++ b/docs/command/atlas-teams-describe.txt @@ -0,0 +1,104 @@ +.. _atlas-teams-describe: + +==================== +atlas teams describe +==================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the details for the specified team for your organization. + +You can return the details for a team using the team's ID or the team's name. You must specify either the id option or the name option. + +To use this command, you must authenticate with a user account or an API key with the Organization Member role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas teams describe [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - --id + - string + - false + - Unique 24-digit string that identifies the team. + * - --name + - string + - false + - Label that identifies the team. + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID NAME + + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return the JSON-formatted details for the the team with the ID 5e44445ef10fab20b49c0f31 in the organization with ID 5e2211c17a3e5a48f5497de3: + atlas teams describe --id 5e44445ef10fab20b49c0f31 --projectId 5e1234c17a3e5a48f5497de3 --output json + + +.. code-block:: + :copyable: false + + # Return the JSON-formatted details for the the team with the name myTeam in the organization with ID 5e2211c17a3e5a48f5497de3: + atlas teams describe --name myTeam --projectId 5e1234c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-teams-list.txt b/docs/command/atlas-teams-list.txt new file mode 100644 index 0000000000..f454ff6762 --- /dev/null +++ b/docs/command/atlas-teams-list.txt @@ -0,0 +1,92 @@ +.. _atlas-teams-list: + +================ +atlas teams list +================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all teams for your organization. + +To use this command, you must authenticate with a user account or an API key with the Organization Member role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas teams list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -c, --compact + - + - false + - Flag that enables the compact array response structure for a json output. The --compact option returns array objects as top-level responses and allows backward compatibility for scripts based on previous CLI versions. Omitting the --compact option for a json output returns array objects within a 'results' sub-array. You must specify --output json to use this option. + * - -h, --help + - + - false + - help for list + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - --omitCount + - + - false + - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return a JSON-formatted list of the teams for the organization with ID 5e2211c17a3e5a48f5497de3: + atlas teams list --orgId 5e1234c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-teams-rename.txt b/docs/command/atlas-teams-rename.txt new file mode 100644 index 0000000000..867a75b2f8 --- /dev/null +++ b/docs/command/atlas-teams-rename.txt @@ -0,0 +1,106 @@ +.. _atlas-teams-rename: + +================== +atlas teams rename +================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Rename a team in your organization. + +To use this command, you must authenticate with a user account or an API key with the Organization Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas teams rename [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - newName + - string + - true + - New label that identifies the team. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for rename + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --teamId + - string + - true + - Unique 24-digit string that identifies the team. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Team '' updated. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Rename a team in the organization with ID 5e2211c17a3e5a48f5497de3: + atlas teams rename newName --teamId 5e1234c17a3e5a48f5497de3 --orgId 5e1234c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-teams-users-add.txt b/docs/command/atlas-teams-users-add.txt new file mode 100644 index 0000000000..eeb6319874 --- /dev/null +++ b/docs/command/atlas-teams-users-add.txt @@ -0,0 +1,108 @@ +.. _atlas-teams-users-add: + +===================== +atlas teams users add +===================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Add the specified MongoDB user to a team for your organization. + +You can add users that are part of the organization or users that have been sent an invitation to join the organization. + +To use this command, you must authenticate with a user account or an API key with the Organization User Admin role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas teams users add ... [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - userId + - string + - true + - Unique 24-digit string that identifies the user. You can add more than one user at a time by specifying multiple user IDs separated by a space. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for add + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --teamId + - string + - true + - Unique 24-digit string that identifies the team. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + User(s) added to the team. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Add the users with the IDs 5dd58c647a3e5a6c5bce46c7 and 5dd56c847a3e5a1f363d424d to the team with the ID 5f6a5c6c713184005d72fe6e for the organization with ID 5e2211c17a3e5a48f5497de3: + atlas teams users add 5dd58c647a3e5a6c5bce46c7 5dd56c847a3e5a1f363d424d --teamId 5f6a5c6c713184005d72fe6e --orgId 5e1234c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-teams-users-delete.txt b/docs/command/atlas-teams-users-delete.txt new file mode 100644 index 0000000000..4cd64e07bd --- /dev/null +++ b/docs/command/atlas-teams-users-delete.txt @@ -0,0 +1,106 @@ +.. _atlas-teams-users-delete: + +======================== +atlas teams users delete +======================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Remove the specified user from a team for your organization. + +To use this command, you must authenticate with a user account or an API key with the Organization User Admin role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas teams users delete [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - userId + - string + - true + - Unique 24-digit string that identifies the user. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + * - --teamId + - string + - true + - Unique 24-digit string that identifies the team. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + User '' deleted from the team + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Remove the user with the ID 5dd58c647a3e5a6c5bce46c7 from the team with the ID 5f6a5c6c713184005d72fe6e for the organization with ID 5e2211c17a3e5a48f5497de3: + atlas teams users delete 5dd58c647a3e5a6c5bce46c7 --teamId 5f6a5c6c713184005d72fe6e --orgId 5e1234c17a3e5a48f5497de3 diff --git a/docs/command/atlas-teams-users-list.txt b/docs/command/atlas-teams-users-list.txt new file mode 100644 index 0000000000..ae494e0213 --- /dev/null +++ b/docs/command/atlas-teams-users-list.txt @@ -0,0 +1,84 @@ +.. _atlas-teams-users-list: + +====================== +atlas teams users list +====================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all users for a team. + +To use this command, you must authenticate with a user account or an API key with the Organization Member role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas teams users list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -c, --compact + - + - false + - Flag that enables the compact array response structure for a json output. The --compact option returns array objects as top-level responses and allows backward compatibility for scripts based on previous CLI versions. Omitting the --compact option for a json output returns array objects within a 'results' sub-array. You must specify --output json to use this option. + * - -h, --help + - + - false + - help for list + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --teamId + - string + - true + - Unique 24-digit string that identifies the team. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return a JSON-formatted list of the users for the team with the ID 5f6a5c6c713184005d72fe6e in the organization with ID 5e2211c17a3e5a48f5497de3: + atlas teams users list --teamId 5f6a5c6c713184005d72fe6e --orgId 5e1234c17a3e5a48f5497de3 --output json diff --git a/docs/command/atlas-teams-users.txt b/docs/command/atlas-teams-users.txt new file mode 100644 index 0000000000..d8724b0790 --- /dev/null +++ b/docs/command/atlas-teams-users.txt @@ -0,0 +1,65 @@ +.. _atlas-teams-users: + +================= +atlas teams users +================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage your Atlas users. + +Create, list and manage your users. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for users + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-teams-users-add` - Add the specified MongoDB user to a team for your organization. +* :ref:`atlas-teams-users-delete` - Remove the specified user from a team for your organization. +* :ref:`atlas-teams-users-list` - Return all users for a team. + + +.. toctree:: + :titlesonly: + + add + delete + list + diff --git a/docs/command/atlas-teams.txt b/docs/command/atlas-teams.txt new file mode 100644 index 0000000000..a32ada2f2b --- /dev/null +++ b/docs/command/atlas-teams.txt @@ -0,0 +1,71 @@ +.. _atlas-teams: + +=========== +atlas teams +=========== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage your Atlas teams. + +Create, list and manage your Atlas teams. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for teams + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-teams-create` - Create a team for your organization. +* :ref:`atlas-teams-delete` - Remove the specified team from your organization. +* :ref:`atlas-teams-describe` - Return the details for the specified team for your organization. +* :ref:`atlas-teams-list` - Return all teams for your organization. +* :ref:`atlas-teams-rename` - Rename a team in your organization. +* :ref:`atlas-teams-users` - Manage your Atlas users. + + +.. toctree:: + :titlesonly: + + create + delete + describe + list + rename + users + diff --git a/docs/command/atlas-users-describe.txt b/docs/command/atlas-users-describe.txt new file mode 100644 index 0000000000..4ec47d18a5 --- /dev/null +++ b/docs/command/atlas-users-describe.txt @@ -0,0 +1,104 @@ +.. _atlas-users-describe: + +==================== +atlas users describe +==================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the details for the specified Atlas user. + +You can specify either the unique 24-digit ID that identifies the Atlas user or the username for the Atlas user. + +User accounts and API keys with any role can run this command. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas users describe [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - --id + - string + - false + - Unique 24-digit identifier of the user. + + Mutually exclusive with --username. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --username + - string + - false + - Name that identifies the user. You must specify a valid email address. + + Mutually exclusive with --id. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID FIRST NAME LAST NAME USERNAME EMAIL + + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Return the JSON-formatted details for the Atlas user with the ID 5dd56c847a3e5a1f363d424d: + atlas users describe --id 5dd56c847a3e5a1f363d424d --output json + + +.. code-block:: + :copyable: false + + # Return the JSON-formatted details for the Atlas user with the username myUser: + atlas users describe --username myUser --output json diff --git a/docs/command/atlas-users-invite.txt b/docs/command/atlas-users-invite.txt new file mode 100644 index 0000000000..7b5ebd3250 --- /dev/null +++ b/docs/command/atlas-users-invite.txt @@ -0,0 +1,126 @@ +.. _atlas-users-invite: + +================== +atlas users invite +================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create an Atlas user for your MongoDB Atlas application and invite the Atlas user to your organizations and projects. + +An Atlas user account grants access only to the the MongoDB Atlas application. To grant database access, create a database user with atlas dbusers create. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas users invite [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --country + - string + - true + - ISO 3166-1 alpha two-letter country code of the user's geographic location. The Atlas CLI requires this option. + * - --email + - string + - true + - Email address for the user. + * - --firstName + - string + - true + - First or given name for the user. + * - -h, --help + - + - false + - help for invite + * - --lastName + - string + - true + - Last name, family name, or surname for the user. + * - --mobile + - string + - false + - Mobile phone number for the user. + * - --orgRole + - strings + - false + - Unique 24-digit string that identifies the organization, colon, and the user's role for the organization. Specify this value as orgID:ROLE. Valid values for ROLE include ORG_OWNER, ORG_MEMBER, ORG_GROUP_CREATOR, ORG_BILLING_ADMIN, and ORG_READ_ONLY. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --password + - string + - false + - Password for the user. + * - --projectRole + - strings + - false + - Unique 24-digit string that identifies the project, colon, and the user's role for the project. Specify this value as projectID:ROLE. Valid values for ROLE include GROUP_CLUSTER_MANAGER, GROUP_DATA_ACCESS_ADMIN, GROUP_DATA_ACCESS_READ_ONLY, GROUP_DATA_ACCESS_READ_WRITE, GROUP_OWNER, and GROUP_READ_ONLY. + * - --username + - string + - true + - Name that identifies the user. You must specify a valid email address. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + The user '' has been invited. + Invited users do not have access to the project until they accept the invitation. + + +Examples +-------- + +.. code-block:: + :copyable: false + + # Create the Atlas user with the username user@example.com and invite them to the organization with the ID 5dd56c847a3e5a1f363d424d with ORG_OWNER access: + atlas users invite --email user@example.com --username user@example.com --orgRole 5dd56c847a3e5a1f363d424d:ORG_OWNER --firstName Example --lastName User --country US --output json + + +.. code-block:: + :copyable: false + + # Create the Atlas user with the username user@example.com and invite them to the project with the ID 5f71e5255afec75a3d0f96dc with GROUP_READ_ONLY access: + atlas users invite --email user@example.com --username user@example.com --projectRole 5f71e5255afec75a3d0f96dc:GROUP_READ_ONLY --firstName Example --lastName User --country US --output json diff --git a/docs/command/atlas-users.txt b/docs/command/atlas-users.txt new file mode 100644 index 0000000000..7507d266ab --- /dev/null +++ b/docs/command/atlas-users.txt @@ -0,0 +1,63 @@ +.. _atlas-users: + +=========== +atlas users +=========== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage your Atlas users. + +Create and manage your Atlas users. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for users + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-users-describe` - Return the details for the specified Atlas user. +* :ref:`atlas-users-invite` - Create an Atlas user for your MongoDB Atlas application and invite the Atlas user to your organizations and projects. + + +.. toctree:: + :titlesonly: + + describe + invite + diff --git a/docs/command/atlas.txt b/docs/command/atlas.txt new file mode 100644 index 0000000000..5264149bd6 --- /dev/null +++ b/docs/command/atlas.txt @@ -0,0 +1,130 @@ +.. _atlas: + +===== +atlas +===== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +CLI tool to manage MongoDB Atlas. + +The Atlas CLI is a command line interface built specifically for MongoDB Atlas. You can manage your Atlas database deployments and Atlas Search from the terminal with short, intuitive commands. + +Use the --help flag with any command for more info on that command. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for atlas + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + :copyable: false + + # Display the help menu for the config command: + atlas config --help + +Related Commands +---------------- + +* :ref:`atlas-accessLists` - Manage the list of IP addresses that can access your Atlas project. +* :ref:`atlas-accessLogs` - Return the access logs for a cluster. +* :ref:`atlas-alerts` - Manage alerts for your project. +* :ref:`atlas-auditing` - Returns database auditing settings for MongoDB Cloud projects. +* :ref:`atlas-auth` - Manage the CLI's authentication state. +* :ref:`atlas-backups` - Manage cloud backups for your project. +* :ref:`atlas-cloudProviders` - Manage cloud provider access in Atlas using AWS IAM roles. +* :ref:`atlas-clusters` - Manage clusters for your project. +* :ref:`atlas-completion` - Generate the autocompletion script for the specified shell +* :ref:`atlas-config` - Configure and manage your user profiles. +* :ref:`atlas-customDbRoles` - Manage custom database roles for your project. +* :ref:`atlas-customDns` - Manage DNS configuration of Atlas project’s clusters deployed to AWS. +* :ref:`atlas-dataFederation` - Data federation. +* :ref:`atlas-dbusers` - Manage database users for your project. +* :ref:`atlas-deployments` - Manage cloud and local deployments. +* :ref:`atlas-events` - Manage events for your organization or project. +* :ref:`atlas-federatedAuthentication` - Manage Atlas Federated Authentication. +* :ref:`atlas-integrations` - Configure third-party integrations for your Atlas project. +* :ref:`atlas-kubernetes` - Manage Kubernetes resources. +* :ref:`atlas-liveMigrations` - Manage a Live Migration to Atlas for your organization. +* :ref:`atlas-logs` - Download host logs for your project. +* :ref:`atlas-maintenanceWindows` - Manage Atlas maintenance windows. +* :ref:`atlas-metrics` - Get metrics on the MongoDB process. +* :ref:`atlas-networking` - Manage or configure network peering for your Atlas project. +* :ref:`atlas-organizations` - Manage your Atlas organizations. +* :ref:`atlas-performanceAdvisor` - Learn more about slow queries and get suggestions to improve database performance. +* :ref:`atlas-plugin` - Manage plugins for the AtlasCLI. +* :ref:`atlas-privateEndpoints` - Manage Atlas private endpoints. +* :ref:`atlas-processes` - Manage MongoDB processes for your project. +* :ref:`atlas-projects` - Manage your Atlas projects. +* :ref:`atlas-security` - Manage security configuration for your project. +* :ref:`atlas-serverless` - Manage serverless instances for your project. +* :ref:`atlas-setup` - Register, authenticate, create, and access an Atlas cluster. +* :ref:`atlas-streams` - Manage your Atlas Stream Processing deployments. +* :ref:`atlas-teams` - Manage your Atlas teams. +* :ref:`atlas-users` - Manage your Atlas users. + + +.. toctree:: + :titlesonly: + + accessLists + accessLogs + alerts + auditing + auth + backups + cloudProviders + clusters + completion + config + customDbRoles + customDns + dataFederation + dbusers + deployments + events + federatedAuthentication + integrations + kubernetes + liveMigrations + logs + maintenanceWindows + metrics + networking + organizations + performanceAdvisor + plugin + privateEndpoints + processes + projects + security + serverless + setup + streams + teams + users + diff --git a/internal/cli/backup/snapshots/download.go b/internal/cli/backup/snapshots/download.go index 32e4b5db72..0ad2983b4e 100644 --- a/internal/cli/backup/snapshots/download.go +++ b/internal/cli/backup/snapshots/download.go @@ -30,7 +30,7 @@ import ( "github.com/mongodb/mongodb-atlas-cli/atlascli/internal/usage" "github.com/spf13/afero" "github.com/spf13/cobra" - atlasv2 "go.mongodb.org/atlas-sdk/v20241113002/admin" + atlasv2 "go.mongodb.org/atlas-sdk/v20241113004/admin" ) type DownloadOpts struct { @@ -127,8 +127,8 @@ func DownloadBuilder() *cobra.Command { ` + fmt.Sprintf("%s\n%s", fmt.Sprintf(usage.RequiredRole, "Project Owner"), "Atlas supports this command only for Flex clusters."), Args: require.ExactArgs(1), Annotations: map[string]string{ - "snapshotId": "Unique 24-hexadecimal digit string that identifies the snapshot to download.", - "output": downloadTemplate, + "snapshotIdDesc": "Unique 24-hexadecimal digit string that identifies the snapshot to download.", + "output": downloadTemplate, }, PreRunE: func(cmd *cobra.Command, _ []string) error { return opts.PreRunE( diff --git a/internal/cli/backup/snapshots/download_test.go b/internal/cli/backup/snapshots/download_test.go index b412a4de27..bc681b5b6d 100644 --- a/internal/cli/backup/snapshots/download_test.go +++ b/internal/cli/backup/snapshots/download_test.go @@ -22,7 +22,7 @@ import ( "github.com/mongodb/mongodb-atlas-cli/atlascli/internal/pointer" "github.com/spf13/afero" "github.com/stretchr/testify/require" - atlasv2 "go.mongodb.org/atlas-sdk/v20241113002/admin" + atlasv2 "go.mongodb.org/atlas-sdk/v20241113004/admin" ) func TestSnapshotDownloadOpts_Run(t *testing.T) { From 187f2b2e8878ace778321988b899ba425185a337 Mon Sep 17 00:00:00 2001 From: andreaangiolillo Date: Thu, 19 Dec 2024 11:34:27 +0000 Subject: [PATCH 3/3] Update download.go --- docs/command/atlas-backups-snapshots-download.txt | 4 ---- internal/cli/backup/snapshots/download.go | 3 +-- 2 files changed, 1 insertion(+), 6 deletions(-) diff --git a/docs/command/atlas-backups-snapshots-download.txt b/docs/command/atlas-backups-snapshots-download.txt index 18331b7e97..360fc219b3 100644 --- a/docs/command/atlas-backups-snapshots-download.txt +++ b/docs/command/atlas-backups-snapshots-download.txt @@ -67,10 +67,6 @@ Options - string - false - Output file name. This value defaults to the Snapshot id. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. * - --projectId - string - false diff --git a/internal/cli/backup/snapshots/download.go b/internal/cli/backup/snapshots/download.go index 0ad2983b4e..4c6957ed9b 100644 --- a/internal/cli/backup/snapshots/download.go +++ b/internal/cli/backup/snapshots/download.go @@ -108,7 +108,7 @@ func (opts *DownloadOpts) Download(url *string) error { func (opts *DownloadOpts) initDefaultOut() error { if opts.Out == "" { opts.Out = opts.id + ".tgz" - } else if strings.Contains(opts.Out, ".tgz") { + } else if !strings.Contains(opts.Out, ".tgz") { return errExtNotSupported } @@ -149,7 +149,6 @@ func DownloadBuilder() *cobra.Command { cmd.Flags().StringVar(&opts.Out, flag.Out, "", usage.SnapshotOut) opts.AddProjectOptsFlags(cmd) - opts.AddOutputOptFlags(cmd) _ = cmd.MarkFlagRequired(flag.ClusterName)