From 79deafc6c53d7f60528337db7906e5b131354793 Mon Sep 17 00:00:00 2001 From: Filipe C Menezes Date: Fri, 1 Mar 2024 10:03:09 +0000 Subject: [PATCH 01/16] CLOUDP-234527 Remove mongocli --- cmd/mongocli/mongocli.go | 122 --------------------------------------- 1 file changed, 122 deletions(-) delete mode 100644 cmd/mongocli/mongocli.go diff --git a/cmd/mongocli/mongocli.go b/cmd/mongocli/mongocli.go deleted file mode 100644 index a1893f13d3..0000000000 --- a/cmd/mongocli/mongocli.go +++ /dev/null @@ -1,122 +0,0 @@ -// Copyright 2020 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 main - -import ( - "context" - "fmt" - "io" - "log" - "os" - "path" - "strings" - - survey "github.com/AlecAivazis/survey/v2/core" - "github.com/mongodb/mongodb-atlas-cli/internal/cli" - "github.com/mongodb/mongodb-atlas-cli/internal/cli/root/mongocli" - "github.com/mongodb/mongodb-atlas-cli/internal/config" - "github.com/spf13/cobra" -) - -var ( - profile string -) - -// Execute adds all child commands to the root command and sets flags appropriately. -// This is called by main.main(). It only needs to happen once to the rootCmd. -func Execute(ctx context.Context) { - rootCmd := mongocli.Builder(&profile, os.Args[1:]) - // append here to avoid a recursive link on generated docs - rootCmd.Long += ` - -To learn more, see our documentation: https://www.mongodb.com/docs/mongocli/stable/` - if err := rootCmd.ExecuteContext(ctx); err != nil { - os.Exit(1) - } -} - -func updateMongoCLIConfigPath() { - mongoCLIConfigHome, err := config.MongoCLIConfigHome() - if err != nil { - return - } - - mongoCLIConfigPath := path.Join(mongoCLIConfigHome, "config.toml") - f, err := os.Open(mongoCLIConfigPath) // if config.toml is already there, exit - if err == nil { - f.Close() - return - } - - oldMongoCLIConfigHome, err := config.OldMongoCLIConfigHome() //nolint:staticcheck // Deprecated before fully removing support in the future - if err != nil { - return - } - - oldMongoCLIConfigPath := path.Join(oldMongoCLIConfigHome, "mongocli.toml") - in, err := os.Open(oldMongoCLIConfigPath) - if err != nil { - return - } - defer in.Close() - - _, _ = fmt.Fprintf(os.Stderr, `MongoCLI uses a new config path. Copying mongocli.toml content to: %s -`, mongoCLIConfigPath) - - // check if new config home already exists and create if not - if _, err = os.Stat(mongoCLIConfigHome); err != nil { - defaultPermissions := 0700 - if err = os.Mkdir(mongoCLIConfigHome, os.FileMode(defaultPermissions)); err != nil { - log.Printf("There was an error generating %s: %v", mongoCLIConfigHome, err) - return - } - } - - out, err := os.Create(mongoCLIConfigPath) - if err != nil { - return - } - defer out.Close() - - if _, err = io.Copy(out, in); err != nil { - _, _ = fmt.Fprintf(os.Stderr, "There was an error generating %s: %v", mongoCLIConfigPath, err) - return - } - defer os.Remove(oldMongoCLIConfigPath) - - _, _ = fmt.Fprintf(os.Stderr, `MongoCLI configuration moved to: %s -`, mongoCLIConfigPath) -} - -// initConfig reads in config file and ENV variables if set. -func initConfig() { - if err := config.LoadMongoCLIConfig(); err != nil { - log.Fatalf("Error loading config: %v", err) - } - - if err := cli.InitProfile(profile); err != nil { - log.Fatalf("Error loading profile: %v", err) - } -} - -func main() { - cobra.EnableCommandSorting = false - if term := os.Getenv("TERM"); strings.HasSuffix(term, "-m") { - survey.DisableColor = true - } - cobra.OnInitialize(updateMongoCLIConfigPath, initConfig) - - Execute(context.Background()) -} From 157b5e9c3917abaf0a36d4caea82fd543c1f21a2 Mon Sep 17 00:00:00 2001 From: Filipe C Menezes Date: Fri, 1 Mar 2024 13:11:01 +0000 Subject: [PATCH 02/16] delete more files --- CHANGELOG_MONGOCLI.md | 3 - Makefile | 52 +-- README.md | 70 ++- atlascli.md | 64 --- build/ci/evergreen.yml | 174 -------- build/ci/release.yml | 123 ------ mongocli.md | 93 ---- test/e2e/brew/brew_test.go | 46 -- test/e2e/cloud_manager/agent_api_keys_test.go | 59 --- test/e2e/cloud_manager/agents_test.go | 120 ------ test/e2e/cloud_manager/alerts_test.go | 180 -------- test/e2e/cloud_manager/dbusers_test.go | 184 -------- .../cloud_manager/decryption/aws/test-input | 4 - .../cloud_manager/decryption/aws/test-output | 4 - .../cloud_manager/decryption/kmip/test1-input | 3 - .../decryption/kmip/test1-output | 2 - .../cloud_manager/decryption/kmip/test2-input | 3 - .../decryption/kmip/test2-output | 2 - .../decryption/localKey/test1-input | 3 - .../decryption/localKey/test1-output | 2 - .../decryption/localKey/test2-input | 3 - .../decryption/localKey/test2-output | 2 - .../decryption/localKey/test3-input | Bin 1214 -> 0 bytes .../decryption/localKey/test3-output | 3 - .../decryption/localKey/test4-input | Bin 1422 -> 0 bytes .../decryption/localKey/test4-output | 3 - .../decryption/localKey/test5-input | 2 - .../decryption/localKey/test5-output | 2 - test/e2e/cloud_manager/decryption_aws_test.go | 61 --- .../e2e/cloud_manager/decryption_kmip_test.go | 99 ----- .../cloud_manager/decryption_localkey_test.go | 81 ---- .../cloud_manager/deploy_replica_set_test.go | 258 ----------- .../deploy_sharded_cluster_test.go | 192 --------- test/e2e/cloud_manager/events_test.go | 79 ---- .../cloud_manager/feature_policies_test.go | 100 ----- test/e2e/cloud_manager/helper_test.go | 408 ------------------ test/e2e/cloud_manager/key_providers_test.go | 71 --- test/e2e/cloud_manager/maintenance_test.go | 159 ------- test/e2e/cloud_manager/servers_test.go | 58 --- test/e2e/ops_manager/version_manifest_test.go | 57 --- 40 files changed, 61 insertions(+), 2768 deletions(-) delete mode 100644 CHANGELOG_MONGOCLI.md delete mode 100644 atlascli.md delete mode 100644 mongocli.md delete mode 100644 test/e2e/cloud_manager/agent_api_keys_test.go delete mode 100644 test/e2e/cloud_manager/agents_test.go delete mode 100644 test/e2e/cloud_manager/alerts_test.go delete mode 100644 test/e2e/cloud_manager/dbusers_test.go delete mode 100644 test/e2e/cloud_manager/decryption/aws/test-input delete mode 100644 test/e2e/cloud_manager/decryption/aws/test-output delete mode 100644 test/e2e/cloud_manager/decryption/kmip/test1-input delete mode 100644 test/e2e/cloud_manager/decryption/kmip/test1-output delete mode 100644 test/e2e/cloud_manager/decryption/kmip/test2-input delete mode 100644 test/e2e/cloud_manager/decryption/kmip/test2-output delete mode 100644 test/e2e/cloud_manager/decryption/localKey/test1-input delete mode 100755 test/e2e/cloud_manager/decryption/localKey/test1-output delete mode 100644 test/e2e/cloud_manager/decryption/localKey/test2-input delete mode 100755 test/e2e/cloud_manager/decryption/localKey/test2-output delete mode 100644 test/e2e/cloud_manager/decryption/localKey/test3-input delete mode 100755 test/e2e/cloud_manager/decryption/localKey/test3-output delete mode 100644 test/e2e/cloud_manager/decryption/localKey/test4-input delete mode 100755 test/e2e/cloud_manager/decryption/localKey/test4-output delete mode 100644 test/e2e/cloud_manager/decryption/localKey/test5-input delete mode 100644 test/e2e/cloud_manager/decryption/localKey/test5-output delete mode 100644 test/e2e/cloud_manager/decryption_aws_test.go delete mode 100644 test/e2e/cloud_manager/decryption_kmip_test.go delete mode 100644 test/e2e/cloud_manager/decryption_localkey_test.go delete mode 100644 test/e2e/cloud_manager/deploy_replica_set_test.go delete mode 100644 test/e2e/cloud_manager/deploy_sharded_cluster_test.go delete mode 100644 test/e2e/cloud_manager/events_test.go delete mode 100644 test/e2e/cloud_manager/feature_policies_test.go delete mode 100644 test/e2e/cloud_manager/helper_test.go delete mode 100644 test/e2e/cloud_manager/key_providers_test.go delete mode 100644 test/e2e/cloud_manager/maintenance_test.go delete mode 100644 test/e2e/cloud_manager/servers_test.go delete mode 100644 test/e2e/ops_manager/version_manifest_test.go diff --git a/CHANGELOG_MONGOCLI.md b/CHANGELOG_MONGOCLI.md deleted file mode 100644 index d2cd3e0bd8..0000000000 --- a/CHANGELOG_MONGOCLI.md +++ /dev/null @@ -1,3 +0,0 @@ -# Changelog - -For a complete list of changes see: https://docs.mongodb.com/mongocli/stable/release-notes/ diff --git a/Makefile b/Makefile index 8bb593193e..f959a10ca0 100644 --- a/Makefile +++ b/Makefile @@ -3,14 +3,6 @@ GOLANGCI_VERSION=v1.56.1 COVERAGE=coverage.out -MCLI_SOURCE_FILES?=./cmd/mongocli -MCLI_BINARY_NAME=mongocli -MCLI_VERSION?=$(shell git describe --match "mongocli/v*" | cut -d "v" -f 2) -MCLI_GIT_SHA?=$(shell git rev-parse HEAD) -MCLI_DESTINATION=./bin/$(MCLI_BINARY_NAME) -MCLI_INSTALL_PATH="${GOPATH}/bin/$(MCLI_BINARY_NAME)" -MCLI_E2E_BINARY?=../../../bin/${MCLI_BINARY_NAME} - ATLAS_SOURCE_FILES?=./cmd/atlas ATLAS_BINARY_NAME=atlas ATLAS_VERSION?=$(shell git describe --match "atlascli/v*" | cut -d "v" -f 2) @@ -18,7 +10,6 @@ ATLAS_DESTINATION=./bin/$(ATLAS_BINARY_NAME) ATLAS_INSTALL_PATH="${GOPATH}/bin/$(ATLAS_BINARY_NAME)" LINKER_FLAGS=-s -w -X github.com/mongodb/mongodb-atlas-cli/internal/version.GitCommit=${MCLI_GIT_SHA} -MCLI_LINKER_FLAGS=${LINKER_FLAGS} -X github.com/mongodb/mongodb-atlas-cli/internal/config.ToolName=$(MCLI_BINARY_NAME) -X github.com/mongodb/mongodb-atlas-cli/internal/version.Version=${MCLI_VERSION} ATLAS_LINKER_FLAGS=${LINKER_FLAGS} -X github.com/mongodb/mongodb-atlas-cli/internal/config.ToolName=atlascli -X github.com/mongodb/mongodb-atlas-cli/internal/version.Version=${ATLAS_VERSION} ATLAS_E2E_BINARY?=../../../bin/${ATLAS_BINARY_NAME} @@ -36,7 +27,6 @@ export PATH := $(shell go env GOPATH)/bin:$(PATH) export PATH := ./bin:$(PATH) export TERM := linux-m export GO111MODULE := on -export MCLI_E2E_BINARY export ATLAS_E2E_BINARY .PHONY: pre-commit @@ -115,44 +105,14 @@ gen-mocks: ## Generate mocks go generate ./internal... .PHONY: gen-docs -gen-docs: gen-docs-mongocli gen-docs-atlascli ## Generate docs for commands - -.PHONY: gen-docs-mongocli -gen-docs-mongocli: ## Generate docs for mongocli commands - @echo "==> Generating docs for mongocli" - go run -ldflags "$(MCLI_LINKER_FLAGS)" ./tools/mongoclidocs/main.go - -.PHONY: gen-docs-atlascli -gen-docs-atlascli: ## Generate docs for atlascli commands - @echo "==> Generating docs for atlascli" + @echo "==> Generating docs" go run -ldflags "$(ATLAS_LINKER_FLAGS)" ./tools/atlasclidocs/main.go .PHONY: build -build: build-mongocli ## Generate a binary for mongocli - -.PHONY: build-all -build-all: build-mongocli build-atlascli ## Generate a binary for both CLIs - -.PHONY: build-mongocli -build-mongocli: ## Generate a mongocli binary in ./bin - @echo "==> Building $(MCLI_BINARY_NAME) binary" - go build -ldflags "$(MCLI_LINKER_FLAGS)" -o $(MCLI_DESTINATION) $(MCLI_SOURCE_FILES) - -.PHONY: build-atlascli -build-atlascli: ## Generate a atlascli binary in ./bin @echo "==> Building $(ATLAS_BINARY_NAME) binary" go build -ldflags "$(ATLAS_LINKER_FLAGS)" -o $(ATLAS_DESTINATION) $(ATLAS_SOURCE_FILES) .PHONY: build-debug -build-debug: build-mongocli-debug build-atlascli-debug ## Generate binaries in ./bin for debugging both CLIs - -.PHONY: build-mongocli-debug -build-mongocli-debug: ## Generate a binary in ./bin for debugging mongocli - @echo "==> Building $(MCLI_BINARY_NAME) binary for debugging" - go build -gcflags="$(DEBUG_FLAGS)" -ldflags "$(MCLI_LINKER_FLAGS)" -o $(MCLI_DESTINATION) $(MCLI_SOURCE_FILES) - -.PHONY: build-atlascli-debug -build-atlascli-debug: ## Generate a binary in ./bin for debugging atlascli @echo "==> Building $(ATLAS_BINARY_NAME) binary for debugging" go build -gcflags="$(DEBUG_FLAGS)" -ldflags "$(ATLAS_LINKER_FLAGS)" -o $(ATLAS_DESTINATION) $(ATLAS_SOURCE_FILES) @@ -178,16 +138,6 @@ unit-test: ## Run unit-tests $(TEST_CMD) --tags="$(UNIT_TAGS)" -race -cover -count=1 -coverprofile $(COVERAGE) ./... .PHONY: install -install: install-mongocli install-atlascli ## Install binaries in $GOPATH/bin for both CLIs - -.PHONY: install-mongocli -install-mongocli: ## Install mongocli binary in $GOPATH/bin - @echo "==> Installing $(MCLI_BINARY_NAME) to $(MCLI_INSTALL_PATH)" - go install -ldflags "$(MCLI_LINKER_FLAGS)" $(MCLI_SOURCE_FILES) - @echo "==> Done..." - -.PHONY: install-atlascli -install-atlascli: ## Install atlascli binary in $GOPATH/bin @echo "==> Installing $(ATLAS_BINARY_NAME) to $(ATLAS_INSTALL_PATH)" go install -ldflags "$(ATLAS_LINKER_FLAGS)" $(ATLAS_SOURCE_FILES) @echo "==> Done..." diff --git a/README.md b/README.md index d75c50bf9d..c2fb46e836 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,67 @@ -## MongoDB Atlas CLI +# Atlas CLI -![GO tests](https://github.com/mongodb/mongodb-atlas-cli/workflows/GO%20tests/badge.svg) -![golangci-lint](https://github.com/mongodb/mongodb-atlas-cli/workflows/golangci-lint/badge.svg) +The MongoDB Atlas CLI is a modern command line interface that enables you to manage MongoDB Atlas from the terminal. -The MongoDB Atlas CLI repository contains the following modern command line interfaces: +![atlascli-atlas-quickstart](https://user-images.githubusercontent.com/5663078/156184669-57c8ddce-6f0a-4e84-9311-2d996cb27942.gif) -- ![icon](https://user-images.githubusercontent.com/5663078/161288347-3d550b8c-bf06-47eb-88cb-25266383147f.png#gh-light-mode-only) ![icon](https://user-images.githubusercontent.com/5663078/161288344-33fa8e03-92ee-46ff-b490-38bf4dd8f379.png#gh-dark-mode-only) - [Atlas CLI](atlascli.md) +## Installing -- ![icon](https://user-images.githubusercontent.com/5663078/161288349-dfef2cd1-0e43-4c44-b5b9-45b7d62c85f6.png#gh-light-mode-only) ![icon](https://user-images.githubusercontent.com/5663078/161288351-0afd25c9-8a06-4a4b-b732-ecf315257aae.png#gh-dark-mode-only) - [MongoDB CLI](mongocli.md) +### Pre-built Binaries -Use simple, one-line commands to interact with MongoDB Atlas, Cloud Manager, or Ops Manager, and to automate management tasks for your deployments. +Download the appropriate version for your platform from [Atlas CLI releases](https://github.com/mongodb/mongodb-atlas-cli/releases). +After you download the library, you can run it from anywhere and don't need to install it into a global location. +This works well for shared hosts and other systems where you don't have a privileged account. + +You can place this binary somewhere in your `PATH` for ease of use. +`/usr/local/bin` is the most probable location. + +### Build From Source + +#### Fetch Source + +```bash +git clone https://github.com/mongodb/mongodb-atlas-cli.git +cd mongodb-atlas-cli +``` + +#### Build + +To build `atlascli`, run: + +```bash +make build-atlascli +``` + +The resulting `atlas` binary is placed in `./bin`. + +#### Install + +To install the `atlas` binary in `$GOPATH/bin`, run: + +```bash +make install-atlascli +``` + +**Note:** running `make build-atlascli` is not needed when running `make install-atlascli`. + + +## Usage + +To get a list of available commands, run `atlas help` +or check our documentation for more details. + +### Configuring Atlas CLI +To use `atlascli`, open your terminal, run `atlas auth login`, and follow the prompted steps. + +### Shell Completions + +If you install via [homebrew](#hombrew-on-macos) no additional actions are needed. + +To get specific instructions for your preferred shell, run: + +```bash +atlas completion --help +``` ## Contributing @@ -19,4 +69,4 @@ See our [CONTRIBUTING.md](CONTRIBUTING.md) guide. ## License -MongoDB CLI and Atlas CLI are released under the Apache 2.0 license. See [LICENSE](LICENSE) +MongoDB Atlas CLI is released under the Apache 2.0 license. See [LICENSE](LICENSE) diff --git a/atlascli.md b/atlascli.md deleted file mode 100644 index 7ba0022653..0000000000 --- a/atlascli.md +++ /dev/null @@ -1,64 +0,0 @@ -# Atlas CLI - -The MongoDB Atlas CLI is a modern command line interface that enables you to manage MongoDB Atlas from the terminal. - -![atlascli-atlas-quickstart](https://user-images.githubusercontent.com/5663078/156184669-57c8ddce-6f0a-4e84-9311-2d996cb27942.gif) - -## Installing - -### Pre-built Binaries - -Download the appropriate version for your platform from [Atlas CLI releases](https://github.com/mongodb/mongodb-atlas-cli/releases). -After you download the library, you can run it from anywhere and don't need to install it into a global location. -This works well for shared hosts and other systems where you don't have a privileged account. - -You can place this binary somewhere in your `PATH` for ease of use. -`/usr/local/bin` is the most probable location. - -### Build From Source - -#### Fetch Source - -```bash -git clone https://github.com/mongodb/mongodb-atlas-cli.git -cd mongodb-atlas-cli -``` - -#### Build - -To build `atlascli`, run: - -```bash -make build-atlascli -``` - -The resulting `atlas` binary is placed in `./bin`. - -#### Install - -To install the `atlas` binary in `$GOPATH/bin`, run: - -```bash -make install-atlascli -``` - -**Note:** running `make build-atlascli` is not needed when running `make install-atlascli`. - - -## Usage - -To get a list of available commands, run `atlas help` -or check our documentation for more details. - -### Configuring Atlas CLI -To use `atlascli`, open your terminal, run `atlas auth login`, and follow the prompted steps. - -### Shell Completions - -If you install via [homebrew](#hombrew-on-macos) no additional actions are needed. - -To get specific instructions for your preferred shell, run: - -```bash -atlas completion --help -``` \ No newline at end of file diff --git a/build/ci/evergreen.yml b/build/ci/evergreen.yml index 28f980fe0b..8304d3b73d 100644 --- a/build/ci/evergreen.yml +++ b/build/ci/evergreen.yml @@ -53,18 +53,6 @@ functions: params: <<: *go_options command: make build-all - "build mongocli": - - command: subprocess.exec - type: test - params: - <<: *go_options - command: make build-mongocli - "build atlascli": - - command: subprocess.exec - type: test - params: - <<: *go_options - command: make build-atlascli "e2e test": - command: subprocess.exec type: test @@ -274,14 +262,6 @@ tasks: tags: ["code_health"] commands: - func: "build" - - name: compile_mongocli - tags: [ "code_health" ] - commands: - - func: "build mongocli" - - name: compile_atlascli - tags: [ "code_health" ] - commands: - - func: "build atlascli" - name: config_e2e tags: ["e2e","required"] must_have_test_results: true @@ -981,160 +961,6 @@ tasks: MCLI_OPS_MANAGER_URL: ${mcli_ops_manager_url} MCLI_SERVICE: cloud E2E_TAGS: atlas,streams - # Cloud Manager and Ops Manager (indirectly) tests - - name: cloud_manager_iam_e2e - tags: ["e2e","generic","cloudmanager"] - must_have_test_results: true - depends_on: - - name: compile - variant: "code_health" - patch_optional: true - commands: - - func: "install gotestsum" - - func: "e2e test" - vars: - MCLI_ORG_ID: ${cloud_manager_org_id} - MCLI_PROJECT_ID: ${cloud_manager_project_id} - MCLI_PRIVATE_API_KEY: ${cloud_manager_private_api_key} - MCLI_PUBLIC_API_KEY: ${cloud_manager_public_api_key} - MCLI_OPS_MANAGER_URL: ${mcli_ops_manager_url} - MCLI_SERVICE: cloud-manager - E2E_TAGS: iam - - name: cloud_manager_generic_e2e - tags: ["e2e","generic","cloudmanager"] - must_have_test_results: true - depends_on: - - name: compile - variant: "code_health" - patch_optional: true - commands: - - func: "install gotestsum" - - func: "e2e test" - vars: - MCLI_ORG_ID: ${cloud_manager_org_id} - MCLI_PROJECT_ID: ${cloud_manager_project_id} - MCLI_PRIVATE_API_KEY: ${cloud_manager_private_api_key} - MCLI_PUBLIC_API_KEY: ${cloud_manager_public_api_key} - MCLI_OPS_MANAGER_URL: ${mcli_ops_manager_url} - MCLI_SERVICE: cloud-manager - E2E_TAGS: cloudmanager,generic - # Deploy a replica set, we need to be careful on running parallel modifications to the automation config - - name: cloud_manager_deploy_replica_set_e2e - tags: ["e2e","clusters","cloudmanager"] - must_have_test_results: true - depends_on: - - name: compile - variant: "code_health" - patch_optional: true - commands: - - func: "install gotestsum" - - func: "build mongocli" - - func: "deploy spawn host" - - func: ssh-ready - - func: "set-up cloud manager" - - func: "install automation agent" - - func: "e2e test" - vars: - E2E_TAGS: cloudmanager,remote,replica - # Deploy a sharded cluster, we need to be careful on running parallel modifications to the automation config - - name: cloud_manager_deploy_sharded_cluster_e2e - tags: ["e2e","clusters","cloudmanager"] - must_have_test_results: true - depends_on: - - name: compile - variant: "code_health" - patch_optional: true - commands: - - func: "install gotestsum" - - func: "build mongocli" - - func: "deploy spawn host" - - func: ssh-ready - - func: "set-up cloud manager" - - func: "install automation agent" - - func: "e2e test" - vars: - E2E_TAGS: cloudmanager,remote,sharded - # Deploy ops manager 6.0 and test against it - - name: ops_manager_6_0_generic_e2e - tags: [ "e2e","ops-manager-60" ] - must_have_test_results: true - depends_on: - - name: compile - variant: "code_health" - patch_optional: true - commands: - - func: "install gotestsum" - - func: "build mongocli" - - func: "deploy spawn host" - - func: ssh-ready - - func: "install ops manager" - vars: - ARCHIVE: ${ops_manager_6_0_archive} - - func: "set-up ops manager" - - func: "e2e test" - vars: - E2E_TAGS: om60,generic - OM_VERSION: 6.0 - - name: ops_manager_6_0_iam_e2e - tags: [ "e2e","ops-manager-60" ] - must_have_test_results: true - depends_on: - - name: compile - variant: "code_health" - patch_optional: true - commands: - - func: "install gotestsum" - - func: "build mongocli" - - func: "deploy spawn host" - - func: ssh-ready - - func: "install ops manager" - vars: - ARCHIVE: ${ops_manager_6_0_archive} - - func: "set-up ops manager" - - func: "e2e test" - vars: - E2E_TAGS: iam,om60 - OM_VERSION: 6.0 - - name: ops_manager_6_0_deploy_replica_set_e2e - tags: [ "e2e","ops-manager-60" ] - must_have_test_results: true - depends_on: - - name: compile - variant: "code_health" - patch_optional: true - commands: - - func: "install gotestsum" - - func: "build mongocli" - - func: "deploy spawn host" - - func: ssh-ready - - func: "install ops manager" - vars: - ARCHIVE: ${ops_manager_6_0_archive} - - func: "set-up ops manager" - - func: "install automation agent" - - func: "e2e test" - vars: - E2E_TAGS: om60,remote,replica - - name: ops_manager_6_0_deploy_sharded_cluster_e2e - tags: [ "e2e","ops-manager-60" ] - must_have_test_results: true - depends_on: - - name: compile - variant: "code_health" - patch_optional: true - commands: - - func: "install gotestsum" - - func: "build mongocli" - - func: "deploy spawn host" - - func: ssh-ready - - func: "install ops manager" - vars: - ARCHIVE: ${ops_manager_6_0_archive} - - func: "set-up ops manager" - - func: "install automation agent" - - func: "e2e test" - vars: - E2E_TAGS: om60,remote,sharded - name: atlas_decrypt_e2e tags: [ "e2e","decrypt" ] must_have_test_results: true diff --git a/build/ci/release.yml b/build/ci/release.yml index ce4a05ab0c..f39f0ff2d1 100644 --- a/build/ci/release.yml +++ b/build/ci/release.yml @@ -384,14 +384,6 @@ tasks: - func: "send slack notification" vars: TOOL_NAME: atlascli - - name: push_mongocli_generate - patchable: false - stepback: false - commands: - - func: "generate evergreen" - vars: - tool_name: mongocli - task_type: snapshot - name: push_atlascli_generate patchable: false stepback: false @@ -400,14 +392,6 @@ tasks: vars: tool_name: atlascli task_type: snapshot - - name: push_stable_mongocli_generate - git_tag_only: true - stepback: false - commands: - - func: "generate evergreen" - vars: - tool_name: mongocli - task_type: publish - name: push_stable_atlascli_generate git_tag_only: true stepback: false @@ -416,13 +400,6 @@ tasks: vars: tool_name: atlascli task_type: publish - - name: pkg_test_mongocli_generate - tags: [ "smoke-test", "mongocli", "pkg" ] - commands: - - func: "generate evergreen" - vars: - tool_name: mongocli - task_type: postpkg - name: pkg_test_atlascli_generate tags: [ "smoke-test", "atlascli", "pkg" ] commands: @@ -442,18 +419,6 @@ tasks: vars: tool_name: atlascli task_type: repo - - name: pkg_test_repo_mongocli - patchable: false - git_tag_only: true - depends_on: - - name: package_goreleaser - variant: "release_mongocli_github" - tags: [ "smoke-test", "generate", "repo", "mongocli" ] - commands: - - func: "generate evergreen" - vars: - tool_name: mongocli - task_type: repo - name: pkg_test_windows tags: [ "smoke-test", "windows" ] depends_on: @@ -465,16 +430,6 @@ tasks: file: windows_post_package_test tool_name: atlascli buildvariants: - - name: go_mongocli_msi_snapshot - display_name: "Packaging MongoCLI (go-msi)" - run_on: - - windows-vsCurrent-small - expansions: - <<: *go_windows_version - tool_name: "mongocli" - unstable: -unstable - tasks: - - name: package_msi - name: go_atlascli_msi_snapshot display_name: "Packaging AtlasCLI (go-msi)" run_on: @@ -485,25 +440,6 @@ buildvariants: unstable: -unstable tasks: - name: package_msi - - name: goreleaser_mongocli_snapshot - display_name: "Packaging MongoCLI (goreleaser)" - run_on: - - rhel80-small - expansions: - <<: *go_linux_version - server_version: "4.4.0-rc3" - goreleaser_file: "build/package/.mongocli.goreleaser.yml" - changelog_file: CHANGELOG_MONGOCLI.md - package_name: "mongocli" - tool_name: "mongocli" - latest_deb: ~latest - latest_rpm: .latest - unstable: -unstable - tasks: - - name: package_goreleaser - depends_on: - - name: package_msi - variant: "go_mongocli_msi_snapshot" - name: goreleaser_atlascli_snapshot display_name: "Packaging AtlasCLI (goreleaser)" run_on: @@ -524,15 +460,6 @@ buildvariants: depends_on: - name: package_msi variant: "go_atlascli_msi_snapshot" - - name: publish_mongocli_snapshot - display_name: "Publish MongoCLI Snapshot" - run_on: - - rhel80-small - expansions: - <<: *go_linux_version - server_version: "4.4.0-rc3" - tasks: - - name: push_mongocli_generate - name: publish_atlascli_snapshot display_name: "Publish AtlasCLI Snapshot" run_on: @@ -541,33 +468,6 @@ buildvariants: <<: *go_linux_version tasks: - name: push_atlascli_generate - - name: release_mongocli_msi - display_name: "Release MongoCLI (go-msi)" - run_on: - - windows-vsCurrent-small - git_tag_only: true - expansions: - <<: *go_windows_version - tool_name: "mongocli" - tasks: - - name: package_msi - - name: release_mongocli_github - display_name: "Release MongoCLI (goreleaser)" - run_on: - - rhel80-small - git_tag_only: true - expansions: - <<: *go_linux_version - server_version: "4.4.0-rc3" - goreleaser_file: "build/package/.mongocli.goreleaser.yml" - changelog_file: CHANGELOG_MONGOCLI.md - package_name: "mongocli" - tool_name: "mongocli" - tasks: - - name: package_goreleaser - depends_on: - - name: package_msi - variant: release_mongocli_msi - name: release_atlascli_github display_name: "Release AtlasCLI (goreleaser)" git_tag_only: true @@ -596,14 +496,6 @@ buildvariants: tool_name: "atlascli" tasks: - name: package_msi - - name: release_mongocli_publish - display_name: "Publish MongoCLI Generator" - run_on: - - rhel80-small - expansions: - <<: *go_linux_version - tasks: - - name: push_stable_mongocli_generate - name: release_atlascli_publish display_name: "Publish AtlasCLI Generator" run_on: @@ -612,13 +504,6 @@ buildvariants: <<: *go_linux_version tasks: - name: push_stable_atlascli_generate - - name: pkg_smoke_tests_docker_mongocli - display_name: "Post packaging smoke tests (Docker / MongoCLI)" - run_on: ubuntu2004-small - expansions: - <<: *go_linux_version - tasks: - - name: .smoke-test .mongocli .pkg - name: pkg_smoke_tests_docker_atlascli display_name: "Post packaging smoke tests (Docker / AtlasCLI)" run_on: ubuntu2004-small @@ -641,11 +526,3 @@ buildvariants: - ubuntu2004-small tasks: - name: .smoke-test .generate .repo .atlascli - - name: release_mongocli_repo_test - display_name: "Test MongoCLI repo" - expansions: - <<: *go_linux_version - run_on: - - ubuntu2004-small - tasks: - - name: .smoke-test .generate .repo .mongocli diff --git a/mongocli.md b/mongocli.md deleted file mode 100644 index 0ac5bf646c..0000000000 --- a/mongocli.md +++ /dev/null @@ -1,93 +0,0 @@ -# MongoDB CLI - -The MongoDB CLI is a modern command line interface that enables you to manage your MongoDB services from the terminal. - -![mongocli-atlas-quickstart](https://user-images.githubusercontent.com/461027/126986233-0dd5c82a-2c75-4887-ab66-eb018c59e093.gif) - -Use simple, one-line commands to interact with MongoDB Atlas, Cloud Manager, or Ops Manager, and automate management tasks for your deployments. - -## Documentation - -See the [official docs](https://docs.mongodb.com/mongocli/stable/) for instructions on how to -install, set up, and reference available commands. - -## Installing - -### Homebrew on macOS - -```bash -brew install mongocli -``` - -### Pre-built Binaries - -Download the appropriate version for your platform from [mongocli releases](https://github.com/mongodb/mongodb-atlas-cli/releases). -After you download the library, you can run it from anywhere and don't need to install it into a global location. -This works well for shared hosts and other systems where you don't have a privileged account. - -You can place this binary somewhere in your `PATH` for ease of use. -`/usr/local/bin` is the most probable location. - -### Build From Source - -#### Fetch Source - -```bash -git clone https://github.com/mongodb/mongodb-atlas-cli.git -cd mongodb-atlas-cli -``` - -#### Build - -To build `mongocli`, run: - -```bash -make build -``` - -The resulting `mongocli` binary is placed in `./bin`. - -#### Install - -To install the `mongocli` binary in `$GOPATH/bin`, run: - -```bash -make install -``` - -**Note:** running `make build` is not needed when running `make install`. - -## Usage - -To get a list of available commands, run `mongocli help` -or check our [documentation](https://docs.mongodb.com/mongocli/master/) for more details. - -### Configuring MongoCLI with Atlas -To use `mongocli` with Atlas, open your terminal, run `mongocli auth login`, and follow the prompted steps. - -### Configuring MongoCLI with Ops Manager and Cloud Manager - -#### Getting API Keys (Ops manager / Cloud Manager) -To use `mongocli`, create API keys. To learn more, see the documentation for the service you're using: -- [Atlas](https://docs.atlas.mongodb.com/configure-api-access/), -- [Ops Manager](https://docs.opsmanager.mongodb.com/current/tutorial/configure-public-api-access/), -- [Cloud Manager](https://docs.cloudmanager.mongodb.com/tutorial/manage-programmatic-api-keys/) - -#### Set up your credentials -To set up your credentials, run `mongocli config`, or use [env variables](https://docs.mongodb.com/mongocli/stable/configure/environment-variables/) instead. - -If you're working with Atlas Gov, Ops Manager or Cloud Manager you need to define the service using `--service` - -- For Atlas Gov, `mongocli config --service cloudgov` -- For Ops Manager, `mongocli config --service ops-manager` -- For Cloud Manager, `mongocli config --service cloud-manager` - -### Shell Completions - -If you install via [homebrew](#hombrew-on-macos) no additional actions are needed. - -To get specific instructions for your preferred shell, run: - -```bash -mongocli completion --help -``` \ No newline at end of file diff --git a/test/e2e/brew/brew_test.go b/test/e2e/brew/brew_test.go index da753b98b2..524df45ac2 100644 --- a/test/e2e/brew/brew_test.go +++ b/test/e2e/brew/brew_test.go @@ -30,52 +30,6 @@ const ( errorMessage = "Error: this action requires authentication" ) -func TestMongoCLIConfig(t *testing.T) { - cliPath, err := e2e.Bin() - if err != nil { - t.Fatalf("unexpected error: %v", err) - } - - tempDirEnv := fmt.Sprintf("XDG_CONFIG_HOME=%s", os.TempDir()) // make sure no config.toml is detected - - t.Run("config ls", func(t *testing.T) { - cmd := exec.Command(cliPath, "config", "ls") - cmd.Env = append(os.Environ(), tempDirEnv) - resp, err := cmd.CombinedOutput() - if err != nil { - t.Fatalf("unexpected error: %v, resp: %v", err, string(resp)) - } - got := strings.TrimSpace(string(resp)) - want := profileString - - if got != want { - t.Errorf("want %q; got %q\n", want, got) - } - }) - - t.Run("iam projects ls", func(t *testing.T) { - cmd := exec.Command(cliPath, "iam", "projects", "ls") - cmd.Env = append(os.Environ(), tempDirEnv) - resp, err := cmd.CombinedOutput() - if err == nil { - t.Fatalf("expected error, resp: %v", string(resp)) - } - got := strings.TrimSpace(string(resp)) - - if !strings.HasPrefix(got, errorMessage) { - t.Errorf("want %q; got %q\n", errorMessage, got) - } - }) - - t.Run("help", func(t *testing.T) { - cmd := exec.Command(cliPath, "help") - cmd.Env = append(os.Environ(), tempDirEnv) - if resp, err := cmd.CombinedOutput(); err != nil { - t.Fatalf("unexpected error, resp: %v", string(resp)) - } - }) -} - func TestAtlasCLIConfig(t *testing.T) { cliPath, err := e2e.AtlasCLIBin() if err != nil { diff --git a/test/e2e/cloud_manager/agent_api_keys_test.go b/test/e2e/cloud_manager/agent_api_keys_test.go deleted file mode 100644 index f906583a05..0000000000 --- a/test/e2e/cloud_manager/agent_api_keys_test.go +++ /dev/null @@ -1,59 +0,0 @@ -// Copyright 2020 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. - -//go:build e2e || (remote && replica && (cloudmanager || om60)) - -package cloud_manager_test - -import ( - "encoding/json" - "os" - "os/exec" - "testing" - - "github.com/mongodb/mongodb-atlas-cli/test/e2e" - "github.com/stretchr/testify/assert" - "github.com/stretchr/testify/require" - "go.mongodb.org/ops-manager/opsmngr" -) - -const ( - apiKeys = "apiKeys" -) - -func TestAgentAPIKeys(t *testing.T) { - cliPath, err := e2e.Bin() - if err != nil { - t.Fatalf("unexpected error: %v", err) - } - - t.Run("List", func(t *testing.T) { - cmd := exec.Command(cliPath, - entity, - agentsEntity, - apiKeys, - "list", - "-o=json", - ) - - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - a := assert.New(t) - - require.NoError(t, err, string(resp)) - var keys []*opsmngr.AgentAPIKey - require.NoError(t, json.Unmarshal(resp, &keys)) - a.NotEmpty(keys) - }) -} diff --git a/test/e2e/cloud_manager/agents_test.go b/test/e2e/cloud_manager/agents_test.go deleted file mode 100644 index fee08fbb1b..0000000000 --- a/test/e2e/cloud_manager/agents_test.go +++ /dev/null @@ -1,120 +0,0 @@ -// Copyright 2020 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. - -//go:build e2e || (remote && replica && (cloudmanager || om60)) - -package cloud_manager_test - -import ( - "encoding/json" - "os" - "os/exec" - "testing" - - "github.com/mongodb/mongodb-atlas-cli/test/e2e" - "github.com/stretchr/testify/assert" - "github.com/stretchr/testify/require" - "go.mongodb.org/ops-manager/opsmngr" -) - -func TestAgents(t *testing.T) { - cliPath, err := e2e.Bin() - require.NoError(t, err) - - var hostname string - t.Run("List", func(t *testing.T) { - cmd := exec.Command(cliPath, - entity, - agentsEntity, - "list", - "AUTOMATION", - "-o=json", - ) - - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - a := assert.New(t) - - require.NoError(t, err, string(resp)) - var servers *opsmngr.Agents - require.NoError(t, json.Unmarshal(resp, &servers)) - a.NotZero(servers.TotalCount) - hostname = servers.Results[0].Hostname - }) - - t.Run("Version List", func(t *testing.T) { - cmd := exec.Command(cliPath, - entity, - agentsEntity, - "version", - "list", - "-o=json", - ) - - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - a := assert.New(t) - - require.NoError(t, err, string(resp)) - var agents *opsmngr.AgentVersions - require.NoError(t, json.Unmarshal(resp, &agents)) - a.NotZero(agents.Count) - }) - - t.Run("Enable backup", func(t *testing.T) { - cmd := exec.Command(cliPath, - entity, - backupEntity, - "enable", - hostname, - ) - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - require.NoError(t, err, string(resp)) - }) - t.Run("Disable backup", func(t *testing.T) { - cmd := exec.Command(cliPath, - entity, - backupEntity, - "disable", - hostname, - ) - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - require.NoError(t, err, string(resp)) - }) - - t.Run("Enable monitoring", func(t *testing.T) { - cmd := exec.Command(cliPath, - entity, - monitoringEntity, - "enable", - hostname, - ) - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - require.NoError(t, err, string(resp)) - }) - t.Run("Disable monitoring", func(t *testing.T) { - cmd := exec.Command(cliPath, - entity, - monitoringEntity, - "disable", - hostname, - ) - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - require.NoError(t, err, string(resp)) - }) -} diff --git a/test/e2e/cloud_manager/alerts_test.go b/test/e2e/cloud_manager/alerts_test.go deleted file mode 100644 index 2b23afc86c..0000000000 --- a/test/e2e/cloud_manager/alerts_test.go +++ /dev/null @@ -1,180 +0,0 @@ -// Copyright 2020 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. - -//go:build e2e || (cloudmanager && generic) - -package cloud_manager_test - -import ( - "encoding/json" - "os" - "os/exec" - "testing" - "time" - - "github.com/mongodb/mongodb-atlas-cli/test/e2e" - "github.com/stretchr/testify/assert" - "github.com/stretchr/testify/require" - "go.mongodb.org/ops-manager/opsmngr" -) - -const ( - closed = "CLOSED" -) - -func TestAlerts(t *testing.T) { - cliPath, err := e2e.Bin() - if err != nil { - t.Fatalf("unexpected error: %v", err) - } - - var alertID string - a := assert.New(t) - - t.Run("List with status CLOSED", func(t *testing.T) { - cmd := exec.Command(cliPath, - entity, - alertsEntity, - "list", - "--status", - closed, - "-o=json", - ) - - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - require.NoError(t, err) - require.NoError(t, err, string(resp)) - var alerts opsmngr.AlertsResponse - require.NoError(t, json.Unmarshal(resp, &alerts)) - a.NotEmpty(alerts.Results) - alertID = alerts.Results[0].ID - }) - - t.Run("List with status OPEN", func(t *testing.T) { - cmd := exec.Command(cliPath, - entity, - alertsEntity, - "list", - "--status", - "OPEN", - "-o=json", - ) - - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - require.NoError(t, err, string(resp)) - }) - - t.Run("Describe", func(t *testing.T) { - cmd := exec.Command(cliPath, - entity, - alertsEntity, - "describe", - alertID, - "-o=json", - ) - - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - require.NoError(t, err, string(resp)) - var alert opsmngr.Alert - require.NoError(t, json.Unmarshal(resp, &alert)) - a.Equal(alertID, alert.ID) - a.Equal(closed, alert.Status) - }) - - t.Run("List with no status", func(t *testing.T) { - cmd := exec.Command(cliPath, - entity, - alertsEntity, - "list", - "-o=json", - ) - - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - require.NoError(t, err, string(resp)) - var alerts opsmngr.AlertsResponse - require.NoError(t, json.Unmarshal(resp, &alerts), string(resp)) - }) - - t.Run("List with status CLOSED", func(t *testing.T) { - cmd := exec.Command(cliPath, - entity, - alertsEntity, - "list", - "--status", - closed, - "-o=json", - ) - - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - require.NoError(t, err, string(resp)) - var alerts opsmngr.AlertsResponse - require.NoError(t, json.Unmarshal(resp, &alerts), string(resp)) - }) - - t.Run("Acknowledge", func(t *testing.T) { - cmd := exec.Command(cliPath, - entity, - alertsEntity, - "ack", - alertID, - "--until", - time.Now().Format(time.RFC3339), - "-o=json") - - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - require.NoError(t, err, string(resp)) - var alert opsmngr.Alert - require.NoError(t, json.Unmarshal(resp, &alert)) - a.Equal(alertID, alert.ID) - }) - - t.Run("Acknowledge Forever", func(t *testing.T) { - cmd := exec.Command(cliPath, - entity, - alertsEntity, - "ack", - alertID, - "--forever", - "-o=json") - - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - require.NoError(t, err, string(resp)) - var alert opsmngr.Alert - require.NoError(t, json.Unmarshal(resp, &alert)) - a.Equal(alertID, alert.ID) - }) - - t.Run("UnAcknowledge", func(t *testing.T) { - cmd := exec.Command(cliPath, - entity, - alertsEntity, - "unack", - alertID, - "-o=json") - - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - require.NoError(t, err, string(resp)) - var alert opsmngr.Alert - require.NoError(t, json.Unmarshal(resp, &alert)) - a.Equal(alertID, alert.ID) - }) -} diff --git a/test/e2e/cloud_manager/dbusers_test.go b/test/e2e/cloud_manager/dbusers_test.go deleted file mode 100644 index be336a93e9..0000000000 --- a/test/e2e/cloud_manager/dbusers_test.go +++ /dev/null @@ -1,184 +0,0 @@ -// Copyright 2020 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. - -//go:build e2e || (remote && replica && (cloudmanager || om60)) - -package cloud_manager_test - -import ( - "bytes" - "encoding/json" - "fmt" - "os" - "os/exec" - "strings" - "testing" - - "github.com/mongodb/mongodb-atlas-cli/test/e2e" - "github.com/stretchr/testify/assert" - "github.com/stretchr/testify/require" - "go.mongodb.org/ops-manager/opsmngr" -) - -func TestDBUsersWithFlags(t *testing.T) { - username, err := generateUsername() - if err != nil { - t.Fatalf("unexpected error: %v", err) - } - - cliPath, err := e2e.Bin() - require.NoError(t, err) - - // make sure security is enabled, this should be a no-op for cloud manager - t.Run("Enable security", func(t *testing.T) { - testEnableSecurity(t, cliPath) - }) - - t.Run("Watch", watchAutomation(cliPath)) - - t.Run("Create", func(t *testing.T) { - cmd := exec.Command(cliPath, - entity, - dbUsersEntity, - "create", - "--username", - username, - "--password=passW0rd", - "--role=readWriteAnyDatabase", - "--mechanisms=SCRAM-SHA-256") - - testCreatePasswordCmd(t, cmd) - }) - - t.Run("List", func(t *testing.T) { - cmd := exec.Command(cliPath, - entity, - dbUsersEntity, - "ls", - "-o=json") - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - require.NoError(t, err, string(resp)) - - var users []opsmngr.MongoDBUser - require.NoError(t, json.Unmarshal(resp, &users), string(resp)) - assert.NotEmpty(t, users) - }) - - t.Run("Delete", func(t *testing.T) { - testDelete(t, cliPath, username) - }) -} - -func TestDBUsersWithStdin(t *testing.T) { - username, err := generateUsername() - if err != nil { - t.Fatalf("unexpected error: %v", err) - } - - cliPath, err := e2e.Bin() - if err != nil { - t.Fatalf("unexpected error: %v", err) - } - - // make sure security is enabled, this should be a no-op for cloud manager - t.Run("Enable security", func(t *testing.T) { - testEnableSecurity(t, cliPath) - }) - - t.Run("Watch", watchAutomation(cliPath)) - - t.Run("CreatePassword", func(t *testing.T) { - cmd := exec.Command(cliPath, - entity, - dbUsersEntity, - "create", - "--username", - username, - "--role=readWriteAnyDatabase", - "--mechanisms=SCRAM-SHA-256") - - passwordStdin := bytes.NewBuffer([]byte("passW0rd")) - cmd.Stdin = passwordStdin - - testCreatePasswordCmd(t, cmd) - }) - - t.Run("Delete", func(t *testing.T) { - testDelete(t, cliPath, username) - }) -} - -func generateUsername() (string, error) { - n, err := e2e.RandInt(1000) - if err != nil { - return "", err - } - return fmt.Sprintf("user-%v", n), nil -} - -func testEnableSecurity(t *testing.T, cliPath string) { - t.Helper() - - cmd := exec.Command(cliPath, - entity, - securityEntity, - "enable", - "MONGODB-CR", - "SCRAM-SHA-256") - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - - if err != nil { - t.Fatalf("unexpected error: %v, resp: %v", err, string(resp)) - } - - if !strings.Contains(string(resp), "Changes are being applied") { - t.Errorf("got=%#v\nwant=%#v\n", string(resp), "Changes are being applied") - } -} - -func testDelete(t *testing.T, cliPath, username string) { - t.Helper() - - cmd := exec.Command(cliPath, - entity, - dbUsersEntity, - "delete", - username, - "--force", - "--authDB", - "admin", - ) - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - - if err != nil { - t.Fatalf("unexpected error: %v, resp: %v", err, string(resp)) - } - - if !strings.Contains(string(resp), "Changes are being applied") { - t.Errorf("got=%#v\nwant=%#v\n", string(resp), "Changes are being applied") - } -} - -func testCreatePasswordCmd(t *testing.T, cmd *exec.Cmd) { - t.Helper() - - cmd.Env = os.Environ() - - resp, err := cmd.CombinedOutput() - require.NoError(t, err, string(resp)) - assert.Contains(t, string(resp), "Changes are being applied") -} diff --git a/test/e2e/cloud_manager/decryption/aws/test-input b/test/e2e/cloud_manager/decryption/aws/test-input deleted file mode 100644 index 7ff034de35..0000000000 --- a/test/e2e/cloud_manager/decryption/aws/test-input +++ /dev/null @@ -1,4 +0,0 @@ -{"ts":{"$date":{"$numberLong":"1644232049921"}},"version":"0.0","compressionMode":"zstd","keyStoreIdentifier":{"provider":"aws","region":"eu-west-1","endpoint":"kms.eu-west-1.amazonaws.com","key":"arn:aws:kms:eu-west-1:358363220050:key/f9b7ca9a-ae3b-44d9-ad91-5936c37e6a06"},"encryptedKey":{"$binary":{"base64":"AQICAHjSDEKfuX2e+ryIAeaf56tyotxJhu/iyv4TIUmBvz7s1gFT16EnYbf81bEGc9AtsEFMAAAAfjB8BgkqhkiG9w0BBwagbzBtAgEAMGgGCSqGSIb3DQEHATAeBglghkgBZQMEAS4wEQQMaTnBj4ff89JaZmZhAgEQgDtX/Ad6As19PiLUMXfXceWQq1gQv2gXp1FH8E9FKHOEnxJZc9IhSK5mfrHZHV7Qwp8SyvycFP6/DZmCKQ==","subType":"0"}},"MAC":"qE9fUsGK0EuRrrCRAQAAAAAAAAAAAAAA","auditRecordType":"header"} -{"ts":{"$date":{"$numberLong":"1644232049922"}},"log":"1Lu4o8XVMM/Rg7GKAQAAAAEAAAAAAAAA/8tXQ36mEd90OaAOzCOSti7N5a2jr0B9ek48/uvyteG/zUJHyM16Hs3wMEhDqTQGBwGhWSHEqXh0/5Jbz6tXsYHhDTMr1BOsn1zaavZScx/CkO5+Hd8Vx+zeFPREtQTe1y+JngXSIroezeyV0/zF4YC4vpug+OZtrEQLNEgwT2bjaqUyaKDbmzCNetd2Ff/eFfMFzinbzKVgXAC7T4YmDuowqXommEXLIBiYh2u4VagwJKZRw5OGZjnvqwyVpSPgGqLxGKUoFigh3NgC6EuGi17VIs5BLRZOIw7+OfbPgQQiKzjCxCk="} -{"ts":{"$date":{"$numberLong":"1644232050645"}},"log":"gjn0BYabxQku84PTAQAAAAIAAAAAAAAAuTcMKIEGtlkPyGGqcj3mVOW0d+SUKGREXwicsBC5oDs+f4GkiNQmwXzpsassKTGLCS30xoEe/2NK/pBB7hB0mUmmoEVXCqgT28aztDXlkN5GeX0ECCYG4HoQyzyVdIi/SFF1Xa7jTLkYGdqwghDaMD/PzJVXcdhCckqPUn9CZKurMnsVZ7KiL8hpgNpQ8Q=="} -{"ts":{"$date":{"$numberLong":"1644232050645"}},"log":"8nCVKIkN1ebPXTIFAQAAAAMAAAAAAAAAMJ6H+8m76AZ0nOAHAWUmd7iZVHepDNpWyIBhTo4C5R7gBHFsPOlr4IETL/v6I+HSU4KBNnOFpoCA7KurmwNwQ7J8xdjrteCWB7WDIzP9cusu+4lsBdkhL/ExIJAaL/Rn/8Kq9482DyPtlxOldSUBP8QlyEJQ/iZ5W2fpgKdZtjCD4g+r6NPOgGjyrtr5bSqWts2f9Omth3r073HViNw="} diff --git a/test/e2e/cloud_manager/decryption/aws/test-output b/test/e2e/cloud_manager/decryption/aws/test-output deleted file mode 100644 index 8a7b8dc701..0000000000 --- a/test/e2e/cloud_manager/decryption/aws/test-output +++ /dev/null @@ -1,4 +0,0 @@ -{"atype":"decryptionLogError","line":1,"error":"error processing header line 1: key provider not supported: aws","ts":1644232049921} -{"atype":"decryptionLogWarning","line":2,"error":"line 2 skipped, the header record for current section is missing or corrupted","ts":1644232049922} -{"atype":"decryptionLogWarning","line":3,"error":"line 3 skipped, the header record for current section is missing or corrupted","ts":1644232050645} -{"atype":"decryptionLogWarning","line":4,"error":"line 4 skipped, the header record for current section is missing or corrupted","ts":1644232050645} diff --git a/test/e2e/cloud_manager/decryption/kmip/test1-input b/test/e2e/cloud_manager/decryption/kmip/test1-input deleted file mode 100644 index 22d2c2b577..0000000000 --- a/test/e2e/cloud_manager/decryption/kmip/test1-input +++ /dev/null @@ -1,3 +0,0 @@ -{"ts":{"$date":{"$numberLong":"1684794503303"}},"version":"0.0","compressionMode":"zstd","keyStoreIdentifier":{"provider":"kmip","uid":"2","kmipServerName":["localhost"],"kmipPort":{"$numberInt":"8081"},"keyWrapMethod":"get"},"encryptedKey":{"$binary":{"base64":"UAAAAAVpdgAMAAAAAB2AFXCfpksWsa1digVrZXkALAAAAAA6+PSblQe8eSZdYN3jlxnjsfQuaCwpi5BhIbfbcOAbbDDD/yC5PDpEzCQyqQA=","subType":"0"}},"MAC":"9303PazVH81ScJRzAQAAAAAAAAAAAAAA","auditRecordType":"header"} -{"ts":{"$date":{"$numberLong":"1684794503304"}},"log":"8kJjU7ETuiDvR2reAQAAAAEAAAAAAAAAIDYYKoGmVWcHkBcBrMx427OJhT50R7MnjaNnAYGAf4S6BfrIm2TZkLKnSXwIGbUp3C6DwRv+cAe+4Fy3OctAg/ON8vTn/hdezC4Qd7cR6bttsS7rzUOPnCppbDqqjqigA18mp5kxK75J0TFyJF2eKQoHqOe2FePHVIZPjihVlv7bE0JqJECewONQdKTEXuFUgnu0PExpqzlIM3ETG+UYmdGKOwxNdaP7woBz5bmiM1lYPeqwKDpYePP1rpnd+KeJwZCaowew5qXOIxSWP8spF/7TQ8N6F+Gc2rrIUlv2KZH2uvy5PZMgWmQuzAKrafT63VKMtiGG5cmtaHIrk+V40rUkD34id8oQgC2QAep9WDzHdsWLMdDYhtIqfzGYY5ohPYM8KwEd/xV4nvAEluRnU3ne4TePKJd2+y1n670YYSDWegePElUgm8tBfsIOI241JMHtAdCvr7icZRJ9ePC7pSlqK7BfdYSVy0yBHp0PbdEF0QjfN4M5820="} -{"ts":{"$date":{"$numberLong":"1684794503305"}},"log":"Q7yNmrI50noCoqq+AQAAAAIAAAAAAAAAIPdPg783XrhWTsPP0dku0rkmlnd1oeofNfoTVmYWFUrlJWWo3mV96wWZfGb5Kv2l0G7STiA+2h0gZTXyf0/1gOo6cJaqla972zvxpc+ZkDu/nXYhNSTYGhSUxZxZ9eDeZeJfzrmUjbJzmVDWg1EteHGFAvOeC8nc9yLgszR9Yy3lHA=="} \ No newline at end of file diff --git a/test/e2e/cloud_manager/decryption/kmip/test1-output b/test/e2e/cloud_manager/decryption/kmip/test1-output deleted file mode 100644 index 836ef183d6..0000000000 --- a/test/e2e/cloud_manager/decryption/kmip/test1-output +++ /dev/null @@ -1,2 +0,0 @@ -{"local":{"isSystemUser":true},"users":[],"roles":[],"result":0,"ts":{"$date":"2023-05-22T22:28:23.304Z"},"atype":"startup","remote":{"isSystemUser":true},"param":{"options":{"auditLog":{"auditEncryptionKeyIdentifier":"2","compressionMode":"zstd","destination":"file","format":"JSON","path":"/home/ec2-user/auditLogKmipGet.json"},"security":{"kmip":{"clientCertificateFile":"/home/ec2-user/trusted-server.pem","port":6666,"serverCAFile":"/home/ec2-user/trusted-ca.pem","serverName":"localhost"}},"setParameter":{"auditEncryptKeyWithKMIPGet":"true"}}},"uuid":{"$binary":{"base64":"RAASK4+JQPCswZA4Dj+rYQ==","subType":"04"}}} -{"atype":"shutdown","remote":{"isSystemUser":true},"ts":{"$date":"2023-05-22T22:28:23.305Z"},"uuid":{"$binary":{"base64":"RAASK4+JQPCswZA4Dj+rYQ==","subType":"04"}},"local":{"isSystemUser":true},"users":[],"roles":[],"param":{},"result":0} \ No newline at end of file diff --git a/test/e2e/cloud_manager/decryption/kmip/test2-input b/test/e2e/cloud_manager/decryption/kmip/test2-input deleted file mode 100644 index d47ce0db48..0000000000 --- a/test/e2e/cloud_manager/decryption/kmip/test2-input +++ /dev/null @@ -1,3 +0,0 @@ -{"ts":{"$date":{"$numberLong":"1684794496078"}},"version":"0.0","compressionMode":"zstd","keyStoreIdentifier":{"provider":"kmip","uid":"1","kmipServerName":["localhost"],"kmipPort":{"$numberInt":"8081"},"keyWrapMethod":"encrypt"},"encryptedKey":{"$binary":{"base64":"WAAAAAVpdgAQAAAAAN11x2662G3HXeUhigtAxegFa2V5ADAAAAAAIgZ8hIYp3L7DxozRbfCkax8EQrOFPq5LFSKSWJSIjfjVKDBdrb7XD0ooJKFueM16AA==","subType":"0"}},"MAC":"I2PLsgYKA6tD2xdnAQAAAAAAAAAAAAAA","auditRecordType":"header"} -{"ts":{"$date":{"$numberLong":"1684794496079"}},"log":"wWElPkopHpZM5jTGAQAAAAEAAAAAAAAAFzmlXU3xqjm23P95QxMPjq/MntwoI6s+FkbcoQ6ruC9U/RDc/gPB1ti8y5vuDZkXqy7eWBvqC4u1kHVDi0cL1KCBQ4tPw9KrRIKjONQ4+IfAnVDYERPmjYMeIU84sfsc1Q9J01HX1BUa3MEsX4kMmx9bkjgIf2s/dMAyWFwhzIAa7/7f49HuDrPK7NbsjFFQN8ihC27oT6jGzSEdfYUevD7uMUITPqutMsdKRvHPSdGMOkH8w+0qnfq2bNgYL51bmf4tjtf8ZzxlCJ+DUj/MoSSrsEjACRB8J5Hj4wnBhtDki73ChIdgoAiAlnt4H95AVIO8F4AhXiLfGV3pBohAhuckhbQr8c+qdSSPajVBFn9srHg38XSTA9jCZD6KdVKZohJbSHgDPIArZs5Izje4JxqTSXpo9aFemA1BQktJnI1OvlMnceTVP4dryhsaAYy1udU2BNPM1VGo"} -{"ts":{"$date":{"$numberLong":"1684794496080"}},"log":"e07mLFJmtG6Coo8aAQAAAAIAAAAAAAAAFcCwWal6FK3ohUjxVuuv9NQAKXgPZsLHIqP4sV31R8CXYA6oJOgL8P+G+rumVbKLX2RqEeh5RlJpJsM6tUuabk89tBZC7b3GJBiP6QSikjs97fj/PDGoVzTAi1MJQH7ZcgpqqwqoF/W2+5LkPXxpBDKv29Cn4GUjPzZExVa9G7fsu6U="} \ No newline at end of file diff --git a/test/e2e/cloud_manager/decryption/kmip/test2-output b/test/e2e/cloud_manager/decryption/kmip/test2-output deleted file mode 100644 index 79d4417d0c..0000000000 --- a/test/e2e/cloud_manager/decryption/kmip/test2-output +++ /dev/null @@ -1,2 +0,0 @@ -{"atype":"startup","local":{"isSystemUser":true},"remote":{"isSystemUser":true},"roles":[],"result":0,"uuid":{"$binary":{"base64":"FD8ajGaEQ6edlVRHmtCT3A==","subType":"04"}},"users":[],"param":{"options":{"security":{"kmip":{"clientCertificateFile":"/home/ec2-user/trusted-server.pem","port":6666,"serverCAFile":"/home/ec2-user/trusted-ca.pem","serverName":"localhost"}},"auditLog":{"path":"/home/ec2-user/auditLogKmipEncrypt.json","auditEncryptionKeyIdentifier":"1","compressionMode":"zstd","destination":"file","format":"JSON"}}},"ts":{"$date":"2023-05-22T22:28:16.079Z"}} -{"atype":"shutdown","uuid":{"$binary":{"base64":"FD8ajGaEQ6edlVRHmtCT3A==","subType":"04"}},"remote":{"isSystemUser":true},"users":[],"param":{},"local":{"isSystemUser":true},"roles":[],"result":0,"ts":{"$date":"2023-05-22T22:28:16.08Z"}} \ No newline at end of file diff --git a/test/e2e/cloud_manager/decryption/localKey/test1-input b/test/e2e/cloud_manager/decryption/localKey/test1-input deleted file mode 100644 index 8621ecfb2c..0000000000 --- a/test/e2e/cloud_manager/decryption/localKey/test1-input +++ /dev/null @@ -1,3 +0,0 @@ -{"ts":{"$date":{"$numberLong":"1644232049921"}},"version":"0.0","compressionMode":"zstd","keyStoreIdentifier":{"provider":"local","filename":"localKey"},"encryptedKey":{"$binary":{"base64":"+yjPCaKKE1M8fZmPGzGHkyfHYxaw34okpavsHzpd8iPVx2+JjOhXwXw5E2FdI5Rcb5JgmcPUFRPISh/7Si1R/g==","subType":"0"}},"MAC":"qE9fUsGK0EuRrrCRAQAAAAAAAAAAAAAA","auditRecordType":"header"} -{"ts":{"$date":{"$numberLong":"1644232049922"}},"log":"1Lu4o8XVMM/Rg7GKAQAAAAEAAAAAAAAA/8tXQ36mEd90OaAOzCOSti7N5a2jr0B9ek48/uvyteG/zUJHyM16Hs3wMEhDqTQGBwGhWSHEqXh0/5Jbz6tXsYHhDTMr1BOsn1zaavZScx/CkO5+Hd8Vx+zeFPREtQTe1y+JngXSIroezeyV0/zF4YC4vpug+OZtrEQLNEgwT2bjaqUyaKDbmzCNetd2Ff/eFfMFzinbzKVgXAC7T4YmDuowqXommEXLIBiYh2u4VagwJKZRw5OGZjnvqwyVpSPgGqLxGKUoFigh3NgC6EuGi17VIs5BLRZOIw7+OfbPgQQiKzjCxCk="} -{"ts":{"$date":{"$numberLong":"1644232050645"}},"log":"gjn0BYabxQku84PTAQAAAAIAAAAAAAAAuTcMKIEGtlkPyGGqcj3mVOW0d+SUKGREXwicsBC5oDs+f4GkiNQmwXzpsassKTGLCS30xoEe/2NK/pBB7hB0mUmmoEVXCqgT28aztDXlkN5GeX0ECCYG4HoQyzyVdIi/SFF1Xa7jTLkYGdqwghDaMD/PzJVXcdhCckqPUn9CZKurMnsVZ7KiL8hpgNpQ8Q=="} diff --git a/test/e2e/cloud_manager/decryption/localKey/test1-output b/test/e2e/cloud_manager/decryption/localKey/test1-output deleted file mode 100755 index 99a00b5988..0000000000 --- a/test/e2e/cloud_manager/decryption/localKey/test1-output +++ /dev/null @@ -1,2 +0,0 @@ -{"remote":{"isSystemUser":true},"users":[],"param":{"options":{"auditLog":{"compressionMode":"zstd","destination":"file","format":"JSON","localAuditKeyFile":"localKey","path":"auditLog.json"}}},"ts":{"$date":"2022-02-07T11:07:29.922Z"},"atype":"startup","uuid":{"$binary":{"base64":"+mOPbB12RDGgTsXXjR8R/A==","subType":"04"}},"local":{"isSystemUser":true},"roles":[],"result":0} -{"users":[],"param":{"ns":"admin"},"result":0,"atype":"createDatabase","uuid":{"$binary":{"base64":"+mOPbB12RDGgTsXXjR8R/A==","subType":"04"}},"remote":{"isSystemUser":true},"local":{"isSystemUser":true},"roles":[],"ts":{"$date":"2022-02-07T11:07:30.645Z"}} diff --git a/test/e2e/cloud_manager/decryption/localKey/test2-input b/test/e2e/cloud_manager/decryption/localKey/test2-input deleted file mode 100644 index 3524a64a6b..0000000000 --- a/test/e2e/cloud_manager/decryption/localKey/test2-input +++ /dev/null @@ -1,3 +0,0 @@ -{"ts":{"$date":{"$numberLong":"1647253445455"}},"version":"0.0","compressionMode":"none","keyStoreIdentifier":{"provider":"local","filename":"localKey"},"encryptedKey":{"$binary":{"base64":"0VJYsG9iqPfOklFL92eArtUFLsvGuTj6BElk4u36uX8X9BUtlBsqskqosMJa/DP6okYmbZI/vxBHw2mXrl5KMQ==","subType":"0"}},"MAC":"hSR+x9ocU9CneeFWAQAAAAAAAAAAAAAA","auditRecordType":"header"} -{"ts":{"$date":{"$numberLong":"1647253445456"}},"log":"hZbRmwiHBV8M2DXzAQAAAAEAAAAAAAAAIirnYxEytXPB7YnylqjP+7zkdiwLVpDIWhSe7PP026VzzMiDEzBnPLwqyYY12V2G1esAZMWiazy4jFiA22+RXLTcQOO09kPYMAQZ/6/Fk8F23mIl6p5BVfy6RRQ00BZG2n8auigp0aTJ2MsVkbAfQpa3OW1WmWr/2f9PltQTTlZuobGLdCCyRTK70QabU9922xhNSHL53U5YA00p3HfnALlMbas87CaOR6wUBDP8otpiNL8NQWQWS9SoZYXAMtgVseO0FvaiS4EInhC8AQmMPpCBK0+yWAwp+KEy4QGHjoMRBL6c5o5jeGdthIVCBJ1nmfAQmEAN/n57X3cccBQMMx+9WhAKzzq5bgAe4+Y2uTZPIk52v++bef6lZYGlQwmtvE7oyZ69BHEk"} -{"ts":{"$date":{"$numberLong":"1647253458076"}},"log":"Q0AKCHDW6tDEoSEXAQAAAAIAAAAAAAAAGyGlUPUbHhFvXo+E7TAjT1tRWbvhqY36pRYg2gvea6af0COeh7BMaIUKZuVxp34DY2vDOWnqTV0dITy/13IQO12lOvLSiD6yg7Dr2jR9n6u6qv+WskczghN4EAImpiK4P6zrWXpXD3hyH8dGTrjAj3vVI/UEvUFHfBFHYUMIH79rGM2behOfrMrXtoqQ4BSVEMrNUQ1eJKBacQiLy9Gh83Pm7yE7DnHsbZjucW5XOyWU2d+LBisF5orqntQL8uNLgsIMrcSFNCAElc9zQtpvGxzqLV/4ljDUAQJbcIPMxh8w+pQpM7cW+YB8S8Pp1TaRQCrEYfjIrP6+XDXGe1Wi9fUK4oKGLQbI6LqX8A=="} diff --git a/test/e2e/cloud_manager/decryption/localKey/test2-output b/test/e2e/cloud_manager/decryption/localKey/test2-output deleted file mode 100755 index 1fadcfa6f1..0000000000 --- a/test/e2e/cloud_manager/decryption/localKey/test2-output +++ /dev/null @@ -1,2 +0,0 @@ -{"local":{"isSystemUser":true},"param":{"options":{"auditLog":{"destination":"file","format":"JSON","localAuditKeyFile":"localKey","path":"auditLogSample-JSON-uncompressed"}}},"result":0,"ts":{"$date":"2022-03-14T10:24:05.456Z"},"atype":"startup","uuid":{"$binary":{"base64":"wgY3QuGhQMCAhbGLgUNJHg==","subType":"04"}},"remote":{"isSystemUser":true},"users":[],"roles":[]} -{"atype":"logout","uuid":{"$binary":{"base64":"iy4FwhbcSGGUlsjiske6Pg==","subType":"04"}},"users":[],"roles":[],"result":0,"local":{"isSystemUser":true},"remote":{"isSystemUser":true},"param":{"reason":"Client has disconnected","initialUsers":[{"db":"local","user":"__system"}],"updatedUsers":[]},"ts":{"$date":"2022-03-14T10:24:18.076Z"}} diff --git a/test/e2e/cloud_manager/decryption/localKey/test3-input b/test/e2e/cloud_manager/decryption/localKey/test3-input deleted file mode 100644 index 1ccf7a87cfb420fdc824d31abb12d18ab864e4ff..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 1214 zcmY+DOUv9;9LA5MRrbR+1d%0M&sWWb7^r`0@YWc?p2qWdYuvKKuB?{ywN- zUIgh0yaE6i-5Y^{ohDfhiz|~)9SCmqL06OxcsYWtT&6i>9C#`NH-I@9_2D4P(>ic^ z^=hx;)HY)H*Pnj(>$@MpzaHFIs~`Uv z@Hhe9?27~nQ7?R)iH9ZOlL?JW`2P+Vn3WThduXS*qqG?Wul28dXkL9C6xU$hc>yL) zJz(_aND42NYcQ=-?1v6d|V~sQrr4Q z!w)AddDyE3Tcw`Q##)>fx=MM@m=Z};gv~y}ytWKgxY;y@lE$KNu{a2$sS8bB8P|&M z#%_c|*B+|=L3W$SE_H0j)}=8fI4;bEw$sPE69VIJ)S8CmgYE z-ys?R>^1WDi0fIrLO$-zX4*j(p&9u@p>)6C0!V2!)Yyi&7xFZG6$RIXUAkDp4yhj$d2CDqBBm% zrLD$wW)695mPSE49?nHJb1pJk$9yU;LLyHtg0Ryi%HdO8Vi}$+r+ieF^8`_OT^76+d0IMkrjq=3k|6>3}fPnJv3Y{Go^(> zTWT6qXJc1FOcUm@W_yuc(++Fo`L^Zj!^{gOttg+vAztUj3V@&cNxoWZ<-aJu=}l&` zVp!p{OV^4@FNN!+;BQb4U5JIcUV55O3Y-|{40V)>#4u%|h08XbrtYO8JDng!yqwNa zW;kDn9=a)f%%N#Kclko{n4O7}*v8yjaK_-uD3y^o(ilu^=){-j)`B~23#zcwtvowf z6E)_}e1gbRUJ4kxc16C@`0dz7l(J+R|2RQ5xnwonsyw5Wln%2l4pwkDQuXb>8RYeKaXM-B(^Y-u8%Z zAHM(dmmmK95C5_Kx^a*B;l1F;!-KEGw_m$<``%~RPv75v>GK=OC%^yo&C9>Ob?1XW z9OdEl?VYbKc$|b@9gKKFCaE6jXTqVR1zW}?{C^9&uuooC%fQV`PwkEXdSRFffc@y` z(07-?+)KlwWJZZ=7h*_q-VbBv=@)MD5fMUiK zmTi~w$US98Zlq$&$(-tbuFLdz!r+E`#D|m#Jf|4j5`{9OIRjIdNrXlCULuP#wZn4BI9nRlTkpZXin}6aW0_NTCluO z>}39Qn5q`(X&F@pD_wP5t6_D{7{z_L-{GA;vxtV5bF1hnpsmg<933OLK~9Ri#&?mU z)D5*&wY}eNJd_aSs8Xb{JPoMPdL7BDwzD(e5G86(*l}m895JIEr-U1~2^X87(8NQj z=~yf<SFA<43<--tR{k-yOtFV<7XuCIXqvX*WS0 zW86H&xa(HyS;pZ@B#!jmNcHu=oy!w;QjJ{AcTLzEvnOWZZS^?-5+Y}7rdVXluvLo2 zFL!71Jfn9TIG--JW89eGLEU0=gRiS4YpM}f?)v=*-PraX=Ji>xB2Cnvb*;QURCtW<|vn+!VQ7}P0TMW1RMJQFCPoJl8UgTlt1SPJA4j)5t|3!bJ8d5kBM z)@Y)&b7sjjrc(~jkGbv5EK|rtJ=COIw;<@nOGNkoi|DuEDVk$!0_wR5JNq4<6zO9` z{8L11@3cVKPpGWzFUXWJwWQyz5&I5F|MWqg5vXQ~8U4ltz1jztN)t$NYYCM$4 zm8V$gHd+oJV(Y0$s_o(y?z^4X@);`gUcc#hUEsHK&)U)rJq@N*y5DfN 0, got 0`) - } - }) -} diff --git a/test/e2e/cloud_manager/maintenance_test.go b/test/e2e/cloud_manager/maintenance_test.go deleted file mode 100644 index d95ad197cb..0000000000 --- a/test/e2e/cloud_manager/maintenance_test.go +++ /dev/null @@ -1,159 +0,0 @@ -// Copyright 2020 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. - -//go:build e2e || (generic && (cloudmanager || om60)) - -package cloud_manager_test - -import ( - "encoding/json" - "fmt" - "os" - "os/exec" - "testing" - "time" - - "github.com/mongodb/mongodb-atlas-cli/test/e2e" - "github.com/stretchr/testify/assert" - "github.com/stretchr/testify/require" - "go.mongodb.org/ops-manager/opsmngr" -) - -func TestMaintenanceWindows(t *testing.T) { - n, err := e2e.RandInt(255) - require.NoError(t, err) - - cliPath, err := e2e.Bin() - require.NoError(t, err) - - projectName := fmt.Sprintf("e2e-maintenance-proj-%v", n) - projectID, err := e2e.CreateProject(projectName) - require.NoError(t, err) - t.Cleanup(func() { - e2e.DeleteProjectWithRetry(t, projectID) - }) - - startDate := time.Now().Format(time.RFC3339) - endDate := time.Now().AddDate(0, 0, 1).Format(time.RFC3339) - var maintenanceWindowID string - - t.Run("create", func(t *testing.T) { - cmd := exec.Command(cliPath, - entity, - maintenanceEntity, - "create", - "--startDate", - startDate, - "--endDate", - endDate, - "--alertType", - "REPLICA_SET", - "-o", - "json", - "--projectId", - projectID) - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - - a := assert.New(t) - require.NoError(t, err, string(resp)) - - var maintenanceWindow opsmngr.MaintenanceWindow - require.NoError(t, json.Unmarshal(resp, &maintenanceWindow)) - a.Equal(startDate, maintenanceWindow.StartDate) - a.Equal(endDate, maintenanceWindow.EndDate) - maintenanceWindowID = maintenanceWindow.ID - }) - - t.Run("describe", func(t *testing.T) { - cmd := exec.Command(cliPath, - entity, - maintenanceEntity, - "describe", - maintenanceWindowID, - "-o", - "json", - "--projectId", - projectID) - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - require.NoError(t, err, string(resp)) - - var maintenanceWindow opsmngr.MaintenanceWindow - require.NoError(t, json.Unmarshal(resp, &maintenanceWindow)) - assert.Equal(t, maintenanceWindowID, maintenanceWindow.ID) - }) - - t.Run("list", func(t *testing.T) { - cmd := exec.Command(cliPath, - entity, - maintenanceEntity, - "ls", - "-o", - "json", - "--projectId", - projectID) - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - - a := assert.New(t) - require.NoError(t, err, string(resp)) - - var maintenanceWindows opsmngr.MaintenanceWindows - require.NoError(t, json.Unmarshal(resp, &maintenanceWindows)) - a.NotEmpty(maintenanceWindows.Results) - }) - - t.Run("update", func(t *testing.T) { - cmd := exec.Command(cliPath, - entity, - maintenanceEntity, - "update", - maintenanceWindowID, - "--alertType", - "CLUSTER", - "-o", - "json", - "--projectId", - projectID) - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - - a := assert.New(t) - require.NoError(t, err, string(resp)) - - var maintenanceWindow opsmngr.MaintenanceWindow - require.NoError(t, json.Unmarshal(resp, &maintenanceWindow)) - a.Contains(maintenanceWindow.AlertTypeNames, "CLUSTER") - }) - - t.Run("delete", func(t *testing.T) { - cmd := exec.Command(cliPath, - entity, - maintenanceEntity, - "delete", - maintenanceWindowID, - "--force", - "--projectId", - projectID) - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - - a := assert.New(t) - - require.NoError(t, err, string(resp)) - expected := fmt.Sprintf("Maintenance window '%s' deleted\n", maintenanceWindowID) - a.Equal(expected, string(resp)) - }) -} diff --git a/test/e2e/cloud_manager/servers_test.go b/test/e2e/cloud_manager/servers_test.go deleted file mode 100644 index 739ef48ae5..0000000000 --- a/test/e2e/cloud_manager/servers_test.go +++ /dev/null @@ -1,58 +0,0 @@ -// Copyright 2020 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. - -//go:build e2e || (remote && replica && (cloudmanager || om60)) - -package cloud_manager_test - -import ( - "encoding/json" - "os" - "os/exec" - "testing" - - "github.com/mongodb/mongodb-atlas-cli/test/e2e" - "go.mongodb.org/ops-manager/opsmngr" -) - -func TestServers(t *testing.T) { - cliPath, err := e2e.Bin() - if err != nil { - t.Fatalf("unexpected error: %v", err) - } - - t.Run("List", func(t *testing.T) { - cmd := exec.Command(cliPath, - entity, - serversEntity, - "list", - "-o=json", - ) - - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - - if err != nil { - t.Fatalf("unexpected error: %v, resp: %v\n", err, string(resp)) - } - - var servers *opsmngr.Agents - if err := json.Unmarshal(resp, &servers); err != nil { - t.Fatalf("unexpected error: %v\n", err) - } - if servers.TotalCount == 0 { - t.Errorf("expected at least one server, got=%d\n", servers.TotalCount) - } - }) -} diff --git a/test/e2e/ops_manager/version_manifest_test.go b/test/e2e/ops_manager/version_manifest_test.go deleted file mode 100644 index b49aa6e19c..0000000000 --- a/test/e2e/ops_manager/version_manifest_test.go +++ /dev/null @@ -1,57 +0,0 @@ -// Copyright 2020 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. - -//go:build e2e || (generic && om60) - -package ops_manager_test - -import ( - "encoding/json" - "os" - "os/exec" - "testing" - - "github.com/mongodb/mongodb-atlas-cli/test/e2e" - "go.mongodb.org/ops-manager/opsmngr" -) - -func TestVersionManifest(t *testing.T) { - cliPath, err := e2e.Bin() - if err != nil { - t.Fatalf("unexpected error: %v", err) - } - - cmd := exec.Command(cliPath, - "om", - "versionManifest", - "update", - os.Getenv("OM_VERSION"), - "-o=json", - ) - - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - - if err != nil { - t.Fatalf("unexpected error: %v, resp: %v\n", err, string(resp)) - } - - var versionManifest *opsmngr.VersionManifest - if err := json.Unmarshal(resp, &versionManifest); err != nil { - t.Fatalf("unexpected error: %v\n", err) - } - if len(versionManifest.Versions) == 0 { - t.Errorf("expected at least one version, got=0\n") - } -} From f9cb1cef1549bba6dc403fa43d055531b7133968 Mon Sep 17 00:00:00 2001 From: Filipe C Menezes Date: Fri, 1 Mar 2024 13:11:36 +0000 Subject: [PATCH 03/16] delete docs --- docs/mongocli/command/mongocli-auth-login.txt | 78 ------- .../mongocli/command/mongocli-auth-logout.txt | 70 ------ .../mongocli/command/mongocli-auth-whoami.txt | 66 ------ docs/mongocli/command/mongocli-auth.txt | 63 ------ ...li-cloud-manager-agents-apiKeys-create.txt | 70 ------ ...li-cloud-manager-agents-apiKeys-delete.txt | 82 ------- ...ocli-cloud-manager-agents-apiKeys-list.txt | 66 ------ .../mongocli-cloud-manager-agents-apiKeys.txt | 63 ------ .../mongocli-cloud-manager-agents-list.txt | 90 -------- .../mongocli-cloud-manager-agents-upgrade.txt | 66 ------ ...cli-cloud-manager-agents-versions-list.txt | 66 ------ ...mongocli-cloud-manager-agents-versions.txt | 59 ----- .../command/mongocli-cloud-manager-agents.txt | 65 ------ ...gocli-cloud-manager-alerts-acknowledge.txt | 103 --------- ...mongocli-cloud-manager-alerts-describe.txt | 102 --------- ...gocli-cloud-manager-alerts-global-list.txt | 74 ------- .../mongocli-cloud-manager-alerts-global.txt | 59 ----- .../mongocli-cloud-manager-alerts-list.txt | 98 --------- ...i-cloud-manager-alerts-settings-create.txt | 188 ---------------- ...i-cloud-manager-alerts-settings-delete.txt | 101 --------- ...-cloud-manager-alerts-settings-disable.txt | 89 -------- ...i-cloud-manager-alerts-settings-enable.txt | 82 ------- ...ud-manager-alerts-settings-fields-type.txt | 71 ------ ...i-cloud-manager-alerts-settings-fields.txt | 59 ----- ...cli-cloud-manager-alerts-settings-list.txt | 83 ------- ...i-cloud-manager-alerts-settings-update.txt | 204 ------------------ ...mongocli-cloud-manager-alerts-settings.txt | 73 ------- ...cli-cloud-manager-alerts-unacknowledge.txt | 95 -------- .../command/mongocli-cloud-manager-alerts.txt | 69 ------ ...ocli-cloud-manager-automation-describe.txt | 66 ------ ...ngocli-cloud-manager-automation-status.txt | 66 ------ ...ngocli-cloud-manager-automation-update.txt | 66 ------ ...ongocli-cloud-manager-automation-watch.txt | 73 ------- .../mongocli-cloud-manager-automation.txt | 65 ------ ...cloud-manager-backups-checkpoints-list.txt | 90 -------- ...ocli-cloud-manager-backups-checkpoints.txt | 59 ----- ...-cloud-manager-backups-config-describe.txt | 82 ------- ...ocli-cloud-manager-backups-config-list.txt | 74 ------- ...li-cloud-manager-backups-config-update.txt | 126 ----------- .../mongocli-cloud-manager-backups-config.txt | 63 ------ ...mongocli-cloud-manager-backups-disable.txt | 78 ------- .../mongocli-cloud-manager-backups-enable.txt | 78 ------- ...li-cloud-manager-backups-restores-list.txt | 90 -------- ...i-cloud-manager-backups-restores-start.txt | 126 ----------- ...ongocli-cloud-manager-backups-restores.txt | 61 ------ ...i-cloud-manager-backups-snapshots-list.txt | 90 -------- ...er-backups-snapshots-schedule-describe.txt | 70 ------ ...ager-backups-snapshots-schedule-update.txt | 110 ---------- ...oud-manager-backups-snapshots-schedule.txt | 61 ------ ...ngocli-cloud-manager-backups-snapshots.txt | 61 ------ .../mongocli-cloud-manager-backups.txt | 69 ------ .../mongocli-cloud-manager-clusters-apply.txt | 66 ------ ...mongocli-cloud-manager-clusters-create.txt | 66 ------ ...mongocli-cloud-manager-clusters-delete.txt | 82 ------- ...ngocli-cloud-manager-clusters-describe.txt | 85 -------- ...-cloud-manager-clusters-indexes-create.txt | 145 ------------- ...ongocli-cloud-manager-clusters-indexes.txt | 59 ----- .../mongocli-cloud-manager-clusters-list.txt | 69 ------ ...loud-manager-clusters-reclaimFreeSpace.txt | 92 -------- ...ongocli-cloud-manager-clusters-restart.txt | 86 -------- ...mongocli-cloud-manager-clusters-resync.txt | 100 --------- ...ngocli-cloud-manager-clusters-shutdown.txt | 86 -------- ...ongocli-cloud-manager-clusters-startup.txt | 86 -------- ...ngocli-cloud-manager-clusters-unmanage.txt | 84 -------- ...mongocli-cloud-manager-clusters-update.txt | 66 ------ .../mongocli-cloud-manager-clusters.txt | 83 ------- .../mongocli-cloud-manager-dbusers-create.txt | 93 -------- .../mongocli-cloud-manager-dbusers-delete.txt | 86 -------- .../mongocli-cloud-manager-dbusers-list.txt | 66 ------ .../mongocli-cloud-manager-dbusers.txt | 67 ------ ...loud-manager-events-organizations-list.txt | 93 -------- ...cli-cloud-manager-events-organizations.txt | 61 ------ ...cli-cloud-manager-events-projects-list.txt | 93 -------- ...mongocli-cloud-manager-events-projects.txt | 61 ------ .../command/mongocli-cloud-manager-events.txt | 61 ------ ...cli-cloud-manager-featurePolicies-list.txt | 74 ------- ...i-cloud-manager-featurePolicies-update.txt | 98 --------- ...mongocli-cloud-manager-featurePolicies.txt | 61 ------ ...oud-manager-liveMigrations-link-create.txt | 66 ------ ...oud-manager-liveMigrations-link-delete.txt | 66 ------ ...d-manager-liveMigrations-link-describe.txt | 66 ------ ...ocli-cloud-manager-liveMigrations-link.txt | 63 ------ .../mongocli-cloud-manager-liveMigrations.txt | 59 ----- .../mongocli-cloud-manager-logs-decrypt.txt | 106 --------- ...ngocli-cloud-manager-logs-jobs-collect.txt | 98 --------- ...ongocli-cloud-manager-logs-jobs-delete.txt | 82 ------- ...gocli-cloud-manager-logs-jobs-download.txt | 86 -------- .../mongocli-cloud-manager-logs-jobs-list.txt | 70 ------ .../mongocli-cloud-manager-logs-jobs.txt | 65 ------ ...i-cloud-manager-logs-keyProviders-list.txt | 73 ------- ...ngocli-cloud-manager-logs-keyProviders.txt | 59 ----- .../command/mongocli-cloud-manager-logs.txt | 63 ------ ...loud-manager-maintenanceWindows-create.txt | 82 ------- ...loud-manager-maintenanceWindows-delete.txt | 82 ------- ...ud-manager-maintenanceWindows-describe.txt | 82 ------- ...-cloud-manager-maintenanceWindows-list.txt | 66 ------ ...loud-manager-maintenanceWindows-update.txt | 98 --------- ...gocli-cloud-manager-maintenanceWindows.txt | 67 ------ ...oud-manager-metrics-databases-describe.txt | 127 ----------- ...i-cloud-manager-metrics-databases-list.txt | 90 -------- ...ngocli-cloud-manager-metrics-databases.txt | 61 ------ ...i-cloud-manager-metrics-disks-describe.txt | 127 ----------- ...gocli-cloud-manager-metrics-disks-list.txt | 90 -------- .../mongocli-cloud-manager-metrics-disks.txt | 61 ------ ...mongocli-cloud-manager-metrics-process.txt | 115 ---------- .../mongocli-cloud-manager-metrics.txt | 63 ------ ...gocli-cloud-manager-monitoring-disable.txt | 78 ------- ...ngocli-cloud-manager-monitoring-enable.txt | 78 ------- ...mongocli-cloud-manager-monitoring-stop.txt | 82 ------- .../mongocli-cloud-manager-monitoring.txt | 63 ------ ...ger-performanceAdvisor-namespaces-list.txt | 95 -------- ...-manager-performanceAdvisor-namespaces.txt | 59 ----- ...Advisor-slowOperationThreshold-disable.txt | 66 ------ ...eAdvisor-slowOperationThreshold-enable.txt | 66 ------ ...formanceAdvisor-slowOperationThreshold.txt | 61 ------ ...-performanceAdvisor-slowQueryLogs-list.txt | 103 --------- ...nager-performanceAdvisor-slowQueryLogs.txt | 59 ----- ...rformanceAdvisor-suggestedIndexes-list.txt | 105 --------- ...er-performanceAdvisor-suggestedIndexes.txt | 59 ----- ...gocli-cloud-manager-performanceAdvisor.txt | 65 ------ ...gocli-cloud-manager-processes-describe.txt | 82 ------- .../mongocli-cloud-manager-processes-list.txt | 78 ------- .../mongocli-cloud-manager-processes.txt | 61 ------ ...mongocli-cloud-manager-security-enable.txt | 78 ------- .../mongocli-cloud-manager-security.txt | 59 ----- .../mongocli-cloud-manager-servers-list.txt | 74 ------- .../mongocli-cloud-manager-servers.txt | 59 ----- .../command/mongocli-cloud-manager.txt | 91 -------- .../command/mongocli-completion-bash.txt | 76 ------- .../command/mongocli-completion-fish.txt | 75 ------- .../mongocli-completion-powershell.txt | 72 ------- .../command/mongocli-completion-zsh.txt | 86 -------- docs/mongocli/command/mongocli-completion.txt | 69 ------ .../command/mongocli-config-delete.txt | 101 --------- .../command/mongocli-config-describe.txt | 78 ------- .../mongocli/command/mongocli-config-edit.txt | 73 ------- .../mongocli/command/mongocli-config-list.txt | 70 ------ .../command/mongocli-config-rename.txt | 85 -------- docs/mongocli/command/mongocli-config-set.txt | 88 -------- docs/mongocli/command/mongocli-config.txt | 117 ---------- .../mongocli-iam-globalAccessLists-create.txt | 77 ------- .../mongocli-iam-globalAccessLists-delete.txt | 85 -------- ...ongocli-iam-globalAccessLists-describe.txt | 85 -------- .../mongocli-iam-globalAccessLists-list.txt | 88 -------- .../mongocli-iam-globalAccessLists.txt | 65 ------ .../mongocli-iam-globalApiKeys-create.txt | 77 ------- .../mongocli-iam-globalApiKeys-delete.txt | 85 -------- .../mongocli-iam-globalApiKeys-describe.txt | 85 -------- .../mongocli-iam-globalApiKeys-list.txt | 77 ------- .../mongocli-iam-globalApiKeys-update.txt | 93 -------- .../command/mongocli-iam-globalApiKeys.txt | 67 ------ ...ganizations-apiKeys-accessLists-create.txt | 103 --------- ...ganizations-apiKeys-accessLists-delete.txt | 105 --------- ...organizations-apiKeys-accessLists-list.txt | 101 --------- ...-iam-organizations-apiKeys-accessLists.txt | 63 ------ ...gocli-iam-organizations-apiKeys-assign.txt | 113 ---------- ...gocli-iam-organizations-apiKeys-create.txt | 97 --------- ...gocli-iam-organizations-apiKeys-delete.txt | 103 --------- ...cli-iam-organizations-apiKeys-describe.txt | 104 --------- ...ongocli-iam-organizations-apiKeys-list.txt | 83 ------- .../mongocli-iam-organizations-apiKeys.txt | 69 ------ .../mongocli-iam-organizations-create.txt | 95 -------- .../mongocli-iam-organizations-delete.txt | 99 --------- .../mongocli-iam-organizations-describe.txt | 98 --------- ...i-iam-organizations-invitations-delete.txt | 101 --------- ...iam-organizations-invitations-describe.txt | 102 --------- ...i-iam-organizations-invitations-invite.txt | 99 --------- ...cli-iam-organizations-invitations-list.txt | 79 ------- ...i-iam-organizations-invitations-update.txt | 117 ---------- ...mongocli-iam-organizations-invitations.txt | 69 ------ .../mongocli-iam-organizations-list.txt | 104 --------- .../mongocli-iam-organizations-users-list.txt | 94 -------- .../mongocli-iam-organizations-users.txt | 59 ----- .../command/mongocli-iam-organizations.txt | 73 ------- .../mongocli-iam-projects-apiKeys-assign.txt | 97 --------- .../mongocli-iam-projects-apiKeys-create.txt | 97 --------- .../mongocli-iam-projects-apiKeys-delete.txt | 105 --------- .../mongocli-iam-projects-apiKeys-list.txt | 83 ------- .../command/mongocli-iam-projects-apiKeys.txt | 65 ------ .../command/mongocli-iam-projects-create.txt | 115 ---------- .../command/mongocli-iam-projects-delete.txt | 97 --------- .../mongocli-iam-projects-describe.txt | 98 --------- ...ngocli-iam-projects-invitations-delete.txt | 101 --------- ...ocli-iam-projects-invitations-describe.txt | 102 --------- ...ngocli-iam-projects-invitations-invite.txt | 99 --------- ...mongocli-iam-projects-invitations-list.txt | 79 ------- ...ngocli-iam-projects-invitations-update.txt | 117 ---------- .../mongocli-iam-projects-invitations.txt | 69 ------ .../command/mongocli-iam-projects-list.txt | 94 -------- .../mongocli-iam-projects-teams-add.txt | 97 --------- .../mongocli-iam-projects-teams-delete.txt | 103 --------- .../mongocli-iam-projects-teams-list.txt | 94 -------- .../mongocli-iam-projects-teams-update.txt | 105 --------- .../command/mongocli-iam-projects-teams.txt | 65 ------ .../mongocli-iam-projects-users-delete.txt | 103 --------- .../mongocli-iam-projects-users-list.txt | 83 ------- .../command/mongocli-iam-projects-users.txt | 61 ------ .../command/mongocli-iam-projects.txt | 75 ------- .../command/mongocli-iam-teams-create.txt | 105 --------- .../command/mongocli-iam-teams-delete.txt | 101 --------- .../command/mongocli-iam-teams-describe.txt | 102 --------- .../command/mongocli-iam-teams-list.txt | 83 ------- .../command/mongocli-iam-teams-users-add.txt | 97 --------- .../mongocli-iam-teams-users-delete.txt | 105 --------- .../command/mongocli-iam-teams-users-list.txt | 79 ------- .../command/mongocli-iam-teams-users.txt | 65 ------ docs/mongocli/command/mongocli-iam-teams.txt | 69 ------ .../command/mongocli-iam-users-delete.txt | 95 -------- .../command/mongocli-iam-users-describe.txt | 98 --------- .../command/mongocli-iam-users-invite.txt | 113 ---------- docs/mongocli/command/mongocli-iam-users.txt | 65 ------ docs/mongocli/command/mongocli-iam.txt | 71 ------ ...nager-admin-backups-blockstores-create.txt | 98 --------- ...nager-admin-backups-blockstores-delete.txt | 78 ------- ...ger-admin-backups-blockstores-describe.txt | 78 ------- ...manager-admin-backups-blockstores-list.txt | 70 ------ ...nager-admin-backups-blockstores-update.txt | 110 ---------- ...-ops-manager-admin-backups-blockstores.txt | 67 ------ ...nager-admin-backups-fileSystems-create.txt | 94 -------- ...nager-admin-backups-fileSystems-delete.txt | 78 ------- ...ger-admin-backups-fileSystems-describe.txt | 78 ------- ...manager-admin-backups-fileSystems-list.txt | 70 ------ ...nager-admin-backups-fileSystems-update.txt | 106 --------- ...-ops-manager-admin-backups-fileSystems.txt | 67 ------ ...ops-manager-admin-backups-oplog-create.txt | 94 -------- ...ops-manager-admin-backups-oplog-delete.txt | 78 ------- ...s-manager-admin-backups-oplog-describe.txt | 78 ------- ...i-ops-manager-admin-backups-oplog-list.txt | 70 ------ ...ops-manager-admin-backups-oplog-update.txt | 106 --------- ...ngocli-ops-manager-admin-backups-oplog.txt | 67 ------ ...li-ops-manager-admin-backups-s3-create.txt | 130 ----------- ...li-ops-manager-admin-backups-s3-delete.txt | 78 ------- ...-ops-manager-admin-backups-s3-describe.txt | 78 ------- ...ocli-ops-manager-admin-backups-s3-list.txt | 70 ------ ...li-ops-manager-admin-backups-s3-update.txt | 142 ------------ .../mongocli-ops-manager-admin-backups-s3.txt | 67 ------ ...-ops-manager-admin-backups-sync-create.txt | 98 --------- ...-ops-manager-admin-backups-sync-delete.txt | 78 ------- ...ps-manager-admin-backups-sync-describe.txt | 78 ------- ...li-ops-manager-admin-backups-sync-list.txt | 70 ------ ...-ops-manager-admin-backups-sync-update.txt | 110 ---------- ...ongocli-ops-manager-admin-backups-sync.txt | 67 ------ .../mongocli-ops-manager-admin-backups.txt | 67 ------ .../command/mongocli-ops-manager-admin.txt | 59 ----- ...ocli-ops-manager-agents-apiKeys-create.txt | 70 ------ ...ocli-ops-manager-agents-apiKeys-delete.txt | 82 ------- ...ngocli-ops-manager-agents-apiKeys-list.txt | 66 ------ .../mongocli-ops-manager-agents-apiKeys.txt | 63 ------ .../mongocli-ops-manager-agents-list.txt | 90 -------- .../mongocli-ops-manager-agents-upgrade.txt | 66 ------ ...gocli-ops-manager-agents-versions-list.txt | 66 ------ .../mongocli-ops-manager-agents-versions.txt | 59 ----- .../command/mongocli-ops-manager-agents.txt | 65 ------ ...ongocli-ops-manager-alerts-acknowledge.txt | 103 --------- .../mongocli-ops-manager-alerts-describe.txt | 102 --------- ...ongocli-ops-manager-alerts-global-list.txt | 74 ------- .../mongocli-ops-manager-alerts-global.txt | 59 ----- .../mongocli-ops-manager-alerts-list.txt | 98 --------- ...cli-ops-manager-alerts-settings-create.txt | 188 ---------------- ...cli-ops-manager-alerts-settings-delete.txt | 101 --------- ...li-ops-manager-alerts-settings-disable.txt | 89 -------- ...cli-ops-manager-alerts-settings-enable.txt | 82 ------- ...ps-manager-alerts-settings-fields-type.txt | 71 ------ ...cli-ops-manager-alerts-settings-fields.txt | 59 ----- ...gocli-ops-manager-alerts-settings-list.txt | 83 ------- ...cli-ops-manager-alerts-settings-update.txt | 204 ------------------ .../mongocli-ops-manager-alerts-settings.txt | 73 ------- ...gocli-ops-manager-alerts-unacknowledge.txt | 95 -------- .../command/mongocli-ops-manager-alerts.txt | 69 ------ ...ngocli-ops-manager-automation-describe.txt | 66 ------ ...mongocli-ops-manager-automation-status.txt | 66 ------ ...mongocli-ops-manager-automation-update.txt | 66 ------ .../mongocli-ops-manager-automation-watch.txt | 73 ------- .../mongocli-ops-manager-automation.txt | 65 ------ ...i-ops-manager-backups-checkpoints-list.txt | 90 -------- ...ngocli-ops-manager-backups-checkpoints.txt | 59 ----- ...li-ops-manager-backups-config-describe.txt | 82 ------- ...ngocli-ops-manager-backups-config-list.txt | 74 ------- ...ocli-ops-manager-backups-config-update.txt | 126 ----------- .../mongocli-ops-manager-backups-config.txt | 63 ------ .../mongocli-ops-manager-backups-disable.txt | 78 ------- .../mongocli-ops-manager-backups-enable.txt | 78 ------- ...ocli-ops-manager-backups-restores-list.txt | 90 -------- ...cli-ops-manager-backups-restores-start.txt | 126 ----------- .../mongocli-ops-manager-backups-restores.txt | 61 ------ ...cli-ops-manager-backups-snapshots-list.txt | 90 -------- ...er-backups-snapshots-schedule-describe.txt | 70 ------ ...ager-backups-snapshots-schedule-update.txt | 110 ---------- ...ops-manager-backups-snapshots-schedule.txt | 61 ------ ...mongocli-ops-manager-backups-snapshots.txt | 61 ------ .../command/mongocli-ops-manager-backups.txt | 69 ------ .../mongocli-ops-manager-clusters-apply.txt | 66 ------ .../mongocli-ops-manager-clusters-create.txt | 66 ------ .../mongocli-ops-manager-clusters-delete.txt | 82 ------- ...mongocli-ops-manager-clusters-describe.txt | 85 -------- ...li-ops-manager-clusters-indexes-create.txt | 145 ------------- .../mongocli-ops-manager-clusters-indexes.txt | 59 ----- .../mongocli-ops-manager-clusters-list.txt | 69 ------ ...-ops-manager-clusters-reclaimFreeSpace.txt | 92 -------- .../mongocli-ops-manager-clusters-restart.txt | 86 -------- .../mongocli-ops-manager-clusters-resync.txt | 100 --------- ...mongocli-ops-manager-clusters-shutdown.txt | 86 -------- .../mongocli-ops-manager-clusters-startup.txt | 86 -------- ...mongocli-ops-manager-clusters-unmanage.txt | 84 -------- .../mongocli-ops-manager-clusters-update.txt | 66 ------ .../command/mongocli-ops-manager-clusters.txt | 83 ------- .../mongocli-ops-manager-dbusers-create.txt | 93 -------- .../mongocli-ops-manager-dbusers-delete.txt | 86 -------- .../mongocli-ops-manager-dbusers-list.txt | 66 ------ .../command/mongocli-ops-manager-dbusers.txt | 67 ------ ...-ops-manager-diagnoseArchives-download.txt | 74 ------- .../mongocli-ops-manager-diagnoseArchives.txt | 59 ----- ...-ops-manager-events-organizations-list.txt | 93 -------- ...gocli-ops-manager-events-organizations.txt | 61 ------ ...gocli-ops-manager-events-projects-list.txt | 93 -------- .../mongocli-ops-manager-events-projects.txt | 61 ------ .../command/mongocli-ops-manager-events.txt | 61 ------ ...gocli-ops-manager-featurePolicies-list.txt | 74 ------- ...cli-ops-manager-featurePolicies-update.txt | 98 --------- .../mongocli-ops-manager-featurePolicies.txt | 61 ------ ...ops-manager-liveMigrations-link-create.txt | 66 ------ ...ops-manager-liveMigrations-link-delete.txt | 66 ------ ...s-manager-liveMigrations-link-describe.txt | 66 ------ ...ngocli-ops-manager-liveMigrations-link.txt | 63 ------ .../mongocli-ops-manager-liveMigrations.txt | 59 ----- .../mongocli-ops-manager-logs-decrypt.txt | 106 --------- ...mongocli-ops-manager-logs-jobs-collect.txt | 98 --------- .../mongocli-ops-manager-logs-jobs-delete.txt | 82 ------- ...ongocli-ops-manager-logs-jobs-download.txt | 86 -------- .../mongocli-ops-manager-logs-jobs-list.txt | 70 ------ .../mongocli-ops-manager-logs-jobs.txt | 65 ------ ...cli-ops-manager-logs-keyProviders-list.txt | 73 ------- ...mongocli-ops-manager-logs-keyProviders.txt | 59 ----- .../command/mongocli-ops-manager-logs.txt | 63 ------ ...-ops-manager-maintenanceWindows-create.txt | 82 ------- ...-ops-manager-maintenanceWindows-delete.txt | 82 ------- ...ps-manager-maintenanceWindows-describe.txt | 82 ------- ...li-ops-manager-maintenanceWindows-list.txt | 66 ------ ...-ops-manager-maintenanceWindows-update.txt | 98 --------- ...ongocli-ops-manager-maintenanceWindows.txt | 67 ------ ...ops-manager-metrics-databases-describe.txt | 127 ----------- ...cli-ops-manager-metrics-databases-list.txt | 90 -------- ...mongocli-ops-manager-metrics-databases.txt | 61 ------ ...cli-ops-manager-metrics-disks-describe.txt | 127 ----------- ...ongocli-ops-manager-metrics-disks-list.txt | 90 -------- .../mongocli-ops-manager-metrics-disks.txt | 61 ------ .../mongocli-ops-manager-metrics-process.txt | 115 ---------- .../command/mongocli-ops-manager-metrics.txt | 63 ------ ...ongocli-ops-manager-monitoring-disable.txt | 78 ------- ...mongocli-ops-manager-monitoring-enable.txt | 78 ------- .../mongocli-ops-manager-monitoring-stop.txt | 82 ------- .../mongocli-ops-manager-monitoring.txt | 63 ------ .../mongocli-ops-manager-owner-create.txt | 84 -------- .../command/mongocli-ops-manager-owner.txt | 59 ----- ...ger-performanceAdvisor-namespaces-list.txt | 95 -------- ...-manager-performanceAdvisor-namespaces.txt | 59 ----- ...Advisor-slowOperationThreshold-disable.txt | 66 ------ ...eAdvisor-slowOperationThreshold-enable.txt | 66 ------ ...formanceAdvisor-slowOperationThreshold.txt | 61 ------ ...-performanceAdvisor-slowQueryLogs-list.txt | 103 --------- ...nager-performanceAdvisor-slowQueryLogs.txt | 59 ----- ...rformanceAdvisor-suggestedIndexes-list.txt | 105 --------- ...er-performanceAdvisor-suggestedIndexes.txt | 59 ----- ...ongocli-ops-manager-performanceAdvisor.txt | 65 ------ ...ongocli-ops-manager-processes-describe.txt | 82 ------- .../mongocli-ops-manager-processes-list.txt | 78 ------- .../mongocli-ops-manager-processes.txt | 61 ------ .../mongocli-ops-manager-security-enable.txt | 78 ------- .../command/mongocli-ops-manager-security.txt | 59 ----- ...ngocli-ops-manager-serverUsage-capture.txt | 58 ----- ...gocli-ops-manager-serverUsage-download.txt | 88 -------- ...r-serverUsage-organizations-hosts-list.txt | 82 ------- ...anager-serverUsage-organizations-hosts.txt | 59 ----- ...sage-organizations-serverType-describe.txt | 66 ------ ...rverUsage-organizations-serverType-set.txt | 78 ------- ...r-serverUsage-organizations-serverType.txt | 61 ------ ...-ops-manager-serverUsage-organizations.txt | 61 ------ ...anager-serverUsage-projects-hosts-list.txt | 82 ------- ...ops-manager-serverUsage-projects-hosts.txt | 59 ----- ...rverUsage-projects-serverType-describe.txt | 66 ------ ...er-serverUsage-projects-serverType-set.txt | 78 ------- ...anager-serverUsage-projects-serverType.txt | 61 ------ ...gocli-ops-manager-serverUsage-projects.txt | 61 ------ .../mongocli-ops-manager-serverUsage.txt | 65 ------ .../mongocli-ops-manager-servers-list.txt | 74 ------- .../command/mongocli-ops-manager-servers.txt | 59 ----- ...li-ops-manager-softwareComponents-list.txt | 62 ------ ...ongocli-ops-manager-softwareComponents.txt | 59 ----- ...cli-ops-manager-versionManifest-update.txt | 82 ------- .../mongocli-ops-manager-versionManifest.txt | 59 ----- .../mongocli/command/mongocli-ops-manager.txt | 103 --------- docs/mongocli/command/mongocli.txt | 67 ------ 392 files changed, 31902 deletions(-) delete mode 100644 docs/mongocli/command/mongocli-auth-login.txt delete mode 100644 docs/mongocli/command/mongocli-auth-logout.txt delete mode 100644 docs/mongocli/command/mongocli-auth-whoami.txt delete mode 100644 docs/mongocli/command/mongocli-auth.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-agents-apiKeys-create.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-agents-apiKeys-delete.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-agents-apiKeys-list.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-agents-apiKeys.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-agents-list.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-agents-upgrade.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-agents-versions-list.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-agents-versions.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-agents.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-alerts-acknowledge.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-alerts-describe.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-alerts-global-list.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-alerts-global.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-alerts-list.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-alerts-settings-create.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-alerts-settings-delete.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-alerts-settings-disable.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-alerts-settings-enable.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-alerts-settings-fields-type.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-alerts-settings-fields.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-alerts-settings-list.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-alerts-settings-update.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-alerts-settings.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-alerts-unacknowledge.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-alerts.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-automation-describe.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-automation-status.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-automation-update.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-automation-watch.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-automation.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-backups-checkpoints-list.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-backups-checkpoints.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-backups-config-describe.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-backups-config-list.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-backups-config-update.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-backups-config.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-backups-disable.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-backups-enable.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-backups-restores-list.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-backups-restores-start.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-backups-restores.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-backups-snapshots-list.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-backups-snapshots-schedule-describe.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-backups-snapshots-schedule-update.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-backups-snapshots-schedule.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-backups-snapshots.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-backups.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-clusters-apply.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-clusters-create.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-clusters-delete.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-clusters-describe.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-clusters-indexes-create.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-clusters-indexes.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-clusters-list.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-clusters-reclaimFreeSpace.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-clusters-restart.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-clusters-resync.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-clusters-shutdown.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-clusters-startup.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-clusters-unmanage.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-clusters-update.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-clusters.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-dbusers-create.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-dbusers-delete.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-dbusers-list.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-dbusers.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-events-organizations-list.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-events-organizations.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-events-projects-list.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-events-projects.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-events.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-featurePolicies-list.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-featurePolicies-update.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-featurePolicies.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-liveMigrations-link-create.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-liveMigrations-link-delete.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-liveMigrations-link-describe.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-liveMigrations-link.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-liveMigrations.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-logs-decrypt.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-logs-jobs-collect.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-logs-jobs-delete.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-logs-jobs-download.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-logs-jobs-list.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-logs-jobs.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-logs-keyProviders-list.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-logs-keyProviders.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-logs.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-maintenanceWindows-create.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-maintenanceWindows-delete.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-maintenanceWindows-describe.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-maintenanceWindows-list.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-maintenanceWindows-update.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-maintenanceWindows.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-metrics-databases-describe.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-metrics-databases-list.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-metrics-databases.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-metrics-disks-describe.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-metrics-disks-list.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-metrics-disks.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-metrics-process.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-metrics.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-monitoring-disable.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-monitoring-enable.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-monitoring-stop.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-monitoring.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-performanceAdvisor-namespaces-list.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-performanceAdvisor-namespaces.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-performanceAdvisor-slowOperationThreshold-disable.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-performanceAdvisor-slowOperationThreshold-enable.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-performanceAdvisor-slowOperationThreshold.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-performanceAdvisor-slowQueryLogs-list.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-performanceAdvisor-slowQueryLogs.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-performanceAdvisor-suggestedIndexes-list.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-performanceAdvisor-suggestedIndexes.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-performanceAdvisor.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-processes-describe.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-processes-list.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-processes.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-security-enable.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-security.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-servers-list.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager-servers.txt delete mode 100644 docs/mongocli/command/mongocli-cloud-manager.txt delete mode 100644 docs/mongocli/command/mongocli-completion-bash.txt delete mode 100644 docs/mongocli/command/mongocli-completion-fish.txt delete mode 100644 docs/mongocli/command/mongocli-completion-powershell.txt delete mode 100644 docs/mongocli/command/mongocli-completion-zsh.txt delete mode 100644 docs/mongocli/command/mongocli-completion.txt delete mode 100644 docs/mongocli/command/mongocli-config-delete.txt delete mode 100644 docs/mongocli/command/mongocli-config-describe.txt delete mode 100644 docs/mongocli/command/mongocli-config-edit.txt delete mode 100644 docs/mongocli/command/mongocli-config-list.txt delete mode 100644 docs/mongocli/command/mongocli-config-rename.txt delete mode 100644 docs/mongocli/command/mongocli-config-set.txt delete mode 100644 docs/mongocli/command/mongocli-config.txt delete mode 100644 docs/mongocli/command/mongocli-iam-globalAccessLists-create.txt delete mode 100644 docs/mongocli/command/mongocli-iam-globalAccessLists-delete.txt delete mode 100644 docs/mongocli/command/mongocli-iam-globalAccessLists-describe.txt delete mode 100644 docs/mongocli/command/mongocli-iam-globalAccessLists-list.txt delete mode 100644 docs/mongocli/command/mongocli-iam-globalAccessLists.txt delete mode 100644 docs/mongocli/command/mongocli-iam-globalApiKeys-create.txt delete mode 100644 docs/mongocli/command/mongocli-iam-globalApiKeys-delete.txt delete mode 100644 docs/mongocli/command/mongocli-iam-globalApiKeys-describe.txt delete mode 100644 docs/mongocli/command/mongocli-iam-globalApiKeys-list.txt delete mode 100644 docs/mongocli/command/mongocli-iam-globalApiKeys-update.txt delete mode 100644 docs/mongocli/command/mongocli-iam-globalApiKeys.txt delete mode 100644 docs/mongocli/command/mongocli-iam-organizations-apiKeys-accessLists-create.txt delete mode 100644 docs/mongocli/command/mongocli-iam-organizations-apiKeys-accessLists-delete.txt delete mode 100644 docs/mongocli/command/mongocli-iam-organizations-apiKeys-accessLists-list.txt delete mode 100644 docs/mongocli/command/mongocli-iam-organizations-apiKeys-accessLists.txt delete mode 100644 docs/mongocli/command/mongocli-iam-organizations-apiKeys-assign.txt delete mode 100644 docs/mongocli/command/mongocli-iam-organizations-apiKeys-create.txt delete mode 100644 docs/mongocli/command/mongocli-iam-organizations-apiKeys-delete.txt delete mode 100644 docs/mongocli/command/mongocli-iam-organizations-apiKeys-describe.txt delete mode 100644 docs/mongocli/command/mongocli-iam-organizations-apiKeys-list.txt delete mode 100644 docs/mongocli/command/mongocli-iam-organizations-apiKeys.txt delete mode 100644 docs/mongocli/command/mongocli-iam-organizations-create.txt delete mode 100644 docs/mongocli/command/mongocli-iam-organizations-delete.txt delete mode 100644 docs/mongocli/command/mongocli-iam-organizations-describe.txt delete mode 100644 docs/mongocli/command/mongocli-iam-organizations-invitations-delete.txt delete mode 100644 docs/mongocli/command/mongocli-iam-organizations-invitations-describe.txt delete mode 100644 docs/mongocli/command/mongocli-iam-organizations-invitations-invite.txt delete mode 100644 docs/mongocli/command/mongocli-iam-organizations-invitations-list.txt delete mode 100644 docs/mongocli/command/mongocli-iam-organizations-invitations-update.txt delete mode 100644 docs/mongocli/command/mongocli-iam-organizations-invitations.txt delete mode 100644 docs/mongocli/command/mongocli-iam-organizations-list.txt delete mode 100644 docs/mongocli/command/mongocli-iam-organizations-users-list.txt delete mode 100644 docs/mongocli/command/mongocli-iam-organizations-users.txt delete mode 100644 docs/mongocli/command/mongocli-iam-organizations.txt delete mode 100644 docs/mongocli/command/mongocli-iam-projects-apiKeys-assign.txt delete mode 100644 docs/mongocli/command/mongocli-iam-projects-apiKeys-create.txt delete mode 100644 docs/mongocli/command/mongocli-iam-projects-apiKeys-delete.txt delete mode 100644 docs/mongocli/command/mongocli-iam-projects-apiKeys-list.txt delete mode 100644 docs/mongocli/command/mongocli-iam-projects-apiKeys.txt delete mode 100644 docs/mongocli/command/mongocli-iam-projects-create.txt delete mode 100644 docs/mongocli/command/mongocli-iam-projects-delete.txt delete mode 100644 docs/mongocli/command/mongocli-iam-projects-describe.txt delete mode 100644 docs/mongocli/command/mongocli-iam-projects-invitations-delete.txt delete mode 100644 docs/mongocli/command/mongocli-iam-projects-invitations-describe.txt delete mode 100644 docs/mongocli/command/mongocli-iam-projects-invitations-invite.txt delete mode 100644 docs/mongocli/command/mongocli-iam-projects-invitations-list.txt delete mode 100644 docs/mongocli/command/mongocli-iam-projects-invitations-update.txt delete mode 100644 docs/mongocli/command/mongocli-iam-projects-invitations.txt delete mode 100644 docs/mongocli/command/mongocli-iam-projects-list.txt delete mode 100644 docs/mongocli/command/mongocli-iam-projects-teams-add.txt delete mode 100644 docs/mongocli/command/mongocli-iam-projects-teams-delete.txt delete mode 100644 docs/mongocli/command/mongocli-iam-projects-teams-list.txt delete mode 100644 docs/mongocli/command/mongocli-iam-projects-teams-update.txt delete mode 100644 docs/mongocli/command/mongocli-iam-projects-teams.txt delete mode 100644 docs/mongocli/command/mongocli-iam-projects-users-delete.txt delete mode 100644 docs/mongocli/command/mongocli-iam-projects-users-list.txt delete mode 100644 docs/mongocli/command/mongocli-iam-projects-users.txt delete mode 100644 docs/mongocli/command/mongocli-iam-projects.txt delete mode 100644 docs/mongocli/command/mongocli-iam-teams-create.txt delete mode 100644 docs/mongocli/command/mongocli-iam-teams-delete.txt delete mode 100644 docs/mongocli/command/mongocli-iam-teams-describe.txt delete mode 100644 docs/mongocli/command/mongocli-iam-teams-list.txt delete mode 100644 docs/mongocli/command/mongocli-iam-teams-users-add.txt delete mode 100644 docs/mongocli/command/mongocli-iam-teams-users-delete.txt delete mode 100644 docs/mongocli/command/mongocli-iam-teams-users-list.txt delete mode 100644 docs/mongocli/command/mongocli-iam-teams-users.txt delete mode 100644 docs/mongocli/command/mongocli-iam-teams.txt delete mode 100644 docs/mongocli/command/mongocli-iam-users-delete.txt delete mode 100644 docs/mongocli/command/mongocli-iam-users-describe.txt delete mode 100644 docs/mongocli/command/mongocli-iam-users-invite.txt delete mode 100644 docs/mongocli/command/mongocli-iam-users.txt delete mode 100644 docs/mongocli/command/mongocli-iam.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-admin-backups-blockstores-create.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-admin-backups-blockstores-delete.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-admin-backups-blockstores-describe.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-admin-backups-blockstores-list.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-admin-backups-blockstores-update.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-admin-backups-blockstores.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-admin-backups-fileSystems-create.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-admin-backups-fileSystems-delete.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-admin-backups-fileSystems-describe.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-admin-backups-fileSystems-list.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-admin-backups-fileSystems-update.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-admin-backups-fileSystems.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-admin-backups-oplog-create.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-admin-backups-oplog-delete.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-admin-backups-oplog-describe.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-admin-backups-oplog-list.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-admin-backups-oplog-update.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-admin-backups-oplog.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-admin-backups-s3-create.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-admin-backups-s3-delete.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-admin-backups-s3-describe.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-admin-backups-s3-list.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-admin-backups-s3-update.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-admin-backups-s3.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-admin-backups-sync-create.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-admin-backups-sync-delete.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-admin-backups-sync-describe.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-admin-backups-sync-list.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-admin-backups-sync-update.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-admin-backups-sync.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-admin-backups.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-admin.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-agents-apiKeys-create.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-agents-apiKeys-delete.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-agents-apiKeys-list.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-agents-apiKeys.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-agents-list.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-agents-upgrade.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-agents-versions-list.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-agents-versions.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-agents.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-alerts-acknowledge.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-alerts-describe.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-alerts-global-list.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-alerts-global.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-alerts-list.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-alerts-settings-create.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-alerts-settings-delete.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-alerts-settings-disable.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-alerts-settings-enable.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-alerts-settings-fields-type.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-alerts-settings-fields.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-alerts-settings-list.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-alerts-settings-update.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-alerts-settings.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-alerts-unacknowledge.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-alerts.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-automation-describe.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-automation-status.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-automation-update.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-automation-watch.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-automation.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-backups-checkpoints-list.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-backups-checkpoints.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-backups-config-describe.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-backups-config-list.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-backups-config-update.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-backups-config.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-backups-disable.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-backups-enable.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-backups-restores-list.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-backups-restores-start.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-backups-restores.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-backups-snapshots-list.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-backups-snapshots-schedule-describe.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-backups-snapshots-schedule-update.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-backups-snapshots-schedule.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-backups-snapshots.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-backups.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-clusters-apply.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-clusters-create.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-clusters-delete.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-clusters-describe.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-clusters-indexes-create.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-clusters-indexes.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-clusters-list.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-clusters-reclaimFreeSpace.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-clusters-restart.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-clusters-resync.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-clusters-shutdown.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-clusters-startup.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-clusters-unmanage.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-clusters-update.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-clusters.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-dbusers-create.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-dbusers-delete.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-dbusers-list.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-dbusers.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-diagnoseArchives-download.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-diagnoseArchives.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-events-organizations-list.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-events-organizations.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-events-projects-list.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-events-projects.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-events.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-featurePolicies-list.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-featurePolicies-update.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-featurePolicies.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-liveMigrations-link-create.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-liveMigrations-link-delete.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-liveMigrations-link-describe.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-liveMigrations-link.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-liveMigrations.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-logs-decrypt.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-logs-jobs-collect.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-logs-jobs-delete.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-logs-jobs-download.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-logs-jobs-list.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-logs-jobs.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-logs-keyProviders-list.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-logs-keyProviders.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-logs.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-maintenanceWindows-create.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-maintenanceWindows-delete.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-maintenanceWindows-describe.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-maintenanceWindows-list.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-maintenanceWindows-update.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-maintenanceWindows.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-metrics-databases-describe.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-metrics-databases-list.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-metrics-databases.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-metrics-disks-describe.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-metrics-disks-list.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-metrics-disks.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-metrics-process.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-metrics.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-monitoring-disable.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-monitoring-enable.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-monitoring-stop.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-monitoring.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-owner-create.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-owner.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-performanceAdvisor-namespaces-list.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-performanceAdvisor-namespaces.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-performanceAdvisor-slowOperationThreshold-disable.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-performanceAdvisor-slowOperationThreshold-enable.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-performanceAdvisor-slowOperationThreshold.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-performanceAdvisor-slowQueryLogs-list.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-performanceAdvisor-slowQueryLogs.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-performanceAdvisor-suggestedIndexes-list.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-performanceAdvisor-suggestedIndexes.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-performanceAdvisor.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-processes-describe.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-processes-list.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-processes.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-security-enable.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-security.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-serverUsage-capture.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-serverUsage-download.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-serverUsage-organizations-hosts-list.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-serverUsage-organizations-hosts.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-serverUsage-organizations-serverType-describe.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-serverUsage-organizations-serverType-set.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-serverUsage-organizations-serverType.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-serverUsage-organizations.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-serverUsage-projects-hosts-list.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-serverUsage-projects-hosts.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-serverUsage-projects-serverType-describe.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-serverUsage-projects-serverType-set.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-serverUsage-projects-serverType.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-serverUsage-projects.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-serverUsage.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-servers-list.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-servers.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-softwareComponents-list.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-softwareComponents.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-versionManifest-update.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager-versionManifest.txt delete mode 100644 docs/mongocli/command/mongocli-ops-manager.txt delete mode 100644 docs/mongocli/command/mongocli.txt diff --git a/docs/mongocli/command/mongocli-auth-login.txt b/docs/mongocli/command/mongocli-auth-login.txt deleted file mode 100644 index e531584850..0000000000 --- a/docs/mongocli/command/mongocli-auth-login.txt +++ /dev/null @@ -1,78 +0,0 @@ -.. _mongocli-auth-login: - -=================== -mongocli auth login -=================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Authenticate with MongoDB Atlas. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli auth login [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 - * - --cm - - - - false - - Log in to Cloud Manager. - * - --gov - - - - false - - Log in to Atlas for Government. - * - -h, --help - - - - false - - help for login - * - --noBrowser - - - - false - - Don't try to open a browser session. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - # Log in to your MongoDB Atlas or Cloud Manager account in interactive mode: - mongocli auth login - diff --git a/docs/mongocli/command/mongocli-auth-logout.txt b/docs/mongocli/command/mongocli-auth-logout.txt deleted file mode 100644 index 5470ddc6c0..0000000000 --- a/docs/mongocli/command/mongocli-auth-logout.txt +++ /dev/null @@ -1,70 +0,0 @@ -.. _mongocli-auth-logout: - -==================== -mongocli auth logout -==================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Log out of the CLI. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli auth logout [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 logout - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - # To log out from the CLI: - mongocli auth logout - diff --git a/docs/mongocli/command/mongocli-auth-whoami.txt b/docs/mongocli/command/mongocli-auth-whoami.txt deleted file mode 100644 index e277501d7e..0000000000 --- a/docs/mongocli/command/mongocli-auth-whoami.txt +++ /dev/null @@ -1,66 +0,0 @@ -.. _mongocli-auth-whoami: - -==================== -mongocli auth whoami -==================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Verifies and displays information about your authentication state. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli auth whoami [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 whoami - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - # See the logged account: - mongocli auth whoami - diff --git a/docs/mongocli/command/mongocli-auth.txt b/docs/mongocli/command/mongocli-auth.txt deleted file mode 100644 index 12d7cfa956..0000000000 --- a/docs/mongocli/command/mongocli-auth.txt +++ /dev/null @@ -1,63 +0,0 @@ -.. _mongocli-auth: - -============= -mongocli auth -============= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage the CLI's authentication state. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for auth - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-auth-login` - Authenticate with MongoDB Atlas. -* :ref:`mongocli-auth-logout` - Log out of the CLI. -* :ref:`mongocli-auth-whoami` - Verifies and displays information about your authentication state. - - -.. toctree:: - :titlesonly: - - login - logout - whoami - diff --git a/docs/mongocli/command/mongocli-cloud-manager-agents-apiKeys-create.txt b/docs/mongocli/command/mongocli-cloud-manager-agents-apiKeys-create.txt deleted file mode 100644 index 0caa87530f..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-agents-apiKeys-create.txt +++ /dev/null @@ -1,70 +0,0 @@ -.. _mongocli-cloud-manager-agents-apiKeys-create: - -============================================ -mongocli cloud-manager agents apiKeys create -============================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create an Agent API Key for your project. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager agents 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. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-cloud-manager-agents-apiKeys-delete.txt b/docs/mongocli/command/mongocli-cloud-manager-agents-apiKeys-delete.txt deleted file mode 100644 index 4bc05da71a..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-agents-apiKeys-delete.txt +++ /dev/null @@ -1,82 +0,0 @@ -.. _mongocli-cloud-manager-agents-apiKeys-delete: - -============================================ -mongocli cloud-manager agents apiKeys delete -============================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Delete an Agent API Key for your project. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager agents 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 - - ID of the 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-cloud-manager-agents-apiKeys-list.txt b/docs/mongocli/command/mongocli-cloud-manager-agents-apiKeys-list.txt deleted file mode 100644 index 79e89ffe50..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-agents-apiKeys-list.txt +++ /dev/null @@ -1,66 +0,0 @@ -.. _mongocli-cloud-manager-agents-apiKeys-list: - -========================================== -mongocli cloud-manager agents apiKeys list -========================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -List available MongoDB Agent API Keys for your project. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager agents 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 - * - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-cloud-manager-agents-apiKeys.txt b/docs/mongocli/command/mongocli-cloud-manager-agents-apiKeys.txt deleted file mode 100644 index e05255ea49..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-agents-apiKeys.txt +++ /dev/null @@ -1,63 +0,0 @@ -.. _mongocli-cloud-manager-agents-apiKeys: - -===================================== -mongocli cloud-manager agents apiKeys -===================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Agent 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-cloud-manager-agents-apiKeys-create` - Create an Agent API Key for your project. -* :ref:`mongocli-cloud-manager-agents-apiKeys-delete` - Delete an Agent API Key for your project. -* :ref:`mongocli-cloud-manager-agents-apiKeys-list` - List available MongoDB Agent API Keys for your project. - - -.. toctree:: - :titlesonly: - - create - delete - list - diff --git a/docs/mongocli/command/mongocli-cloud-manager-agents-list.txt b/docs/mongocli/command/mongocli-cloud-manager-agents-list.txt deleted file mode 100644 index 9bda7f50d7..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-agents-list.txt +++ /dev/null @@ -1,90 +0,0 @@ -.. _mongocli-cloud-manager-agents-list: - -================================== -mongocli cloud-manager agents list -================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -List available MongoDB Agents for your project. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager agents 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 - * - AUTOMATION|MONITORING|BACKUP - - string - - true - - Agent type - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-cloud-manager-agents-upgrade.txt b/docs/mongocli/command/mongocli-cloud-manager-agents-upgrade.txt deleted file mode 100644 index ee3b595c29..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-agents-upgrade.txt +++ /dev/null @@ -1,66 +0,0 @@ -.. _mongocli-cloud-manager-agents-upgrade: - -===================================== -mongocli cloud-manager agents upgrade -===================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Upgrade MongoDB Agents to the latest available version. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager agents upgrade [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 upgrade - * - -o, --output - - string - - false - - 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-cloud-manager-agents-versions-list.txt b/docs/mongocli/command/mongocli-cloud-manager-agents-versions-list.txt deleted file mode 100644 index 82a31d197f..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-agents-versions-list.txt +++ /dev/null @@ -1,66 +0,0 @@ -.. _mongocli-cloud-manager-agents-versions-list: - -=========================================== -mongocli cloud-manager agents versions list -=========================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -List MongoDB Agent versions in the provided project. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager agents versions 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-cloud-manager-agents-versions.txt b/docs/mongocli/command/mongocli-cloud-manager-agents-versions.txt deleted file mode 100644 index 248a24a4ac..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-agents-versions.txt +++ /dev/null @@ -1,59 +0,0 @@ -.. _mongocli-cloud-manager-agents-versions: - -====================================== -mongocli cloud-manager agents versions -====================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage MongoDB Agents versions. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for versions - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-cloud-manager-agents-versions-list` - List MongoDB Agent versions in the provided project. - - -.. toctree:: - :titlesonly: - - list - diff --git a/docs/mongocli/command/mongocli-cloud-manager-agents.txt b/docs/mongocli/command/mongocli-cloud-manager-agents.txt deleted file mode 100644 index 5560c5e613..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-agents.txt +++ /dev/null @@ -1,65 +0,0 @@ -.. _mongocli-cloud-manager-agents: - -============================= -mongocli cloud-manager agents -============================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage MongoDB Agents. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for agents - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-cloud-manager-agents-apiKeys` - Agent API Keys operations. -* :ref:`mongocli-cloud-manager-agents-list` - List available MongoDB Agents for your project. -* :ref:`mongocli-cloud-manager-agents-upgrade` - Upgrade MongoDB Agents to the latest available version. -* :ref:`mongocli-cloud-manager-agents-versions` - Manage MongoDB Agents versions. - - -.. toctree:: - :titlesonly: - - apiKeys - list - upgrade - versions - diff --git a/docs/mongocli/command/mongocli-cloud-manager-alerts-acknowledge.txt b/docs/mongocli/command/mongocli-cloud-manager-alerts-acknowledge.txt deleted file mode 100644 index d26e07d06f..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-alerts-acknowledge.txt +++ /dev/null @@ -1,103 +0,0 @@ -.. _mongocli-cloud-manager-alerts-acknowledge: - -========================================= -mongocli cloud-manager alerts acknowledge -========================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Acknowledges the specified alert 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 - - mongocli cloud-manager alerts acknowledge [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - alertId - - string - - true - - ID of the alert you want to acknowledge or unacknowledge. - -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. - * - -F, --forever - - - - false - - Option that acknowledges an alert 'forever'. You can't set both the forever option and the until option in the same command. - * - -h, --help - - - - false - - help for acknowledge - * - -o, --output - - string - - false - - 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. - * - --until - - string - - false - - ISO 8601-formatted time until which the alert is acknowledged. This command returns this value if a MongoDB user previously acknowledged the alert. After this date, the alert becomes unacknowledged. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - # Acknowledge an alert with the ID 5d1113b25a115342acc2d1aa in the project with the ID 5e2211c17a3e5a48f5497de3 until January 1 2028: - mongocli atlas alerts acknowledge 5d1113b25a115342acc2d1aa --until 2028-01-01T20:24:26Z --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/mongocli/command/mongocli-cloud-manager-alerts-describe.txt b/docs/mongocli/command/mongocli-cloud-manager-alerts-describe.txt deleted file mode 100644 index f676e5885f..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-alerts-describe.txt +++ /dev/null @@ -1,102 +0,0 @@ -.. _mongocli-cloud-manager-alerts-describe: - -====================================== -mongocli cloud-manager alerts describe -====================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return the details for the specified alert 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 - - mongocli cloud-manager alerts 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 - * - alertId - - string - - true - - Unique identifier of the alert you want to describe. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - ID TYPE METRIC STATUS - - - -Examples --------- - -.. code-block:: - - # Return the JSON-formatted details for the alert with the ID 5d1113b25a115342acc2d1aa in the project with the ID 5e2211c17a3e5a48f5497de3: - mongocli atlas alerts describe 5d1113b25a115342acc2d1aa --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/mongocli/command/mongocli-cloud-manager-alerts-global-list.txt b/docs/mongocli/command/mongocli-cloud-manager-alerts-global-list.txt deleted file mode 100644 index d393391f91..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-alerts-global-list.txt +++ /dev/null @@ -1,74 +0,0 @@ -.. _mongocli-cloud-manager-alerts-global-list: - -========================================= -mongocli cloud-manager alerts global list -========================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns all global alerts for the specified Ops Manager project. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager alerts global 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. - * - --status - - string - - false - - State of the alert. Valid values include TRACKING, OPEN, CLOSED, and CANCELLED. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-cloud-manager-alerts-global.txt b/docs/mongocli/command/mongocli-cloud-manager-alerts-global.txt deleted file mode 100644 index 7dda792f46..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-alerts-global.txt +++ /dev/null @@ -1,59 +0,0 @@ -.. _mongocli-cloud-manager-alerts-global: - -==================================== -mongocli cloud-manager alerts global -==================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Retrieves all the global alerts for the specified Ops Manager project. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for global - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-cloud-manager-alerts-global-list` - Returns all global alerts for the specified Ops Manager project. - - -.. toctree:: - :titlesonly: - - list - diff --git a/docs/mongocli/command/mongocli-cloud-manager-alerts-list.txt b/docs/mongocli/command/mongocli-cloud-manager-alerts-list.txt deleted file mode 100644 index 2bda019dc4..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-alerts-list.txt +++ /dev/null @@ -1,98 +0,0 @@ -.. _mongocli-cloud-manager-alerts-list: - -================================== -mongocli cloud-manager alerts list -================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return all alerts 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 - - mongocli cloud-manager alerts 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. - * - --status - - string - - false - - State of the alert. Valid values include TRACKING, OPEN, CLOSED, and CANCELLED. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -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 - - - -Examples --------- - -.. code-block:: - - # Return a JSON-formatted list of all alerts for the project with the ID 5e2211c17a3e5a48f5497de3: - mongocli atlas alerts list --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/mongocli/command/mongocli-cloud-manager-alerts-settings-create.txt b/docs/mongocli/command/mongocli-cloud-manager-alerts-settings-create.txt deleted file mode 100644 index 75dd6188d0..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-alerts-settings-create.txt +++ /dev/null @@ -1,188 +0,0 @@ -.. _mongocli-cloud-manager-alerts-settings-create: - -============================================= -mongocli cloud-manager alerts settings create -============================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create an alert 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 - - mongocli cloud-manager alerts settings 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 - - false - - Datadog API Key, Opsgenie API Key, or VictorOps API key. Required if the notificationType is DATADOG, OPS_GENIE, or VICTOR_OPS, respectively. - * - --enabled - - - - false - - Flag that indicates whether to enable the alert configuration. - * - --event - - string - - false - - Type of event that triggered the alert. To learn which values the CLI accepts, see the possible eventTypeName values in the API documentation for Atlas (https://dochub.mongodb.org/core/atlas-event-names), Ops Manager (https://dochub.mongodb.org/core/om-event-names), or Cloud Manager (https://dochub.mongodb.org/core/cm-event-names). - * - -h, --help - - - - false - - help for create - * - --matcherFieldName - - string - - false - - Name of the field in the target object to match on. To learn the valid values, run mongocli atlas alerts settings fields type. - * - --matcherOperator - - string - - false - - Comparison operator to apply when checking the current metric against matcherValue. Valid values are CONTAINS, ENDS_WITH, EQUALS, NOT_CONTAINS, NOT_EQUALS, REGEX, STARTS_WITH. - * - --matcherValue - - string - - false - - Value to test with the specified operator. If matcherFieldName is set to TYPE_NAME, you can match on the following values: CONFIG, MONGOS, PRIMARY, SECONDARY, STANDALONE. - * - --metricMode - - string - - false - - Option that indicates whether Atlas computes the current metric value as an average. Valid value is AVERAGE. - * - --metricName - - string - - false - - Name of the metric against which this command checks the configured alert. To learn the valid values, see https://dochub.mongodb.org/core/alert-host-metrics-atlas. This option applies only if the event is set to OUTSIDE_METRIC_THRESHOLD. - * - --metricOperator - - string - - false - - Comparison operator to apply when checking the current metric value. Valid values are LESS_THAN and GREATER_THAN. - * - --metricThreshold - - float - - false - - Threshold value outside of which an alert will be triggered. - * - --metricUnits - - string - - false - - Units for the threshold value. Valid values are BITS, BYTES, DAYS, GIGABITS, GIGABYTES, HOURS, KILOBITS, KILOBYTES, MEGABITS, MEGABYTES, MILLISECONDS, MINUTES, PETABYTES, RAW, SECONDS, TERABYTES. - * - --notificationChannelName - - string - - false - - Slack channel name. Required for the SLACK notifications type. - * - --notificationDelayMin - - int - - false - - Number of minutes to wait after an alert condition is detected before sending out the first notification. - * - --notificationEmailAddress - - string - - false - - Email address to which alert notifications are sent. - * - --notificationEmailEnabled - - - - false - - Flag that enables email notifications. Configurable for GROUP and USER notification types. - * - --notificationIntervalMin - - int - - false - - Number of minutes to wait between successive notifications for unacknowledged alerts that are not resolved. - * - --notificationMobileNumber - - string - - false - - Mobile number to which alert notifications are sent. - * - --notificationRegion - - string - - false - - Region that indicates which API URL to use. - * - --notificationServiceKey - - string - - false - - PagerDuty service key. - * - --notificationSmsEnabled - - - - false - - Flag that enables text message notifications. - * - --notificationTeamId - - string - - false - - Unique identifier of a team. - * - --notificationToken - - string - - false - - Slack API token, or Bot token. - * - --notificationType - - string - - false - - Type of alert notification. Valid values are DATADOG, EMAIL, GROUP (Project), ORG, OPS_GENIE, PAGER_DUTY, SLACK, SMS, USER, or VICTOR_OPS. - * - --notificationUsername - - string - - false - - Name of the Atlas user to which to send notifications. - * - --notificationVictorOpsRoutingKey - - string - - false - - Routing key associated with your Splunk On-Call 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Alert configuration created. - - -Examples --------- - -.. code-block:: - - # Create an alert configuration that notifies a user when they join a group for the project with the ID 5df90590f10fab5e33de2305: - mongocli atlas alerts settings create --event JOINED_GROUP --enabled \ - --notificationType USER --notificationEmailEnabled \ - --notificationUsername john@example.com \ - --output json --projectId 5df90590f10fab5e33de2305 diff --git a/docs/mongocli/command/mongocli-cloud-manager-alerts-settings-delete.txt b/docs/mongocli/command/mongocli-cloud-manager-alerts-settings-delete.txt deleted file mode 100644 index 5d205debfb..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-alerts-settings-delete.txt +++ /dev/null @@ -1,101 +0,0 @@ -.. _mongocli-cloud-manager-alerts-settings-delete: - -============================================= -mongocli cloud-manager alerts settings delete -============================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Remove the specified alert 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 - - mongocli cloud-manager alerts settings 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 - * - alertConfigId - - string - - true - - Unique identifier of the alert configuration 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Alert config '' deleted - - -Examples --------- - -.. code-block:: - - # Remove the alert configuration with the ID 5d1113b25a115342acc2d1aa in the project with the ID 5e2211c17a3e5a48f5497de3: - mongocli atlas alerts settings delete 5d1113b25a115342acc2d1aa --projectId 5e2211c17a3e5a48f5497de3 diff --git a/docs/mongocli/command/mongocli-cloud-manager-alerts-settings-disable.txt b/docs/mongocli/command/mongocli-cloud-manager-alerts-settings-disable.txt deleted file mode 100644 index 8d2e6b3964..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-alerts-settings-disable.txt +++ /dev/null @@ -1,89 +0,0 @@ -.. _mongocli-cloud-manager-alerts-settings-disable: - -============================================== -mongocli cloud-manager alerts settings disable -============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Disables one alert configuration for the specified project. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager alerts settings disable [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - alertConfigId - - string - - true - - ID of the alert configuration you want to disable. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - # Disable the alert configuration with the ID 5d1113b25a115342acc2d1aa in the project with the ID 5e2211c17a3e5a48f5497de3: - mongocli atlas alerts settings disable 5d1113b25a115342acc2d1aa --projectId 5e2211c17a3e5a48f5497de3 diff --git a/docs/mongocli/command/mongocli-cloud-manager-alerts-settings-enable.txt b/docs/mongocli/command/mongocli-cloud-manager-alerts-settings-enable.txt deleted file mode 100644 index 08409551d2..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-alerts-settings-enable.txt +++ /dev/null @@ -1,82 +0,0 @@ -.. _mongocli-cloud-manager-alerts-settings-enable: - -============================================= -mongocli cloud-manager alerts settings enable -============================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Enables one alert configuration for the specified project. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager alerts settings enable [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - alertConfigId - - string - - true - - ID of the alert you want to enable. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-cloud-manager-alerts-settings-fields-type.txt b/docs/mongocli/command/mongocli-cloud-manager-alerts-settings-fields-type.txt deleted file mode 100644 index 930968018a..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-alerts-settings-fields-type.txt +++ /dev/null @@ -1,71 +0,0 @@ -.. _mongocli-cloud-manager-alerts-settings-fields-type: - -================================================== -mongocli cloud-manager alerts settings fields type -================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return all available field types that the matcherFieldName option accepts when you create or update an alert configuration. - -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 - - mongocli cloud-manager alerts settings fields type [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 type - * - -o, --output - - string - - false - - 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - # Return a JSON-formatted list of accepted field types for the matchersFieldName option: - mongocli atlas alerts settings fields type --output json diff --git a/docs/mongocli/command/mongocli-cloud-manager-alerts-settings-fields.txt b/docs/mongocli/command/mongocli-cloud-manager-alerts-settings-fields.txt deleted file mode 100644 index 0cd2d88e68..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-alerts-settings-fields.txt +++ /dev/null @@ -1,59 +0,0 @@ -.. _mongocli-cloud-manager-alerts-settings-fields: - -============================================= -mongocli cloud-manager alerts settings fields -============================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manages alert configuration fields for your project. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for fields - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-cloud-manager-alerts-settings-fields-type` - Return all available field types that the matcherFieldName option accepts when you create or update an alert configuration. - - -.. toctree:: - :titlesonly: - - type - diff --git a/docs/mongocli/command/mongocli-cloud-manager-alerts-settings-list.txt b/docs/mongocli/command/mongocli-cloud-manager-alerts-settings-list.txt deleted file mode 100644 index e074b74f1b..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-alerts-settings-list.txt +++ /dev/null @@ -1,83 +0,0 @@ -.. _mongocli-cloud-manager-alerts-settings-list: - -=========================================== -mongocli cloud-manager alerts settings list -=========================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns all alert configurations 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 - - mongocli cloud-manager alerts settings 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - # Return a JSON-formatted list of all alert configurations for the project with the ID 5df90590f10fab5e33de2305: - mongocli atlas alerts settings list --projectId 5df90590f10fab5e33de2305 --output json diff --git a/docs/mongocli/command/mongocli-cloud-manager-alerts-settings-update.txt b/docs/mongocli/command/mongocli-cloud-manager-alerts-settings-update.txt deleted file mode 100644 index f423e46567..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-alerts-settings-update.txt +++ /dev/null @@ -1,204 +0,0 @@ -.. _mongocli-cloud-manager-alerts-settings-update: - -============================================= -mongocli cloud-manager alerts settings update -============================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Modify the details of the specified alert 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 - - mongocli cloud-manager alerts settings 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 - * - alertConfigId - - string - - true - - Unique identifier of the alert configuration you want to update. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --apiKey - - string - - false - - Datadog API Key, Opsgenie API Key, or VictorOps API key. Required if the notificationType is DATADOG, OPS_GENIE, or VICTOR_OPS, respectively. - * - --enabled - - - - false - - Flag that indicates whether to enable the alert configuration. - * - --event - - string - - false - - Type of event that triggered the alert. To learn which values the CLI accepts, see the possible eventTypeName values in the API documentation for Atlas (https://dochub.mongodb.org/core/atlas-event-names), Ops Manager (https://dochub.mongodb.org/core/om-event-names), or Cloud Manager (https://dochub.mongodb.org/core/cm-event-names). - * - -h, --help - - - - false - - help for update - * - --matcherFieldName - - string - - false - - Name of the field in the target object to match on. To learn the valid values, run mongocli atlas alerts settings fields type. - * - --matcherOperator - - string - - false - - Comparison operator to apply when checking the current metric against matcherValue. Valid values are CONTAINS, ENDS_WITH, EQUALS, NOT_CONTAINS, NOT_EQUALS, REGEX, STARTS_WITH. - * - --matcherValue - - string - - false - - Value to test with the specified operator. If matcherFieldName is set to TYPE_NAME, you can match on the following values: CONFIG, MONGOS, PRIMARY, SECONDARY, STANDALONE. - * - --metricMode - - string - - false - - Option that indicates whether Atlas computes the current metric value as an average. Valid value is AVERAGE. - * - --metricName - - string - - false - - Name of the metric against which this command checks the configured alert. To learn the valid values, see https://dochub.mongodb.org/core/alert-host-metrics-atlas. This option applies only if the event is set to OUTSIDE_METRIC_THRESHOLD. - * - --metricOperator - - string - - false - - Comparison operator to apply when checking the current metric value. Valid values are LESS_THAN and GREATER_THAN. - * - --metricThreshold - - float - - false - - Threshold value outside of which an alert will be triggered. - * - --metricUnits - - string - - false - - Units for the threshold value. Valid values are BITS, BYTES, DAYS, GIGABITS, GIGABYTES, HOURS, KILOBITS, KILOBYTES, MEGABITS, MEGABYTES, MILLISECONDS, MINUTES, PETABYTES, RAW, SECONDS, TERABYTES. - * - --notificationChannelName - - string - - false - - Slack channel name. Required for the SLACK notifications type. - * - --notificationDelayMin - - int - - false - - Number of minutes to wait after an alert condition is detected before sending out the first notification. - * - --notificationEmailAddress - - string - - false - - Email address to which alert notifications are sent. - * - --notificationEmailEnabled - - - - false - - Flag that enables email notifications. Configurable for GROUP and USER notification types. - * - --notificationIntervalMin - - int - - false - - Number of minutes to wait between successive notifications for unacknowledged alerts that are not resolved. - * - --notificationMobileNumber - - string - - false - - Mobile number to which alert notifications are sent. - * - --notificationRegion - - string - - false - - Region that indicates which API URL to use. - * - --notificationServiceKey - - string - - false - - PagerDuty service key. - * - --notificationSmsEnabled - - - - false - - Flag that enables text message notifications. - * - --notificationTeamId - - string - - false - - Unique identifier of a team. - * - --notificationToken - - string - - false - - Slack API token, or Bot token. - * - --notificationType - - string - - false - - Type of alert notification. Valid values are DATADOG, EMAIL, GROUP (Project), ORG, OPS_GENIE, PAGER_DUTY, SLACK, SMS, USER, or VICTOR_OPS. - * - --notificationUsername - - string - - false - - Name of the Atlas user to which to send notifications. - * - --notificationVictorOpsRoutingKey - - string - - false - - Routing key associated with your Splunk On-Call 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Alert configuration '' updated. - - -Examples --------- - -.. code-block:: - - # Modify the alert configuration with the ID 5d1113b25a115342acc2d1aa so that it notifies a user when they join a group for the project with the ID 5df90590f10fab5e33de2305: - mongocli atlas alerts settings update 5d1113b25a115342acc2d1aa --event JOINED_GROUP --enabled \ - --notificationType USER --notificationEmailEnabled \ - --notificationUsername john@example.com \ - --output json --projectId 5df90590f10fab5e33de2305 diff --git a/docs/mongocli/command/mongocli-cloud-manager-alerts-settings.txt b/docs/mongocli/command/mongocli-cloud-manager-alerts-settings.txt deleted file mode 100644 index 0dc0acd50d..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-alerts-settings.txt +++ /dev/null @@ -1,73 +0,0 @@ -.. _mongocli-cloud-manager-alerts-settings: - -====================================== -mongocli cloud-manager alerts settings -====================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manages alerts configuration for your project. - -Use this command to list, create, edit, delete, enable and disable alert configurations. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-cloud-manager-alerts-settings-create` - Create an alert configuration for your project. -* :ref:`mongocli-cloud-manager-alerts-settings-delete` - Remove the specified alert configuration for your project. -* :ref:`mongocli-cloud-manager-alerts-settings-disable` - Disables one alert configuration for the specified project. -* :ref:`mongocli-cloud-manager-alerts-settings-enable` - Enables one alert configuration for the specified project. -* :ref:`mongocli-cloud-manager-alerts-settings-fields` - Manages alert configuration fields for your project. -* :ref:`mongocli-cloud-manager-alerts-settings-list` - Returns all alert configurations for your project. -* :ref:`mongocli-cloud-manager-alerts-settings-update` - Modify the details of the specified alert configuration for your project. - - -.. toctree:: - :titlesonly: - - create - delete - disable - enable - fields - list - update - diff --git a/docs/mongocli/command/mongocli-cloud-manager-alerts-unacknowledge.txt b/docs/mongocli/command/mongocli-cloud-manager-alerts-unacknowledge.txt deleted file mode 100644 index c2023bc1f7..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-alerts-unacknowledge.txt +++ /dev/null @@ -1,95 +0,0 @@ -.. _mongocli-cloud-manager-alerts-unacknowledge: - -=========================================== -mongocli cloud-manager alerts unacknowledge -=========================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Unacknowledge the specified alert 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 - - mongocli cloud-manager alerts unacknowledge [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - alertId - - string - - true - - Unique ID of the alert you want to unacknowledge. - -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 unacknowledge - * - -o, --output - - string - - false - - 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - # Unacknowledge the alert with the ID 5d1113b25a115342acc2d1aa in the project with the ID 5e2211c17a3e5a48f5497de3: - mongocli atlas alerts unacknowledge 5d1113b25a115342acc2d1aa --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/mongocli/command/mongocli-cloud-manager-alerts.txt b/docs/mongocli/command/mongocli-cloud-manager-alerts.txt deleted file mode 100644 index fe11882746..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-alerts.txt +++ /dev/null @@ -1,69 +0,0 @@ -.. _mongocli-cloud-manager-alerts: - -============================= -mongocli cloud-manager alerts -============================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage alerts for your project. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for alerts - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-cloud-manager-alerts-acknowledge` - Acknowledges the specified alert for your project. -* :ref:`mongocli-cloud-manager-alerts-describe` - Return the details for the specified alert for your project. -* :ref:`mongocli-cloud-manager-alerts-global` - Retrieves all the global alerts for the specified Ops Manager project. -* :ref:`mongocli-cloud-manager-alerts-list` - Return all alerts for your project. -* :ref:`mongocli-cloud-manager-alerts-settings` - Manages alerts configuration for your project. -* :ref:`mongocli-cloud-manager-alerts-unacknowledge` - Unacknowledge the specified alert for your project. - - -.. toctree:: - :titlesonly: - - acknowledge - describe - global - list - settings - unacknowledge - diff --git a/docs/mongocli/command/mongocli-cloud-manager-automation-describe.txt b/docs/mongocli/command/mongocli-cloud-manager-automation-describe.txt deleted file mode 100644 index eb1868ea3c..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-automation-describe.txt +++ /dev/null @@ -1,66 +0,0 @@ -.. _mongocli-cloud-manager-automation-describe: - -========================================== -mongocli cloud-manager automation describe -========================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Get the current automation configuration for a project. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager automation 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-cloud-manager-automation-status.txt b/docs/mongocli/command/mongocli-cloud-manager-automation-status.txt deleted file mode 100644 index 7104953567..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-automation-status.txt +++ /dev/null @@ -1,66 +0,0 @@ -.. _mongocli-cloud-manager-automation-status: - -======================================== -mongocli cloud-manager automation status -======================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Show the current status of the automation config. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager automation status [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 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-cloud-manager-automation-update.txt b/docs/mongocli/command/mongocli-cloud-manager-automation-update.txt deleted file mode 100644 index c29a913055..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-automation-update.txt +++ /dev/null @@ -1,66 +0,0 @@ -.. _mongocli-cloud-manager-automation-update: - -======================================== -mongocli cloud-manager automation update -======================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Update the current automation configuration for a project. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager automation 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 - * - -f, --file - - string - - true - - Filename to use - * - -h, --help - - - - false - - help for update - * - --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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-cloud-manager-automation-watch.txt b/docs/mongocli/command/mongocli-cloud-manager-automation-watch.txt deleted file mode 100644 index dd3b3ce367..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-automation-watch.txt +++ /dev/null @@ -1,73 +0,0 @@ -.. _mongocli-cloud-manager-automation-watch: - -======================================= -mongocli cloud-manager automation watch -======================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Watch for automation changes to be completed. - -This command checks the automation "lastGoalVersionAchieved" periodically until it matches "goalVersion". -Once the expected status is reached, the command prints "Changes deployed successfully." -If you run the command in the terminal, it blocks the terminal session until the changes are completed. -You can interrupt the command's polling at any time with CTRL-C. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager automation 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 - * - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - mongocli ops-manager automation watch diff --git a/docs/mongocli/command/mongocli-cloud-manager-automation.txt b/docs/mongocli/command/mongocli-cloud-manager-automation.txt deleted file mode 100644 index 7e77181ffd..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-automation.txt +++ /dev/null @@ -1,65 +0,0 @@ -.. _mongocli-cloud-manager-automation: - -================================= -mongocli cloud-manager automation -================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage automation configuration for your project. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for automation - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-cloud-manager-automation-describe` - Get the current automation configuration for a project. -* :ref:`mongocli-cloud-manager-automation-status` - Show the current status of the automation config. -* :ref:`mongocli-cloud-manager-automation-update` - Update the current automation configuration for a project. -* :ref:`mongocli-cloud-manager-automation-watch` - Watch for automation changes to be completed. - - -.. toctree:: - :titlesonly: - - describe - status - update - watch - diff --git a/docs/mongocli/command/mongocli-cloud-manager-backups-checkpoints-list.txt b/docs/mongocli/command/mongocli-cloud-manager-backups-checkpoints-list.txt deleted file mode 100644 index 6d541c4bb4..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-backups-checkpoints-list.txt +++ /dev/null @@ -1,90 +0,0 @@ -.. _mongocli-cloud-manager-backups-checkpoints-list: - -=============================================== -mongocli cloud-manager backups checkpoints list -=============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -List continuous backup checkpoints for your project. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager backups checkpoints 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 - * - clusterId - - string - - true - - ID of the cluster. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-cloud-manager-backups-checkpoints.txt b/docs/mongocli/command/mongocli-cloud-manager-backups-checkpoints.txt deleted file mode 100644 index af15e58858..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-backups-checkpoints.txt +++ /dev/null @@ -1,59 +0,0 @@ -.. _mongocli-cloud-manager-backups-checkpoints: - -========================================== -mongocli cloud-manager backups checkpoints -========================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage backup checkpoints for your project. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for checkpoints - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-cloud-manager-backups-checkpoints-list` - List continuous backup checkpoints for your project. - - -.. toctree:: - :titlesonly: - - list - diff --git a/docs/mongocli/command/mongocli-cloud-manager-backups-config-describe.txt b/docs/mongocli/command/mongocli-cloud-manager-backups-config-describe.txt deleted file mode 100644 index 2cbc2f8bfa..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-backups-config-describe.txt +++ /dev/null @@ -1,82 +0,0 @@ -.. _mongocli-cloud-manager-backups-config-describe: - -============================================== -mongocli cloud-manager backups config describe -============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Get a backup configuration. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager backups 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 - * - clusterId - - string - - true - - ID of the cluster. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-cloud-manager-backups-config-list.txt b/docs/mongocli/command/mongocli-cloud-manager-backups-config-list.txt deleted file mode 100644 index 1403e72f3b..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-backups-config-list.txt +++ /dev/null @@ -1,74 +0,0 @@ -.. _mongocli-cloud-manager-backups-config-list: - -========================================== -mongocli cloud-manager backups config list -========================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -List backup configurations for your project. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager backups 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 - * - --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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-cloud-manager-backups-config-update.txt b/docs/mongocli/command/mongocli-cloud-manager-backups-config-update.txt deleted file mode 100644 index 2c7680ea44..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-backups-config-update.txt +++ /dev/null @@ -1,126 +0,0 @@ -.. _mongocli-cloud-manager-backups-config-update: - -============================================ -mongocli cloud-manager backups config update -============================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Update a backup configuration. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager backups config 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 - * - clusterId - - string - - true - - ID of the cluster. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --authMechanism - - string - - false - - Authentication mechanism needed to connect to the sync source database. - * - --encryption - - - - false - - Flag that indicates if encryption is enabled for the backup configuration. - * - --excludedNamespace - - strings - - false - - List of database names and collection names to omit from the backup. Passing this flag replaces preexisting data. - * - -h, --help - - - - false - - help for update - * - --includedNamespace - - strings - - false - - List of database names and collection names to include in the backup. 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. - * - --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. - * - --provisioned - - - - false - - Flag that indicates if Ops Manager has provisioned the resources needed to store a backup. - * - --ssl - - - - false - - Flag that indicates if TLS is enabled for the sync source database. - * - --status - - string - - false - - Status of the backup configuration. - * - --storageEngine - - string - - false - - Storage engine for the backup. - * - --syncSource - - string - - false - - mongod instance from which you retrieve backup data. - * - --username - - string - - false - - 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-cloud-manager-backups-config.txt b/docs/mongocli/command/mongocli-cloud-manager-backups-config.txt deleted file mode 100644 index c61660c378..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-backups-config.txt +++ /dev/null @@ -1,63 +0,0 @@ -.. _mongocli-cloud-manager-backups-config: - -===================================== -mongocli cloud-manager backups config -===================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage backup configurations for your project. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-cloud-manager-backups-config-describe` - Get a backup configuration. -* :ref:`mongocli-cloud-manager-backups-config-list` - List backup configurations for your project. -* :ref:`mongocli-cloud-manager-backups-config-update` - Update a backup configuration. - - -.. toctree:: - :titlesonly: - - describe - list - update - diff --git a/docs/mongocli/command/mongocli-cloud-manager-backups-disable.txt b/docs/mongocli/command/mongocli-cloud-manager-backups-disable.txt deleted file mode 100644 index f0de8e262a..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-backups-disable.txt +++ /dev/null @@ -1,78 +0,0 @@ -.. _mongocli-cloud-manager-backups-disable: - -====================================== -mongocli cloud-manager backups disable -====================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Disable backup for a given hostname - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager backups disable [options] - -.. 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 hostname. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-cloud-manager-backups-enable.txt b/docs/mongocli/command/mongocli-cloud-manager-backups-enable.txt deleted file mode 100644 index 841e7a34a1..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-backups-enable.txt +++ /dev/null @@ -1,78 +0,0 @@ -.. _mongocli-cloud-manager-backups-enable: - -===================================== -mongocli cloud-manager backups enable -===================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Enable backup for a given hostname - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager backups enable [options] - -.. 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 hostname. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-cloud-manager-backups-restores-list.txt b/docs/mongocli/command/mongocli-cloud-manager-backups-restores-list.txt deleted file mode 100644 index fc9c4a35dc..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-backups-restores-list.txt +++ /dev/null @@ -1,90 +0,0 @@ -.. _mongocli-cloud-manager-backups-restores-list: - -============================================ -mongocli cloud-manager backups restores list -============================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Lists restore jobs for a project and cluster. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager 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 - * - clusterId - - string - - true - - ID of the cluster. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-cloud-manager-backups-restores-start.txt b/docs/mongocli/command/mongocli-cloud-manager-backups-restores-start.txt deleted file mode 100644 index 566a849f32..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-backups-restores-start.txt +++ /dev/null @@ -1,126 +0,0 @@ -.. _mongocli-cloud-manager-backups-restores-start: - -============================================= -mongocli cloud-manager backups restores start -============================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Start a restore job for a project and cluster. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager backups restores 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 - * - AUTOMATED_RESTORE|HTTP - - string - - true - - Restore type. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --checkpointId - - string - - false - - Unique identifier for the sharded cluster checkpoint that represents the point in time to which your data will be restored. If you set checkpointId, you cannot set oplogInc, oplogTs, snapshotId, or pointInTimeUTCMillis. - * - --clusterId - - string - - true - - Unique identifier of the cluster. - * - --expirationHours - - int - - false - - Number of hours the download URL is valid once the restore job is complete. For use only with download restore jobs. - * - --expires - - string - - false - - Timestamp in ISO 8601 date and time format after which the URL is no longer available. For use only with download restore jobs. - * - -h, --help - - - - false - - help for start - * - --maxDownloads - - int - - false - - Number of times the download URL can be used. This value must be 1 or greater. For use only with download restore jobs. - * - --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 - - string - - 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. - * - --pointInTimeUTCMillis - - float - - false - - Timestamp in the number of milliseconds 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 to restore. You must specify a snapshotId for automated restores. - * - --targetClusterId - - string - - false - - Unique identifier of the target cluster. For use only with automated restore jobs. - * - --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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-cloud-manager-backups-restores.txt b/docs/mongocli/command/mongocli-cloud-manager-backups-restores.txt deleted file mode 100644 index d6203875e5..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-backups-restores.txt +++ /dev/null @@ -1,61 +0,0 @@ -.. _mongocli-cloud-manager-backups-restores: - -======================================= -mongocli cloud-manager backups restores -======================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-cloud-manager-backups-restores-list` - Lists restore jobs for a project and cluster. -* :ref:`mongocli-cloud-manager-backups-restores-start` - Start a restore job for a project and cluster. - - -.. toctree:: - :titlesonly: - - list - start - diff --git a/docs/mongocli/command/mongocli-cloud-manager-backups-snapshots-list.txt b/docs/mongocli/command/mongocli-cloud-manager-backups-snapshots-list.txt deleted file mode 100644 index 7716697422..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-backups-snapshots-list.txt +++ /dev/null @@ -1,90 +0,0 @@ -.. _mongocli-cloud-manager-backups-snapshots-list: - -============================================= -mongocli cloud-manager backups snapshots list -============================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -List snapshots for a project and cluster. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager 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 - * - clusterId - - string - - true - - ID of the cluster. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-cloud-manager-backups-snapshots-schedule-describe.txt b/docs/mongocli/command/mongocli-cloud-manager-backups-snapshots-schedule-describe.txt deleted file mode 100644 index a0c1e32eff..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-backups-snapshots-schedule-describe.txt +++ /dev/null @@ -1,70 +0,0 @@ -.. _mongocli-cloud-manager-backups-snapshots-schedule-describe: - -========================================================== -mongocli cloud-manager backups snapshots schedule describe -========================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Describe a snapshot schedule for a cluster. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager backups snapshots schedule 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 - * - --clusterId - - string - - true - - Unique identifier of the cluster. - * - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-cloud-manager-backups-snapshots-schedule-update.txt b/docs/mongocli/command/mongocli-cloud-manager-backups-snapshots-schedule-update.txt deleted file mode 100644 index 8eb212b905..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-backups-snapshots-schedule-update.txt +++ /dev/null @@ -1,110 +0,0 @@ -.. _mongocli-cloud-manager-backups-snapshots-schedule-update: - -======================================================== -mongocli cloud-manager backups snapshots schedule update -======================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Update a snapshot schedule for a cluster. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager backups snapshots schedule 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 - * - --clusterCheckpointIntervalMin - - int - - false - - Number of minutes between successive cluster checkpoints. Valid values are 15, 30, or 60. - * - --clusterId - - string - - true - - Unique identifier of the cluster. - * - --dailySnapshotRetentionDays - - int - - false - - Number of days to retain daily snapshots. Accepted values are between 1 and 365 inclusive. - * - -h, --help - - - - false - - help for update - * - --monthlySnapshotRetentionMonths - - int - - false - - Number of months to retain monthly snapshots. Accepted values are between 1 and 36 inclusive. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --pointInTimeWindowHours - - int - - false - - Number of hours in the past for which MongoDB should create a point-in-time snapshot. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --referenceHourOfDay - - int - - false - - Hour of the day to schedule snapshots using a 24-hour clock. Accepted values are between 0 and 23 inclusive. - * - --referenceMinuteOfHour - - int - - false - - Minute of the hour to schedule snapshots. Accepted values are between 0 and 59 inclusive. - * - --referenceTimeZoneOffset - - string - - false - - ISO-8601-formatted timezone offset where the Ops Manager host resides. - * - --snapshotIntervalHours - - int - - false - - Number of hours between snapshots. Valid values are 6, 8, 12, or 24. - * - --snapshotRetentionDays - - int - - false - - Number of days to keep recent snapshots. Accepted values are between 2 and 5 inclusive. - * - --weeklySnapshotRetentionWeeks - - int - - false - - Number of weeks to retain weekly snapshots. Accepted values are between 1 and 52 inclusive. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-cloud-manager-backups-snapshots-schedule.txt b/docs/mongocli/command/mongocli-cloud-manager-backups-snapshots-schedule.txt deleted file mode 100644 index 4d6f99aaf2..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-backups-snapshots-schedule.txt +++ /dev/null @@ -1,61 +0,0 @@ -.. _mongocli-cloud-manager-backups-snapshots-schedule: - -================================================= -mongocli cloud-manager backups snapshots schedule -================================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage backup snapshot schedules for a cluster. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for schedule - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-cloud-manager-backups-snapshots-schedule-describe` - Describe a snapshot schedule for a cluster. -* :ref:`mongocli-cloud-manager-backups-snapshots-schedule-update` - Update a snapshot schedule for a cluster. - - -.. toctree:: - :titlesonly: - - describe - update - diff --git a/docs/mongocli/command/mongocli-cloud-manager-backups-snapshots.txt b/docs/mongocli/command/mongocli-cloud-manager-backups-snapshots.txt deleted file mode 100644 index ef3eeb78d9..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-backups-snapshots.txt +++ /dev/null @@ -1,61 +0,0 @@ -.. _mongocli-cloud-manager-backups-snapshots: - -======================================== -mongocli cloud-manager backups snapshots -======================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-cloud-manager-backups-snapshots-list` - List snapshots for a project and cluster. -* :ref:`mongocli-cloud-manager-backups-snapshots-schedule` - Manage backup snapshot schedules for a cluster. - - -.. toctree:: - :titlesonly: - - list - schedule - diff --git a/docs/mongocli/command/mongocli-cloud-manager-backups.txt b/docs/mongocli/command/mongocli-cloud-manager-backups.txt deleted file mode 100644 index c9cd4c1b73..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-backups.txt +++ /dev/null @@ -1,69 +0,0 @@ -.. _mongocli-cloud-manager-backups: - -============================== -mongocli cloud-manager backups -============================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage continuous 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-cloud-manager-backups-checkpoints` - Manage backup checkpoints for your project. -* :ref:`mongocli-cloud-manager-backups-config` - Manage backup configurations for your project. -* :ref:`mongocli-cloud-manager-backups-disable` - Disable backup for a given hostname -* :ref:`mongocli-cloud-manager-backups-enable` - Enable backup for a given hostname -* :ref:`mongocli-cloud-manager-backups-restores` - Manage restore jobs for your project. -* :ref:`mongocli-cloud-manager-backups-snapshots` - Manage backup snapshots for your project. - - -.. toctree:: - :titlesonly: - - checkpoints - config - disable - enable - restores - snapshots - diff --git a/docs/mongocli/command/mongocli-cloud-manager-clusters-apply.txt b/docs/mongocli/command/mongocli-cloud-manager-clusters-apply.txt deleted file mode 100644 index 5108909ada..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-clusters-apply.txt +++ /dev/null @@ -1,66 +0,0 @@ -.. _mongocli-cloud-manager-clusters-apply: - -===================================== -mongocli cloud-manager clusters apply -===================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Apply a new cluster configuration for your project. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager clusters 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 - * - -f, --file - - string - - true - - Filename to use to change the automation config - * - -h, --help - - - - false - - help for apply - * - --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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-cloud-manager-clusters-create.txt b/docs/mongocli/command/mongocli-cloud-manager-clusters-create.txt deleted file mode 100644 index 7bb0171242..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-clusters-create.txt +++ /dev/null @@ -1,66 +0,0 @@ -.. _mongocli-cloud-manager-clusters-create: - -====================================== -mongocli cloud-manager clusters create -====================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create a MongoDB cluster. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager clusters 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 - * - -f, --file - - string - - true - - Filename to use to create the cluster - * - -h, --help - - - - false - - help for create - * - --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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-cloud-manager-clusters-delete.txt b/docs/mongocli/command/mongocli-cloud-manager-clusters-delete.txt deleted file mode 100644 index 52da4ccc6f..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-clusters-delete.txt +++ /dev/null @@ -1,82 +0,0 @@ -.. _mongocli-cloud-manager-clusters-delete: - -====================================== -mongocli cloud-manager clusters delete -====================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Completely removes a cluster from your project. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager 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 - * - name - - string - - true - - Name of the cLuster. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-cloud-manager-clusters-describe.txt b/docs/mongocli/command/mongocli-cloud-manager-clusters-describe.txt deleted file mode 100644 index fff98e6f13..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-clusters-describe.txt +++ /dev/null @@ -1,85 +0,0 @@ -.. _mongocli-cloud-manager-clusters-describe: - -======================================== -mongocli cloud-manager clusters describe -======================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Describe a cluster. - -When describing cluster with no output format please provide the cluster ID. -When using an output format please provide the cluster name. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager 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 - * - id|name - - string - - true - - Name or ID of the cluster. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-cloud-manager-clusters-indexes-create.txt b/docs/mongocli/command/mongocli-cloud-manager-clusters-indexes-create.txt deleted file mode 100644 index 84d5b79bad..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-clusters-indexes-create.txt +++ /dev/null @@ -1,145 +0,0 @@ -.. _mongocli-cloud-manager-clusters-indexes-create: - -============================================== -mongocli cloud-manager clusters indexes create -============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create a rolling index for your MongoDB cluster. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager 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 to create. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --MaxVariable - - string - - false - - Flag that determines which characters to ignore. This flag applies only if you set indexConfigs.collation.alternate to shifted. - * - --alternate - - string - - false - - Flag that determines whether collation should consider whitespace and punctuation as base characters during comparisons. - * - --backwards - - - - false - - Flag that indicates whether strings with diacritics sort from the back to the front of the string. - * - --caseFirst - - string - - false - - Flag that determines the sort order of case differences during tertiary level comparisons. - * - --caseLevel - - - - false - - Flag that enables index case comparison. This flag applies only if the strength level is set to 1 or 2. - * - --collectionName - - string - - true - - Name of the collection. - * - --db - - string - - true - - Name of the database. - * - -h, --help - - - - false - - help for create - * - --key - - strings - - true - - Field to be indexed and the type of index in the following format: field:type. - * - --locale - - string - - false - - Locale that the ICU defines. - * - --normalization - - - - false - - Flag that indicates whether collation checks if text requires normalization and performs normalization to compare text. - * - --numericOrdering - - - - false - - Flag that indicates that collation compares numeric strings as numbers. If you set to false, collation compares numeric strings as strings. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --rsName - - string - - true - - Replica set that the index is built on. - * - --sparse - - - - false - - Flag that creates a sparse index. To learn more, see https://dochub.mongodb.org/core/index-sparse-manual. - * - --strength - - int - - false - - Level of comparison to perform. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - # Create an index named bedrooms_1 on the listings collection of the realestate database on the replica set repl1. - The command uses the default profile. - - mongocli om clusters indexes create bedrooms_1 \ - --collectionName listings --db realestate --key bedrooms:1 \ - --rsName repl1 diff --git a/docs/mongocli/command/mongocli-cloud-manager-clusters-indexes.txt b/docs/mongocli/command/mongocli-cloud-manager-clusters-indexes.txt deleted file mode 100644 index 9169b39d30..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-clusters-indexes.txt +++ /dev/null @@ -1,59 +0,0 @@ -.. _mongocli-cloud-manager-clusters-indexes: - -======================================= -mongocli cloud-manager 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-cloud-manager-clusters-indexes-create` - Create a rolling index for your MongoDB cluster. - - -.. toctree:: - :titlesonly: - - create - diff --git a/docs/mongocli/command/mongocli-cloud-manager-clusters-list.txt b/docs/mongocli/command/mongocli-cloud-manager-clusters-list.txt deleted file mode 100644 index da99a46fa6..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-clusters-list.txt +++ /dev/null @@ -1,69 +0,0 @@ -.. _mongocli-cloud-manager-clusters-list: - -==================================== -mongocli cloud-manager clusters list -==================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -List clusters for your project. - -When listing clusters with no output format the information provided is defined by monitoring. -When using an output format the information will be provided by automation. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager 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 - * - -o, --output - - string - - false - - 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-cloud-manager-clusters-reclaimFreeSpace.txt b/docs/mongocli/command/mongocli-cloud-manager-clusters-reclaimFreeSpace.txt deleted file mode 100644 index c019b57112..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-clusters-reclaimFreeSpace.txt +++ /dev/null @@ -1,92 +0,0 @@ -.. _mongocli-cloud-manager-clusters-reclaimFreeSpace: - -================================================ -mongocli cloud-manager clusters reclaimFreeSpace -================================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Reclaim unused space for a cluster using compact. - -During certain operations, MongoDB might move or delete data but it doesn't free the currently unused space. Ops Manager reclaims the disk space in a rolling fashion across members of the replica set or shards. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager clusters reclaimFreeSpace [options] - -.. 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 reclaim free space. - -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 reclaimFreeSpace - * - --processName - - strings - - false - - Unique identifier for the host of a MongoDB process in the following format: {hostname}:{port}. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --timestamp - - string - - false - - Timestamp in ISO 8601 format when the service reclaims the space. This option defaults 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-cloud-manager-clusters-restart.txt b/docs/mongocli/command/mongocli-cloud-manager-clusters-restart.txt deleted file mode 100644 index c958e66b14..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-clusters-restart.txt +++ /dev/null @@ -1,86 +0,0 @@ -.. _mongocli-cloud-manager-clusters-restart: - -======================================= -mongocli cloud-manager clusters restart -======================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Restart a cluster for your project. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager clusters restart [options] - -.. 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 you want to restart. - -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 restart - * - --processName - - strings - - false - - Unique identifier for the host of a MongoDB process in the following format: {hostname}:{port}. - * - --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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-cloud-manager-clusters-resync.txt b/docs/mongocli/command/mongocli-cloud-manager-clusters-resync.txt deleted file mode 100644 index 7ee65d5bde..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-clusters-resync.txt +++ /dev/null @@ -1,100 +0,0 @@ -.. _mongocli-cloud-manager-clusters-resync: - -====================================== -mongocli cloud-manager clusters resync -====================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Start an initial sync for a cluster or process. - -The MongoDB Agent checks whether the specified timestamp is later than the time of the last resync, and if confirmed, the MongoDB Agent: - -1. Starts the initial sync on the secondary nodes in a rolling fashion -2. Waits until you ask the primary node to become the secondary with the rs.stepDown() method -3. Starts the initial sync on the primary node - -Warning: Use this method with caution. During initial sync, Automation removes the entire contents of the node’s dbPath directory. - -To learn more, see: https://docs.mongodb.com/manual/tutorial/resync-replica-set-member/ - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager clusters resync [options] - -.. 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 start a resync. - -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 resync - * - --processName - - strings - - false - - Unique identifier for the host of a MongoDB process in the following format: {hostname}:{port}. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --timestamp - - string - - false - - Timestamp in ISO 8601 format when the sync starts. This option defaults 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-cloud-manager-clusters-shutdown.txt b/docs/mongocli/command/mongocli-cloud-manager-clusters-shutdown.txt deleted file mode 100644 index e28b97cb74..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-clusters-shutdown.txt +++ /dev/null @@ -1,86 +0,0 @@ -.. _mongocli-cloud-manager-clusters-shutdown: - -======================================== -mongocli cloud-manager clusters shutdown -======================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Shutdown a cluster for your project. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager clusters shutdown [options] - -.. 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 that you want to shutdown. - -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 shutdown - * - --processName - - strings - - false - - Unique identifier for the host of a MongoDB process in the following format: {hostname}:{port}. - * - --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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-cloud-manager-clusters-startup.txt b/docs/mongocli/command/mongocli-cloud-manager-clusters-startup.txt deleted file mode 100644 index 2a28cc9f0b..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-clusters-startup.txt +++ /dev/null @@ -1,86 +0,0 @@ -.. _mongocli-cloud-manager-clusters-startup: - -======================================= -mongocli cloud-manager clusters startup -======================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Start up a cluster for your project. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager clusters startup [options] - -.. 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 that you want to start. - -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 startup - * - --processName - - strings - - false - - Unique identifier for the host of a MongoDB process in the following format: {hostname}:{port}. - * - --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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-cloud-manager-clusters-unmanage.txt b/docs/mongocli/command/mongocli-cloud-manager-clusters-unmanage.txt deleted file mode 100644 index d46eefaf71..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-clusters-unmanage.txt +++ /dev/null @@ -1,84 +0,0 @@ -.. _mongocli-cloud-manager-clusters-unmanage: - -======================================== -mongocli cloud-manager clusters unmanage -======================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Stop managing a cluster via automation. - -This commands only removes entries from the automation config but does not actually remove a cluster. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager clusters unmanage [options] - -.. 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 cluster for which you want to un-manage. - -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 unmanage - * - --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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-cloud-manager-clusters-update.txt b/docs/mongocli/command/mongocli-cloud-manager-clusters-update.txt deleted file mode 100644 index c95c332924..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-clusters-update.txt +++ /dev/null @@ -1,66 +0,0 @@ -.. _mongocli-cloud-manager-clusters-update: - -====================================== -mongocli cloud-manager clusters update -====================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Update a MongoDB cluster. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager clusters 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 - * - -f, --file - - string - - true - - Filename to use to update the cluster - * - -h, --help - - - - false - - help for update - * - --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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-cloud-manager-clusters.txt b/docs/mongocli/command/mongocli-cloud-manager-clusters.txt deleted file mode 100644 index 532eb3bf39..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-clusters.txt +++ /dev/null @@ -1,83 +0,0 @@ -.. _mongocli-cloud-manager-clusters: - -=============================== -mongocli cloud-manager clusters -=============================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage clusters for your project. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-cloud-manager-clusters-apply` - Apply a new cluster configuration for your project. -* :ref:`mongocli-cloud-manager-clusters-create` - Create a MongoDB cluster. -* :ref:`mongocli-cloud-manager-clusters-delete` - Completely removes a cluster from your project. -* :ref:`mongocli-cloud-manager-clusters-describe` - Describe a cluster. -* :ref:`mongocli-cloud-manager-clusters-indexes` - Manage cluster rolling indexes for your project. -* :ref:`mongocli-cloud-manager-clusters-list` - List clusters for your project. -* :ref:`mongocli-cloud-manager-clusters-reclaimFreeSpace` - Reclaim unused space for a cluster using compact. -* :ref:`mongocli-cloud-manager-clusters-restart` - Restart a cluster for your project. -* :ref:`mongocli-cloud-manager-clusters-resync` - Start an initial sync for a cluster or process. -* :ref:`mongocli-cloud-manager-clusters-shutdown` - Shutdown a cluster for your project. -* :ref:`mongocli-cloud-manager-clusters-startup` - Start up a cluster for your project. -* :ref:`mongocli-cloud-manager-clusters-unmanage` - Stop managing a cluster via automation. -* :ref:`mongocli-cloud-manager-clusters-update` - Update a MongoDB cluster. - - -.. toctree:: - :titlesonly: - - apply - create - delete - describe - indexes - list - reclaimFreeSpace - restart - resync - shutdown - startup - unmanage - update - diff --git a/docs/mongocli/command/mongocli-cloud-manager-dbusers-create.txt b/docs/mongocli/command/mongocli-cloud-manager-dbusers-create.txt deleted file mode 100644 index 6954f7b532..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-dbusers-create.txt +++ /dev/null @@ -1,93 +0,0 @@ -.. _mongocli-cloud-manager-dbusers-create: - -===================================== -mongocli cloud-manager dbusers create -===================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create a database user for your project. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager dbusers 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 - * - --authDB - - string - - false - - Authentication database name. This value defaults to "admin". - * - -h, --help - - - - false - - help for create - * - --mechanisms - - strings - - false - - Authentication mechanism. Valid values are SCRAM-SHA-1 or SCRAM-SHA-256. This value defaults to [SCRAM-SHA-1]. - * - -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. - * - -u, --username - - string - - true - - 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - # - -.. code-block:: - - # Create a user with readWriteAnyDatabase and clusterMonitor access - mongocli om dbuser create --username --role readWriteAnyDatabase,clusterMonitor --mechanisms SCRAM-SHA-256 --projectId diff --git a/docs/mongocli/command/mongocli-cloud-manager-dbusers-delete.txt b/docs/mongocli/command/mongocli-cloud-manager-dbusers-delete.txt deleted file mode 100644 index 7f28fcba2e..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-dbusers-delete.txt +++ /dev/null @@ -1,86 +0,0 @@ -.. _mongocli-cloud-manager-dbusers-delete: - -===================================== -mongocli cloud-manager dbusers delete -===================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Delete a database user for your project. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager 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 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. 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-cloud-manager-dbusers-list.txt b/docs/mongocli/command/mongocli-cloud-manager-dbusers-list.txt deleted file mode 100644 index 869e9875e2..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-dbusers-list.txt +++ /dev/null @@ -1,66 +0,0 @@ -.. _mongocli-cloud-manager-dbusers-list: - -=================================== -mongocli cloud-manager dbusers list -=================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -List Atlas database users for your project. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager 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 - * - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-cloud-manager-dbusers.txt b/docs/mongocli/command/mongocli-cloud-manager-dbusers.txt deleted file mode 100644 index ab88e09b67..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-dbusers.txt +++ /dev/null @@ -1,67 +0,0 @@ -.. _mongocli-cloud-manager-dbusers: - -============================== -mongocli cloud-manager 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 cluster. -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-cloud-manager-dbusers-create` - Create a database user for your project. -* :ref:`mongocli-cloud-manager-dbusers-delete` - Delete a database user for your project. -* :ref:`mongocli-cloud-manager-dbusers-list` - List Atlas database users for your project. - - -.. toctree:: - :titlesonly: - - create - delete - list - diff --git a/docs/mongocli/command/mongocli-cloud-manager-events-organizations-list.txt b/docs/mongocli/command/mongocli-cloud-manager-events-organizations-list.txt deleted file mode 100644 index f000cbcb2b..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-events-organizations-list.txt +++ /dev/null @@ -1,93 +0,0 @@ -.. _mongocli-cloud-manager-events-organizations-list: - -================================================ -mongocli cloud-manager 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 - - mongocli cloud-manager 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. - * - --minDate - - string - - false - - Minimum created date. This option returns events whose created date is greater than or equal to the specified value. - * - --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 possible eventTypeName values in the API documentation for Atlas (https://dochub.mongodb.org/core/atlas-event-names), Ops Manager (https://dochub.mongodb.org/core/om-event-names), or Cloud Manager (https://dochub.mongodb.org/core/cm-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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - # Return a JSON-formatted list of events for the organization with the ID 5dd5a6b6f10fab1d71a58495: - mongocli atlas events organizations list --orgId 5dd5a6b6f10fab1d71a58495 --output json diff --git a/docs/mongocli/command/mongocli-cloud-manager-events-organizations.txt b/docs/mongocli/command/mongocli-cloud-manager-events-organizations.txt deleted file mode 100644 index 9dc3fa7a4e..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-events-organizations.txt +++ /dev/null @@ -1,61 +0,0 @@ -.. _mongocli-cloud-manager-events-organizations: - -=========================================== -mongocli cloud-manager 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-cloud-manager-events-organizations-list` - Return all events for the specified organization. - - -.. toctree:: - :titlesonly: - - list - diff --git a/docs/mongocli/command/mongocli-cloud-manager-events-projects-list.txt b/docs/mongocli/command/mongocli-cloud-manager-events-projects-list.txt deleted file mode 100644 index aab8722aba..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-events-projects-list.txt +++ /dev/null @@ -1,93 +0,0 @@ -.. _mongocli-cloud-manager-events-projects-list: - -=========================================== -mongocli cloud-manager 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 - - mongocli cloud-manager 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. - * - --minDate - - string - - false - - Minimum created date. This option returns events whose created date is greater than or equal to the specified value. - * - -o, --output - - string - - false - - 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 possible eventTypeName values in the API documentation for Atlas (https://dochub.mongodb.org/core/atlas-event-names), Ops Manager (https://dochub.mongodb.org/core/om-event-names), or Cloud Manager (https://dochub.mongodb.org/core/cm-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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - # Return a JSON-formatted list of events for the project with the ID 5e2211c17a3e5a48f5497de3: - mongocli atlas events projects list --Id 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/mongocli/command/mongocli-cloud-manager-events-projects.txt b/docs/mongocli/command/mongocli-cloud-manager-events-projects.txt deleted file mode 100644 index 29f8accc26..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-events-projects.txt +++ /dev/null @@ -1,61 +0,0 @@ -.. _mongocli-cloud-manager-events-projects: - -====================================== -mongocli cloud-manager 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-cloud-manager-events-projects-list` - Return all events for the specified project. - - -.. toctree:: - :titlesonly: - - list - diff --git a/docs/mongocli/command/mongocli-cloud-manager-events.txt b/docs/mongocli/command/mongocli-cloud-manager-events.txt deleted file mode 100644 index e1c071f8a7..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-events.txt +++ /dev/null @@ -1,61 +0,0 @@ -.. _mongocli-cloud-manager-events: - -============================= -mongocli cloud-manager 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-cloud-manager-events-organizations` - Organization operations. -* :ref:`mongocli-cloud-manager-events-projects` - Project operations. - - -.. toctree:: - :titlesonly: - - organizations - projects - diff --git a/docs/mongocli/command/mongocli-cloud-manager-featurePolicies-list.txt b/docs/mongocli/command/mongocli-cloud-manager-featurePolicies-list.txt deleted file mode 100644 index 0d3cec5a5c..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-featurePolicies-list.txt +++ /dev/null @@ -1,74 +0,0 @@ -.. _mongocli-cloud-manager-featurePolicies-list: - -=========================================== -mongocli cloud-manager featurePolicies list -=========================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -List feature control policies for your project. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager featurePolicies 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-cloud-manager-featurePolicies-update.txt b/docs/mongocli/command/mongocli-cloud-manager-featurePolicies-update.txt deleted file mode 100644 index ea03e47ff2..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-featurePolicies-update.txt +++ /dev/null @@ -1,98 +0,0 @@ -.. _mongocli-cloud-manager-featurePolicies-update: - -============================================= -mongocli cloud-manager featurePolicies update -============================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Update feature control policies for your project. - -Feature Control Policies allow you to enable or disable certain MongoDB features based on your site-specific needs. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager featurePolicies 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 - * - -f, --file - - string - - false - - File name that identifies an optional file with a json policy configuration. - * - -h, --help - - - - false - - help for update - * - --name - - string - - false - - Identifying label for the external system that manages this Ops Manager 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. - * - --policy - - strings - - false - - List of policies that the external system applies to this Ops Manager Project. 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. - * - --systemId - - string - - false - - Unique identifier of the external system that manages this Ops Manager Project. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - # Disable user management for a project: - mongocli ops-manager featurePolicies update --projectId --name Operator --policy DISABLE_USER_MANAGEMENT - - -.. code-block:: - - # Update policies from a JSON configuration file: - mongocli atlas featurePolicies update --projectId --file - diff --git a/docs/mongocli/command/mongocli-cloud-manager-featurePolicies.txt b/docs/mongocli/command/mongocli-cloud-manager-featurePolicies.txt deleted file mode 100644 index 9e8871b0dc..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-featurePolicies.txt +++ /dev/null @@ -1,61 +0,0 @@ -.. _mongocli-cloud-manager-featurePolicies: - -====================================== -mongocli cloud-manager featurePolicies -====================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage feature control policies. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for featurePolicies - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-cloud-manager-featurePolicies-list` - List feature control policies for your project. -* :ref:`mongocli-cloud-manager-featurePolicies-update` - Update feature control policies for your project. - - -.. toctree:: - :titlesonly: - - list - update - diff --git a/docs/mongocli/command/mongocli-cloud-manager-liveMigrations-link-create.txt b/docs/mongocli/command/mongocli-cloud-manager-liveMigrations-link-create.txt deleted file mode 100644 index 9e80951d2a..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-liveMigrations-link-create.txt +++ /dev/null @@ -1,66 +0,0 @@ -.. _mongocli-cloud-manager-liveMigrations-link-create: - -================================================= -mongocli cloud-manager liveMigrations link create -================================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create one new organization link. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager 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 - * - -h, --help - - - - false - - help for create - * - --linkToken - - string - - false - - Link-token generated by Atlas. - * - --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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-cloud-manager-liveMigrations-link-delete.txt b/docs/mongocli/command/mongocli-cloud-manager-liveMigrations-link-delete.txt deleted file mode 100644 index 2ae45f4366..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-liveMigrations-link-delete.txt +++ /dev/null @@ -1,66 +0,0 @@ -.. _mongocli-cloud-manager-liveMigrations-link-delete: - -================================================= -mongocli cloud-manager 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 - - mongocli cloud-manager 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-cloud-manager-liveMigrations-link-describe.txt b/docs/mongocli/command/mongocli-cloud-manager-liveMigrations-link-describe.txt deleted file mode 100644 index f43f4de3bf..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-liveMigrations-link-describe.txt +++ /dev/null @@ -1,66 +0,0 @@ -.. _mongocli-cloud-manager-liveMigrations-link-describe: - -=================================================== -mongocli cloud-manager liveMigrations link describe -=================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return the status of the connection between the specified source organization and the target MongoDB Atlas organization. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager liveMigrations link 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-cloud-manager-liveMigrations-link.txt b/docs/mongocli/command/mongocli-cloud-manager-liveMigrations-link.txt deleted file mode 100644 index 9db72c0194..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-liveMigrations-link.txt +++ /dev/null @@ -1,63 +0,0 @@ -.. _mongocli-cloud-manager-liveMigrations-link: - -========================================== -mongocli cloud-manager 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-cloud-manager-liveMigrations-link-create` - Create one new organization link. -* :ref:`mongocli-cloud-manager-liveMigrations-link-delete` - Delete one link-token. -* :ref:`mongocli-cloud-manager-liveMigrations-link-describe` - Return the status of the connection between the specified source organization and the target MongoDB Atlas organization. - - -.. toctree:: - :titlesonly: - - create - delete - describe - diff --git a/docs/mongocli/command/mongocli-cloud-manager-liveMigrations.txt b/docs/mongocli/command/mongocli-cloud-manager-liveMigrations.txt deleted file mode 100644 index 46e0166fc0..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-liveMigrations.txt +++ /dev/null @@ -1,59 +0,0 @@ -.. _mongocli-cloud-manager-liveMigrations: - -===================================== -mongocli cloud-manager 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-cloud-manager-liveMigrations-link` - Manage the link-token for your organization. - - -.. toctree:: - :titlesonly: - - link - diff --git a/docs/mongocli/command/mongocli-cloud-manager-logs-decrypt.txt b/docs/mongocli/command/mongocli-cloud-manager-logs-decrypt.txt deleted file mode 100644 index d116941b0e..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-logs-decrypt.txt +++ /dev/null @@ -1,106 +0,0 @@ -.. _mongocli-cloud-manager-logs-decrypt: - -=================================== -mongocli cloud-manager logs decrypt -=================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Decrypts an audit log file with the provided local key file or with a server that supports KMIP. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager logs decrypt [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 - * - -f, --file - - string - - true - - Path to the file that contains encrypted audit logs. - * - -h, --help - - - - false - - help for decrypt - * - --kmipClientCertificateFile - - string - - false - - Path to the Client Certificate file used to connect to the server that supports Key Management Interoperability Protocol (KMIP). - * - --kmipClientCertificatePassword - - string - - false - - Password to decrypt the Private Key of the Client Certificate used to connect to the server that supports KMIP. - * - --kmipPassword - - string - - false - - Password that authenticates the username to the server that supports KMIP. - * - --kmipServerCAFile - - string - - false - - Path to the CA file used to connect to the server that supports KMIP. - * - --kmipUsername - - string - - false - - Username for authenticating to the server that supports KMIP. - * - --localKeyFile - - string - - false - - Path to the file that contains the Key Encryption Key (KEK) that is used to encrypt the Log Encryption Key (LEK). - * - -o, --out - - string - - false - - Path to the file where MongoCLI will save the contents of the decrypted audit log. If not specified, MongoCLI writes the contents of the decrypted audit log to stdout. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - # - -.. code-block:: - - # For audit logs in BSON format: - mongocli ops-manager logs decrypt --localKeyFile /path/to/keyFile --file /path/to/logFile.bson --out /path/to/file.json - -.. code-block:: - - # For audit logs in JSON format: - mongocli ops-manager logs decrypt --localKeyFile /path/to/keyFile --file /path/to/logFile.json --out /path/to/file.json diff --git a/docs/mongocli/command/mongocli-cloud-manager-logs-jobs-collect.txt b/docs/mongocli/command/mongocli-cloud-manager-logs-jobs-collect.txt deleted file mode 100644 index 6e9cf28ce2..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-logs-jobs-collect.txt +++ /dev/null @@ -1,98 +0,0 @@ -.. _mongocli-cloud-manager-logs-jobs-collect: - -======================================== -mongocli cloud-manager logs jobs collect -======================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Start a job to collect logs for your project. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager logs jobs collect [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - resourceType - - string - - true - - Type of resource to collect logs from. - * - resourceName - - string - - true - - Name of the resource to collect logs from. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for collect - * - -o, --output - - string - - false - - 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. - * - --redacted - - - - false - - Flag that indicates whether to replace emails, hostnames, IP addresses, and namespaces in API responses involving this job with random string values. - * - --sizeRequestedPerFileBytes - - int - - true - - Size for each log file in bytes. - * - --type - - strings - - true - - Array of strings specifying the types of logs to collect. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-cloud-manager-logs-jobs-delete.txt b/docs/mongocli/command/mongocli-cloud-manager-logs-jobs-delete.txt deleted file mode 100644 index 27f115d57e..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-logs-jobs-delete.txt +++ /dev/null @@ -1,82 +0,0 @@ -.. _mongocli-cloud-manager-logs-jobs-delete: - -======================================= -mongocli cloud-manager logs jobs delete -======================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Delete a log collection job from your project. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager logs jobs 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 - - Log job identifier. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-cloud-manager-logs-jobs-download.txt b/docs/mongocli/command/mongocli-cloud-manager-logs-jobs-download.txt deleted file mode 100644 index a23f7db420..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-logs-jobs-download.txt +++ /dev/null @@ -1,86 +0,0 @@ -.. _mongocli-cloud-manager-logs-jobs-download: - -========================================= -mongocli cloud-manager logs jobs download -========================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Download logs generated by a log collection job. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager logs jobs 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 - * - ID - - string - - true - - Log job identifier. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --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. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-cloud-manager-logs-jobs-list.txt b/docs/mongocli/command/mongocli-cloud-manager-logs-jobs-list.txt deleted file mode 100644 index b2ce5d4080..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-logs-jobs-list.txt +++ /dev/null @@ -1,70 +0,0 @@ -.. _mongocli-cloud-manager-logs-jobs-list: - -===================================== -mongocli cloud-manager logs jobs list -===================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -List log collection jobs for your project. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager logs jobs 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. - * - --verbose - - - - false - - Flag that returns all child jobs in the response. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-cloud-manager-logs-jobs.txt b/docs/mongocli/command/mongocli-cloud-manager-logs-jobs.txt deleted file mode 100644 index e17213fa66..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-logs-jobs.txt +++ /dev/null @@ -1,65 +0,0 @@ -.. _mongocli-cloud-manager-logs-jobs: - -================================ -mongocli cloud-manager logs jobs -================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage log collection jobs for your project. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for jobs - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-cloud-manager-logs-jobs-collect` - Start a job to collect logs for your project. -* :ref:`mongocli-cloud-manager-logs-jobs-delete` - Delete a log collection job from your project. -* :ref:`mongocli-cloud-manager-logs-jobs-download` - Download logs generated by a log collection job. -* :ref:`mongocli-cloud-manager-logs-jobs-list` - List log collection jobs for your project. - - -.. toctree:: - :titlesonly: - - collect - delete - download - list - diff --git a/docs/mongocli/command/mongocli-cloud-manager-logs-keyProviders-list.txt b/docs/mongocli/command/mongocli-cloud-manager-logs-keyProviders-list.txt deleted file mode 100644 index 866f09132a..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-logs-keyProviders-list.txt +++ /dev/null @@ -1,73 +0,0 @@ -.. _mongocli-cloud-manager-logs-keyProviders-list: - -============================================= -mongocli cloud-manager logs keyProviders list -============================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Lists all key provider configurations found in the encrypted audit log file. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager logs keyProviders 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 - * - -f, --file - - string - - true - - Path to the file that contains encrypted audit logs. - * - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - - mongocli ops-manager listKeyProvider --file log.gz diff --git a/docs/mongocli/command/mongocli-cloud-manager-logs-keyProviders.txt b/docs/mongocli/command/mongocli-cloud-manager-logs-keyProviders.txt deleted file mode 100644 index a3a2badc7a..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-logs-keyProviders.txt +++ /dev/null @@ -1,59 +0,0 @@ -.. _mongocli-cloud-manager-logs-keyProviders: - -======================================== -mongocli cloud-manager logs keyProviders -======================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage your key collections. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for keyProviders - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-cloud-manager-logs-keyProviders-list` - Lists all key provider configurations found in the encrypted audit log file. - - -.. toctree:: - :titlesonly: - - list - diff --git a/docs/mongocli/command/mongocli-cloud-manager-logs.txt b/docs/mongocli/command/mongocli-cloud-manager-logs.txt deleted file mode 100644 index 50b92d8713..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-logs.txt +++ /dev/null @@ -1,63 +0,0 @@ -.. _mongocli-cloud-manager-logs: - -=========================== -mongocli cloud-manager logs -=========================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage log collection jobs 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-cloud-manager-logs-decrypt` - Decrypts an audit log file with the provided local key file or with a server that supports KMIP. -* :ref:`mongocli-cloud-manager-logs-jobs` - Manage log collection jobs for your project. -* :ref:`mongocli-cloud-manager-logs-keyProviders` - Manage your key collections. - - -.. toctree:: - :titlesonly: - - decrypt - jobs - keyProviders - diff --git a/docs/mongocli/command/mongocli-cloud-manager-maintenanceWindows-create.txt b/docs/mongocli/command/mongocli-cloud-manager-maintenanceWindows-create.txt deleted file mode 100644 index 139642ea6a..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-maintenanceWindows-create.txt +++ /dev/null @@ -1,82 +0,0 @@ -.. _mongocli-cloud-manager-maintenanceWindows-create: - -================================================ -mongocli cloud-manager maintenanceWindows create -================================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create a maintenance window. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager maintenanceWindows 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 - * - --alertType - - strings - - true - - Alert types to silence during the maintenance window. Valid values include HOST, REPLICA_SET, CLUSTER, AGENT, or BACKUP. - * - --desc - - string - - false - - Description of the maintenance window. - * - --endDate - - string - - true - - Timestamp in ISO 8601 date and time format in UTC when the maintenance window ends. - * - -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. - * - --startDate - - string - - true - - Timestamp in ISO 8601 date and time format in UTC when the maintenance window starts. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-cloud-manager-maintenanceWindows-delete.txt b/docs/mongocli/command/mongocli-cloud-manager-maintenanceWindows-delete.txt deleted file mode 100644 index dd99a7f64c..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-maintenanceWindows-delete.txt +++ /dev/null @@ -1,82 +0,0 @@ -.. _mongocli-cloud-manager-maintenanceWindows-delete: - -================================================ -mongocli cloud-manager maintenanceWindows delete -================================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Delete a maintenance window. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager maintenanceWindows 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 - - Maintenance window identifier. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-cloud-manager-maintenanceWindows-describe.txt b/docs/mongocli/command/mongocli-cloud-manager-maintenanceWindows-describe.txt deleted file mode 100644 index 95d71583ae..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-maintenanceWindows-describe.txt +++ /dev/null @@ -1,82 +0,0 @@ -.. _mongocli-cloud-manager-maintenanceWindows-describe: - -================================================== -mongocli cloud-manager maintenanceWindows describe -================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Get a maintenance window. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager maintenanceWindows 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 - - Maintenance window identifier. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-cloud-manager-maintenanceWindows-list.txt b/docs/mongocli/command/mongocli-cloud-manager-maintenanceWindows-list.txt deleted file mode 100644 index dbdd4c6a10..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-maintenanceWindows-list.txt +++ /dev/null @@ -1,66 +0,0 @@ -.. _mongocli-cloud-manager-maintenanceWindows-list: - -============================================== -mongocli cloud-manager maintenanceWindows list -============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -List maintenance windows. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager maintenanceWindows 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-cloud-manager-maintenanceWindows-update.txt b/docs/mongocli/command/mongocli-cloud-manager-maintenanceWindows-update.txt deleted file mode 100644 index c2c4b6233d..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-maintenanceWindows-update.txt +++ /dev/null @@ -1,98 +0,0 @@ -.. _mongocli-cloud-manager-maintenanceWindows-update: - -================================================ -mongocli cloud-manager maintenanceWindows update -================================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Update a maintenance window. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager maintenanceWindows 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 - - Maintenance window identifier. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --alertType - - strings - - false - - Alert types to silence during the maintenance window. Valid values include HOST, REPLICA_SET, CLUSTER, AGENT, or BACKUP. Passing this flag replaces preexisting data. - * - --desc - - string - - false - - Description of the maintenance window. - * - --endDate - - string - - false - - Timestamp in ISO 8601 date and time format in UTC when the maintenance window ends. - * - -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. - * - --startDate - - string - - false - - Timestamp in ISO 8601 date and time format in UTC when the maintenance window starts. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-cloud-manager-maintenanceWindows.txt b/docs/mongocli/command/mongocli-cloud-manager-maintenanceWindows.txt deleted file mode 100644 index 70579bd334..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-maintenanceWindows.txt +++ /dev/null @@ -1,67 +0,0 @@ -.. _mongocli-cloud-manager-maintenanceWindows: - -========================================= -mongocli cloud-manager maintenanceWindows -========================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage Ops Manager/Cloud Manager 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-cloud-manager-maintenanceWindows-create` - Create a maintenance window. -* :ref:`mongocli-cloud-manager-maintenanceWindows-delete` - Delete a maintenance window. -* :ref:`mongocli-cloud-manager-maintenanceWindows-describe` - Get a maintenance window. -* :ref:`mongocli-cloud-manager-maintenanceWindows-list` - List maintenance windows. -* :ref:`mongocli-cloud-manager-maintenanceWindows-update` - Update a maintenance window. - - -.. toctree:: - :titlesonly: - - create - delete - describe - list - update - diff --git a/docs/mongocli/command/mongocli-cloud-manager-metrics-databases-describe.txt b/docs/mongocli/command/mongocli-cloud-manager-metrics-databases-describe.txt deleted file mode 100644 index 41710c15e5..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-metrics-databases-describe.txt +++ /dev/null @@ -1,127 +0,0 @@ -.. _mongocli-cloud-manager-metrics-databases-describe: - -================================================= -mongocli cloud-manager metrics databases describe -================================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Describe database measurements for a given host database. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager 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 - * - hostId - - string - - true - - Process identifier. You can use mongocli ops-manager processes list to get the ID. - * - name - - string - - true - - Database name. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - # List metrics for the database test of the process e4ac1e57c58cc9c8aaa5a1163a851993 - mongocli ops-manager metrics database describe e4ac1e57c58cc9c8aaa5a1163a851993 test --period P1DT12H --granularity PT5 diff --git a/docs/mongocli/command/mongocli-cloud-manager-metrics-databases-list.txt b/docs/mongocli/command/mongocli-cloud-manager-metrics-databases-list.txt deleted file mode 100644 index a810dd37e3..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-metrics-databases-list.txt +++ /dev/null @@ -1,90 +0,0 @@ -.. _mongocli-cloud-manager-metrics-databases-list: - -============================================= -mongocli cloud-manager metrics databases list -============================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -List available databases for a given host. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager 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 - * - ID - - string - - true - - Process identifier. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-cloud-manager-metrics-databases.txt b/docs/mongocli/command/mongocli-cloud-manager-metrics-databases.txt deleted file mode 100644 index 902713968c..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-metrics-databases.txt +++ /dev/null @@ -1,61 +0,0 @@ -.. _mongocli-cloud-manager-metrics-databases: - -======================================== -mongocli cloud-manager metrics databases -======================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -List available databases or databases measurements 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-cloud-manager-metrics-databases-describe` - Describe database measurements for a given host database. -* :ref:`mongocli-cloud-manager-metrics-databases-list` - List available databases for a given host. - - -.. toctree:: - :titlesonly: - - describe - list - diff --git a/docs/mongocli/command/mongocli-cloud-manager-metrics-disks-describe.txt b/docs/mongocli/command/mongocli-cloud-manager-metrics-disks-describe.txt deleted file mode 100644 index 796e884826..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-metrics-disks-describe.txt +++ /dev/null @@ -1,127 +0,0 @@ -.. _mongocli-cloud-manager-metrics-disks-describe: - -============================================= -mongocli cloud-manager metrics disks describe -============================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Describe disks measurements for a given host partition. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager 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 - * - hostId - - string - - true - - Process identifier. You can use mongocli ops-manager processes list to get the ID. - * - name - - string - - true - - Partition name. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - # List metrics for the test partition of the process e4ac1e57c58cc9c8aaa5a1163a851993 - mongocli ops-manager metrics disk describe e4ac1e57c58cc9c8aaa5a1163a851993 test --period P1DT12H --granularity PT5 diff --git a/docs/mongocli/command/mongocli-cloud-manager-metrics-disks-list.txt b/docs/mongocli/command/mongocli-cloud-manager-metrics-disks-list.txt deleted file mode 100644 index 82937ccf0d..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-metrics-disks-list.txt +++ /dev/null @@ -1,90 +0,0 @@ -.. _mongocli-cloud-manager-metrics-disks-list: - -========================================= -mongocli cloud-manager metrics disks list -========================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -List available disks for a given host. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager 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 - * - ID - - string - - true - - Process identifier. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-cloud-manager-metrics-disks.txt b/docs/mongocli/command/mongocli-cloud-manager-metrics-disks.txt deleted file mode 100644 index 9f149a4140..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-metrics-disks.txt +++ /dev/null @@ -1,61 +0,0 @@ -.. _mongocli-cloud-manager-metrics-disks: - -==================================== -mongocli cloud-manager metrics disks -==================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -List available disks or disks measurements 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-cloud-manager-metrics-disks-describe` - Describe disks measurements for a given host partition. -* :ref:`mongocli-cloud-manager-metrics-disks-list` - List available disks for a given host. - - -.. toctree:: - :titlesonly: - - describe - list - diff --git a/docs/mongocli/command/mongocli-cloud-manager-metrics-process.txt b/docs/mongocli/command/mongocli-cloud-manager-metrics-process.txt deleted file mode 100644 index be7c198450..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-metrics-process.txt +++ /dev/null @@ -1,115 +0,0 @@ -.. _mongocli-cloud-manager-metrics-process: - -====================================== -mongocli cloud-manager metrics process -====================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Get measurements for a given host. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager metrics process [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - hostId - - string - - true - - Process identifier. You can use mongocli ops-manager processes list to get the ID. - -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 process - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - # List metrics for the process e4ac1e57c58cc9c8aaa5a1163a851993 - mongocli ops-manager metrics process e4ac1e57c58cc9c8aaa5a1163a851993 --period P1DT12H --granularity PT5 diff --git a/docs/mongocli/command/mongocli-cloud-manager-metrics.txt b/docs/mongocli/command/mongocli-cloud-manager-metrics.txt deleted file mode 100644 index ba91403e53..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-metrics.txt +++ /dev/null @@ -1,63 +0,0 @@ -.. _mongocli-cloud-manager-metrics: - -============================== -mongocli cloud-manager metrics -============================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Get measurements on the state of 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-cloud-manager-metrics-databases` - List available databases or databases measurements for a given host. -* :ref:`mongocli-cloud-manager-metrics-disks` - List available disks or disks measurements for a given host. -* :ref:`mongocli-cloud-manager-metrics-process` - Get measurements for a given host. - - -.. toctree:: - :titlesonly: - - databases - disks - process - diff --git a/docs/mongocli/command/mongocli-cloud-manager-monitoring-disable.txt b/docs/mongocli/command/mongocli-cloud-manager-monitoring-disable.txt deleted file mode 100644 index 5c42ac246c..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-monitoring-disable.txt +++ /dev/null @@ -1,78 +0,0 @@ -.. _mongocli-cloud-manager-monitoring-disable: - -========================================= -mongocli cloud-manager monitoring disable -========================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Disable monitoring for a given hostname - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager monitoring disable [options] - -.. 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 for the hostname. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-cloud-manager-monitoring-enable.txt b/docs/mongocli/command/mongocli-cloud-manager-monitoring-enable.txt deleted file mode 100644 index 3ed50c7852..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-monitoring-enable.txt +++ /dev/null @@ -1,78 +0,0 @@ -.. _mongocli-cloud-manager-monitoring-enable: - -======================================== -mongocli cloud-manager monitoring enable -======================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Enable monitoring for a given hostname - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager monitoring enable [options] - -.. 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 for the hostname. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-cloud-manager-monitoring-stop.txt b/docs/mongocli/command/mongocli-cloud-manager-monitoring-stop.txt deleted file mode 100644 index f51726ec25..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-monitoring-stop.txt +++ /dev/null @@ -1,82 +0,0 @@ -.. _mongocli-cloud-manager-monitoring-stop: - -====================================== -mongocli cloud-manager monitoring stop -====================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Stops monitoring the MongoDB process specified - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager monitoring stop [options] - -.. 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 - - Process identifier. - -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 stop - * - --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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-cloud-manager-monitoring.txt b/docs/mongocli/command/mongocli-cloud-manager-monitoring.txt deleted file mode 100644 index b4d993e9b7..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-monitoring.txt +++ /dev/null @@ -1,63 +0,0 @@ -.. _mongocli-cloud-manager-monitoring: - -================================= -mongocli cloud-manager monitoring -================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage monitoring for your project. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for monitoring - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-cloud-manager-monitoring-disable` - Disable monitoring for a given hostname -* :ref:`mongocli-cloud-manager-monitoring-enable` - Enable monitoring for a given hostname -* :ref:`mongocli-cloud-manager-monitoring-stop` - Stops monitoring the MongoDB process specified - - -.. toctree:: - :titlesonly: - - disable - enable - stop - diff --git a/docs/mongocli/command/mongocli-cloud-manager-performanceAdvisor-namespaces-list.txt b/docs/mongocli/command/mongocli-cloud-manager-performanceAdvisor-namespaces-list.txt deleted file mode 100644 index d4e7b78c3a..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-performanceAdvisor-namespaces-list.txt +++ /dev/null @@ -1,95 +0,0 @@ -.. _mongocli-cloud-manager-performanceAdvisor-namespaces-list: - -========================================================= -mongocli cloud-manager 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 - - mongocli cloud-manager 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 - * - --hostId - - string - - false - - Unique identifier for the host of a MongoDB process. - * - -o, --output - - string - - false - - 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 - - false - - Unique identifier for the host of a MongoDB process in the following format: {hostname}:{port}. - * - --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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - # 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: - mongocli atlas performanceAdvisor namespaces list --processName atlas-111ggi-shard-00-00.111xx.mongodb.net:27017 --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/mongocli/command/mongocli-cloud-manager-performanceAdvisor-namespaces.txt b/docs/mongocli/command/mongocli-cloud-manager-performanceAdvisor-namespaces.txt deleted file mode 100644 index a8b2156bf5..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-performanceAdvisor-namespaces.txt +++ /dev/null @@ -1,59 +0,0 @@ -.. _mongocli-cloud-manager-performanceAdvisor-namespaces: - -==================================================== -mongocli cloud-manager 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-cloud-manager-performanceAdvisor-namespaces-list` - Return up to 20 namespaces for collections experiencing slow queries on the specified host. - - -.. toctree:: - :titlesonly: - - list - diff --git a/docs/mongocli/command/mongocli-cloud-manager-performanceAdvisor-slowOperationThreshold-disable.txt b/docs/mongocli/command/mongocli-cloud-manager-performanceAdvisor-slowOperationThreshold-disable.txt deleted file mode 100644 index dd97e4575a..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-performanceAdvisor-slowOperationThreshold-disable.txt +++ /dev/null @@ -1,66 +0,0 @@ -.. _mongocli-cloud-manager-performanceAdvisor-slowOperationThreshold-disable: - -======================================================================== -mongocli cloud-manager 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 - - mongocli cloud-manager 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-cloud-manager-performanceAdvisor-slowOperationThreshold-enable.txt b/docs/mongocli/command/mongocli-cloud-manager-performanceAdvisor-slowOperationThreshold-enable.txt deleted file mode 100644 index f661ed8dec..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-performanceAdvisor-slowOperationThreshold-enable.txt +++ /dev/null @@ -1,66 +0,0 @@ -.. _mongocli-cloud-manager-performanceAdvisor-slowOperationThreshold-enable: - -======================================================================= -mongocli cloud-manager 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 - - mongocli cloud-manager 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-cloud-manager-performanceAdvisor-slowOperationThreshold.txt b/docs/mongocli/command/mongocli-cloud-manager-performanceAdvisor-slowOperationThreshold.txt deleted file mode 100644 index 8f0d191ba1..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-performanceAdvisor-slowOperationThreshold.txt +++ /dev/null @@ -1,61 +0,0 @@ -.. _mongocli-cloud-manager-performanceAdvisor-slowOperationThreshold: - -================================================================ -mongocli cloud-manager 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-cloud-manager-performanceAdvisor-slowOperationThreshold-disable` - Disable the application-managed slow operation threshold for your project. -* :ref:`mongocli-cloud-manager-performanceAdvisor-slowOperationThreshold-enable` - Enable the application-managed slow operation threshold for your project. - - -.. toctree:: - :titlesonly: - - disable - enable - diff --git a/docs/mongocli/command/mongocli-cloud-manager-performanceAdvisor-slowQueryLogs-list.txt b/docs/mongocli/command/mongocli-cloud-manager-performanceAdvisor-slowQueryLogs-list.txt deleted file mode 100644 index 840b7caee7..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-performanceAdvisor-slowQueryLogs-list.txt +++ /dev/null @@ -1,103 +0,0 @@ -.. _mongocli-cloud-manager-performanceAdvisor-slowQueryLogs-list: - -============================================================ -mongocli cloud-manager 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 - - mongocli cloud-manager 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 - * - --hostId - - string - - false - - Unique identifier for the host of a MongoDB process. - * - --nLog - - int - - false - - Maximum number of log lines to return. This value defaults to 20000. - * - --namespaces - - string - - 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 - - false - - Unique identifier for the host of a MongoDB process in the following format: {hostname}:{port}. - * - --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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - # 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: - mongocli atlas performanceAdvisor slowQueryLogs list --processName atlas-111ggi-shard-00-00.111xx.mongodb.net:27017 --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/mongocli/command/mongocli-cloud-manager-performanceAdvisor-slowQueryLogs.txt b/docs/mongocli/command/mongocli-cloud-manager-performanceAdvisor-slowQueryLogs.txt deleted file mode 100644 index afe31091b7..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-performanceAdvisor-slowQueryLogs.txt +++ /dev/null @@ -1,59 +0,0 @@ -.. _mongocli-cloud-manager-performanceAdvisor-slowQueryLogs: - -======================================================= -mongocli cloud-manager 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-cloud-manager-performanceAdvisor-slowQueryLogs-list` - Return log lines for slow queries that the Performance Advisor and Query Profiler identified. - - -.. toctree:: - :titlesonly: - - list - diff --git a/docs/mongocli/command/mongocli-cloud-manager-performanceAdvisor-suggestedIndexes-list.txt b/docs/mongocli/command/mongocli-cloud-manager-performanceAdvisor-suggestedIndexes-list.txt deleted file mode 100644 index 62d762708b..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-performanceAdvisor-suggestedIndexes-list.txt +++ /dev/null @@ -1,105 +0,0 @@ -.. _mongocli-cloud-manager-performanceAdvisor-suggestedIndexes-list: - -=============================================================== -mongocli cloud-manager 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 - - mongocli cloud-manager 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 - * - --hostId - - string - - false - - Unique identifier for the host of a MongoDB process. - * - --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 - - string - - 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 - - false - - Unique identifier for the host of a MongoDB process in the following format: {hostname}:{port}. - * - --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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - # 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: - mongocli atlas performanceAdvisor suggestedIndexes list --processName atlas-111ggi-shard-00-00.111xx.mongodb.net:27017 --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/mongocli/command/mongocli-cloud-manager-performanceAdvisor-suggestedIndexes.txt b/docs/mongocli/command/mongocli-cloud-manager-performanceAdvisor-suggestedIndexes.txt deleted file mode 100644 index 0400547b5e..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-performanceAdvisor-suggestedIndexes.txt +++ /dev/null @@ -1,59 +0,0 @@ -.. _mongocli-cloud-manager-performanceAdvisor-suggestedIndexes: - -========================================================== -mongocli cloud-manager 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-cloud-manager-performanceAdvisor-suggestedIndexes-list` - Return the suggested indexes for collections experiencing slow queries. - - -.. toctree:: - :titlesonly: - - list - diff --git a/docs/mongocli/command/mongocli-cloud-manager-performanceAdvisor.txt b/docs/mongocli/command/mongocli-cloud-manager-performanceAdvisor.txt deleted file mode 100644 index 79a4816ad9..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-performanceAdvisor.txt +++ /dev/null @@ -1,65 +0,0 @@ -.. _mongocli-cloud-manager-performanceAdvisor: - -========================================= -mongocli cloud-manager 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-cloud-manager-performanceAdvisor-namespaces` - Retrieve namespaces for collections experiencing slow queries -* :ref:`mongocli-cloud-manager-performanceAdvisor-slowOperationThreshold` - Enable or disable management of the slow operation threshold for your cluster. -* :ref:`mongocli-cloud-manager-performanceAdvisor-slowQueryLogs` - Get log lines for slow queries for a specified host -* :ref:`mongocli-cloud-manager-performanceAdvisor-suggestedIndexes` - Get suggested indexes for collections experiencing slow queries - - -.. toctree:: - :titlesonly: - - namespaces - slowOperationThreshold - slowQueryLogs - suggestedIndexes - diff --git a/docs/mongocli/command/mongocli-cloud-manager-processes-describe.txt b/docs/mongocli/command/mongocli-cloud-manager-processes-describe.txt deleted file mode 100644 index 66a084e17a..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-processes-describe.txt +++ /dev/null @@ -1,82 +0,0 @@ -.. _mongocli-cloud-manager-processes-describe: - -========================================= -mongocli cloud-manager processes describe -========================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Describe MongoDB processes for your project. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager 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 - * - hostId - - string - - true - - Process identifier. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-cloud-manager-processes-list.txt b/docs/mongocli/command/mongocli-cloud-manager-processes-list.txt deleted file mode 100644 index 9445565672..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-processes-list.txt +++ /dev/null @@ -1,78 +0,0 @@ -.. _mongocli-cloud-manager-processes-list: - -===================================== -mongocli cloud-manager processes list -===================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -List MongoDB processes for your project. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager 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 - * - --clusterId - - string - - false - - Unique identifier of the cluster. - * - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-cloud-manager-processes.txt b/docs/mongocli/command/mongocli-cloud-manager-processes.txt deleted file mode 100644 index 79c47e18b4..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-processes.txt +++ /dev/null @@ -1,61 +0,0 @@ -.. _mongocli-cloud-manager-processes: - -================================ -mongocli cloud-manager 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-cloud-manager-processes-describe` - Describe MongoDB processes for your project. -* :ref:`mongocli-cloud-manager-processes-list` - List MongoDB processes for your project. - - -.. toctree:: - :titlesonly: - - describe - list - diff --git a/docs/mongocli/command/mongocli-cloud-manager-security-enable.txt b/docs/mongocli/command/mongocli-cloud-manager-security-enable.txt deleted file mode 100644 index 3367760435..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-security-enable.txt +++ /dev/null @@ -1,78 +0,0 @@ -.. _mongocli-cloud-manager-security-enable: - -====================================== -mongocli cloud-manager security enable -====================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Enable authentication mechanisms for your project. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager security enable [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - MONGODB-CR|SCRAM-SHA-256 - - string - - true - - Authentication mechanism. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-cloud-manager-security.txt b/docs/mongocli/command/mongocli-cloud-manager-security.txt deleted file mode 100644 index 29e0de404b..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-security.txt +++ /dev/null @@ -1,59 +0,0 @@ -.. _mongocli-cloud-manager-security: - -=============================== -mongocli cloud-manager 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-cloud-manager-security-enable` - Enable authentication mechanisms for your project. - - -.. toctree:: - :titlesonly: - - enable - diff --git a/docs/mongocli/command/mongocli-cloud-manager-servers-list.txt b/docs/mongocli/command/mongocli-cloud-manager-servers-list.txt deleted file mode 100644 index 47254a9683..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-servers-list.txt +++ /dev/null @@ -1,74 +0,0 @@ -.. _mongocli-cloud-manager-servers-list: - -=================================== -mongocli cloud-manager servers list -=================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -List all available servers running an automation agent for your project. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli cloud-manager servers 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-cloud-manager-servers.txt b/docs/mongocli/command/mongocli-cloud-manager-servers.txt deleted file mode 100644 index be77fb7741..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager-servers.txt +++ /dev/null @@ -1,59 +0,0 @@ -.. _mongocli-cloud-manager-servers: - -============================== -mongocli cloud-manager servers -============================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage automated servers for your project. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for servers - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-cloud-manager-servers-list` - List all available servers running an automation agent for your project. - - -.. toctree:: - :titlesonly: - - list - diff --git a/docs/mongocli/command/mongocli-cloud-manager.txt b/docs/mongocli/command/mongocli-cloud-manager.txt deleted file mode 100644 index 74a9d0049b..0000000000 --- a/docs/mongocli/command/mongocli-cloud-manager.txt +++ /dev/null @@ -1,91 +0,0 @@ -.. _mongocli-cloud-manager: - -====================== -mongocli cloud-manager -====================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -MongoDB Cloud Manager operations. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for cloud-manager - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-cloud-manager-agents` - Manage MongoDB Agents. -* :ref:`mongocli-cloud-manager-alerts` - Manage alerts for your project. -* :ref:`mongocli-cloud-manager-automation` - Manage automation configuration for your project. -* :ref:`mongocli-cloud-manager-backups` - Manage continuous backups for your project. -* :ref:`mongocli-cloud-manager-clusters` - Manage clusters for your project. -* :ref:`mongocli-cloud-manager-dbusers` - Manage database users for your project. -* :ref:`mongocli-cloud-manager-events` - Manage events for your organization or project. -* :ref:`mongocli-cloud-manager-featurePolicies` - Manage feature control policies. -* :ref:`mongocli-cloud-manager-liveMigrations` - Manage a Live Migration to Atlas for your organization. -* :ref:`mongocli-cloud-manager-logs` - Manage log collection jobs for your project. -* :ref:`mongocli-cloud-manager-maintenanceWindows` - Manage Ops Manager/Cloud Manager maintenance windows. -* :ref:`mongocli-cloud-manager-metrics` - Get measurements on the state of the MongoDB process. -* :ref:`mongocli-cloud-manager-monitoring` - Manage monitoring for your project. -* :ref:`mongocli-cloud-manager-performanceAdvisor` - Learn more about slow queries and get suggestions to improve database performance. -* :ref:`mongocli-cloud-manager-processes` - Manage MongoDB processes for your project. -* :ref:`mongocli-cloud-manager-security` - Manage security configuration for your project. -* :ref:`mongocli-cloud-manager-servers` - Manage automated servers for your project. - - -.. toctree:: - :titlesonly: - - agents - alerts - automation - backups - clusters - dbusers - events - featurePolicies - liveMigrations - logs - maintenanceWindows - metrics - monitoring - performanceAdvisor - processes - security - servers - diff --git a/docs/mongocli/command/mongocli-completion-bash.txt b/docs/mongocli/command/mongocli-completion-bash.txt deleted file mode 100644 index f95518d80e..0000000000 --- a/docs/mongocli/command/mongocli-completion-bash.txt +++ /dev/null @@ -1,76 +0,0 @@ -.. _mongocli-completion-bash: - -======================== -mongocli 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 <(mongocli completion bash) -To load completions for every new session, execute once: -Linux: -$ mongocli completion bash > /etc/bash_completion.d/mongocli -MacOS: -$ mongocli completion bash > /usr/local/etc/bash_completion.d/mongocli -You will need to start a new shell for this setup to take effect. - - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-completion-fish.txt b/docs/mongocli/command/mongocli-completion-fish.txt deleted file mode 100644 index 825d0c4ac5..0000000000 --- a/docs/mongocli/command/mongocli-completion-fish.txt +++ /dev/null @@ -1,75 +0,0 @@ -.. _mongocli-completion-fish: - -======================== -mongocli 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: - - mongocli completion fish | source - -To load completions for every new session, execute once: - - mongocli completion fish > ~/.config/fish/completions/mongocli.fish - -You will need to start a new shell for this setup to take effect. - - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-completion-powershell.txt b/docs/mongocli/command/mongocli-completion-powershell.txt deleted file mode 100644 index a9f1faf311..0000000000 --- a/docs/mongocli/command/mongocli-completion-powershell.txt +++ /dev/null @@ -1,72 +0,0 @@ -.. _mongocli-completion-powershell: - -============================== -mongocli 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: - - mongocli 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 - - mongocli 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-completion-zsh.txt b/docs/mongocli/command/mongocli-completion-zsh.txt deleted file mode 100644 index 4ebe05adf2..0000000000 --- a/docs/mongocli/command/mongocli-completion-zsh.txt +++ /dev/null @@ -1,86 +0,0 @@ -.. _mongocli-completion-zsh: - -======================= -mongocli 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 <(mongocli completion zsh) - -To load completions for every new session, execute once: - -#### Linux: - - mongocli completion zsh > "${fpath[1]}/_mongocli" - -#### macOS: - - mongocli completion zsh > $(brew --prefix)/share/zsh/site-functions/_mongocli - -You will need to start a new shell for this setup to take effect. - - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-completion.txt b/docs/mongocli/command/mongocli-completion.txt deleted file mode 100644 index fe7b74d891..0000000000 --- a/docs/mongocli/command/mongocli-completion.txt +++ /dev/null @@ -1,69 +0,0 @@ -.. _mongocli-completion: - -=================== -mongocli 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 mongocli 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-completion-bash` - Generate the autocompletion script for bash -* :ref:`mongocli-completion-fish` - Generate the autocompletion script for fish -* :ref:`mongocli-completion-powershell` - Generate the autocompletion script for powershell -* :ref:`mongocli-completion-zsh` - Generate the autocompletion script for zsh - - -.. toctree:: - :titlesonly: - - bash - fish - powershell - zsh - diff --git a/docs/mongocli/command/mongocli-config-delete.txt b/docs/mongocli/command/mongocli-config-delete.txt deleted file mode 100644 index 5d38b2b6d4..0000000000 --- a/docs/mongocli/command/mongocli-config-delete.txt +++ /dev/null @@ -1,101 +0,0 @@ -.. _mongocli-config-delete: - -====================== -mongocli 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 - - mongocli 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -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:: - - # Delete the default profile configuration: - atlas config delete default - - -.. code-block:: - - # Skip the confirmation question and delete the default profile configuration: - atlas config delete default --force diff --git a/docs/mongocli/command/mongocli-config-describe.txt b/docs/mongocli/command/mongocli-config-describe.txt deleted file mode 100644 index cdd1f1709a..0000000000 --- a/docs/mongocli/command/mongocli-config-describe.txt +++ /dev/null @@ -1,78 +0,0 @@ -.. _mongocli-config-describe: - -======================== -mongocli 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 - - mongocli 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-config-edit.txt b/docs/mongocli/command/mongocli-config-edit.txt deleted file mode 100644 index b9eb6d2510..0000000000 --- a/docs/mongocli/command/mongocli-config-edit.txt +++ /dev/null @@ -1,73 +0,0 @@ -.. _mongocli-config-edit: - -==================== -mongocli 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 - - mongocli 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - # To open the config - mongocli config edit - - -.. toctree:: - :titlesonly: - - diff --git a/docs/mongocli/command/mongocli-config-list.txt b/docs/mongocli/command/mongocli-config-list.txt deleted file mode 100644 index b669350968..0000000000 --- a/docs/mongocli/command/mongocli-config-list.txt +++ /dev/null @@ -1,70 +0,0 @@ -.. _mongocli-config-list: - -==================== -mongocli 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 - - mongocli 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - mongocli config ls diff --git a/docs/mongocli/command/mongocli-config-rename.txt b/docs/mongocli/command/mongocli-config-rename.txt deleted file mode 100644 index df748c47c4..0000000000 --- a/docs/mongocli/command/mongocli-config-rename.txt +++ /dev/null @@ -1,85 +0,0 @@ -.. _mongocli-config-rename: - -====================== -mongocli 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 - - mongocli 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - # Rename a profile called myProfile to testProfile: - mongocli config rename myProfile testProfile diff --git a/docs/mongocli/command/mongocli-config-set.txt b/docs/mongocli/command/mongocli-config-set.txt deleted file mode 100644 index 21a144e726..0000000000 --- a/docs/mongocli/command/mongocli-config-set.txt +++ /dev/null @@ -1,88 +0,0 @@ -.. _mongocli-config-set: - -=================== -mongocli 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 - - mongocli 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 and MongoDB 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. Additionally, values that are only valid for MongoDB CLI include ops_manager_url base_url, ops_manager_ca_certificate, and ops_manager_skip_verify. - * - 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - Set the Ops Manager base URL in the profile myProfile to http://localhost:30700/: - mongocli config set ops_manager_url http://localhost:30700/ -P myProfile - - Set the organization ID in the default profile to 5dd5aaef7a3e5a6c5bd12de4: - mongocli config set org_id 5dd5aaef7a3e5a6c5bd12de4 diff --git a/docs/mongocli/command/mongocli-config.txt b/docs/mongocli/command/mongocli-config.txt deleted file mode 100644 index 87be95d9e5..0000000000 --- a/docs/mongocli/command/mongocli-config.txt +++ /dev/null @@ -1,117 +0,0 @@ -.. _mongocli-config: - -=============== -mongocli config -=============== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Configure and manage your user profiles. - -You can define the settings that the MongoDB CLI uses to interact with MongoDB services. -All settings are optional. You can specify settings individually by running: -$ mongocli config set --help -You can also use environment variables (MCLI_*) when running the tool. -To find out more, see the documentation: https://docs.mongodb.com/mongocli/stable/configure/environment-variables/. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli config [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 config - * - --service - - string - - false - - Type of MongoDB service. Valid values are cloud, cloudgov, cloud-manager, or ops-manager. This value defaults to "cloud". - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - # - -.. code-block:: - - # Configure a profile to interact with Atlas: - mongocli config - -.. code-block:: - - # Configure a profile to interact with Atlas for Government: - mongocli config --service cloudgov - - -.. code-block:: - - # Configure a profile to interact with Cloud Manager: - mongocli config --service cloud-manager - -.. code-block:: - - # Configure a profile to interact with Ops Manager: - mongocli config --service ops-manager - -Related Commands ----------------- - -* :ref:`mongocli-config-delete` - Delete a profile. -* :ref:`mongocli-config-describe` - Return the profile you specify. -* :ref:`mongocli-config-edit` - Opens the config file with the default text editor. -* :ref:`mongocli-config-list` - Return a list of available profiles by name. -* :ref:`mongocli-config-rename` - Rename a profile. -* :ref:`mongocli-config-set` - Configure specific properties of a profile. - - -.. toctree:: - :titlesonly: - - delete - describe - edit - list - rename - set - diff --git a/docs/mongocli/command/mongocli-iam-globalAccessLists-create.txt b/docs/mongocli/command/mongocli-iam-globalAccessLists-create.txt deleted file mode 100644 index f54fb89152..0000000000 --- a/docs/mongocli/command/mongocli-iam-globalAccessLists-create.txt +++ /dev/null @@ -1,77 +0,0 @@ -.. _mongocli-iam-globalAccessLists-create: - -===================================== -mongocli iam globalAccessLists create -===================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create an IP access list entry for your global API key. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli iam globalAccessLists 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 - * - --cidr - - string - - true - - 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. - * - --desc - - string - - true - - 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. - * - -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. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - # Create an access list entry for your global API key to allow access from 192.0.2.0/24: - mongocli iam globalAccessLists create --cidr 192.0.2.0/24 --desc "My Global IP" --output json diff --git a/docs/mongocli/command/mongocli-iam-globalAccessLists-delete.txt b/docs/mongocli/command/mongocli-iam-globalAccessLists-delete.txt deleted file mode 100644 index bd2ae16d05..0000000000 --- a/docs/mongocli/command/mongocli-iam-globalAccessLists-delete.txt +++ /dev/null @@ -1,85 +0,0 @@ -.. _mongocli-iam-globalAccessLists-delete: - -===================================== -mongocli iam globalAccessLists delete -===================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Remove the specified IP access list entry for your global API key. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli iam globalAccessLists 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 access list entry. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - # Remove the IP access list entry with the ID 5f5bad7a57aef32b04ed0210 from the access list for the global API key: - mongocli iam globalAccessLists delete 5f5bad7a57aef32b04ed0210 diff --git a/docs/mongocli/command/mongocli-iam-globalAccessLists-describe.txt b/docs/mongocli/command/mongocli-iam-globalAccessLists-describe.txt deleted file mode 100644 index c61b516a05..0000000000 --- a/docs/mongocli/command/mongocli-iam-globalAccessLists-describe.txt +++ /dev/null @@ -1,85 +0,0 @@ -.. _mongocli-iam-globalAccessLists-describe: - -======================================= -mongocli iam globalAccessLists describe -======================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return the details for the specified access list entry for your global API key. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli iam globalAccessLists 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 access list entry. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - # Return the JSON-formatted details for the access list entry with the ID 5f5bad7a57aef32b04ed0210 from the access list for the global API key: - mongocli iam globalAccessLists describe 5f5bad7a57aef32b04ed0210 --output json diff --git a/docs/mongocli/command/mongocli-iam-globalAccessLists-list.txt b/docs/mongocli/command/mongocli-iam-globalAccessLists-list.txt deleted file mode 100644 index 2a5871ec0a..0000000000 --- a/docs/mongocli/command/mongocli-iam-globalAccessLists-list.txt +++ /dev/null @@ -1,88 +0,0 @@ -.. _mongocli-iam-globalAccessLists-list: - -=================================== -mongocli iam globalAccessLists list -=================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return all IP access list entries for your global API key. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli iam globalAccessLists 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. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - ID CIDR BLOCK CREATED AT - - - -Examples --------- - -.. code-block:: - - # Return a JSON-formatted list of all access list entries for the global API key: - mongocli iam globalAccessLists list --output json diff --git a/docs/mongocli/command/mongocli-iam-globalAccessLists.txt b/docs/mongocli/command/mongocli-iam-globalAccessLists.txt deleted file mode 100644 index ff98eb44a2..0000000000 --- a/docs/mongocli/command/mongocli-iam-globalAccessLists.txt +++ /dev/null @@ -1,65 +0,0 @@ -.. _mongocli-iam-globalAccessLists: - -============================== -mongocli iam globalAccessLists -============================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage IP access list for Global API Key. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for globalAccessLists - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-iam-globalAccessLists-create` - Create an IP access list entry for your global API key. -* :ref:`mongocli-iam-globalAccessLists-delete` - Remove the specified IP access list entry for your global API key. -* :ref:`mongocli-iam-globalAccessLists-describe` - Return the details for the specified access list entry for your global API key. -* :ref:`mongocli-iam-globalAccessLists-list` - Return all IP access list entries for your global API key. - - -.. toctree:: - :titlesonly: - - create - delete - describe - list - diff --git a/docs/mongocli/command/mongocli-iam-globalApiKeys-create.txt b/docs/mongocli/command/mongocli-iam-globalApiKeys-create.txt deleted file mode 100644 index b07787b8ed..0000000000 --- a/docs/mongocli/command/mongocli-iam-globalApiKeys-create.txt +++ /dev/null @@ -1,77 +0,0 @@ -.. _mongocli-iam-globalApiKeys-create: - -================================= -mongocli iam globalApiKeys create -================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create a global API key for your Ops Manager instance. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli iam globalApiKeys 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. - * - --role - - strings - - true - - Role or roles that you want to assign to the API key. To assign more than one role, you can specify each role with a separate role flag or specify all of the roles as a comma-separated list using one role flag. Valid values are GLOBAL_AUTOMATION_ADMIN, GLOBAL_BACKUP_ADMIN GLOBAL_MONITORING_ADMIN, GLOBAL_OWNER, GLOBAL_READ_ONLY,GLOBAL_USER_ADMIN. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - # Create a global API key that grants GLOBAL_READ_ONLY and GLOBAL_USER_ADMIN access for your Ops Manager instance: - mongocli iam globalApiKeys create --desc "My Global API key" --role "GLOBAL_READ_ONLY","GLOBAL_USER_ADMIN" --output json diff --git a/docs/mongocli/command/mongocli-iam-globalApiKeys-delete.txt b/docs/mongocli/command/mongocli-iam-globalApiKeys-delete.txt deleted file mode 100644 index b50caf76a7..0000000000 --- a/docs/mongocli/command/mongocli-iam-globalApiKeys-delete.txt +++ /dev/null @@ -1,85 +0,0 @@ -.. _mongocli-iam-globalApiKeys-delete: - -================================= -mongocli iam globalApiKeys delete -================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Remove the specified global API key from your Ops Manager instance. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli iam globalApiKeys 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 global 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 - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - # Remove the global API key with the ID 5f5bad7a57aef32b04ed0210 from your Ops Manager instance: - mongocli iam globalApiKeys delete 5f5bad7a57aef32b04ed0210 diff --git a/docs/mongocli/command/mongocli-iam-globalApiKeys-describe.txt b/docs/mongocli/command/mongocli-iam-globalApiKeys-describe.txt deleted file mode 100644 index 4dd73f1dca..0000000000 --- a/docs/mongocli/command/mongocli-iam-globalApiKeys-describe.txt +++ /dev/null @@ -1,85 +0,0 @@ -.. _mongocli-iam-globalApiKeys-describe: - -=================================== -mongocli iam globalApiKeys describe -=================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return the details for the specified global API key for your Ops Manager instance. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli iam globalApiKeys 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 global API key. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - # Return the JSON-formatted details for the global API key with the ID 5f5bad7a57aef32b04ed0210: - mongocli iam globalApiKeys describe 5f5bad7a57aef32b04ed0210 --output json diff --git a/docs/mongocli/command/mongocli-iam-globalApiKeys-list.txt b/docs/mongocli/command/mongocli-iam-globalApiKeys-list.txt deleted file mode 100644 index bf02b1a392..0000000000 --- a/docs/mongocli/command/mongocli-iam-globalApiKeys-list.txt +++ /dev/null @@ -1,77 +0,0 @@ -.. _mongocli-iam-globalApiKeys-list: - -=============================== -mongocli iam globalApiKeys list -=============================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return all global API keys for your Ops Manager instance. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli iam globalApiKeys 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. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - # Return a JSON-formatted list of global API keys: - mongocli iam globalApiKeys list --output json diff --git a/docs/mongocli/command/mongocli-iam-globalApiKeys-update.txt b/docs/mongocli/command/mongocli-iam-globalApiKeys-update.txt deleted file mode 100644 index d82b769498..0000000000 --- a/docs/mongocli/command/mongocli-iam-globalApiKeys-update.txt +++ /dev/null @@ -1,93 +0,0 @@ -.. _mongocli-iam-globalApiKeys-update: - -================================= -mongocli iam globalApiKeys update -================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Modify the roles and description for a global API key. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli iam globalApiKeys 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 - - Unique 24-digit string that identifies the global API key. - -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 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. - * - --role - - strings - - true - - Role or roles that you want to assign to the API key. To assign more than one role, you can specify each role with a separate role flag or specify all of the roles as a comma-separated list using one role flag. Valid values are GLOBAL_AUTOMATION_ADMIN, GLOBAL_BACKUP_ADMIN GLOBAL_MONITORING_ADMIN, GLOBAL_OWNER, GLOBAL_READ_ONLY,GLOBAL_USER_ADMIN. 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - # Modify the roles and description for the global API key with the ID 5f5bad7a57aef32b04ed0210: - mongocli iam globalApiKeys update 5f5bad7a57aef32b04ed0210 --desc "My Sample Global API Key" --role GLOBAL_MONITORING_ADMIN --output json diff --git a/docs/mongocli/command/mongocli-iam-globalApiKeys.txt b/docs/mongocli/command/mongocli-iam-globalApiKeys.txt deleted file mode 100644 index a9b0b551b1..0000000000 --- a/docs/mongocli/command/mongocli-iam-globalApiKeys.txt +++ /dev/null @@ -1,67 +0,0 @@ -.. _mongocli-iam-globalApiKeys: - -========================== -mongocli iam globalApiKeys -========================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Global API Keys operations. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for globalApiKeys - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-iam-globalApiKeys-create` - Create a global API key for your Ops Manager instance. -* :ref:`mongocli-iam-globalApiKeys-delete` - Remove the specified global API key from your Ops Manager instance. -* :ref:`mongocli-iam-globalApiKeys-describe` - Return the details for the specified global API key for your Ops Manager instance. -* :ref:`mongocli-iam-globalApiKeys-list` - Return all global API keys for your Ops Manager instance. -* :ref:`mongocli-iam-globalApiKeys-update` - Modify the roles and description for a global API key. - - -.. toctree:: - :titlesonly: - - create - delete - describe - list - update - diff --git a/docs/mongocli/command/mongocli-iam-organizations-apiKeys-accessLists-create.txt b/docs/mongocli/command/mongocli-iam-organizations-apiKeys-accessLists-create.txt deleted file mode 100644 index 4fc87e8659..0000000000 --- a/docs/mongocli/command/mongocli-iam-organizations-apiKeys-accessLists-create.txt +++ /dev/null @@ -1,103 +0,0 @@ -.. _mongocli-iam-organizations-apiKeys-accessLists-create: - -===================================================== -mongocli iam 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 mongocli 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 - - mongocli iam 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -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:: - - # Create access list entries for two IP addresses for the API key with the ID 5f24084d8dbffa3ad3f21234 in the organization with the ID 5a1b39eec902201990f12345: - mongocli 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/mongocli/command/mongocli-iam-organizations-apiKeys-accessLists-delete.txt b/docs/mongocli/command/mongocli-iam-organizations-apiKeys-accessLists-delete.txt deleted file mode 100644 index bd6dcd8beb..0000000000 --- a/docs/mongocli/command/mongocli-iam-organizations-apiKeys-accessLists-delete.txt +++ /dev/null @@ -1,105 +0,0 @@ -.. _mongocli-iam-organizations-apiKeys-accessLists-delete: - -===================================================== -mongocli iam 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 - - mongocli iam 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. If the entry includes a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -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:: - - # 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: - mongocli organizations apiKeys accessLists delete 192.0.2.0 --apiKey 5f24084d8dbffa3ad3f21234 --orgId 5a1b39eec902201990f12345 diff --git a/docs/mongocli/command/mongocli-iam-organizations-apiKeys-accessLists-list.txt b/docs/mongocli/command/mongocli-iam-organizations-apiKeys-accessLists-list.txt deleted file mode 100644 index b3e51e69cd..0000000000 --- a/docs/mongocli/command/mongocli-iam-organizations-apiKeys-accessLists-list.txt +++ /dev/null @@ -1,101 +0,0 @@ -.. _mongocli-iam-organizations-apiKeys-accessLists-list: - -=================================================== -mongocli iam 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 mongocli 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 - - mongocli iam 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. - * - --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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - # Return a JSON-formatted list of access list entries for the API key with the ID 5f24084d8dbffa3ad3f21234 in the organization with the ID 5a1b39eec902201990f12345: - mongocli organizations apiKeys accessLists list --apiKey 5f24084d8dbffa3ad3f21234 --orgId 5a1b39eec902201990f12345 --output json diff --git a/docs/mongocli/command/mongocli-iam-organizations-apiKeys-accessLists.txt b/docs/mongocli/command/mongocli-iam-organizations-apiKeys-accessLists.txt deleted file mode 100644 index 44082e2008..0000000000 --- a/docs/mongocli/command/mongocli-iam-organizations-apiKeys-accessLists.txt +++ /dev/null @@ -1,63 +0,0 @@ -.. _mongocli-iam-organizations-apiKeys-accessLists: - -============================================== -mongocli iam 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-iam-organizations-apiKeys-accessLists-create` - Create an IP access list entry for your API Key. -* :ref:`mongocli-iam-organizations-apiKeys-accessLists-delete` - Remove the specified IP access list entry from your API Key. -* :ref:`mongocli-iam-organizations-apiKeys-accessLists-list` - Return all IP access list entries for your API Key. - - -.. toctree:: - :titlesonly: - - create - delete - list - diff --git a/docs/mongocli/command/mongocli-iam-organizations-apiKeys-assign.txt b/docs/mongocli/command/mongocli-iam-organizations-apiKeys-assign.txt deleted file mode 100644 index 2b71253dc3..0000000000 --- a/docs/mongocli/command/mongocli-iam-organizations-apiKeys-assign.txt +++ /dev/null @@ -1,113 +0,0 @@ -.. _mongocli-iam-organizations-apiKeys-assign: - -========================================= -mongocli iam 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 mongocli 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 - - mongocli iam 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -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:: - - # Modify the role and description for the API key with the ID 5f24084d8dbffa3ad3f21234 for the organization with the ID 5a1b39eec902201990f12345: - mongocli organizations apiKeys assign 5f24084d8dbffa3ad3f21234 --role ORG_MEMBER --desc "User1 Member Key" --orgId 5a1b39eec902201990f12345 --output json diff --git a/docs/mongocli/command/mongocli-iam-organizations-apiKeys-create.txt b/docs/mongocli/command/mongocli-iam-organizations-apiKeys-create.txt deleted file mode 100644 index 5409ca9c26..0000000000 --- a/docs/mongocli/command/mongocli-iam-organizations-apiKeys-create.txt +++ /dev/null @@ -1,97 +0,0 @@ -.. _mongocli-iam-organizations-apiKeys-create: - -========================================= -mongocli iam 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 - - mongocli iam 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -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:: - - # Create an organization API key with organization owner access in the organization with the ID 5a1b39eec902201990f12345: - mongocli organizations apiKeys create --role ORG_OWNER --desc "My API Key" --orgId 5a1b39eec902201990f12345 --output json diff --git a/docs/mongocli/command/mongocli-iam-organizations-apiKeys-delete.txt b/docs/mongocli/command/mongocli-iam-organizations-apiKeys-delete.txt deleted file mode 100644 index 5bdb1aa0f8..0000000000 --- a/docs/mongocli/command/mongocli-iam-organizations-apiKeys-delete.txt +++ /dev/null @@ -1,103 +0,0 @@ -.. _mongocli-iam-organizations-apiKeys-delete: - -========================================= -mongocli iam 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 mongocli 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 - - mongocli iam 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -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:: - - # Remove the organization API key with the ID 5f24084d8dbffa3ad3f21234 for the organization with the ID 5a1b39eec902201990f12345: - mongocli organizations apiKeys delete 5f24084d8dbffa3ad3f21234 --orgId 5a1b39eec902201990f12345 diff --git a/docs/mongocli/command/mongocli-iam-organizations-apiKeys-describe.txt b/docs/mongocli/command/mongocli-iam-organizations-apiKeys-describe.txt deleted file mode 100644 index e18f3b1021..0000000000 --- a/docs/mongocli/command/mongocli-iam-organizations-apiKeys-describe.txt +++ /dev/null @@ -1,104 +0,0 @@ -.. _mongocli-iam-organizations-apiKeys-describe: - -=========================================== -mongocli iam 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 mongocli 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 - - mongocli iam 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -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:: - - # Return the JSON-formatted details for the organization API key with the ID 5f24084d8dbffa3ad3f21234 for the organization with the ID 5a1b39eec902201990f12345: - mongocli organizations apiKeys describe 5f24084d8dbffa3ad3f21234 --orgId 5a1b39eec902201990f12345 -output json diff --git a/docs/mongocli/command/mongocli-iam-organizations-apiKeys-list.txt b/docs/mongocli/command/mongocli-iam-organizations-apiKeys-list.txt deleted file mode 100644 index ce71e4d656..0000000000 --- a/docs/mongocli/command/mongocli-iam-organizations-apiKeys-list.txt +++ /dev/null @@ -1,83 +0,0 @@ -.. _mongocli-iam-organizations-apiKeys-list: - -======================================= -mongocli iam 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 - - mongocli iam 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 - * - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - # Return a JSON-formatted list of organization API keys for the organization with the ID 5a1b39eec902201990f12345: - mongocli organizations apiKeys list --orgId 5a1b39eec902201990f12345 --output json diff --git a/docs/mongocli/command/mongocli-iam-organizations-apiKeys.txt b/docs/mongocli/command/mongocli-iam-organizations-apiKeys.txt deleted file mode 100644 index cd66615507..0000000000 --- a/docs/mongocli/command/mongocli-iam-organizations-apiKeys.txt +++ /dev/null @@ -1,69 +0,0 @@ -.. _mongocli-iam-organizations-apiKeys: - -================================== -mongocli iam 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-iam-organizations-apiKeys-accessLists` - Manage the IP access list for your API Key. -* :ref:`mongocli-iam-organizations-apiKeys-assign` - Modify the roles or description for the specified organization API key. -* :ref:`mongocli-iam-organizations-apiKeys-create` - Create an API Key for your organization. -* :ref:`mongocli-iam-organizations-apiKeys-delete` - Remove the specified API key for your organization. -* :ref:`mongocli-iam-organizations-apiKeys-describe` - Return the details for the specified API key for your organization. -* :ref:`mongocli-iam-organizations-apiKeys-list` - Return all API keys for your organization. - - -.. toctree:: - :titlesonly: - - accessLists - assign - create - delete - describe - list - diff --git a/docs/mongocli/command/mongocli-iam-organizations-create.txt b/docs/mongocli/command/mongocli-iam-organizations-create.txt deleted file mode 100644 index f9d0daa891..0000000000 --- a/docs/mongocli/command/mongocli-iam-organizations-create.txt +++ /dev/null @@ -1,95 +0,0 @@ -.. _mongocli-iam-organizations-create: - -================================= -mongocli iam organizations create -================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create an Ops Manager or Cloud Manager organization. This command is unavailable for Atlas. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli iam 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 - * - -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. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Organization '' created. - - -Examples --------- - -.. code-block:: - - # Create an Ops Manager organization with the name myOrg: - mongocli iam organizations create myOrg --output json diff --git a/docs/mongocli/command/mongocli-iam-organizations-delete.txt b/docs/mongocli/command/mongocli-iam-organizations-delete.txt deleted file mode 100644 index e9bc8fbe62..0000000000 --- a/docs/mongocli/command/mongocli-iam-organizations-delete.txt +++ /dev/null @@ -1,99 +0,0 @@ -.. _mongocli-iam-organizations-delete: - -================================= -mongocli iam 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 - - mongocli iam 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -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:: - - # Remove the organization with the ID 5e2211c17a3e5a48f5497de3: - mongocli organizations delete 5e2211c17a3e5a48f5497de3 diff --git a/docs/mongocli/command/mongocli-iam-organizations-describe.txt b/docs/mongocli/command/mongocli-iam-organizations-describe.txt deleted file mode 100644 index 7f013c0d55..0000000000 --- a/docs/mongocli/command/mongocli-iam-organizations-describe.txt +++ /dev/null @@ -1,98 +0,0 @@ -.. _mongocli-iam-organizations-describe: - -=================================== -mongocli iam 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 - - mongocli iam 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -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:: - - # Return the JSON-formatted details for the organization with the ID 5e2211c17a3e5a48f5497de3: - mongocli organizations describe 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/mongocli/command/mongocli-iam-organizations-invitations-delete.txt b/docs/mongocli/command/mongocli-iam-organizations-invitations-delete.txt deleted file mode 100644 index b591293982..0000000000 --- a/docs/mongocli/command/mongocli-iam-organizations-invitations-delete.txt +++ /dev/null @@ -1,101 +0,0 @@ -.. _mongocli-iam-organizations-invitations-delete: - -============================================= -mongocli iam 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 - - mongocli iam 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -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:: - - # Remove the pending invitation with the ID 5dd56c847a3e5a1f363d424d from the organization with the ID 5f71e5255afec75a3d0f96dc: - mongocli organizations invitations delete 5dd56c847a3e5a1f363d424d --orgId 5f71e5255afec75a3d0f96dc diff --git a/docs/mongocli/command/mongocli-iam-organizations-invitations-describe.txt b/docs/mongocli/command/mongocli-iam-organizations-invitations-describe.txt deleted file mode 100644 index 1798956b88..0000000000 --- a/docs/mongocli/command/mongocli-iam-organizations-invitations-describe.txt +++ /dev/null @@ -1,102 +0,0 @@ -.. _mongocli-iam-organizations-invitations-describe: - -=============================================== -mongocli iam 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 - - mongocli iam 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - ID USERNAME CREATED AT EXPIRES AT - - - -Examples --------- - -.. code-block:: - - # Return the JSON-formatted details of the pending invitation with the ID 5dd56c847a3e5a1f363d424d for the organization with the ID 5f71e5255afec75a3d0f96dc: - mongocli organizations invitations describe 5dd56c847a3e5a1f363d424d --orgId 5f71e5255afec75a3d0f96dc --output json diff --git a/docs/mongocli/command/mongocli-iam-organizations-invitations-invite.txt b/docs/mongocli/command/mongocli-iam-organizations-invitations-invite.txt deleted file mode 100644 index 1847c5cec2..0000000000 --- a/docs/mongocli/command/mongocli-iam-organizations-invitations-invite.txt +++ /dev/null @@ -1,99 +0,0 @@ -.. _mongocli-iam-organizations-invitations-invite: - -============================================= -mongocli iam 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 - - mongocli iam 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 - * - -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 - - true - - User's roles for the associated organization. To learn which values MCLI accepts, see the Items Enum for roles in the Atlas API spec: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/#operation/createOrganizationInvitation/. - * - --teamId - - strings - - false - - 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - # Invite the MongoDB user with the email user@example.com to the organization with the ID 5f71e5255afec75a3d0f96dc with ORG_OWNER access: - mongocli organizations invitations invite user@example.com --orgId 5f71e5255afec75a3d0f96dc --role ORG_OWNER --output json diff --git a/docs/mongocli/command/mongocli-iam-organizations-invitations-list.txt b/docs/mongocli/command/mongocli-iam-organizations-invitations-list.txt deleted file mode 100644 index fdb744c34b..0000000000 --- a/docs/mongocli/command/mongocli-iam-organizations-invitations-list.txt +++ /dev/null @@ -1,79 +0,0 @@ -.. _mongocli-iam-organizations-invitations-list: - -=========================================== -mongocli iam 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 - - mongocli iam 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - # Return a JSON-formatted list of pending invitations to the organization with the ID 5f71e5255afec75a3d0f96dc: - mongocli organizations invitations list --orgId 5f71e5255afec75a3d0f96dc --output json diff --git a/docs/mongocli/command/mongocli-iam-organizations-invitations-update.txt b/docs/mongocli/command/mongocli-iam-organizations-invitations-update.txt deleted file mode 100644 index 6d240fd8b7..0000000000 --- a/docs/mongocli/command/mongocli-iam-organizations-invitations-update.txt +++ /dev/null @@ -1,117 +0,0 @@ -.. _mongocli-iam-organizations-invitations-update: - -============================================= -mongocli iam 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 - - mongocli iam 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. To learn which values MCLI accepts, see the Items Enum for roles in the Atlas API spec: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/#operation/createOrganizationInvitation/. 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -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:: - - # Modify the pending invitation with the ID 5dd56c847a3e5a1f363d424d to grant ORG_OWNER access the organization with the ID 5f71e5255afec75a3d0f96dc: - mongocli organizations invitations update 5dd56c847a3e5a1f363d424d --orgId 5f71e5255afec75a3d0f96dc --role ORG_OWNER --output json - - -.. code-block:: - - # Modify the invitation for the user with the email address user@example.com to grant ORG_OWNER access the organization with the ID 5f71e5255afec75a3d0f96dc: - mongocli organizations invitations update --email user@example.com --orgId 5f71e5255afec75a3d0f96dc --role ORG_OWNER --output json diff --git a/docs/mongocli/command/mongocli-iam-organizations-invitations.txt b/docs/mongocli/command/mongocli-iam-organizations-invitations.txt deleted file mode 100644 index a98ccec5b8..0000000000 --- a/docs/mongocli/command/mongocli-iam-organizations-invitations.txt +++ /dev/null @@ -1,69 +0,0 @@ -.. _mongocli-iam-organizations-invitations: - -====================================== -mongocli iam 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-iam-organizations-invitations-delete` - Remove the specified pending invitation to your organization. -* :ref:`mongocli-iam-organizations-invitations-describe` - Return the details for the specified pending invitation to your organization. -* :ref:`mongocli-iam-organizations-invitations-invite` - Invite the specified MongoDB user to your organization. -* :ref:`mongocli-iam-organizations-invitations-list` - Return all pending invitations to your organization. -* :ref:`mongocli-iam-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/mongocli/command/mongocli-iam-organizations-list.txt b/docs/mongocli/command/mongocli-iam-organizations-list.txt deleted file mode 100644 index c6095df475..0000000000 --- a/docs/mongocli/command/mongocli-iam-organizations-list.txt +++ /dev/null @@ -1,104 +0,0 @@ -.. _mongocli-iam-organizations-list: - -=============================== -mongocli iam 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 - - mongocli iam 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 indictaes 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. - * - -o, --output - - string - - false - - 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -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:: - - # Return a JSON-formatted list of all organizations: - mongocli organizations list --output json - - -.. code-block:: - - # Return a JSON-formatted list that includes the organizations named org1 and Org1, but doesn't return org123: - mongocli organizations list --name org1 --output json diff --git a/docs/mongocli/command/mongocli-iam-organizations-users-list.txt b/docs/mongocli/command/mongocli-iam-organizations-users-list.txt deleted file mode 100644 index 059e4eb45d..0000000000 --- a/docs/mongocli/command/mongocli-iam-organizations-users-list.txt +++ /dev/null @@ -1,94 +0,0 @@ -.. _mongocli-iam-organizations-users-list: - -===================================== -mongocli iam 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 - - mongocli iam 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. - * - --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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -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:: - - # Return a JSON-formatted list of all users for the organization with the ID 5e2211c17a3e5a48f5497de3: - mongocli organizations users list --orgId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/mongocli/command/mongocli-iam-organizations-users.txt b/docs/mongocli/command/mongocli-iam-organizations-users.txt deleted file mode 100644 index 151ea699a6..0000000000 --- a/docs/mongocli/command/mongocli-iam-organizations-users.txt +++ /dev/null @@ -1,59 +0,0 @@ -.. _mongocli-iam-organizations-users: - -================================ -mongocli iam organizations users -================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage your Ops Manager or Cloud Manager 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-iam-organizations-users-list` - Return all users for an organization. - - -.. toctree:: - :titlesonly: - - list - diff --git a/docs/mongocli/command/mongocli-iam-organizations.txt b/docs/mongocli/command/mongocli-iam-organizations.txt deleted file mode 100644 index e5309196e9..0000000000 --- a/docs/mongocli/command/mongocli-iam-organizations.txt +++ /dev/null @@ -1,73 +0,0 @@ -.. _mongocli-iam-organizations: - -========================== -mongocli iam organizations -========================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage your Ops Manager or Cloud Manager 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-iam-organizations-apiKeys` - Organization API Keys operations. -* :ref:`mongocli-iam-organizations-create` - Create an Ops Manager or Cloud Manager organization. This command is unavailable for Atlas. -* :ref:`mongocli-iam-organizations-delete` - Remove the specified organization. -* :ref:`mongocli-iam-organizations-describe` - Return the details for the specified organizations. -* :ref:`mongocli-iam-organizations-invitations` - Invitation operations. -* :ref:`mongocli-iam-organizations-list` - Return all organizations. -* :ref:`mongocli-iam-organizations-users` - Manage your Ops Manager or Cloud Manager users. - - -.. toctree:: - :titlesonly: - - apiKeys - create - delete - describe - invitations - list - users - diff --git a/docs/mongocli/command/mongocli-iam-projects-apiKeys-assign.txt b/docs/mongocli/command/mongocli-iam-projects-apiKeys-assign.txt deleted file mode 100644 index 538f28c3b6..0000000000 --- a/docs/mongocli/command/mongocli-iam-projects-apiKeys-assign.txt +++ /dev/null @@ -1,97 +0,0 @@ -.. _mongocli-iam-projects-apiKeys-assign: - -==================================== -mongocli iam 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 mongocli organizations apiKeys list. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli iam 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - # Assign an organization API key with the ID 5f46ae53d58b421fe3edc115 and grant the GROUP_DATA_ACCESS_READ_WRITE role for the project with ID 5e2211c17a3e5a48f5497de3: - mongocli projects apiKeys assign 5f46ae53d58b421fe3edc115 --projectId 5e1234c17a3e5a48f5497de3 --role GROUP_DATA_ACCESS_READ_WRITE --output json diff --git a/docs/mongocli/command/mongocli-iam-projects-apiKeys-create.txt b/docs/mongocli/command/mongocli-iam-projects-apiKeys-create.txt deleted file mode 100644 index bbaef3cfc5..0000000000 --- a/docs/mongocli/command/mongocli-iam-projects-apiKeys-create.txt +++ /dev/null @@ -1,97 +0,0 @@ -.. _mongocli-iam-projects-apiKeys-create: - -==================================== -mongocli iam 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 - - mongocli iam 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -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:: - - # Create an organization API key with the ORG_OWNER role and assign it to the project with ID 5e2211c17a3e5a48f5497de3: - mongocli projects apiKeys create --desc "My API key" --projectId 5e1234c17a3e5a48f5497de3 --role ORG_OWNER --output json diff --git a/docs/mongocli/command/mongocli-iam-projects-apiKeys-delete.txt b/docs/mongocli/command/mongocli-iam-projects-apiKeys-delete.txt deleted file mode 100644 index ef6d372eef..0000000000 --- a/docs/mongocli/command/mongocli-iam-projects-apiKeys-delete.txt +++ /dev/null @@ -1,105 +0,0 @@ -.. _mongocli-iam-projects-apiKeys-delete: - -==================================== -mongocli iam 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 mongocli projects apiKeys assign command. - -To view possible values for the ID argument, run mongocli 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 - - mongocli iam 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -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:: - - # Remove an organization API key with the ID 5f46ae53d58b421fe3edc115 from the project with ID 5e2211c17a3e5a48f5497de3: - mongocli projects apiKeys delete 5f46ae53d58b421fe3edc115 --projectId 5e1234c17a3e5a48f5497de3 diff --git a/docs/mongocli/command/mongocli-iam-projects-apiKeys-list.txt b/docs/mongocli/command/mongocli-iam-projects-apiKeys-list.txt deleted file mode 100644 index 825c550e35..0000000000 --- a/docs/mongocli/command/mongocli-iam-projects-apiKeys-list.txt +++ /dev/null @@ -1,83 +0,0 @@ -.. _mongocli-iam-projects-apiKeys-list: - -================================== -mongocli iam 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 - - mongocli iam 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 - * - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - # Return a JSON-formatted list of organization API keys assigned to the project with ID 5e2211c17a3e5a48f5497de3: - mongocli projects apiKeys list --projectId 5e1234c17a3e5a48f5497de3 --output json diff --git a/docs/mongocli/command/mongocli-iam-projects-apiKeys.txt b/docs/mongocli/command/mongocli-iam-projects-apiKeys.txt deleted file mode 100644 index 16d7cc6985..0000000000 --- a/docs/mongocli/command/mongocli-iam-projects-apiKeys.txt +++ /dev/null @@ -1,65 +0,0 @@ -.. _mongocli-iam-projects-apiKeys: - -============================= -mongocli iam 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-iam-projects-apiKeys-assign` - Assign the specified organization API key to your project and modify the API key's roles for the project. -* :ref:`mongocli-iam-projects-apiKeys-create` - Create an organization API key and assign it to your project. -* :ref:`mongocli-iam-projects-apiKeys-delete` - Remove the specified organization API key from your project. -* :ref:`mongocli-iam-projects-apiKeys-list` - Return all organization API keys assigned to your project. - - -.. toctree:: - :titlesonly: - - assign - create - delete - list - diff --git a/docs/mongocli/command/mongocli-iam-projects-create.txt b/docs/mongocli/command/mongocli-iam-projects-create.txt deleted file mode 100644 index 1f2ad49d9a..0000000000 --- a/docs/mongocli/command/mongocli-iam-projects-create.txt +++ /dev/null @@ -1,115 +0,0 @@ -.. _mongocli-iam-projects-create: - -============================ -mongocli iam 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 - - mongocli iam 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. - * - --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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -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:: - - # Create a project in the organization with the ID 5e2211c17a3e5a48f5497de3 using default alert settings: - mongocli projects create --orgId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/mongocli/command/mongocli-iam-projects-delete.txt b/docs/mongocli/command/mongocli-iam-projects-delete.txt deleted file mode 100644 index 565bdf4b4a..0000000000 --- a/docs/mongocli/command/mongocli-iam-projects-delete.txt +++ /dev/null @@ -1,97 +0,0 @@ -.. _mongocli-iam-projects-delete: - -============================ -mongocli iam 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 - - mongocli iam 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -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:: - - # Remove the project with the ID 5e2211c17a3e5a48f5497de3: - mongocli projects delete 5e2211c17a3e5a48f5497de3 diff --git a/docs/mongocli/command/mongocli-iam-projects-describe.txt b/docs/mongocli/command/mongocli-iam-projects-describe.txt deleted file mode 100644 index 31f3cd0763..0000000000 --- a/docs/mongocli/command/mongocli-iam-projects-describe.txt +++ /dev/null @@ -1,98 +0,0 @@ -.. _mongocli-iam-projects-describe: - -============================== -mongocli iam 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 - - mongocli iam 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -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:: - - # Return the JSON-formatted details for the project with the ID 5e2211c17a3e5a48f5497de3: - mongocli projects describe 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/mongocli/command/mongocli-iam-projects-invitations-delete.txt b/docs/mongocli/command/mongocli-iam-projects-invitations-delete.txt deleted file mode 100644 index 77e4a94ace..0000000000 --- a/docs/mongocli/command/mongocli-iam-projects-invitations-delete.txt +++ /dev/null @@ -1,101 +0,0 @@ -.. _mongocli-iam-projects-invitations-delete: - -======================================== -mongocli iam projects invitations delete -======================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Remove the specified pending invitation 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 - - mongocli iam projects 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 - * - --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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -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:: - - # Remove the pending invitation with the ID 5dd56c847a3e5a1f363d424d from the project with the ID 5f71e5255afec75a3d0f96dc: - mongocli projects invitations delete 5dd56c847a3e5a1f363d424d --projectId 5f71e5255afec75a3d0f96dc diff --git a/docs/mongocli/command/mongocli-iam-projects-invitations-describe.txt b/docs/mongocli/command/mongocli-iam-projects-invitations-describe.txt deleted file mode 100644 index 3cea2c99b1..0000000000 --- a/docs/mongocli/command/mongocli-iam-projects-invitations-describe.txt +++ /dev/null @@ -1,102 +0,0 @@ -.. _mongocli-iam-projects-invitations-describe: - -========================================== -mongocli iam projects 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 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 - - mongocli iam projects 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 - * - -o, --output - - string - - false - - 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - ID USERNAME CREATED AT EXPIRES AT - - - -Examples --------- - -.. code-block:: - - # Return the JSON-formatted details of the pending invitation with the ID 5dd56c847a3e5a1f363d424d for the project with the ID 5f71e5255afec75a3d0f96dc: - mongocli projects invitations describe 5dd56c847a3e5a1f363d424d --projectId 5f71e5255afec75a3d0f96dc --output json diff --git a/docs/mongocli/command/mongocli-iam-projects-invitations-invite.txt b/docs/mongocli/command/mongocli-iam-projects-invitations-invite.txt deleted file mode 100644 index ed9138c53f..0000000000 --- a/docs/mongocli/command/mongocli-iam-projects-invitations-invite.txt +++ /dev/null @@ -1,99 +0,0 @@ -.. _mongocli-iam-projects-invitations-invite: - -======================================== -mongocli iam projects invitations invite -======================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Invite the specified MongoDB user 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 - - mongocli iam projects 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 project. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for invite - * - -o, --output - - string - - false - - 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's roles 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, GROUP_READ_ONLY, GROUP_AUTOMATION_ADMIN, GROUP_BACKUP_ADMIN, and GROUP_MONITORING_ADMIN. - * - --teamId - - strings - - false - - 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - # Invite the MongoDB user with the email user@example.com to the project with the ID 5f71e5255afec75a3d0f96dc with GROUP_READ_ONLY access: - mongocli projects invitations invite user@example.com --projectId 5f71e5255afec75a3d0f96dc --role GROUP_READ_ONLY --output json diff --git a/docs/mongocli/command/mongocli-iam-projects-invitations-list.txt b/docs/mongocli/command/mongocli-iam-projects-invitations-list.txt deleted file mode 100644 index 910f79e1d8..0000000000 --- a/docs/mongocli/command/mongocli-iam-projects-invitations-list.txt +++ /dev/null @@ -1,79 +0,0 @@ -.. _mongocli-iam-projects-invitations-list: - -====================================== -mongocli iam projects invitations list -====================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return all pending invitations 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 - - mongocli iam projects 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 - * - -o, --output - - string - - false - - 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - # Return a JSON-formatted list of pending invitations to the project with the ID 5f71e5255afec75a3d0f96dc: - mongocli projects invitations list --projectId 5f71e5255afec75a3d0f96dc --output json diff --git a/docs/mongocli/command/mongocli-iam-projects-invitations-update.txt b/docs/mongocli/command/mongocli-iam-projects-invitations-update.txt deleted file mode 100644 index df861d552c..0000000000 --- a/docs/mongocli/command/mongocli-iam-projects-invitations-update.txt +++ /dev/null @@ -1,117 +0,0 @@ -.. _mongocli-iam-projects-invitations-update: - -======================================== -mongocli iam projects 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 project. - -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 Project Owner role. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli iam projects 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 - * - -o, --output - - string - - false - - 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's roles for the associated organization. To learn which values MCLI accepts, see the Items Enum for roles in the Atlas API spec: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/#operation/createOrganizationInvitation/. 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -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:: - - # Modify the pending invitation with the ID 5dd56c847a3e5a1f363d424d to grant GROUP_READ_ONLY access the project with the ID 5f71e5255afec75a3d0f96dc: - mongocli projects invitations update 5dd56c847a3e5a1f363d424d --projectId 5f71e5255afec75a3d0f96dc --role GROUP_READ_ONLY --output json - - -.. code-block:: - - # Modify the invitation for the user with the email address user@example.com to grant GROUP_READ_ONLY access the project with the ID 5f71e5255afec75a3d0f96dc: - mongocli projects invitations update --email user@example.com --projectId 5f71e5255afec75a3d0f96dc --role GROUP_READ_ONLY --output json diff --git a/docs/mongocli/command/mongocli-iam-projects-invitations.txt b/docs/mongocli/command/mongocli-iam-projects-invitations.txt deleted file mode 100644 index 760add5f5a..0000000000 --- a/docs/mongocli/command/mongocli-iam-projects-invitations.txt +++ /dev/null @@ -1,69 +0,0 @@ -.. _mongocli-iam-projects-invitations: - -================================= -mongocli iam projects invitations -================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Invitation operations. - -Create, list and manage your MongoDB project 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-iam-projects-invitations-delete` - Remove the specified pending invitation to your project. -* :ref:`mongocli-iam-projects-invitations-describe` - Return the details for the specified pending invitation to your project. -* :ref:`mongocli-iam-projects-invitations-invite` - Invite the specified MongoDB user to your project. -* :ref:`mongocli-iam-projects-invitations-list` - Return all pending invitations to your project. -* :ref:`mongocli-iam-projects-invitations-update` - Modifies the details of the specified pending invitation to your project. - - -.. toctree:: - :titlesonly: - - delete - describe - invite - list - update - diff --git a/docs/mongocli/command/mongocli-iam-projects-list.txt b/docs/mongocli/command/mongocli-iam-projects-list.txt deleted file mode 100644 index 6141974f80..0000000000 --- a/docs/mongocli/command/mongocli-iam-projects-list.txt +++ /dev/null @@ -1,94 +0,0 @@ -.. _mongocli-iam-projects-list: - -========================== -mongocli iam 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 - - mongocli iam 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. - * - --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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -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:: - - # Return a JSON-formatted list of all projects: - mongocli projects list --output json diff --git a/docs/mongocli/command/mongocli-iam-projects-teams-add.txt b/docs/mongocli/command/mongocli-iam-projects-teams-add.txt deleted file mode 100644 index a5da71a035..0000000000 --- a/docs/mongocli/command/mongocli-iam-projects-teams-add.txt +++ /dev/null @@ -1,97 +0,0 @@ -.. _mongocli-iam-projects-teams-add: - -=============================== -mongocli iam 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 - - mongocli iam 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - # Add the team with the ID 5dd58c647a3e5a6c5bce46c7 to the project with the ID 5e2211c17a3e5a48f5497de3 with GROUP_READ_ONLY project access: - mongocli projects teams add 5dd58c647a3e5a6c5bce46c7 --projectId 5e2211c17a3e5a48f5497de3 --role GROUP_READ_ONLY diff --git a/docs/mongocli/command/mongocli-iam-projects-teams-delete.txt b/docs/mongocli/command/mongocli-iam-projects-teams-delete.txt deleted file mode 100644 index e3db4727b6..0000000000 --- a/docs/mongocli/command/mongocli-iam-projects-teams-delete.txt +++ /dev/null @@ -1,103 +0,0 @@ -.. _mongocli-iam-projects-teams-delete: - -================================== -mongocli iam 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 - - mongocli iam 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -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:: - - # Remove the team with the ID 5dd58c647a3e5a6c5bce46c7 from the project with the ID 5e2211c17a3e5a48f5497de3: - mongocli projects teams delete 5dd58c647a3e5a6c5bce46c7 --projectId 5e2211c17a3e5a48f5497de3 diff --git a/docs/mongocli/command/mongocli-iam-projects-teams-list.txt b/docs/mongocli/command/mongocli-iam-projects-teams-list.txt deleted file mode 100644 index 4a18f7062d..0000000000 --- a/docs/mongocli/command/mongocli-iam-projects-teams-list.txt +++ /dev/null @@ -1,94 +0,0 @@ -.. _mongocli-iam-projects-teams-list: - -================================ -mongocli iam 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 - - mongocli iam 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. - * - -o, --output - - string - - false - - 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -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:: - - # Return a JSON-formatted list of all teams for the project with the ID 5e2211c17a3e5a48f5497de3: - mongocli projects teams list --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/mongocli/command/mongocli-iam-projects-teams-update.txt b/docs/mongocli/command/mongocli-iam-projects-teams-update.txt deleted file mode 100644 index af2da7cdd9..0000000000 --- a/docs/mongocli/command/mongocli-iam-projects-teams-update.txt +++ /dev/null @@ -1,105 +0,0 @@ -.. _mongocli-iam-projects-teams-update: - -================================== -mongocli iam 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 - - mongocli iam 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -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:: - - # Modify the roles for the team with the ID 5dd56c847a3e5a1f363d424d to grant GROUP_READ_ONLY access to the project with the ID 5f71e5255afec75a3d0f96dc: - mongocli projects teams update 5dd56c847a3e5a1f363d424d --projectId 5f71e5255afec75a3d0f96dc --role GROUP_READ_ONLY --output json diff --git a/docs/mongocli/command/mongocli-iam-projects-teams.txt b/docs/mongocli/command/mongocli-iam-projects-teams.txt deleted file mode 100644 index 67d2ce8f24..0000000000 --- a/docs/mongocli/command/mongocli-iam-projects-teams.txt +++ /dev/null @@ -1,65 +0,0 @@ -.. _mongocli-iam-projects-teams: - -=========================== -mongocli iam projects teams -=========================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage your Ops Manager or Cloud Manager 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-iam-projects-teams-add` - Add the specified team to your project. -* :ref:`mongocli-iam-projects-teams-delete` - Remove the specified team from your project. -* :ref:`mongocli-iam-projects-teams-list` - Return all teams for a project. -* :ref:`mongocli-iam-projects-teams-update` - Modify the roles for the specified team for your project. - - -.. toctree:: - :titlesonly: - - add - delete - list - update - diff --git a/docs/mongocli/command/mongocli-iam-projects-users-delete.txt b/docs/mongocli/command/mongocli-iam-projects-users-delete.txt deleted file mode 100644 index 189bb7bf23..0000000000 --- a/docs/mongocli/command/mongocli-iam-projects-users-delete.txt +++ /dev/null @@ -1,103 +0,0 @@ -.. _mongocli-iam-projects-users-delete: - -================================== -mongocli iam 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 - - mongocli iam 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -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:: - - # Remove the user with the ID 5dd58c647a3e5a6c5bce46c7 from the project with the ID 5e2211c17a3e5a48f5497de3: - mongocli projects users delete 5dd58c647a3e5a6c5bce46c7 --projectId 5e2211c17a3e5a48f5497de3 diff --git a/docs/mongocli/command/mongocli-iam-projects-users-list.txt b/docs/mongocli/command/mongocli-iam-projects-users-list.txt deleted file mode 100644 index cf4775142e..0000000000 --- a/docs/mongocli/command/mongocli-iam-projects-users-list.txt +++ /dev/null @@ -1,83 +0,0 @@ -.. _mongocli-iam-projects-users-list: - -================================ -mongocli iam 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 - - mongocli iam 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 - * - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - # Return a JSON-formatted list of all users for the project with the ID 5e2211c17a3e5a48f5497de3: - mongocli projects users list --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/mongocli/command/mongocli-iam-projects-users.txt b/docs/mongocli/command/mongocli-iam-projects-users.txt deleted file mode 100644 index 075afcef1a..0000000000 --- a/docs/mongocli/command/mongocli-iam-projects-users.txt +++ /dev/null @@ -1,61 +0,0 @@ -.. _mongocli-iam-projects-users: - -=========================== -mongocli iam 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-iam-projects-users-delete` - Remove the specified user from your project. -* :ref:`mongocli-iam-projects-users-list` - Return all users for a project. - - -.. toctree:: - :titlesonly: - - delete - list - diff --git a/docs/mongocli/command/mongocli-iam-projects.txt b/docs/mongocli/command/mongocli-iam-projects.txt deleted file mode 100644 index 4b102c9b70..0000000000 --- a/docs/mongocli/command/mongocli-iam-projects.txt +++ /dev/null @@ -1,75 +0,0 @@ -.. _mongocli-iam-projects: - -===================== -mongocli iam projects -===================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage your Ops Manager or Cloud Manager 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-iam-projects-apiKeys` - Manage API Keys for your project. -* :ref:`mongocli-iam-projects-create` - Create a project in your organization. -* :ref:`mongocli-iam-projects-delete` - Remove the specified project. -* :ref:`mongocli-iam-projects-describe` - Return the details for the specified project. -* :ref:`mongocli-iam-projects-invitations` - Invitation operations. -* :ref:`mongocli-iam-projects-list` - Return all projects. -* :ref:`mongocli-iam-projects-teams` - Manage your Ops Manager or Cloud Manager teams. -* :ref:`mongocli-iam-projects-users` - Manage users for a project. - - -.. toctree:: - :titlesonly: - - apiKeys - create - delete - describe - invitations - list - teams - users - diff --git a/docs/mongocli/command/mongocli-iam-teams-create.txt b/docs/mongocli/command/mongocli-iam-teams-create.txt deleted file mode 100644 index 7857edeb4c..0000000000 --- a/docs/mongocli/command/mongocli-iam-teams-create.txt +++ /dev/null @@ -1,105 +0,0 @@ -.. _mongocli-iam-teams-create: - -========================= -mongocli iam 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 - - mongocli iam 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -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:: - - # Create a team named myTeam in the organization with ID 5e2211c17a3e5a48f5497de3: - mongocli teams create myTeam --username user1@example.com,user2@example.com --orgId 5e1234c17a3e5a48f5497de3 --output json diff --git a/docs/mongocli/command/mongocli-iam-teams-delete.txt b/docs/mongocli/command/mongocli-iam-teams-delete.txt deleted file mode 100644 index e3f0f1b9d8..0000000000 --- a/docs/mongocli/command/mongocli-iam-teams-delete.txt +++ /dev/null @@ -1,101 +0,0 @@ -.. _mongocli-iam-teams-delete: - -========================= -mongocli iam 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 - - mongocli iam 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -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:: - - # Remove the team with the ID 5e44445ef10fab20b49c0f31 from the organization with ID 5e2211c17a3e5a48f5497de3: - mongocli teams delete 5e44445ef10fab20b49c0f31 --orgId 5e1234c17a3e5a48f5497de3 diff --git a/docs/mongocli/command/mongocli-iam-teams-describe.txt b/docs/mongocli/command/mongocli-iam-teams-describe.txt deleted file mode 100644 index 291ce3baba..0000000000 --- a/docs/mongocli/command/mongocli-iam-teams-describe.txt +++ /dev/null @@ -1,102 +0,0 @@ -.. _mongocli-iam-teams-describe: - -=========================== -mongocli iam 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 - - mongocli iam 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -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:: - - # Return the JSON-formatted details for the the team with the ID 5e44445ef10fab20b49c0f31 in the organization with ID 5e2211c17a3e5a48f5497de3: - mongocli teams describe --id 5e44445ef10fab20b49c0f31 --projectId 5e1234c17a3e5a48f5497de3 --output json - - -.. code-block:: - - # Return the JSON-formatted details for the the team with the name myTeam in the organization with ID 5e2211c17a3e5a48f5497de3: - mongocli teams describe --name myTeam --projectId 5e1234c17a3e5a48f5497de3 --output json diff --git a/docs/mongocli/command/mongocli-iam-teams-list.txt b/docs/mongocli/command/mongocli-iam-teams-list.txt deleted file mode 100644 index 3d86f04cbd..0000000000 --- a/docs/mongocli/command/mongocli-iam-teams-list.txt +++ /dev/null @@ -1,83 +0,0 @@ -.. _mongocli-iam-teams-list: - -======================= -mongocli iam 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 - - mongocli iam 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. - * - --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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - # Return a JSON-formatted list of the teams for the organization with ID 5e2211c17a3e5a48f5497de3: - mongocli teams list --orgId 5e1234c17a3e5a48f5497de3 --output json diff --git a/docs/mongocli/command/mongocli-iam-teams-users-add.txt b/docs/mongocli/command/mongocli-iam-teams-users-add.txt deleted file mode 100644 index 0c80a71f2b..0000000000 --- a/docs/mongocli/command/mongocli-iam-teams-users-add.txt +++ /dev/null @@ -1,97 +0,0 @@ -.. _mongocli-iam-teams-users-add: - -============================ -mongocli iam 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. - -Users must be current members of your organization before you can add them to a team. - -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 - - mongocli iam 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - # Add the users with the IDs 5dd58c647a3e5a6c5bce46c7 and 5dd56c847a3e5a1f363d424d to the team with the ID 5f6a5c6c713184005d72fe6e for the organization with ID 5e2211c17a3e5a48f5497de3: - mongocli teams users add 5dd58c647a3e5a6c5bce46c7 5dd56c847a3e5a1f363d424d --teamId 5f6a5c6c713184005d72fe6e --orgId 5e1234c17a3e5a48f5497de3 --output json diff --git a/docs/mongocli/command/mongocli-iam-teams-users-delete.txt b/docs/mongocli/command/mongocli-iam-teams-users-delete.txt deleted file mode 100644 index 2c506d4c6e..0000000000 --- a/docs/mongocli/command/mongocli-iam-teams-users-delete.txt +++ /dev/null @@ -1,105 +0,0 @@ -.. _mongocli-iam-teams-users-delete: - -=============================== -mongocli iam 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 - - mongocli iam 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -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:: - - # Remove the user with the ID 5dd58c647a3e5a6c5bce46c7 from the team with the ID 5f6a5c6c713184005d72fe6e for the organization with ID 5e2211c17a3e5a48f5497de3: - mongocli teams users delete 5dd58c647a3e5a6c5bce46c7 --teamId 5f6a5c6c713184005d72fe6e --orgId 5e1234c17a3e5a48f5497de3 diff --git a/docs/mongocli/command/mongocli-iam-teams-users-list.txt b/docs/mongocli/command/mongocli-iam-teams-users-list.txt deleted file mode 100644 index d6cf0dbc59..0000000000 --- a/docs/mongocli/command/mongocli-iam-teams-users-list.txt +++ /dev/null @@ -1,79 +0,0 @@ -.. _mongocli-iam-teams-users-list: - -============================= -mongocli iam 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 - - mongocli iam 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 - * - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - # Return a JSON-formatted list of the users for the team with the ID 5f6a5c6c713184005d72fe6e in the organization with ID 5e2211c17a3e5a48f5497de3: - mongocli teams users list --teamId 5f6a5c6c713184005d72fe6e --orgId 5e1234c17a3e5a48f5497de3 --output json diff --git a/docs/mongocli/command/mongocli-iam-teams-users.txt b/docs/mongocli/command/mongocli-iam-teams-users.txt deleted file mode 100644 index 55ee32b72f..0000000000 --- a/docs/mongocli/command/mongocli-iam-teams-users.txt +++ /dev/null @@ -1,65 +0,0 @@ -.. _mongocli-iam-teams-users: - -======================== -mongocli iam teams users -======================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage your Ops Manager or Cloud Manager 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-iam-teams-users-add` - Add the specified MongoDB user to a team for your organization. -* :ref:`mongocli-iam-teams-users-delete` - Remove the specified user from a team for your organization. -* :ref:`mongocli-iam-teams-users-list` - Return all users for a team. - - -.. toctree:: - :titlesonly: - - add - delete - list - diff --git a/docs/mongocli/command/mongocli-iam-teams.txt b/docs/mongocli/command/mongocli-iam-teams.txt deleted file mode 100644 index 681ef5e1e5..0000000000 --- a/docs/mongocli/command/mongocli-iam-teams.txt +++ /dev/null @@ -1,69 +0,0 @@ -.. _mongocli-iam-teams: - -================== -mongocli iam teams -================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage your Ops Manager or Cloud Manager teams. - -Create, list and manage your Cloud Manager or Ops Manager 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-iam-teams-create` - Create a team for your organization. -* :ref:`mongocli-iam-teams-delete` - Remove the specified team from your organization. -* :ref:`mongocli-iam-teams-describe` - Return the details for the specified team for your organization. -* :ref:`mongocli-iam-teams-list` - Return all teams for your organization. -* :ref:`mongocli-iam-teams-users` - Manage your Ops Manager or Cloud Manager users. - - -.. toctree:: - :titlesonly: - - create - delete - describe - list - users - diff --git a/docs/mongocli/command/mongocli-iam-users-delete.txt b/docs/mongocli/command/mongocli-iam-users-delete.txt deleted file mode 100644 index af68a39493..0000000000 --- a/docs/mongocli/command/mongocli-iam-users-delete.txt +++ /dev/null @@ -1,95 +0,0 @@ -.. _mongocli-iam-users-delete: - -========================= -mongocli iam users delete -========================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Remove the specified Ops Manager user. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli iam 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 in Ops Manager. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - User '' deleted - - -Examples --------- - -.. code-block:: - - # Remove the Ops Manager user with the ID 5e44445ef10fab20b49c0f31: - mongocli iam users delete 5e44445ef10fab20b49c0f31 diff --git a/docs/mongocli/command/mongocli-iam-users-describe.txt b/docs/mongocli/command/mongocli-iam-users-describe.txt deleted file mode 100644 index efa05e176c..0000000000 --- a/docs/mongocli/command/mongocli-iam-users-describe.txt +++ /dev/null @@ -1,98 +0,0 @@ -.. _mongocli-iam-users-describe: - -=========================== -mongocli iam users describe -=========================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return the details for the specified MongoDB user. - -You can specify either the unique 24-digit ID that identifies the MongoDB user or the username for the MongoDB user. - -User accounts and API keys with any role can run this command. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli iam 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. - * - -o, --output - - string - - false - - 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. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -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:: - - # Return the JSON-formatted details for the MongoDB user with the ID 5dd56c847a3e5a1f363d424d: - mongocli users describe --id 5dd56c847a3e5a1f363d424d --output json - - -.. code-block:: - - # Return the JSON-formatted details for the MongoDB user with the username myUser: - mongocli users describe --username myUser --output json diff --git a/docs/mongocli/command/mongocli-iam-users-invite.txt b/docs/mongocli/command/mongocli-iam-users-invite.txt deleted file mode 100644 index 2e37b71a66..0000000000 --- a/docs/mongocli/command/mongocli-iam-users-invite.txt +++ /dev/null @@ -1,113 +0,0 @@ -.. _mongocli-iam-users-invite: - -========================= -mongocli iam users invite -========================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create a MongoDB user for your MongoDB application and invite the MongoDB user to your organizations and projects. - -A MongoDB user account grants access only to the the MongoDB application. To grant database access, create a database user with mongocli dbusers create. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli iam 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 - - false - - 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. To learn which values MCLI accepts, see the Items Enum for roles in the Atlas API spec: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/#operation/createOrganizationInvitation/. - * - -o, --output - - string - - false - - 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, GROUP_READ_ONLY, GROUP_AUTOMATION_ADMIN, GROUP_BACKUP_ADMIN, and GROUP_MONITORING_ADMIN. - * - --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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - # Create the MongoDB user with the username user@example.com and invite them to the organization with the ID 5dd56c847a3e5a1f363d424d with ORG_OWNER access: - mongocli users invite --email user@example.com --username user@example.com --orgRole 5dd56c847a3e5a1f363d424d:ORG_OWNER --firstName Example --lastName User --country US --output json - - -.. code-block:: - - # Create the MongoDB user with the username user@example.com and invite them to the project with the ID 5f71e5255afec75a3d0f96dc with GROUP_READ_ONLY access: - mongocli 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/mongocli/command/mongocli-iam-users.txt b/docs/mongocli/command/mongocli-iam-users.txt deleted file mode 100644 index 743d1597d7..0000000000 --- a/docs/mongocli/command/mongocli-iam-users.txt +++ /dev/null @@ -1,65 +0,0 @@ -.. _mongocli-iam-users: - -================== -mongocli iam users -================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage your Ops Manager or Cloud Manager users. - -Create, list and manage your Cloud Manager or Ops Manager 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-iam-users-delete` - Remove the specified Ops Manager user. -* :ref:`mongocli-iam-users-describe` - Return the details for the specified MongoDB user. -* :ref:`mongocli-iam-users-invite` - Create a MongoDB user for your MongoDB application and invite the MongoDB user to your organizations and projects. - - -.. toctree:: - :titlesonly: - - delete - describe - invite - diff --git a/docs/mongocli/command/mongocli-iam.txt b/docs/mongocli/command/mongocli-iam.txt deleted file mode 100644 index 51b3c13d92..0000000000 --- a/docs/mongocli/command/mongocli-iam.txt +++ /dev/null @@ -1,71 +0,0 @@ -.. _mongocli-iam: - -============ -mongocli iam -============ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Organization and projects operations. - -Identity and Access Management. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for iam - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-iam-globalAccessLists` - Manage IP access list for Global API Key. -* :ref:`mongocli-iam-globalApiKeys` - Global API Keys operations. -* :ref:`mongocli-iam-organizations` - Manage your Ops Manager or Cloud Manager organizations. -* :ref:`mongocli-iam-projects` - Manage your Ops Manager or Cloud Manager projects. -* :ref:`mongocli-iam-teams` - Manage your Ops Manager or Cloud Manager teams. -* :ref:`mongocli-iam-users` - Manage your Ops Manager or Cloud Manager users. - - -.. toctree:: - :titlesonly: - - globalAccessLists - globalApiKeys - organizations - projects - teams - users - diff --git a/docs/mongocli/command/mongocli-ops-manager-admin-backups-blockstores-create.txt b/docs/mongocli/command/mongocli-ops-manager-admin-backups-blockstores-create.txt deleted file mode 100644 index 7991f357da..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-admin-backups-blockstores-create.txt +++ /dev/null @@ -1,98 +0,0 @@ -.. _mongocli-ops-manager-admin-backups-blockstores-create: - -===================================================== -mongocli ops-manager admin backups blockstores create -===================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create a backup blockstore configuration. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager admin backups blockstores 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 - * - --assignment - - - - false - - Flag indicating whether this blockstore can be assigned backup jobs. - * - --encryptedCredentials - - - - false - - Flag indicating whether the username and password were encrypted using the credentials tool. - * - -h, --help - - - - false - - help for create - * - --label - - strings - - false - - Array of tags to manage which backup jobs Ops Manager can assign to which blockstores. - * - --loadFactor - - int - - false - - A positive, non-zero integer that expresses how much backup work this snapshot store should perform compared to another snapshot store. - * - --maxCapacityGB - - int - - false - - Maximum amount of data in GB the blockstore can store. - * - --name - - string - - true - - Unique name that labels this blockstore. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --ssl - - - - false - - Flag that indicates whether the blockstore accepts only connections encrypted using TLS. - * - --uri - - string - - true - - Comma-separated list of hosts in the format for accessing the blockstore. - * - --writeConcern - - string - - false - - Write concern for the blockstore. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-admin-backups-blockstores-delete.txt b/docs/mongocli/command/mongocli-ops-manager-admin-backups-blockstores-delete.txt deleted file mode 100644 index 36ec238c4c..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-admin-backups-blockstores-delete.txt +++ /dev/null @@ -1,78 +0,0 @@ -.. _mongocli-ops-manager-admin-backups-blockstores-delete: - -===================================================== -mongocli ops-manager admin backups blockstores delete -===================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Delete a backup blockstore configuration. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager admin backups blockstores 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 - - Blockstore identifier. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-admin-backups-blockstores-describe.txt b/docs/mongocli/command/mongocli-ops-manager-admin-backups-blockstores-describe.txt deleted file mode 100644 index 5ad2911ced..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-admin-backups-blockstores-describe.txt +++ /dev/null @@ -1,78 +0,0 @@ -.. _mongocli-ops-manager-admin-backups-blockstores-describe: - -======================================================= -mongocli ops-manager admin backups blockstores describe -======================================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Get a backup blockstore configuration. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager admin backups blockstores 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 - - Blockstore identifier. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-admin-backups-blockstores-list.txt b/docs/mongocli/command/mongocli-ops-manager-admin-backups-blockstores-list.txt deleted file mode 100644 index fbe55343a9..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-admin-backups-blockstores-list.txt +++ /dev/null @@ -1,70 +0,0 @@ -.. _mongocli-ops-manager-admin-backups-blockstores-list: - -=================================================== -mongocli ops-manager admin backups blockstores list -=================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -List backup blockstore configurations. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager admin backups blockstores 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. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-admin-backups-blockstores-update.txt b/docs/mongocli/command/mongocli-ops-manager-admin-backups-blockstores-update.txt deleted file mode 100644 index 85da4e49cf..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-admin-backups-blockstores-update.txt +++ /dev/null @@ -1,110 +0,0 @@ -.. _mongocli-ops-manager-admin-backups-blockstores-update: - -===================================================== -mongocli ops-manager admin backups blockstores update -===================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Update a backup blockstore configuration. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager admin backups blockstores 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 - - Blockstore identifier. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --assignment - - - - false - - Flag indicating whether this blockstore can be assigned backup jobs. - * - --encryptedCredentials - - - - false - - Flag indicating whether the username and password were encrypted using the credentials tool. - * - -h, --help - - - - false - - help for update - * - --label - - strings - - false - - Array of tags to manage which backup jobs Ops Manager can assign to which blockstores. Passing this flag replaces preexisting data. - * - --loadFactor - - int - - false - - A positive, non-zero integer that expresses how much backup work this snapshot store should perform compared to another snapshot store. - * - --maxCapacityGB - - int - - false - - Maximum amount of data in GB the blockstore can store. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --ssl - - - - false - - Flag that indicates whether the blockstore accepts only connections encrypted using TLS. - * - --uri - - string - - false - - Comma-separated list of hosts in the format for accessing the blockstore. - * - --writeConcern - - string - - false - - Write concern for the blockstore. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-admin-backups-blockstores.txt b/docs/mongocli/command/mongocli-ops-manager-admin-backups-blockstores.txt deleted file mode 100644 index 1d5df52be6..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-admin-backups-blockstores.txt +++ /dev/null @@ -1,67 +0,0 @@ -.. _mongocli-ops-manager-admin-backups-blockstores: - -============================================== -mongocli ops-manager admin backups blockstores -============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage backup blockstore configurations. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for blockstores - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-ops-manager-admin-backups-blockstores-create` - Create a backup blockstore configuration. -* :ref:`mongocli-ops-manager-admin-backups-blockstores-delete` - Delete a backup blockstore configuration. -* :ref:`mongocli-ops-manager-admin-backups-blockstores-describe` - Get a backup blockstore configuration. -* :ref:`mongocli-ops-manager-admin-backups-blockstores-list` - List backup blockstore configurations. -* :ref:`mongocli-ops-manager-admin-backups-blockstores-update` - Update a backup blockstore configuration. - - -.. toctree:: - :titlesonly: - - create - delete - describe - list - update - diff --git a/docs/mongocli/command/mongocli-ops-manager-admin-backups-fileSystems-create.txt b/docs/mongocli/command/mongocli-ops-manager-admin-backups-fileSystems-create.txt deleted file mode 100644 index 6452784e91..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-admin-backups-fileSystems-create.txt +++ /dev/null @@ -1,94 +0,0 @@ -.. _mongocli-ops-manager-admin-backups-fileSystems-create: - -===================================================== -mongocli ops-manager admin backups fileSystems create -===================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create a file system configuration. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager admin backups fileSystems 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 - * - --assignment - - - - false - - Flag indicating whether this file system store can be assigned backup jobs. - * - --encryptedCredentials - - - - false - - Flag indicating whether the username and password were encrypted using the credentials tool. - * - -h, --help - - - - false - - help for create - * - --label - - strings - - false - - Array of tags to manage which backup jobs Ops Manager can assign to which blockstores. - * - --loadFactor - - int - - false - - A positive, non-zero integer that expresses how much backup work this snapshot store should perform compared to another snapshot store. - * - --mmapv1CompressionSetting - - string - - true - - Compression setting for the MMAPv1 storage engine snaphots. - * - --name - - string - - true - - Unique name that labels this file system store configuration. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --storePath - - string - - true - - Location on the file system store host for storing file system-based backups. - * - --wtCompressionSetting - - string - - true - - Compression setting for the WiredTiger storage engine snaphots. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-admin-backups-fileSystems-delete.txt b/docs/mongocli/command/mongocli-ops-manager-admin-backups-fileSystems-delete.txt deleted file mode 100644 index 21a566f9fd..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-admin-backups-fileSystems-delete.txt +++ /dev/null @@ -1,78 +0,0 @@ -.. _mongocli-ops-manager-admin-backups-fileSystems-delete: - -===================================================== -mongocli ops-manager admin backups fileSystems delete -===================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Delete a file system configuration. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager admin backups fileSystems 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 - - Configuration identifier. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-admin-backups-fileSystems-describe.txt b/docs/mongocli/command/mongocli-ops-manager-admin-backups-fileSystems-describe.txt deleted file mode 100644 index c957492e06..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-admin-backups-fileSystems-describe.txt +++ /dev/null @@ -1,78 +0,0 @@ -.. _mongocli-ops-manager-admin-backups-fileSystems-describe: - -======================================================= -mongocli ops-manager admin backups fileSystems describe -======================================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Get a file system configuration. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager admin backups fileSystems 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 - - Configuration identifier. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-admin-backups-fileSystems-list.txt b/docs/mongocli/command/mongocli-ops-manager-admin-backups-fileSystems-list.txt deleted file mode 100644 index 0d6bc98d71..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-admin-backups-fileSystems-list.txt +++ /dev/null @@ -1,70 +0,0 @@ -.. _mongocli-ops-manager-admin-backups-fileSystems-list: - -=================================================== -mongocli ops-manager admin backups fileSystems list -=================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -List file system configurations. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager admin backups fileSystems 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. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-admin-backups-fileSystems-update.txt b/docs/mongocli/command/mongocli-ops-manager-admin-backups-fileSystems-update.txt deleted file mode 100644 index 0039c0465b..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-admin-backups-fileSystems-update.txt +++ /dev/null @@ -1,106 +0,0 @@ -.. _mongocli-ops-manager-admin-backups-fileSystems-update: - -===================================================== -mongocli ops-manager admin backups fileSystems update -===================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Update a file system configuration. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager admin backups fileSystems 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 - - Configuration identifier. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --assignment - - - - false - - Flag indicating whether this file system store can be assigned backup jobs. - * - --encryptedCredentials - - - - false - - Flag indicating whether the username and password were encrypted using the credentials tool. - * - -h, --help - - - - false - - help for update - * - --label - - strings - - false - - Array of tags to manage which backup jobs Ops Manager can assign to which blockstores. Passing this flag replaces preexisting data. - * - --loadFactor - - int - - false - - A positive, non-zero integer that expresses how much backup work this snapshot store should perform compared to another snapshot store. - * - --mmapv1CompressionSetting - - string - - true - - Compression setting for the MMAPv1 storage engine snaphots. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --storePath - - string - - true - - Location on the file system store host for storing file system-based backups. - * - --wtCompressionSetting - - string - - true - - Compression setting for the WiredTiger storage engine snaphots. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-admin-backups-fileSystems.txt b/docs/mongocli/command/mongocli-ops-manager-admin-backups-fileSystems.txt deleted file mode 100644 index ebb2439cd9..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-admin-backups-fileSystems.txt +++ /dev/null @@ -1,67 +0,0 @@ -.. _mongocli-ops-manager-admin-backups-fileSystems: - -============================================== -mongocli ops-manager admin backups fileSystems -============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage file system configurations. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for fileSystems - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-ops-manager-admin-backups-fileSystems-create` - Create a file system configuration. -* :ref:`mongocli-ops-manager-admin-backups-fileSystems-delete` - Delete a file system configuration. -* :ref:`mongocli-ops-manager-admin-backups-fileSystems-describe` - Get a file system configuration. -* :ref:`mongocli-ops-manager-admin-backups-fileSystems-list` - List file system configurations. -* :ref:`mongocli-ops-manager-admin-backups-fileSystems-update` - Update a file system configuration. - - -.. toctree:: - :titlesonly: - - create - delete - describe - list - update - diff --git a/docs/mongocli/command/mongocli-ops-manager-admin-backups-oplog-create.txt b/docs/mongocli/command/mongocli-ops-manager-admin-backups-oplog-create.txt deleted file mode 100644 index 671eef4c20..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-admin-backups-oplog-create.txt +++ /dev/null @@ -1,94 +0,0 @@ -.. _mongocli-ops-manager-admin-backups-oplog-create: - -=============================================== -mongocli ops-manager admin backups oplog create -=============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create a backup oplog configuration. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager admin backups oplog 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 - * - --assignment - - - - false - - Flag indicating whether this oplog can be assigned backup jobs. - * - --encryptedCredentials - - - - false - - Flag indicating whether the username and password were encrypted using the credentials tool. - * - -h, --help - - - - false - - help for create - * - --label - - strings - - false - - Array of tags to manage which backup jobs Ops Manager can assign to which blockstores. - * - --maxCapacityGB - - int - - false - - Maximum amount of data in GB the blockstore can store. - * - --name - - string - - true - - Unique name that labels this oplog store. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --ssl - - - - false - - Flag that indicates whether this oplog store accepts only connections encrypted using TLS - * - --uri - - string - - true - - Comma-separated list of hosts in the format for accessing the blockstore. - * - --writeConcern - - string - - false - - Write concern for the blockstore. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-admin-backups-oplog-delete.txt b/docs/mongocli/command/mongocli-ops-manager-admin-backups-oplog-delete.txt deleted file mode 100644 index 6c2464e5a4..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-admin-backups-oplog-delete.txt +++ /dev/null @@ -1,78 +0,0 @@ -.. _mongocli-ops-manager-admin-backups-oplog-delete: - -=============================================== -mongocli ops-manager admin backups oplog delete -=============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Delete a backup oplog configuration. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager admin backups oplog 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 - - Oplog name. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-admin-backups-oplog-describe.txt b/docs/mongocli/command/mongocli-ops-manager-admin-backups-oplog-describe.txt deleted file mode 100644 index 2b77c481e3..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-admin-backups-oplog-describe.txt +++ /dev/null @@ -1,78 +0,0 @@ -.. _mongocli-ops-manager-admin-backups-oplog-describe: - -================================================= -mongocli ops-manager admin backups oplog describe -================================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Get a backup oplog configuration. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager admin backups oplog 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 - - Oplog name. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-admin-backups-oplog-list.txt b/docs/mongocli/command/mongocli-ops-manager-admin-backups-oplog-list.txt deleted file mode 100644 index 4ec11dfc45..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-admin-backups-oplog-list.txt +++ /dev/null @@ -1,70 +0,0 @@ -.. _mongocli-ops-manager-admin-backups-oplog-list: - -============================================= -mongocli ops-manager admin backups oplog list -============================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -List backup oplog configurations. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager admin backups oplog 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. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-admin-backups-oplog-update.txt b/docs/mongocli/command/mongocli-ops-manager-admin-backups-oplog-update.txt deleted file mode 100644 index 69503a9aed..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-admin-backups-oplog-update.txt +++ /dev/null @@ -1,106 +0,0 @@ -.. _mongocli-ops-manager-admin-backups-oplog-update: - -=============================================== -mongocli ops-manager admin backups oplog update -=============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Update a backup oplog configuration. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager admin backups oplog 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 - - Oplog identifier. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --assignment - - - - false - - Flag indicating whether this oplog can be assigned backup jobs. - * - --encryptedCredentials - - - - false - - Flag indicating whether the username and password were encrypted using the credentials tool. - * - -h, --help - - - - false - - help for update - * - --label - - strings - - false - - Array of tags to manage which backup jobs Ops Manager can assign to which blockstores. Passing this flag replaces preexisting data. - * - --maxCapacityGB - - int - - false - - Maximum amount of data in GB the blockstore can store. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --ssl - - - - false - - Flag that indicates whether this oplog store accepts only connections encrypted using TLS - * - --uri - - string - - true - - Comma-separated list of hosts in the format for accessing the blockstore. - * - --writeConcern - - string - - false - - Write concern for the blockstore. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-admin-backups-oplog.txt b/docs/mongocli/command/mongocli-ops-manager-admin-backups-oplog.txt deleted file mode 100644 index 74a8257709..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-admin-backups-oplog.txt +++ /dev/null @@ -1,67 +0,0 @@ -.. _mongocli-ops-manager-admin-backups-oplog: - -======================================== -mongocli ops-manager admin backups oplog -======================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage backup oplog configurations. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for oplog - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-ops-manager-admin-backups-oplog-create` - Create a backup oplog configuration. -* :ref:`mongocli-ops-manager-admin-backups-oplog-delete` - Delete a backup oplog configuration. -* :ref:`mongocli-ops-manager-admin-backups-oplog-describe` - Get a backup oplog configuration. -* :ref:`mongocli-ops-manager-admin-backups-oplog-list` - List backup oplog configurations. -* :ref:`mongocli-ops-manager-admin-backups-oplog-update` - Update a backup oplog configuration. - - -.. toctree:: - :titlesonly: - - create - delete - describe - list - update - diff --git a/docs/mongocli/command/mongocli-ops-manager-admin-backups-s3-create.txt b/docs/mongocli/command/mongocli-ops-manager-admin-backups-s3-create.txt deleted file mode 100644 index b436621f87..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-admin-backups-s3-create.txt +++ /dev/null @@ -1,130 +0,0 @@ -.. _mongocli-ops-manager-admin-backups-s3-create: - -============================================ -mongocli ops-manager admin backups s3 create -============================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create a backup S3 blockstore configuration. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager admin backups s3 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 - * - --acceptedTos - - - - true - - Flag that indicates whether you accepted the terms of service for using Amazon S3-compatible stores with Ops Manager. - * - --assignment - - - - false - - Flag indicating whether this blockstore can be assigned backup jobs. - * - --awsAccessKey - - string - - false - - AWS Access Key ID that can access the Amazon S3 bucket specified in s3BucketName. - * - --awsSecretKey - - string - - false - - AWS Secret Access Key that can access the Amazon S3 bucket specified in s3BucketName. - * - --disableProxyS3 - - - - false - - Flag that indicates whether to use the HTTP proxy when connecting to Amazon S3. - * - --encryptedCredentials - - - - false - - Flag indicating whether the username and password were encrypted using the credentials tool. - * - -h, --help - - - - false - - help for create - * - --label - - strings - - false - - Array of tags to manage which backup jobs Ops Manager can assign to which blockstores. - * - --loadFactor - - int - - false - - A positive, non-zero integer that expresses how much backup work this snapshot store should perform compared to another snapshot store. - * - --name - - string - - true - - Unique name that labels this blockstore. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --pathStyleAccessEnabled - - - - false - - Flag that indicates the style of the endpoint. - * - --s3AuthMethod - - string - - true - - Method used to authorize access to the Amazon S3 bucket specified in s3BucketName. Valid values are KEYS or IAM_ROLE. - * - --s3BucketEndpoint - - string - - true - - URL that Ops Manager uses to access this Amazon S3 or S3-compatible bucket. - * - --s3BucketName - - string - - true - - Name of the Amazon S3 bucket that hosts the S3 blockstore. - * - --s3MaxConnections - - int - - false - - Positive integer that indicates the maximum number of connections to this Amazon S3 blockstore. - * - --sseEnabled - - - - false - - Flag that indicates whether the Amazon S3 blockstore enables server-side encryption. - * - --uri - - string - - true - - Comma-separated list of hosts in the format for accessing the blockstore. - * - --writeConcern - - string - - false - - Write concern for the blockstore. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-admin-backups-s3-delete.txt b/docs/mongocli/command/mongocli-ops-manager-admin-backups-s3-delete.txt deleted file mode 100644 index 4a61669032..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-admin-backups-s3-delete.txt +++ /dev/null @@ -1,78 +0,0 @@ -.. _mongocli-ops-manager-admin-backups-s3-delete: - -============================================ -mongocli ops-manager admin backups s3 delete -============================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Delete a backup s3 blockstore configuration. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager admin backups s3 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 - - Blockstore identifier. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-admin-backups-s3-describe.txt b/docs/mongocli/command/mongocli-ops-manager-admin-backups-s3-describe.txt deleted file mode 100644 index ca17ca5289..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-admin-backups-s3-describe.txt +++ /dev/null @@ -1,78 +0,0 @@ -.. _mongocli-ops-manager-admin-backups-s3-describe: - -============================================== -mongocli ops-manager admin backups s3 describe -============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Get a backup s3 blockstore configuration. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager admin backups s3 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 - - Configuration identifier. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-admin-backups-s3-list.txt b/docs/mongocli/command/mongocli-ops-manager-admin-backups-s3-list.txt deleted file mode 100644 index 13c552febd..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-admin-backups-s3-list.txt +++ /dev/null @@ -1,70 +0,0 @@ -.. _mongocli-ops-manager-admin-backups-s3-list: - -========================================== -mongocli ops-manager admin backups s3 list -========================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -List backup s3 blockstore configurations. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager admin backups s3 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. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-admin-backups-s3-update.txt b/docs/mongocli/command/mongocli-ops-manager-admin-backups-s3-update.txt deleted file mode 100644 index d02aca8f42..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-admin-backups-s3-update.txt +++ /dev/null @@ -1,142 +0,0 @@ -.. _mongocli-ops-manager-admin-backups-s3-update: - -============================================ -mongocli ops-manager admin backups s3 update -============================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Update a backup S3 blockstore configuration. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager admin backups s3 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 - - Blockstore identifier. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --acceptedTos - - - - true - - Flag that indicates whether you accepted the terms of service for using Amazon S3-compatible stores with Ops Manager. - * - --assignment - - - - false - - Flag indicating whether this blockstore can be assigned backup jobs. - * - --awsAccessKey - - string - - false - - AWS Access Key ID that can access the Amazon S3 bucket specified in s3BucketName. - * - --awsSecretKey - - string - - false - - AWS Secret Access Key that can access the Amazon S3 bucket specified in s3BucketName. - * - --disableProxyS3 - - - - false - - Flag that indicates whether to use the HTTP proxy when connecting to Amazon S3. - * - --encryptedCredentials - - - - false - - Flag indicating whether the username and password were encrypted using the credentials tool. - * - -h, --help - - - - false - - help for update - * - --label - - strings - - false - - Array of tags to manage which backup jobs Ops Manager can assign to which blockstores. Passing this flag replaces preexisting data. - * - --loadFactor - - int - - false - - A positive, non-zero integer that expresses how much backup work this snapshot store should perform compared to another snapshot store. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --pathStyleAccessEnabled - - - - false - - Flag that indicates the style of the endpoint. - * - --s3AuthMethod - - string - - true - - Method used to authorize access to the Amazon S3 bucket specified in s3BucketName. Valid values are KEYS or IAM_ROLE. - * - --s3BucketEndpoint - - string - - true - - URL that Ops Manager uses to access this Amazon S3 or S3-compatible bucket. - * - --s3BucketName - - string - - true - - Name of the Amazon S3 bucket that hosts the S3 blockstore. - * - --s3MaxConnections - - int - - false - - Positive integer that indicates the maximum number of connections to this Amazon S3 blockstore. - * - --sseEnabled - - - - false - - Flag that indicates whether the Amazon S3 blockstore enables server-side encryption. - * - --uri - - string - - true - - Comma-separated list of hosts in the format for accessing the blockstore. - * - --writeConcern - - string - - false - - Write concern for the blockstore. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-admin-backups-s3.txt b/docs/mongocli/command/mongocli-ops-manager-admin-backups-s3.txt deleted file mode 100644 index df4a0cf754..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-admin-backups-s3.txt +++ /dev/null @@ -1,67 +0,0 @@ -.. _mongocli-ops-manager-admin-backups-s3: - -===================================== -mongocli ops-manager admin backups s3 -===================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage backup s3 blockstore configurations. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for s3 - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-ops-manager-admin-backups-s3-create` - Create a backup S3 blockstore configuration. -* :ref:`mongocli-ops-manager-admin-backups-s3-delete` - Delete a backup s3 blockstore configuration. -* :ref:`mongocli-ops-manager-admin-backups-s3-describe` - Get a backup s3 blockstore configuration. -* :ref:`mongocli-ops-manager-admin-backups-s3-list` - List backup s3 blockstore configurations. -* :ref:`mongocli-ops-manager-admin-backups-s3-update` - Update a backup S3 blockstore configuration. - - -.. toctree:: - :titlesonly: - - create - delete - describe - list - update - diff --git a/docs/mongocli/command/mongocli-ops-manager-admin-backups-sync-create.txt b/docs/mongocli/command/mongocli-ops-manager-admin-backups-sync-create.txt deleted file mode 100644 index 5a22596b40..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-admin-backups-sync-create.txt +++ /dev/null @@ -1,98 +0,0 @@ -.. _mongocli-ops-manager-admin-backups-sync-create: - -============================================== -mongocli ops-manager admin backups sync create -============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create a backup sync configuration. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager admin backups sync 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 - * - --assignment - - - - false - - Flag indicating whether this sync store can be assigned backup jobs. - * - --encryptedCredentials - - - - false - - Flag indicating whether the username and password were encrypted using the credentials tool. - * - -h, --help - - - - false - - help for create - * - --label - - strings - - false - - Array of tags to manage which backup jobs Ops Manager can assign to which blockstores. - * - --loadFactor - - int - - false - - A positive, non-zero integer that expresses how much backup work this snapshot store should perform compared to another snapshot store. - * - --maxCapacityGB - - int - - false - - Maximum amount of data in GB the blockstore can store. - * - --name - - string - - true - - Unique name that labels this sync store. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --ssl - - - - false - - Flag that indicates whether the blockstore accepts only connections encrypted using TLS. - * - --uri - - string - - true - - Comma-separated list of hosts in the format for accessing the blockstore. - * - --writeConcern - - string - - false - - Write concern for the blockstore. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-admin-backups-sync-delete.txt b/docs/mongocli/command/mongocli-ops-manager-admin-backups-sync-delete.txt deleted file mode 100644 index e22bd7251c..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-admin-backups-sync-delete.txt +++ /dev/null @@ -1,78 +0,0 @@ -.. _mongocli-ops-manager-admin-backups-sync-delete: - -============================================== -mongocli ops-manager admin backups sync delete -============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Delete a backup sync configuration. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager admin backups sync 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 - - Configuration identifier. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-admin-backups-sync-describe.txt b/docs/mongocli/command/mongocli-ops-manager-admin-backups-sync-describe.txt deleted file mode 100644 index 5a5a50a287..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-admin-backups-sync-describe.txt +++ /dev/null @@ -1,78 +0,0 @@ -.. _mongocli-ops-manager-admin-backups-sync-describe: - -================================================ -mongocli ops-manager admin backups sync describe -================================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Get a backup sync configuration. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager admin backups sync 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 - - Configuration identifier. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-admin-backups-sync-list.txt b/docs/mongocli/command/mongocli-ops-manager-admin-backups-sync-list.txt deleted file mode 100644 index 2f44f962d7..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-admin-backups-sync-list.txt +++ /dev/null @@ -1,70 +0,0 @@ -.. _mongocli-ops-manager-admin-backups-sync-list: - -============================================ -mongocli ops-manager admin backups sync list -============================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -List backup sync configurations. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager admin backups sync 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. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-admin-backups-sync-update.txt b/docs/mongocli/command/mongocli-ops-manager-admin-backups-sync-update.txt deleted file mode 100644 index 8a851cc96a..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-admin-backups-sync-update.txt +++ /dev/null @@ -1,110 +0,0 @@ -.. _mongocli-ops-manager-admin-backups-sync-update: - -============================================== -mongocli ops-manager admin backups sync update -============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Update a backup sync configuration. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager admin backups sync 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 - - Configuration identifier. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --assignment - - - - false - - Flag indicating whether this sync store can be assigned backup jobs. - * - --encryptedCredentials - - - - false - - Flag indicating whether the username and password were encrypted using the credentials tool. - * - -h, --help - - - - false - - help for update - * - --label - - strings - - false - - Array of tags to manage which backup jobs Ops Manager can assign to which blockstores. Passing this flag replaces preexisting data. - * - --loadFactor - - int - - false - - A positive, non-zero integer that expresses how much backup work this snapshot store should perform compared to another snapshot store. - * - --maxCapacityGB - - int - - false - - Maximum amount of data in GB the blockstore can store. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --ssl - - - - false - - Flag that indicates whether the blockstore accepts only connections encrypted using TLS. - * - --uri - - string - - true - - Comma-separated list of hosts in the format for accessing the blockstore. - * - --writeConcern - - string - - false - - Write concern for the blockstore. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-admin-backups-sync.txt b/docs/mongocli/command/mongocli-ops-manager-admin-backups-sync.txt deleted file mode 100644 index f05833f84e..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-admin-backups-sync.txt +++ /dev/null @@ -1,67 +0,0 @@ -.. _mongocli-ops-manager-admin-backups-sync: - -======================================= -mongocli ops-manager admin backups sync -======================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage backup sync configurations. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for sync - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-ops-manager-admin-backups-sync-create` - Create a backup sync configuration. -* :ref:`mongocli-ops-manager-admin-backups-sync-delete` - Delete a backup sync configuration. -* :ref:`mongocli-ops-manager-admin-backups-sync-describe` - Get a backup sync configuration. -* :ref:`mongocli-ops-manager-admin-backups-sync-list` - List backup sync configurations. -* :ref:`mongocli-ops-manager-admin-backups-sync-update` - Update a backup sync configuration. - - -.. toctree:: - :titlesonly: - - create - delete - describe - list - update - diff --git a/docs/mongocli/command/mongocli-ops-manager-admin-backups.txt b/docs/mongocli/command/mongocli-ops-manager-admin-backups.txt deleted file mode 100644 index f4b64b57ba..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-admin-backups.txt +++ /dev/null @@ -1,67 +0,0 @@ -.. _mongocli-ops-manager-admin-backups: - -================================== -mongocli ops-manager admin backups -================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage backup administration. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-ops-manager-admin-backups-blockstores` - Manage backup blockstore configurations. -* :ref:`mongocli-ops-manager-admin-backups-fileSystems` - Manage file system configurations. -* :ref:`mongocli-ops-manager-admin-backups-oplog` - Manage backup oplog configurations. -* :ref:`mongocli-ops-manager-admin-backups-s3` - Manage backup s3 blockstore configurations. -* :ref:`mongocli-ops-manager-admin-backups-sync` - Manage backup sync configurations. - - -.. toctree:: - :titlesonly: - - blockstores - fileSystems - oplog - s3 - sync - diff --git a/docs/mongocli/command/mongocli-ops-manager-admin.txt b/docs/mongocli/command/mongocli-ops-manager-admin.txt deleted file mode 100644 index a4f1d01200..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-admin.txt +++ /dev/null @@ -1,59 +0,0 @@ -.. _mongocli-ops-manager-admin: - -========================== -mongocli ops-manager admin -========================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage backup administration. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for admin - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-ops-manager-admin-backups` - Manage backup administration. - - -.. toctree:: - :titlesonly: - - backups - diff --git a/docs/mongocli/command/mongocli-ops-manager-agents-apiKeys-create.txt b/docs/mongocli/command/mongocli-ops-manager-agents-apiKeys-create.txt deleted file mode 100644 index fd21de480d..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-agents-apiKeys-create.txt +++ /dev/null @@ -1,70 +0,0 @@ -.. _mongocli-ops-manager-agents-apiKeys-create: - -========================================== -mongocli ops-manager agents apiKeys create -========================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create an Agent API Key for your project. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager agents 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. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-agents-apiKeys-delete.txt b/docs/mongocli/command/mongocli-ops-manager-agents-apiKeys-delete.txt deleted file mode 100644 index 576b750795..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-agents-apiKeys-delete.txt +++ /dev/null @@ -1,82 +0,0 @@ -.. _mongocli-ops-manager-agents-apiKeys-delete: - -========================================== -mongocli ops-manager agents apiKeys delete -========================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Delete an Agent API Key for your project. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager agents 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 - - ID of the 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-agents-apiKeys-list.txt b/docs/mongocli/command/mongocli-ops-manager-agents-apiKeys-list.txt deleted file mode 100644 index 3fa3364ea7..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-agents-apiKeys-list.txt +++ /dev/null @@ -1,66 +0,0 @@ -.. _mongocli-ops-manager-agents-apiKeys-list: - -======================================== -mongocli ops-manager agents apiKeys list -======================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -List available MongoDB Agent API Keys for your project. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager agents 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 - * - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-agents-apiKeys.txt b/docs/mongocli/command/mongocli-ops-manager-agents-apiKeys.txt deleted file mode 100644 index a4be7ca021..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-agents-apiKeys.txt +++ /dev/null @@ -1,63 +0,0 @@ -.. _mongocli-ops-manager-agents-apiKeys: - -=================================== -mongocli ops-manager agents apiKeys -=================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Agent 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-ops-manager-agents-apiKeys-create` - Create an Agent API Key for your project. -* :ref:`mongocli-ops-manager-agents-apiKeys-delete` - Delete an Agent API Key for your project. -* :ref:`mongocli-ops-manager-agents-apiKeys-list` - List available MongoDB Agent API Keys for your project. - - -.. toctree:: - :titlesonly: - - create - delete - list - diff --git a/docs/mongocli/command/mongocli-ops-manager-agents-list.txt b/docs/mongocli/command/mongocli-ops-manager-agents-list.txt deleted file mode 100644 index 8792453c0c..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-agents-list.txt +++ /dev/null @@ -1,90 +0,0 @@ -.. _mongocli-ops-manager-agents-list: - -================================ -mongocli ops-manager agents list -================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -List available MongoDB Agents for your project. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager agents 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 - * - AUTOMATION|MONITORING|BACKUP - - string - - true - - Agent type - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-agents-upgrade.txt b/docs/mongocli/command/mongocli-ops-manager-agents-upgrade.txt deleted file mode 100644 index 350e12aa86..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-agents-upgrade.txt +++ /dev/null @@ -1,66 +0,0 @@ -.. _mongocli-ops-manager-agents-upgrade: - -=================================== -mongocli ops-manager agents upgrade -=================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Upgrade MongoDB Agents to the latest available version. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager agents upgrade [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 upgrade - * - -o, --output - - string - - false - - 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-agents-versions-list.txt b/docs/mongocli/command/mongocli-ops-manager-agents-versions-list.txt deleted file mode 100644 index c8d35a38b2..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-agents-versions-list.txt +++ /dev/null @@ -1,66 +0,0 @@ -.. _mongocli-ops-manager-agents-versions-list: - -========================================= -mongocli ops-manager agents versions list -========================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -List MongoDB Agent versions in the provided project. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager agents versions 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-agents-versions.txt b/docs/mongocli/command/mongocli-ops-manager-agents-versions.txt deleted file mode 100644 index 4635861001..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-agents-versions.txt +++ /dev/null @@ -1,59 +0,0 @@ -.. _mongocli-ops-manager-agents-versions: - -==================================== -mongocli ops-manager agents versions -==================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage MongoDB Agents versions. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for versions - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-ops-manager-agents-versions-list` - List MongoDB Agent versions in the provided project. - - -.. toctree:: - :titlesonly: - - list - diff --git a/docs/mongocli/command/mongocli-ops-manager-agents.txt b/docs/mongocli/command/mongocli-ops-manager-agents.txt deleted file mode 100644 index 578e23a728..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-agents.txt +++ /dev/null @@ -1,65 +0,0 @@ -.. _mongocli-ops-manager-agents: - -=========================== -mongocli ops-manager agents -=========================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage MongoDB Agents. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for agents - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-ops-manager-agents-apiKeys` - Agent API Keys operations. -* :ref:`mongocli-ops-manager-agents-list` - List available MongoDB Agents for your project. -* :ref:`mongocli-ops-manager-agents-upgrade` - Upgrade MongoDB Agents to the latest available version. -* :ref:`mongocli-ops-manager-agents-versions` - Manage MongoDB Agents versions. - - -.. toctree:: - :titlesonly: - - apiKeys - list - upgrade - versions - diff --git a/docs/mongocli/command/mongocli-ops-manager-alerts-acknowledge.txt b/docs/mongocli/command/mongocli-ops-manager-alerts-acknowledge.txt deleted file mode 100644 index 923f6ec69c..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-alerts-acknowledge.txt +++ /dev/null @@ -1,103 +0,0 @@ -.. _mongocli-ops-manager-alerts-acknowledge: - -======================================= -mongocli ops-manager alerts acknowledge -======================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Acknowledges the specified alert 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 - - mongocli ops-manager alerts acknowledge [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - alertId - - string - - true - - ID of the alert you want to acknowledge or unacknowledge. - -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. - * - -F, --forever - - - - false - - Option that acknowledges an alert 'forever'. You can't set both the forever option and the until option in the same command. - * - -h, --help - - - - false - - help for acknowledge - * - -o, --output - - string - - false - - 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. - * - --until - - string - - false - - ISO 8601-formatted time until which the alert is acknowledged. This command returns this value if a MongoDB user previously acknowledged the alert. After this date, the alert becomes unacknowledged. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - # Acknowledge an alert with the ID 5d1113b25a115342acc2d1aa in the project with the ID 5e2211c17a3e5a48f5497de3 until January 1 2028: - mongocli atlas alerts acknowledge 5d1113b25a115342acc2d1aa --until 2028-01-01T20:24:26Z --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/mongocli/command/mongocli-ops-manager-alerts-describe.txt b/docs/mongocli/command/mongocli-ops-manager-alerts-describe.txt deleted file mode 100644 index 512ed9b4ff..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-alerts-describe.txt +++ /dev/null @@ -1,102 +0,0 @@ -.. _mongocli-ops-manager-alerts-describe: - -==================================== -mongocli ops-manager alerts describe -==================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return the details for the specified alert 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 - - mongocli ops-manager alerts 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 - * - alertId - - string - - true - - Unique identifier of the alert you want to describe. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - ID TYPE METRIC STATUS - - - -Examples --------- - -.. code-block:: - - # Return the JSON-formatted details for the alert with the ID 5d1113b25a115342acc2d1aa in the project with the ID 5e2211c17a3e5a48f5497de3: - mongocli atlas alerts describe 5d1113b25a115342acc2d1aa --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/mongocli/command/mongocli-ops-manager-alerts-global-list.txt b/docs/mongocli/command/mongocli-ops-manager-alerts-global-list.txt deleted file mode 100644 index 3619a6c522..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-alerts-global-list.txt +++ /dev/null @@ -1,74 +0,0 @@ -.. _mongocli-ops-manager-alerts-global-list: - -======================================= -mongocli ops-manager alerts global list -======================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns all global alerts for the specified Ops Manager project. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager alerts global 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. - * - --status - - string - - false - - State of the alert. Valid values include TRACKING, OPEN, CLOSED, and CANCELLED. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-alerts-global.txt b/docs/mongocli/command/mongocli-ops-manager-alerts-global.txt deleted file mode 100644 index 483a06f37f..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-alerts-global.txt +++ /dev/null @@ -1,59 +0,0 @@ -.. _mongocli-ops-manager-alerts-global: - -================================== -mongocli ops-manager alerts global -================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Retrieves all the global alerts for the specified Ops Manager project. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for global - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-ops-manager-alerts-global-list` - Returns all global alerts for the specified Ops Manager project. - - -.. toctree:: - :titlesonly: - - list - diff --git a/docs/mongocli/command/mongocli-ops-manager-alerts-list.txt b/docs/mongocli/command/mongocli-ops-manager-alerts-list.txt deleted file mode 100644 index 2d3e4799cc..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-alerts-list.txt +++ /dev/null @@ -1,98 +0,0 @@ -.. _mongocli-ops-manager-alerts-list: - -================================ -mongocli ops-manager alerts list -================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return all alerts 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 - - mongocli ops-manager alerts 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. - * - --status - - string - - false - - State of the alert. Valid values include TRACKING, OPEN, CLOSED, and CANCELLED. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -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 - - - -Examples --------- - -.. code-block:: - - # Return a JSON-formatted list of all alerts for the project with the ID 5e2211c17a3e5a48f5497de3: - mongocli atlas alerts list --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/mongocli/command/mongocli-ops-manager-alerts-settings-create.txt b/docs/mongocli/command/mongocli-ops-manager-alerts-settings-create.txt deleted file mode 100644 index 097ed96133..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-alerts-settings-create.txt +++ /dev/null @@ -1,188 +0,0 @@ -.. _mongocli-ops-manager-alerts-settings-create: - -=========================================== -mongocli ops-manager alerts settings create -=========================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create an alert 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 - - mongocli ops-manager alerts settings 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 - - false - - Datadog API Key, Opsgenie API Key, or VictorOps API key. Required if the notificationType is DATADOG, OPS_GENIE, or VICTOR_OPS, respectively. - * - --enabled - - - - false - - Flag that indicates whether to enable the alert configuration. - * - --event - - string - - false - - Type of event that triggered the alert. To learn which values the CLI accepts, see the possible eventTypeName values in the API documentation for Atlas (https://dochub.mongodb.org/core/atlas-event-names), Ops Manager (https://dochub.mongodb.org/core/om-event-names), or Cloud Manager (https://dochub.mongodb.org/core/cm-event-names). - * - -h, --help - - - - false - - help for create - * - --matcherFieldName - - string - - false - - Name of the field in the target object to match on. To learn the valid values, run mongocli atlas alerts settings fields type. - * - --matcherOperator - - string - - false - - Comparison operator to apply when checking the current metric against matcherValue. Valid values are CONTAINS, ENDS_WITH, EQUALS, NOT_CONTAINS, NOT_EQUALS, REGEX, STARTS_WITH. - * - --matcherValue - - string - - false - - Value to test with the specified operator. If matcherFieldName is set to TYPE_NAME, you can match on the following values: CONFIG, MONGOS, PRIMARY, SECONDARY, STANDALONE. - * - --metricMode - - string - - false - - Option that indicates whether Atlas computes the current metric value as an average. Valid value is AVERAGE. - * - --metricName - - string - - false - - Name of the metric against which this command checks the configured alert. To learn the valid values, see https://dochub.mongodb.org/core/alert-host-metrics-atlas. This option applies only if the event is set to OUTSIDE_METRIC_THRESHOLD. - * - --metricOperator - - string - - false - - Comparison operator to apply when checking the current metric value. Valid values are LESS_THAN and GREATER_THAN. - * - --metricThreshold - - float - - false - - Threshold value outside of which an alert will be triggered. - * - --metricUnits - - string - - false - - Units for the threshold value. Valid values are BITS, BYTES, DAYS, GIGABITS, GIGABYTES, HOURS, KILOBITS, KILOBYTES, MEGABITS, MEGABYTES, MILLISECONDS, MINUTES, PETABYTES, RAW, SECONDS, TERABYTES. - * - --notificationChannelName - - string - - false - - Slack channel name. Required for the SLACK notifications type. - * - --notificationDelayMin - - int - - false - - Number of minutes to wait after an alert condition is detected before sending out the first notification. - * - --notificationEmailAddress - - string - - false - - Email address to which alert notifications are sent. - * - --notificationEmailEnabled - - - - false - - Flag that enables email notifications. Configurable for GROUP and USER notification types. - * - --notificationIntervalMin - - int - - false - - Number of minutes to wait between successive notifications for unacknowledged alerts that are not resolved. - * - --notificationMobileNumber - - string - - false - - Mobile number to which alert notifications are sent. - * - --notificationRegion - - string - - false - - Region that indicates which API URL to use. - * - --notificationServiceKey - - string - - false - - PagerDuty service key. - * - --notificationSmsEnabled - - - - false - - Flag that enables text message notifications. - * - --notificationTeamId - - string - - false - - Unique identifier of a team. - * - --notificationToken - - string - - false - - Slack API token, or Bot token. - * - --notificationType - - string - - false - - Type of alert notification. Valid values are DATADOG, EMAIL, GROUP (Project), ORG, OPS_GENIE, PAGER_DUTY, SLACK, SMS, USER, or VICTOR_OPS. - * - --notificationUsername - - string - - false - - Name of the Atlas user to which to send notifications. - * - --notificationVictorOpsRoutingKey - - string - - false - - Routing key associated with your Splunk On-Call 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Alert configuration created. - - -Examples --------- - -.. code-block:: - - # Create an alert configuration that notifies a user when they join a group for the project with the ID 5df90590f10fab5e33de2305: - mongocli atlas alerts settings create --event JOINED_GROUP --enabled \ - --notificationType USER --notificationEmailEnabled \ - --notificationUsername john@example.com \ - --output json --projectId 5df90590f10fab5e33de2305 diff --git a/docs/mongocli/command/mongocli-ops-manager-alerts-settings-delete.txt b/docs/mongocli/command/mongocli-ops-manager-alerts-settings-delete.txt deleted file mode 100644 index 315e186c3a..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-alerts-settings-delete.txt +++ /dev/null @@ -1,101 +0,0 @@ -.. _mongocli-ops-manager-alerts-settings-delete: - -=========================================== -mongocli ops-manager alerts settings delete -=========================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Remove the specified alert 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 - - mongocli ops-manager alerts settings 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 - * - alertConfigId - - string - - true - - Unique identifier of the alert configuration 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Alert config '' deleted - - -Examples --------- - -.. code-block:: - - # Remove the alert configuration with the ID 5d1113b25a115342acc2d1aa in the project with the ID 5e2211c17a3e5a48f5497de3: - mongocli atlas alerts settings delete 5d1113b25a115342acc2d1aa --projectId 5e2211c17a3e5a48f5497de3 diff --git a/docs/mongocli/command/mongocli-ops-manager-alerts-settings-disable.txt b/docs/mongocli/command/mongocli-ops-manager-alerts-settings-disable.txt deleted file mode 100644 index ee57c9c5cf..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-alerts-settings-disable.txt +++ /dev/null @@ -1,89 +0,0 @@ -.. _mongocli-ops-manager-alerts-settings-disable: - -============================================ -mongocli ops-manager alerts settings disable -============================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Disables one alert configuration for the specified project. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager alerts settings disable [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - alertConfigId - - string - - true - - ID of the alert configuration you want to disable. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - # Disable the alert configuration with the ID 5d1113b25a115342acc2d1aa in the project with the ID 5e2211c17a3e5a48f5497de3: - mongocli atlas alerts settings disable 5d1113b25a115342acc2d1aa --projectId 5e2211c17a3e5a48f5497de3 diff --git a/docs/mongocli/command/mongocli-ops-manager-alerts-settings-enable.txt b/docs/mongocli/command/mongocli-ops-manager-alerts-settings-enable.txt deleted file mode 100644 index b49dcd22e7..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-alerts-settings-enable.txt +++ /dev/null @@ -1,82 +0,0 @@ -.. _mongocli-ops-manager-alerts-settings-enable: - -=========================================== -mongocli ops-manager alerts settings enable -=========================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Enables one alert configuration for the specified project. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager alerts settings enable [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - alertConfigId - - string - - true - - ID of the alert you want to enable. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-alerts-settings-fields-type.txt b/docs/mongocli/command/mongocli-ops-manager-alerts-settings-fields-type.txt deleted file mode 100644 index b05dff11e0..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-alerts-settings-fields-type.txt +++ /dev/null @@ -1,71 +0,0 @@ -.. _mongocli-ops-manager-alerts-settings-fields-type: - -================================================ -mongocli ops-manager alerts settings fields type -================================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return all available field types that the matcherFieldName option accepts when you create or update an alert configuration. - -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 - - mongocli ops-manager alerts settings fields type [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 type - * - -o, --output - - string - - false - - 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - # Return a JSON-formatted list of accepted field types for the matchersFieldName option: - mongocli atlas alerts settings fields type --output json diff --git a/docs/mongocli/command/mongocli-ops-manager-alerts-settings-fields.txt b/docs/mongocli/command/mongocli-ops-manager-alerts-settings-fields.txt deleted file mode 100644 index bb4260c017..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-alerts-settings-fields.txt +++ /dev/null @@ -1,59 +0,0 @@ -.. _mongocli-ops-manager-alerts-settings-fields: - -=========================================== -mongocli ops-manager alerts settings fields -=========================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manages alert configuration fields for your project. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for fields - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-ops-manager-alerts-settings-fields-type` - Return all available field types that the matcherFieldName option accepts when you create or update an alert configuration. - - -.. toctree:: - :titlesonly: - - type - diff --git a/docs/mongocli/command/mongocli-ops-manager-alerts-settings-list.txt b/docs/mongocli/command/mongocli-ops-manager-alerts-settings-list.txt deleted file mode 100644 index 3eeb8cbc5f..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-alerts-settings-list.txt +++ /dev/null @@ -1,83 +0,0 @@ -.. _mongocli-ops-manager-alerts-settings-list: - -========================================= -mongocli ops-manager alerts settings list -========================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Returns all alert configurations 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 - - mongocli ops-manager alerts settings 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - # Return a JSON-formatted list of all alert configurations for the project with the ID 5df90590f10fab5e33de2305: - mongocli atlas alerts settings list --projectId 5df90590f10fab5e33de2305 --output json diff --git a/docs/mongocli/command/mongocli-ops-manager-alerts-settings-update.txt b/docs/mongocli/command/mongocli-ops-manager-alerts-settings-update.txt deleted file mode 100644 index a2dd1200cc..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-alerts-settings-update.txt +++ /dev/null @@ -1,204 +0,0 @@ -.. _mongocli-ops-manager-alerts-settings-update: - -=========================================== -mongocli ops-manager alerts settings update -=========================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Modify the details of the specified alert 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 - - mongocli ops-manager alerts settings 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 - * - alertConfigId - - string - - true - - Unique identifier of the alert configuration you want to update. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --apiKey - - string - - false - - Datadog API Key, Opsgenie API Key, or VictorOps API key. Required if the notificationType is DATADOG, OPS_GENIE, or VICTOR_OPS, respectively. - * - --enabled - - - - false - - Flag that indicates whether to enable the alert configuration. - * - --event - - string - - false - - Type of event that triggered the alert. To learn which values the CLI accepts, see the possible eventTypeName values in the API documentation for Atlas (https://dochub.mongodb.org/core/atlas-event-names), Ops Manager (https://dochub.mongodb.org/core/om-event-names), or Cloud Manager (https://dochub.mongodb.org/core/cm-event-names). - * - -h, --help - - - - false - - help for update - * - --matcherFieldName - - string - - false - - Name of the field in the target object to match on. To learn the valid values, run mongocli atlas alerts settings fields type. - * - --matcherOperator - - string - - false - - Comparison operator to apply when checking the current metric against matcherValue. Valid values are CONTAINS, ENDS_WITH, EQUALS, NOT_CONTAINS, NOT_EQUALS, REGEX, STARTS_WITH. - * - --matcherValue - - string - - false - - Value to test with the specified operator. If matcherFieldName is set to TYPE_NAME, you can match on the following values: CONFIG, MONGOS, PRIMARY, SECONDARY, STANDALONE. - * - --metricMode - - string - - false - - Option that indicates whether Atlas computes the current metric value as an average. Valid value is AVERAGE. - * - --metricName - - string - - false - - Name of the metric against which this command checks the configured alert. To learn the valid values, see https://dochub.mongodb.org/core/alert-host-metrics-atlas. This option applies only if the event is set to OUTSIDE_METRIC_THRESHOLD. - * - --metricOperator - - string - - false - - Comparison operator to apply when checking the current metric value. Valid values are LESS_THAN and GREATER_THAN. - * - --metricThreshold - - float - - false - - Threshold value outside of which an alert will be triggered. - * - --metricUnits - - string - - false - - Units for the threshold value. Valid values are BITS, BYTES, DAYS, GIGABITS, GIGABYTES, HOURS, KILOBITS, KILOBYTES, MEGABITS, MEGABYTES, MILLISECONDS, MINUTES, PETABYTES, RAW, SECONDS, TERABYTES. - * - --notificationChannelName - - string - - false - - Slack channel name. Required for the SLACK notifications type. - * - --notificationDelayMin - - int - - false - - Number of minutes to wait after an alert condition is detected before sending out the first notification. - * - --notificationEmailAddress - - string - - false - - Email address to which alert notifications are sent. - * - --notificationEmailEnabled - - - - false - - Flag that enables email notifications. Configurable for GROUP and USER notification types. - * - --notificationIntervalMin - - int - - false - - Number of minutes to wait between successive notifications for unacknowledged alerts that are not resolved. - * - --notificationMobileNumber - - string - - false - - Mobile number to which alert notifications are sent. - * - --notificationRegion - - string - - false - - Region that indicates which API URL to use. - * - --notificationServiceKey - - string - - false - - PagerDuty service key. - * - --notificationSmsEnabled - - - - false - - Flag that enables text message notifications. - * - --notificationTeamId - - string - - false - - Unique identifier of a team. - * - --notificationToken - - string - - false - - Slack API token, or Bot token. - * - --notificationType - - string - - false - - Type of alert notification. Valid values are DATADOG, EMAIL, GROUP (Project), ORG, OPS_GENIE, PAGER_DUTY, SLACK, SMS, USER, or VICTOR_OPS. - * - --notificationUsername - - string - - false - - Name of the Atlas user to which to send notifications. - * - --notificationVictorOpsRoutingKey - - string - - false - - Routing key associated with your Splunk On-Call 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Output ------- - -If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. - -.. code-block:: - - Alert configuration '' updated. - - -Examples --------- - -.. code-block:: - - # Modify the alert configuration with the ID 5d1113b25a115342acc2d1aa so that it notifies a user when they join a group for the project with the ID 5df90590f10fab5e33de2305: - mongocli atlas alerts settings update 5d1113b25a115342acc2d1aa --event JOINED_GROUP --enabled \ - --notificationType USER --notificationEmailEnabled \ - --notificationUsername john@example.com \ - --output json --projectId 5df90590f10fab5e33de2305 diff --git a/docs/mongocli/command/mongocli-ops-manager-alerts-settings.txt b/docs/mongocli/command/mongocli-ops-manager-alerts-settings.txt deleted file mode 100644 index ca78a31cef..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-alerts-settings.txt +++ /dev/null @@ -1,73 +0,0 @@ -.. _mongocli-ops-manager-alerts-settings: - -==================================== -mongocli ops-manager alerts settings -==================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manages alerts configuration for your project. - -Use this command to list, create, edit, delete, enable and disable alert configurations. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-ops-manager-alerts-settings-create` - Create an alert configuration for your project. -* :ref:`mongocli-ops-manager-alerts-settings-delete` - Remove the specified alert configuration for your project. -* :ref:`mongocli-ops-manager-alerts-settings-disable` - Disables one alert configuration for the specified project. -* :ref:`mongocli-ops-manager-alerts-settings-enable` - Enables one alert configuration for the specified project. -* :ref:`mongocli-ops-manager-alerts-settings-fields` - Manages alert configuration fields for your project. -* :ref:`mongocli-ops-manager-alerts-settings-list` - Returns all alert configurations for your project. -* :ref:`mongocli-ops-manager-alerts-settings-update` - Modify the details of the specified alert configuration for your project. - - -.. toctree:: - :titlesonly: - - create - delete - disable - enable - fields - list - update - diff --git a/docs/mongocli/command/mongocli-ops-manager-alerts-unacknowledge.txt b/docs/mongocli/command/mongocli-ops-manager-alerts-unacknowledge.txt deleted file mode 100644 index 6c5a43cbe8..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-alerts-unacknowledge.txt +++ /dev/null @@ -1,95 +0,0 @@ -.. _mongocli-ops-manager-alerts-unacknowledge: - -========================================= -mongocli ops-manager alerts unacknowledge -========================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Unacknowledge the specified alert 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 - - mongocli ops-manager alerts unacknowledge [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - alertId - - string - - true - - Unique ID of the alert you want to unacknowledge. - -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 unacknowledge - * - -o, --output - - string - - false - - 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - # Unacknowledge the alert with the ID 5d1113b25a115342acc2d1aa in the project with the ID 5e2211c17a3e5a48f5497de3: - mongocli atlas alerts unacknowledge 5d1113b25a115342acc2d1aa --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/mongocli/command/mongocli-ops-manager-alerts.txt b/docs/mongocli/command/mongocli-ops-manager-alerts.txt deleted file mode 100644 index e8f037d658..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-alerts.txt +++ /dev/null @@ -1,69 +0,0 @@ -.. _mongocli-ops-manager-alerts: - -=========================== -mongocli ops-manager alerts -=========================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage alerts for your project. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for alerts - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-ops-manager-alerts-acknowledge` - Acknowledges the specified alert for your project. -* :ref:`mongocli-ops-manager-alerts-describe` - Return the details for the specified alert for your project. -* :ref:`mongocli-ops-manager-alerts-global` - Retrieves all the global alerts for the specified Ops Manager project. -* :ref:`mongocli-ops-manager-alerts-list` - Return all alerts for your project. -* :ref:`mongocli-ops-manager-alerts-settings` - Manages alerts configuration for your project. -* :ref:`mongocli-ops-manager-alerts-unacknowledge` - Unacknowledge the specified alert for your project. - - -.. toctree:: - :titlesonly: - - acknowledge - describe - global - list - settings - unacknowledge - diff --git a/docs/mongocli/command/mongocli-ops-manager-automation-describe.txt b/docs/mongocli/command/mongocli-ops-manager-automation-describe.txt deleted file mode 100644 index 26889f4a58..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-automation-describe.txt +++ /dev/null @@ -1,66 +0,0 @@ -.. _mongocli-ops-manager-automation-describe: - -======================================== -mongocli ops-manager automation describe -======================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Get the current automation configuration for a project. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager automation 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-automation-status.txt b/docs/mongocli/command/mongocli-ops-manager-automation-status.txt deleted file mode 100644 index 4f2cdea47b..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-automation-status.txt +++ /dev/null @@ -1,66 +0,0 @@ -.. _mongocli-ops-manager-automation-status: - -====================================== -mongocli ops-manager automation status -====================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Show the current status of the automation config. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager automation status [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 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-automation-update.txt b/docs/mongocli/command/mongocli-ops-manager-automation-update.txt deleted file mode 100644 index ed7ffd33a2..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-automation-update.txt +++ /dev/null @@ -1,66 +0,0 @@ -.. _mongocli-ops-manager-automation-update: - -====================================== -mongocli ops-manager automation update -====================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Update the current automation configuration for a project. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager automation 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 - * - -f, --file - - string - - true - - Filename to use - * - -h, --help - - - - false - - help for update - * - --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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-automation-watch.txt b/docs/mongocli/command/mongocli-ops-manager-automation-watch.txt deleted file mode 100644 index d0c072df56..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-automation-watch.txt +++ /dev/null @@ -1,73 +0,0 @@ -.. _mongocli-ops-manager-automation-watch: - -===================================== -mongocli ops-manager automation watch -===================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Watch for automation changes to be completed. - -This command checks the automation "lastGoalVersionAchieved" periodically until it matches "goalVersion". -Once the expected status is reached, the command prints "Changes deployed successfully." -If you run the command in the terminal, it blocks the terminal session until the changes are completed. -You can interrupt the command's polling at any time with CTRL-C. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager automation 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 - * - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - mongocli ops-manager automation watch diff --git a/docs/mongocli/command/mongocli-ops-manager-automation.txt b/docs/mongocli/command/mongocli-ops-manager-automation.txt deleted file mode 100644 index 4024e29d62..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-automation.txt +++ /dev/null @@ -1,65 +0,0 @@ -.. _mongocli-ops-manager-automation: - -=============================== -mongocli ops-manager automation -=============================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage automation configuration for your project. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for automation - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-ops-manager-automation-describe` - Get the current automation configuration for a project. -* :ref:`mongocli-ops-manager-automation-status` - Show the current status of the automation config. -* :ref:`mongocli-ops-manager-automation-update` - Update the current automation configuration for a project. -* :ref:`mongocli-ops-manager-automation-watch` - Watch for automation changes to be completed. - - -.. toctree:: - :titlesonly: - - describe - status - update - watch - diff --git a/docs/mongocli/command/mongocli-ops-manager-backups-checkpoints-list.txt b/docs/mongocli/command/mongocli-ops-manager-backups-checkpoints-list.txt deleted file mode 100644 index a70183f8ad..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-backups-checkpoints-list.txt +++ /dev/null @@ -1,90 +0,0 @@ -.. _mongocli-ops-manager-backups-checkpoints-list: - -============================================= -mongocli ops-manager backups checkpoints list -============================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -List continuous backup checkpoints for your project. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager backups checkpoints 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 - * - clusterId - - string - - true - - ID of the cluster. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-backups-checkpoints.txt b/docs/mongocli/command/mongocli-ops-manager-backups-checkpoints.txt deleted file mode 100644 index 0259807342..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-backups-checkpoints.txt +++ /dev/null @@ -1,59 +0,0 @@ -.. _mongocli-ops-manager-backups-checkpoints: - -======================================== -mongocli ops-manager backups checkpoints -======================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage backup checkpoints for your project. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for checkpoints - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-ops-manager-backups-checkpoints-list` - List continuous backup checkpoints for your project. - - -.. toctree:: - :titlesonly: - - list - diff --git a/docs/mongocli/command/mongocli-ops-manager-backups-config-describe.txt b/docs/mongocli/command/mongocli-ops-manager-backups-config-describe.txt deleted file mode 100644 index d00405b2eb..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-backups-config-describe.txt +++ /dev/null @@ -1,82 +0,0 @@ -.. _mongocli-ops-manager-backups-config-describe: - -============================================ -mongocli ops-manager backups config describe -============================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Get a backup configuration. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager backups 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 - * - clusterId - - string - - true - - ID of the cluster. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-backups-config-list.txt b/docs/mongocli/command/mongocli-ops-manager-backups-config-list.txt deleted file mode 100644 index c1924f77cd..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-backups-config-list.txt +++ /dev/null @@ -1,74 +0,0 @@ -.. _mongocli-ops-manager-backups-config-list: - -======================================== -mongocli ops-manager backups config list -======================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -List backup configurations for your project. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager backups 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 - * - --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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-backups-config-update.txt b/docs/mongocli/command/mongocli-ops-manager-backups-config-update.txt deleted file mode 100644 index e1951c7757..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-backups-config-update.txt +++ /dev/null @@ -1,126 +0,0 @@ -.. _mongocli-ops-manager-backups-config-update: - -========================================== -mongocli ops-manager backups config update -========================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Update a backup configuration. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager backups config 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 - * - clusterId - - string - - true - - ID of the cluster. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --authMechanism - - string - - false - - Authentication mechanism needed to connect to the sync source database. - * - --encryption - - - - false - - Flag that indicates if encryption is enabled for the backup configuration. - * - --excludedNamespace - - strings - - false - - List of database names and collection names to omit from the backup. Passing this flag replaces preexisting data. - * - -h, --help - - - - false - - help for update - * - --includedNamespace - - strings - - false - - List of database names and collection names to include in the backup. 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. - * - --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. - * - --provisioned - - - - false - - Flag that indicates if Ops Manager has provisioned the resources needed to store a backup. - * - --ssl - - - - false - - Flag that indicates if TLS is enabled for the sync source database. - * - --status - - string - - false - - Status of the backup configuration. - * - --storageEngine - - string - - false - - Storage engine for the backup. - * - --syncSource - - string - - false - - mongod instance from which you retrieve backup data. - * - --username - - string - - false - - 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-backups-config.txt b/docs/mongocli/command/mongocli-ops-manager-backups-config.txt deleted file mode 100644 index 9eb3c23cd4..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-backups-config.txt +++ /dev/null @@ -1,63 +0,0 @@ -.. _mongocli-ops-manager-backups-config: - -=================================== -mongocli ops-manager backups config -=================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage backup configurations for your project. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-ops-manager-backups-config-describe` - Get a backup configuration. -* :ref:`mongocli-ops-manager-backups-config-list` - List backup configurations for your project. -* :ref:`mongocli-ops-manager-backups-config-update` - Update a backup configuration. - - -.. toctree:: - :titlesonly: - - describe - list - update - diff --git a/docs/mongocli/command/mongocli-ops-manager-backups-disable.txt b/docs/mongocli/command/mongocli-ops-manager-backups-disable.txt deleted file mode 100644 index bb26f68551..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-backups-disable.txt +++ /dev/null @@ -1,78 +0,0 @@ -.. _mongocli-ops-manager-backups-disable: - -==================================== -mongocli ops-manager backups disable -==================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Disable backup for a given hostname - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager backups disable [options] - -.. 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 hostname. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-backups-enable.txt b/docs/mongocli/command/mongocli-ops-manager-backups-enable.txt deleted file mode 100644 index 4d01d58d43..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-backups-enable.txt +++ /dev/null @@ -1,78 +0,0 @@ -.. _mongocli-ops-manager-backups-enable: - -=================================== -mongocli ops-manager backups enable -=================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Enable backup for a given hostname - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager backups enable [options] - -.. 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 hostname. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-backups-restores-list.txt b/docs/mongocli/command/mongocli-ops-manager-backups-restores-list.txt deleted file mode 100644 index 802ebd6688..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-backups-restores-list.txt +++ /dev/null @@ -1,90 +0,0 @@ -.. _mongocli-ops-manager-backups-restores-list: - -========================================== -mongocli ops-manager backups restores list -========================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Lists restore jobs for a project and cluster. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager 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 - * - clusterId - - string - - true - - ID of the cluster. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-backups-restores-start.txt b/docs/mongocli/command/mongocli-ops-manager-backups-restores-start.txt deleted file mode 100644 index 3e8bc0b814..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-backups-restores-start.txt +++ /dev/null @@ -1,126 +0,0 @@ -.. _mongocli-ops-manager-backups-restores-start: - -=========================================== -mongocli ops-manager backups restores start -=========================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Start a restore job for a project and cluster. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager backups restores 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 - * - AUTOMATED_RESTORE|HTTP - - string - - true - - Restore type. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --checkpointId - - string - - false - - Unique identifier for the sharded cluster checkpoint that represents the point in time to which your data will be restored. If you set checkpointId, you cannot set oplogInc, oplogTs, snapshotId, or pointInTimeUTCMillis. - * - --clusterId - - string - - true - - Unique identifier of the cluster. - * - --expirationHours - - int - - false - - Number of hours the download URL is valid once the restore job is complete. For use only with download restore jobs. - * - --expires - - string - - false - - Timestamp in ISO 8601 date and time format after which the URL is no longer available. For use only with download restore jobs. - * - -h, --help - - - - false - - help for start - * - --maxDownloads - - int - - false - - Number of times the download URL can be used. This value must be 1 or greater. For use only with download restore jobs. - * - --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 - - string - - 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. - * - --pointInTimeUTCMillis - - float - - false - - Timestamp in the number of milliseconds 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 to restore. You must specify a snapshotId for automated restores. - * - --targetClusterId - - string - - false - - Unique identifier of the target cluster. For use only with automated restore jobs. - * - --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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-backups-restores.txt b/docs/mongocli/command/mongocli-ops-manager-backups-restores.txt deleted file mode 100644 index 8d4c9f6203..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-backups-restores.txt +++ /dev/null @@ -1,61 +0,0 @@ -.. _mongocli-ops-manager-backups-restores: - -===================================== -mongocli ops-manager backups restores -===================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-ops-manager-backups-restores-list` - Lists restore jobs for a project and cluster. -* :ref:`mongocli-ops-manager-backups-restores-start` - Start a restore job for a project and cluster. - - -.. toctree:: - :titlesonly: - - list - start - diff --git a/docs/mongocli/command/mongocli-ops-manager-backups-snapshots-list.txt b/docs/mongocli/command/mongocli-ops-manager-backups-snapshots-list.txt deleted file mode 100644 index f5164a3dcb..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-backups-snapshots-list.txt +++ /dev/null @@ -1,90 +0,0 @@ -.. _mongocli-ops-manager-backups-snapshots-list: - -=========================================== -mongocli ops-manager backups snapshots list -=========================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -List snapshots for a project and cluster. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager 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 - * - clusterId - - string - - true - - ID of the cluster. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-backups-snapshots-schedule-describe.txt b/docs/mongocli/command/mongocli-ops-manager-backups-snapshots-schedule-describe.txt deleted file mode 100644 index a52c7e9540..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-backups-snapshots-schedule-describe.txt +++ /dev/null @@ -1,70 +0,0 @@ -.. _mongocli-ops-manager-backups-snapshots-schedule-describe: - -======================================================== -mongocli ops-manager backups snapshots schedule describe -======================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Describe a snapshot schedule for a cluster. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager backups snapshots schedule 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 - * - --clusterId - - string - - true - - Unique identifier of the cluster. - * - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-backups-snapshots-schedule-update.txt b/docs/mongocli/command/mongocli-ops-manager-backups-snapshots-schedule-update.txt deleted file mode 100644 index 98175f1577..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-backups-snapshots-schedule-update.txt +++ /dev/null @@ -1,110 +0,0 @@ -.. _mongocli-ops-manager-backups-snapshots-schedule-update: - -====================================================== -mongocli ops-manager backups snapshots schedule update -====================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Update a snapshot schedule for a cluster. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager backups snapshots schedule 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 - * - --clusterCheckpointIntervalMin - - int - - false - - Number of minutes between successive cluster checkpoints. Valid values are 15, 30, or 60. - * - --clusterId - - string - - true - - Unique identifier of the cluster. - * - --dailySnapshotRetentionDays - - int - - false - - Number of days to retain daily snapshots. Accepted values are between 1 and 365 inclusive. - * - -h, --help - - - - false - - help for update - * - --monthlySnapshotRetentionMonths - - int - - false - - Number of months to retain monthly snapshots. Accepted values are between 1 and 36 inclusive. - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --pointInTimeWindowHours - - int - - false - - Number of hours in the past for which MongoDB should create a point-in-time snapshot. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --referenceHourOfDay - - int - - false - - Hour of the day to schedule snapshots using a 24-hour clock. Accepted values are between 0 and 23 inclusive. - * - --referenceMinuteOfHour - - int - - false - - Minute of the hour to schedule snapshots. Accepted values are between 0 and 59 inclusive. - * - --referenceTimeZoneOffset - - string - - false - - ISO-8601-formatted timezone offset where the Ops Manager host resides. - * - --snapshotIntervalHours - - int - - false - - Number of hours between snapshots. Valid values are 6, 8, 12, or 24. - * - --snapshotRetentionDays - - int - - false - - Number of days to keep recent snapshots. Accepted values are between 2 and 5 inclusive. - * - --weeklySnapshotRetentionWeeks - - int - - false - - Number of weeks to retain weekly snapshots. Accepted values are between 1 and 52 inclusive. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-backups-snapshots-schedule.txt b/docs/mongocli/command/mongocli-ops-manager-backups-snapshots-schedule.txt deleted file mode 100644 index a8a48a94c0..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-backups-snapshots-schedule.txt +++ /dev/null @@ -1,61 +0,0 @@ -.. _mongocli-ops-manager-backups-snapshots-schedule: - -=============================================== -mongocli ops-manager backups snapshots schedule -=============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage backup snapshot schedules for a cluster. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for schedule - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-ops-manager-backups-snapshots-schedule-describe` - Describe a snapshot schedule for a cluster. -* :ref:`mongocli-ops-manager-backups-snapshots-schedule-update` - Update a snapshot schedule for a cluster. - - -.. toctree:: - :titlesonly: - - describe - update - diff --git a/docs/mongocli/command/mongocli-ops-manager-backups-snapshots.txt b/docs/mongocli/command/mongocli-ops-manager-backups-snapshots.txt deleted file mode 100644 index 3ef602b1af..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-backups-snapshots.txt +++ /dev/null @@ -1,61 +0,0 @@ -.. _mongocli-ops-manager-backups-snapshots: - -====================================== -mongocli ops-manager backups snapshots -====================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-ops-manager-backups-snapshots-list` - List snapshots for a project and cluster. -* :ref:`mongocli-ops-manager-backups-snapshots-schedule` - Manage backup snapshot schedules for a cluster. - - -.. toctree:: - :titlesonly: - - list - schedule - diff --git a/docs/mongocli/command/mongocli-ops-manager-backups.txt b/docs/mongocli/command/mongocli-ops-manager-backups.txt deleted file mode 100644 index 770d8414fd..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-backups.txt +++ /dev/null @@ -1,69 +0,0 @@ -.. _mongocli-ops-manager-backups: - -============================ -mongocli ops-manager backups -============================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage continuous 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-ops-manager-backups-checkpoints` - Manage backup checkpoints for your project. -* :ref:`mongocli-ops-manager-backups-config` - Manage backup configurations for your project. -* :ref:`mongocli-ops-manager-backups-disable` - Disable backup for a given hostname -* :ref:`mongocli-ops-manager-backups-enable` - Enable backup for a given hostname -* :ref:`mongocli-ops-manager-backups-restores` - Manage restore jobs for your project. -* :ref:`mongocli-ops-manager-backups-snapshots` - Manage backup snapshots for your project. - - -.. toctree:: - :titlesonly: - - checkpoints - config - disable - enable - restores - snapshots - diff --git a/docs/mongocli/command/mongocli-ops-manager-clusters-apply.txt b/docs/mongocli/command/mongocli-ops-manager-clusters-apply.txt deleted file mode 100644 index 99c3dc08f9..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-clusters-apply.txt +++ /dev/null @@ -1,66 +0,0 @@ -.. _mongocli-ops-manager-clusters-apply: - -=================================== -mongocli ops-manager clusters apply -=================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Apply a new cluster configuration for your project. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager clusters 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 - * - -f, --file - - string - - true - - Filename to use to change the automation config - * - -h, --help - - - - false - - help for apply - * - --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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-clusters-create.txt b/docs/mongocli/command/mongocli-ops-manager-clusters-create.txt deleted file mode 100644 index 21ef0b490f..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-clusters-create.txt +++ /dev/null @@ -1,66 +0,0 @@ -.. _mongocli-ops-manager-clusters-create: - -==================================== -mongocli ops-manager clusters create -==================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create a MongoDB cluster. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager clusters 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 - * - -f, --file - - string - - true - - Filename to use to create the cluster - * - -h, --help - - - - false - - help for create - * - --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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-clusters-delete.txt b/docs/mongocli/command/mongocli-ops-manager-clusters-delete.txt deleted file mode 100644 index d155a51771..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-clusters-delete.txt +++ /dev/null @@ -1,82 +0,0 @@ -.. _mongocli-ops-manager-clusters-delete: - -==================================== -mongocli ops-manager clusters delete -==================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Completely removes a cluster from your project. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager 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 - * - name - - string - - true - - Name of the cLuster. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-clusters-describe.txt b/docs/mongocli/command/mongocli-ops-manager-clusters-describe.txt deleted file mode 100644 index 810c5f4231..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-clusters-describe.txt +++ /dev/null @@ -1,85 +0,0 @@ -.. _mongocli-ops-manager-clusters-describe: - -====================================== -mongocli ops-manager clusters describe -====================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Describe a cluster. - -When describing cluster with no output format please provide the cluster ID. -When using an output format please provide the cluster name. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager 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 - * - id|name - - string - - true - - Name or ID of the cluster. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-clusters-indexes-create.txt b/docs/mongocli/command/mongocli-ops-manager-clusters-indexes-create.txt deleted file mode 100644 index 103a832ea0..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-clusters-indexes-create.txt +++ /dev/null @@ -1,145 +0,0 @@ -.. _mongocli-ops-manager-clusters-indexes-create: - -============================================ -mongocli ops-manager clusters indexes create -============================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create a rolling index for your MongoDB cluster. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager 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 to create. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --MaxVariable - - string - - false - - Flag that determines which characters to ignore. This flag applies only if you set indexConfigs.collation.alternate to shifted. - * - --alternate - - string - - false - - Flag that determines whether collation should consider whitespace and punctuation as base characters during comparisons. - * - --backwards - - - - false - - Flag that indicates whether strings with diacritics sort from the back to the front of the string. - * - --caseFirst - - string - - false - - Flag that determines the sort order of case differences during tertiary level comparisons. - * - --caseLevel - - - - false - - Flag that enables index case comparison. This flag applies only if the strength level is set to 1 or 2. - * - --collectionName - - string - - true - - Name of the collection. - * - --db - - string - - true - - Name of the database. - * - -h, --help - - - - false - - help for create - * - --key - - strings - - true - - Field to be indexed and the type of index in the following format: field:type. - * - --locale - - string - - false - - Locale that the ICU defines. - * - --normalization - - - - false - - Flag that indicates whether collation checks if text requires normalization and performs normalization to compare text. - * - --numericOrdering - - - - false - - Flag that indicates that collation compares numeric strings as numbers. If you set to false, collation compares numeric strings as strings. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --rsName - - string - - true - - Replica set that the index is built on. - * - --sparse - - - - false - - Flag that creates a sparse index. To learn more, see https://dochub.mongodb.org/core/index-sparse-manual. - * - --strength - - int - - false - - Level of comparison to perform. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - # Create an index named bedrooms_1 on the listings collection of the realestate database on the replica set repl1. - The command uses the default profile. - - mongocli om clusters indexes create bedrooms_1 \ - --collectionName listings --db realestate --key bedrooms:1 \ - --rsName repl1 diff --git a/docs/mongocli/command/mongocli-ops-manager-clusters-indexes.txt b/docs/mongocli/command/mongocli-ops-manager-clusters-indexes.txt deleted file mode 100644 index 8134aa2f1f..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-clusters-indexes.txt +++ /dev/null @@ -1,59 +0,0 @@ -.. _mongocli-ops-manager-clusters-indexes: - -===================================== -mongocli ops-manager 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-ops-manager-clusters-indexes-create` - Create a rolling index for your MongoDB cluster. - - -.. toctree:: - :titlesonly: - - create - diff --git a/docs/mongocli/command/mongocli-ops-manager-clusters-list.txt b/docs/mongocli/command/mongocli-ops-manager-clusters-list.txt deleted file mode 100644 index edc59e4793..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-clusters-list.txt +++ /dev/null @@ -1,69 +0,0 @@ -.. _mongocli-ops-manager-clusters-list: - -================================== -mongocli ops-manager clusters list -================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -List clusters for your project. - -When listing clusters with no output format the information provided is defined by monitoring. -When using an output format the information will be provided by automation. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager 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 - * - -o, --output - - string - - false - - 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-clusters-reclaimFreeSpace.txt b/docs/mongocli/command/mongocli-ops-manager-clusters-reclaimFreeSpace.txt deleted file mode 100644 index 7146a06fa2..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-clusters-reclaimFreeSpace.txt +++ /dev/null @@ -1,92 +0,0 @@ -.. _mongocli-ops-manager-clusters-reclaimFreeSpace: - -============================================== -mongocli ops-manager clusters reclaimFreeSpace -============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Reclaim unused space for a cluster using compact. - -During certain operations, MongoDB might move or delete data but it doesn't free the currently unused space. Ops Manager reclaims the disk space in a rolling fashion across members of the replica set or shards. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager clusters reclaimFreeSpace [options] - -.. 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 reclaim free space. - -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 reclaimFreeSpace - * - --processName - - strings - - false - - Unique identifier for the host of a MongoDB process in the following format: {hostname}:{port}. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --timestamp - - string - - false - - Timestamp in ISO 8601 format when the service reclaims the space. This option defaults 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-clusters-restart.txt b/docs/mongocli/command/mongocli-ops-manager-clusters-restart.txt deleted file mode 100644 index 7f80a2318c..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-clusters-restart.txt +++ /dev/null @@ -1,86 +0,0 @@ -.. _mongocli-ops-manager-clusters-restart: - -===================================== -mongocli ops-manager clusters restart -===================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Restart a cluster for your project. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager clusters restart [options] - -.. 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 you want to restart. - -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 restart - * - --processName - - strings - - false - - Unique identifier for the host of a MongoDB process in the following format: {hostname}:{port}. - * - --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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-clusters-resync.txt b/docs/mongocli/command/mongocli-ops-manager-clusters-resync.txt deleted file mode 100644 index 2cce3d88bb..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-clusters-resync.txt +++ /dev/null @@ -1,100 +0,0 @@ -.. _mongocli-ops-manager-clusters-resync: - -==================================== -mongocli ops-manager clusters resync -==================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Start an initial sync for a cluster or process. - -The MongoDB Agent checks whether the specified timestamp is later than the time of the last resync, and if confirmed, the MongoDB Agent: - -1. Starts the initial sync on the secondary nodes in a rolling fashion -2. Waits until you ask the primary node to become the secondary with the rs.stepDown() method -3. Starts the initial sync on the primary node - -Warning: Use this method with caution. During initial sync, Automation removes the entire contents of the node’s dbPath directory. - -To learn more, see: https://docs.mongodb.com/manual/tutorial/resync-replica-set-member/ - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager clusters resync [options] - -.. 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 start a resync. - -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 resync - * - --processName - - strings - - false - - Unique identifier for the host of a MongoDB process in the following format: {hostname}:{port}. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --timestamp - - string - - false - - Timestamp in ISO 8601 format when the sync starts. This option defaults 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-clusters-shutdown.txt b/docs/mongocli/command/mongocli-ops-manager-clusters-shutdown.txt deleted file mode 100644 index 15a6e62ce0..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-clusters-shutdown.txt +++ /dev/null @@ -1,86 +0,0 @@ -.. _mongocli-ops-manager-clusters-shutdown: - -====================================== -mongocli ops-manager clusters shutdown -====================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Shutdown a cluster for your project. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager clusters shutdown [options] - -.. 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 that you want to shutdown. - -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 shutdown - * - --processName - - strings - - false - - Unique identifier for the host of a MongoDB process in the following format: {hostname}:{port}. - * - --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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-clusters-startup.txt b/docs/mongocli/command/mongocli-ops-manager-clusters-startup.txt deleted file mode 100644 index 020cb39274..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-clusters-startup.txt +++ /dev/null @@ -1,86 +0,0 @@ -.. _mongocli-ops-manager-clusters-startup: - -===================================== -mongocli ops-manager clusters startup -===================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Start up a cluster for your project. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager clusters startup [options] - -.. 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 that you want to start. - -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 startup - * - --processName - - strings - - false - - Unique identifier for the host of a MongoDB process in the following format: {hostname}:{port}. - * - --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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-clusters-unmanage.txt b/docs/mongocli/command/mongocli-ops-manager-clusters-unmanage.txt deleted file mode 100644 index 1be659ba2c..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-clusters-unmanage.txt +++ /dev/null @@ -1,84 +0,0 @@ -.. _mongocli-ops-manager-clusters-unmanage: - -====================================== -mongocli ops-manager clusters unmanage -====================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Stop managing a cluster via automation. - -This commands only removes entries from the automation config but does not actually remove a cluster. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager clusters unmanage [options] - -.. 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 cluster for which you want to un-manage. - -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 unmanage - * - --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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-clusters-update.txt b/docs/mongocli/command/mongocli-ops-manager-clusters-update.txt deleted file mode 100644 index b8fe1aaafe..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-clusters-update.txt +++ /dev/null @@ -1,66 +0,0 @@ -.. _mongocli-ops-manager-clusters-update: - -==================================== -mongocli ops-manager clusters update -==================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Update a MongoDB cluster. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager clusters 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 - * - -f, --file - - string - - true - - Filename to use to update the cluster - * - -h, --help - - - - false - - help for update - * - --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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-clusters.txt b/docs/mongocli/command/mongocli-ops-manager-clusters.txt deleted file mode 100644 index d745bd57f8..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-clusters.txt +++ /dev/null @@ -1,83 +0,0 @@ -.. _mongocli-ops-manager-clusters: - -============================= -mongocli ops-manager clusters -============================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage clusters for your project. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-ops-manager-clusters-apply` - Apply a new cluster configuration for your project. -* :ref:`mongocli-ops-manager-clusters-create` - Create a MongoDB cluster. -* :ref:`mongocli-ops-manager-clusters-delete` - Completely removes a cluster from your project. -* :ref:`mongocli-ops-manager-clusters-describe` - Describe a cluster. -* :ref:`mongocli-ops-manager-clusters-indexes` - Manage cluster rolling indexes for your project. -* :ref:`mongocli-ops-manager-clusters-list` - List clusters for your project. -* :ref:`mongocli-ops-manager-clusters-reclaimFreeSpace` - Reclaim unused space for a cluster using compact. -* :ref:`mongocli-ops-manager-clusters-restart` - Restart a cluster for your project. -* :ref:`mongocli-ops-manager-clusters-resync` - Start an initial sync for a cluster or process. -* :ref:`mongocli-ops-manager-clusters-shutdown` - Shutdown a cluster for your project. -* :ref:`mongocli-ops-manager-clusters-startup` - Start up a cluster for your project. -* :ref:`mongocli-ops-manager-clusters-unmanage` - Stop managing a cluster via automation. -* :ref:`mongocli-ops-manager-clusters-update` - Update a MongoDB cluster. - - -.. toctree:: - :titlesonly: - - apply - create - delete - describe - indexes - list - reclaimFreeSpace - restart - resync - shutdown - startup - unmanage - update - diff --git a/docs/mongocli/command/mongocli-ops-manager-dbusers-create.txt b/docs/mongocli/command/mongocli-ops-manager-dbusers-create.txt deleted file mode 100644 index 7b71d60281..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-dbusers-create.txt +++ /dev/null @@ -1,93 +0,0 @@ -.. _mongocli-ops-manager-dbusers-create: - -=================================== -mongocli ops-manager dbusers create -=================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create a database user for your project. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager dbusers 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 - * - --authDB - - string - - false - - Authentication database name. This value defaults to "admin". - * - -h, --help - - - - false - - help for create - * - --mechanisms - - strings - - false - - Authentication mechanism. Valid values are SCRAM-SHA-1 or SCRAM-SHA-256. This value defaults to [SCRAM-SHA-1]. - * - -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. - * - -u, --username - - string - - true - - 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - # - -.. code-block:: - - # Create a user with readWriteAnyDatabase and clusterMonitor access - mongocli om dbuser create --username --role readWriteAnyDatabase,clusterMonitor --mechanisms SCRAM-SHA-256 --projectId diff --git a/docs/mongocli/command/mongocli-ops-manager-dbusers-delete.txt b/docs/mongocli/command/mongocli-ops-manager-dbusers-delete.txt deleted file mode 100644 index 970a4d96b2..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-dbusers-delete.txt +++ /dev/null @@ -1,86 +0,0 @@ -.. _mongocli-ops-manager-dbusers-delete: - -=================================== -mongocli ops-manager dbusers delete -=================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Delete a database user for your project. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager 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 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. 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-dbusers-list.txt b/docs/mongocli/command/mongocli-ops-manager-dbusers-list.txt deleted file mode 100644 index 4e062daf00..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-dbusers-list.txt +++ /dev/null @@ -1,66 +0,0 @@ -.. _mongocli-ops-manager-dbusers-list: - -================================= -mongocli ops-manager dbusers list -================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -List Atlas database users for your project. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager 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 - * - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-dbusers.txt b/docs/mongocli/command/mongocli-ops-manager-dbusers.txt deleted file mode 100644 index 73d205a19e..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-dbusers.txt +++ /dev/null @@ -1,67 +0,0 @@ -.. _mongocli-ops-manager-dbusers: - -============================ -mongocli ops-manager 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 cluster. -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-ops-manager-dbusers-create` - Create a database user for your project. -* :ref:`mongocli-ops-manager-dbusers-delete` - Delete a database user for your project. -* :ref:`mongocli-ops-manager-dbusers-list` - List Atlas database users for your project. - - -.. toctree:: - :titlesonly: - - create - delete - list - diff --git a/docs/mongocli/command/mongocli-ops-manager-diagnoseArchives-download.txt b/docs/mongocli/command/mongocli-ops-manager-diagnoseArchives-download.txt deleted file mode 100644 index a1dfd1e381..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-diagnoseArchives-download.txt +++ /dev/null @@ -1,74 +0,0 @@ -.. _mongocli-ops-manager-diagnoseArchives-download: - -============================================== -mongocli ops-manager diagnoseArchives download -============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Download diagnose archives. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager diagnoseArchives download [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 download - * - --limit - - int - - false - - Max number of entries for the diagnose archive. - * - --minutes - - int - - false - - Beginning of the period, in UNIX Epoch format, from which to start retrieving the diagnose archive. Ops Manager takes out minutes from the current time. - * - --out - - string - - false - - Optional output file name. This value defaults to diagnose-archive.tar.gz. This value defaults to "diagnose-archive.tar.gz". - * - --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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-diagnoseArchives.txt b/docs/mongocli/command/mongocli-ops-manager-diagnoseArchives.txt deleted file mode 100644 index 4f705655b8..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-diagnoseArchives.txt +++ /dev/null @@ -1,59 +0,0 @@ -.. _mongocli-ops-manager-diagnoseArchives: - -===================================== -mongocli ops-manager diagnoseArchives -===================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage diagnose archives. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for diagnoseArchives - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-ops-manager-diagnoseArchives-download` - Download diagnose archives. - - -.. toctree:: - :titlesonly: - - download - diff --git a/docs/mongocli/command/mongocli-ops-manager-events-organizations-list.txt b/docs/mongocli/command/mongocli-ops-manager-events-organizations-list.txt deleted file mode 100644 index bcb0aac3b3..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-events-organizations-list.txt +++ /dev/null @@ -1,93 +0,0 @@ -.. _mongocli-ops-manager-events-organizations-list: - -============================================== -mongocli ops-manager 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 - - mongocli ops-manager 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. - * - --minDate - - string - - false - - Minimum created date. This option returns events whose created date is greater than or equal to the specified value. - * - --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 possible eventTypeName values in the API documentation for Atlas (https://dochub.mongodb.org/core/atlas-event-names), Ops Manager (https://dochub.mongodb.org/core/om-event-names), or Cloud Manager (https://dochub.mongodb.org/core/cm-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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - # Return a JSON-formatted list of events for the organization with the ID 5dd5a6b6f10fab1d71a58495: - mongocli atlas events organizations list --orgId 5dd5a6b6f10fab1d71a58495 --output json diff --git a/docs/mongocli/command/mongocli-ops-manager-events-organizations.txt b/docs/mongocli/command/mongocli-ops-manager-events-organizations.txt deleted file mode 100644 index 1ea6613e6d..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-events-organizations.txt +++ /dev/null @@ -1,61 +0,0 @@ -.. _mongocli-ops-manager-events-organizations: - -========================================= -mongocli ops-manager 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-ops-manager-events-organizations-list` - Return all events for the specified organization. - - -.. toctree:: - :titlesonly: - - list - diff --git a/docs/mongocli/command/mongocli-ops-manager-events-projects-list.txt b/docs/mongocli/command/mongocli-ops-manager-events-projects-list.txt deleted file mode 100644 index 2e2305f94c..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-events-projects-list.txt +++ /dev/null @@ -1,93 +0,0 @@ -.. _mongocli-ops-manager-events-projects-list: - -========================================= -mongocli ops-manager 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 - - mongocli ops-manager 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. - * - --minDate - - string - - false - - Minimum created date. This option returns events whose created date is greater than or equal to the specified value. - * - -o, --output - - string - - false - - 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 possible eventTypeName values in the API documentation for Atlas (https://dochub.mongodb.org/core/atlas-event-names), Ops Manager (https://dochub.mongodb.org/core/om-event-names), or Cloud Manager (https://dochub.mongodb.org/core/cm-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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - # Return a JSON-formatted list of events for the project with the ID 5e2211c17a3e5a48f5497de3: - mongocli atlas events projects list --Id 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/mongocli/command/mongocli-ops-manager-events-projects.txt b/docs/mongocli/command/mongocli-ops-manager-events-projects.txt deleted file mode 100644 index 103119e852..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-events-projects.txt +++ /dev/null @@ -1,61 +0,0 @@ -.. _mongocli-ops-manager-events-projects: - -==================================== -mongocli ops-manager 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-ops-manager-events-projects-list` - Return all events for the specified project. - - -.. toctree:: - :titlesonly: - - list - diff --git a/docs/mongocli/command/mongocli-ops-manager-events.txt b/docs/mongocli/command/mongocli-ops-manager-events.txt deleted file mode 100644 index 69ee72d367..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-events.txt +++ /dev/null @@ -1,61 +0,0 @@ -.. _mongocli-ops-manager-events: - -=========================== -mongocli ops-manager 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-ops-manager-events-organizations` - Organization operations. -* :ref:`mongocli-ops-manager-events-projects` - Project operations. - - -.. toctree:: - :titlesonly: - - organizations - projects - diff --git a/docs/mongocli/command/mongocli-ops-manager-featurePolicies-list.txt b/docs/mongocli/command/mongocli-ops-manager-featurePolicies-list.txt deleted file mode 100644 index 802d3c5005..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-featurePolicies-list.txt +++ /dev/null @@ -1,74 +0,0 @@ -.. _mongocli-ops-manager-featurePolicies-list: - -========================================= -mongocli ops-manager featurePolicies list -========================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -List feature control policies for your project. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager featurePolicies 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-featurePolicies-update.txt b/docs/mongocli/command/mongocli-ops-manager-featurePolicies-update.txt deleted file mode 100644 index 670d39e1ab..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-featurePolicies-update.txt +++ /dev/null @@ -1,98 +0,0 @@ -.. _mongocli-ops-manager-featurePolicies-update: - -=========================================== -mongocli ops-manager featurePolicies update -=========================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Update feature control policies for your project. - -Feature Control Policies allow you to enable or disable certain MongoDB features based on your site-specific needs. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager featurePolicies 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 - * - -f, --file - - string - - false - - File name that identifies an optional file with a json policy configuration. - * - -h, --help - - - - false - - help for update - * - --name - - string - - false - - Identifying label for the external system that manages this Ops Manager 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. - * - --policy - - strings - - false - - List of policies that the external system applies to this Ops Manager Project. 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. - * - --systemId - - string - - false - - Unique identifier of the external system that manages this Ops Manager Project. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - # Disable user management for a project: - mongocli ops-manager featurePolicies update --projectId --name Operator --policy DISABLE_USER_MANAGEMENT - - -.. code-block:: - - # Update policies from a JSON configuration file: - mongocli atlas featurePolicies update --projectId --file - diff --git a/docs/mongocli/command/mongocli-ops-manager-featurePolicies.txt b/docs/mongocli/command/mongocli-ops-manager-featurePolicies.txt deleted file mode 100644 index 6630e795a6..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-featurePolicies.txt +++ /dev/null @@ -1,61 +0,0 @@ -.. _mongocli-ops-manager-featurePolicies: - -==================================== -mongocli ops-manager featurePolicies -==================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage feature control policies. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for featurePolicies - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-ops-manager-featurePolicies-list` - List feature control policies for your project. -* :ref:`mongocli-ops-manager-featurePolicies-update` - Update feature control policies for your project. - - -.. toctree:: - :titlesonly: - - list - update - diff --git a/docs/mongocli/command/mongocli-ops-manager-liveMigrations-link-create.txt b/docs/mongocli/command/mongocli-ops-manager-liveMigrations-link-create.txt deleted file mode 100644 index 932cfdc7fb..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-liveMigrations-link-create.txt +++ /dev/null @@ -1,66 +0,0 @@ -.. _mongocli-ops-manager-liveMigrations-link-create: - -=============================================== -mongocli ops-manager liveMigrations link create -=============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create one new organization link. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager 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 - * - -h, --help - - - - false - - help for create - * - --linkToken - - string - - false - - Link-token generated by Atlas. - * - --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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-liveMigrations-link-delete.txt b/docs/mongocli/command/mongocli-ops-manager-liveMigrations-link-delete.txt deleted file mode 100644 index 633cde0623..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-liveMigrations-link-delete.txt +++ /dev/null @@ -1,66 +0,0 @@ -.. _mongocli-ops-manager-liveMigrations-link-delete: - -=============================================== -mongocli ops-manager 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 - - mongocli ops-manager 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-liveMigrations-link-describe.txt b/docs/mongocli/command/mongocli-ops-manager-liveMigrations-link-describe.txt deleted file mode 100644 index 418f81c8bf..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-liveMigrations-link-describe.txt +++ /dev/null @@ -1,66 +0,0 @@ -.. _mongocli-ops-manager-liveMigrations-link-describe: - -================================================= -mongocli ops-manager liveMigrations link describe -================================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Return the status of the connection between the specified source organization and the target MongoDB Atlas organization. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager liveMigrations link 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-liveMigrations-link.txt b/docs/mongocli/command/mongocli-ops-manager-liveMigrations-link.txt deleted file mode 100644 index 48a5857ad0..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-liveMigrations-link.txt +++ /dev/null @@ -1,63 +0,0 @@ -.. _mongocli-ops-manager-liveMigrations-link: - -======================================== -mongocli ops-manager 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-ops-manager-liveMigrations-link-create` - Create one new organization link. -* :ref:`mongocli-ops-manager-liveMigrations-link-delete` - Delete one link-token. -* :ref:`mongocli-ops-manager-liveMigrations-link-describe` - Return the status of the connection between the specified source organization and the target MongoDB Atlas organization. - - -.. toctree:: - :titlesonly: - - create - delete - describe - diff --git a/docs/mongocli/command/mongocli-ops-manager-liveMigrations.txt b/docs/mongocli/command/mongocli-ops-manager-liveMigrations.txt deleted file mode 100644 index efeb89df8d..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-liveMigrations.txt +++ /dev/null @@ -1,59 +0,0 @@ -.. _mongocli-ops-manager-liveMigrations: - -=================================== -mongocli ops-manager 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-ops-manager-liveMigrations-link` - Manage the link-token for your organization. - - -.. toctree:: - :titlesonly: - - link - diff --git a/docs/mongocli/command/mongocli-ops-manager-logs-decrypt.txt b/docs/mongocli/command/mongocli-ops-manager-logs-decrypt.txt deleted file mode 100644 index 194c5abd2b..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-logs-decrypt.txt +++ /dev/null @@ -1,106 +0,0 @@ -.. _mongocli-ops-manager-logs-decrypt: - -================================= -mongocli ops-manager logs decrypt -================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Decrypts an audit log file with the provided local key file or with a server that supports KMIP. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager logs decrypt [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 - * - -f, --file - - string - - true - - Path to the file that contains encrypted audit logs. - * - -h, --help - - - - false - - help for decrypt - * - --kmipClientCertificateFile - - string - - false - - Path to the Client Certificate file used to connect to the server that supports Key Management Interoperability Protocol (KMIP). - * - --kmipClientCertificatePassword - - string - - false - - Password to decrypt the Private Key of the Client Certificate used to connect to the server that supports KMIP. - * - --kmipPassword - - string - - false - - Password that authenticates the username to the server that supports KMIP. - * - --kmipServerCAFile - - string - - false - - Path to the CA file used to connect to the server that supports KMIP. - * - --kmipUsername - - string - - false - - Username for authenticating to the server that supports KMIP. - * - --localKeyFile - - string - - false - - Path to the file that contains the Key Encryption Key (KEK) that is used to encrypt the Log Encryption Key (LEK). - * - -o, --out - - string - - false - - Path to the file where MongoCLI will save the contents of the decrypted audit log. If not specified, MongoCLI writes the contents of the decrypted audit log to stdout. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - # - -.. code-block:: - - # For audit logs in BSON format: - mongocli ops-manager logs decrypt --localKeyFile /path/to/keyFile --file /path/to/logFile.bson --out /path/to/file.json - -.. code-block:: - - # For audit logs in JSON format: - mongocli ops-manager logs decrypt --localKeyFile /path/to/keyFile --file /path/to/logFile.json --out /path/to/file.json diff --git a/docs/mongocli/command/mongocli-ops-manager-logs-jobs-collect.txt b/docs/mongocli/command/mongocli-ops-manager-logs-jobs-collect.txt deleted file mode 100644 index a4260fa9d4..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-logs-jobs-collect.txt +++ /dev/null @@ -1,98 +0,0 @@ -.. _mongocli-ops-manager-logs-jobs-collect: - -====================================== -mongocli ops-manager logs jobs collect -====================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Start a job to collect logs for your project. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager logs jobs collect [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - resourceType - - string - - true - - Type of resource to collect logs from. - * - resourceName - - string - - true - - Name of the resource to collect logs from. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for collect - * - -o, --output - - string - - false - - 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. - * - --redacted - - - - false - - Flag that indicates whether to replace emails, hostnames, IP addresses, and namespaces in API responses involving this job with random string values. - * - --sizeRequestedPerFileBytes - - int - - true - - Size for each log file in bytes. - * - --type - - strings - - true - - Array of strings specifying the types of logs to collect. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-logs-jobs-delete.txt b/docs/mongocli/command/mongocli-ops-manager-logs-jobs-delete.txt deleted file mode 100644 index c41c2e7b92..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-logs-jobs-delete.txt +++ /dev/null @@ -1,82 +0,0 @@ -.. _mongocli-ops-manager-logs-jobs-delete: - -===================================== -mongocli ops-manager logs jobs delete -===================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Delete a log collection job from your project. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager logs jobs 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 - - Log job identifier. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-logs-jobs-download.txt b/docs/mongocli/command/mongocli-ops-manager-logs-jobs-download.txt deleted file mode 100644 index 15ee940d7a..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-logs-jobs-download.txt +++ /dev/null @@ -1,86 +0,0 @@ -.. _mongocli-ops-manager-logs-jobs-download: - -======================================= -mongocli ops-manager logs jobs download -======================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Download logs generated by a log collection job. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager logs jobs 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 - * - ID - - string - - true - - Log job identifier. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --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. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-logs-jobs-list.txt b/docs/mongocli/command/mongocli-ops-manager-logs-jobs-list.txt deleted file mode 100644 index 066d8543fb..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-logs-jobs-list.txt +++ /dev/null @@ -1,70 +0,0 @@ -.. _mongocli-ops-manager-logs-jobs-list: - -=================================== -mongocli ops-manager logs jobs list -=================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -List log collection jobs for your project. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager logs jobs 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. - * - --verbose - - - - false - - Flag that returns all child jobs in the response. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-logs-jobs.txt b/docs/mongocli/command/mongocli-ops-manager-logs-jobs.txt deleted file mode 100644 index 2551db9561..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-logs-jobs.txt +++ /dev/null @@ -1,65 +0,0 @@ -.. _mongocli-ops-manager-logs-jobs: - -============================== -mongocli ops-manager logs jobs -============================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage log collection jobs for your project. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for jobs - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-ops-manager-logs-jobs-collect` - Start a job to collect logs for your project. -* :ref:`mongocli-ops-manager-logs-jobs-delete` - Delete a log collection job from your project. -* :ref:`mongocli-ops-manager-logs-jobs-download` - Download logs generated by a log collection job. -* :ref:`mongocli-ops-manager-logs-jobs-list` - List log collection jobs for your project. - - -.. toctree:: - :titlesonly: - - collect - delete - download - list - diff --git a/docs/mongocli/command/mongocli-ops-manager-logs-keyProviders-list.txt b/docs/mongocli/command/mongocli-ops-manager-logs-keyProviders-list.txt deleted file mode 100644 index d3fafc8672..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-logs-keyProviders-list.txt +++ /dev/null @@ -1,73 +0,0 @@ -.. _mongocli-ops-manager-logs-keyProviders-list: - -=========================================== -mongocli ops-manager logs keyProviders list -=========================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Lists all key provider configurations found in the encrypted audit log file. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager logs keyProviders 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 - * - -f, --file - - string - - true - - Path to the file that contains encrypted audit logs. - * - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - - mongocli ops-manager listKeyProvider --file log.gz diff --git a/docs/mongocli/command/mongocli-ops-manager-logs-keyProviders.txt b/docs/mongocli/command/mongocli-ops-manager-logs-keyProviders.txt deleted file mode 100644 index da795528df..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-logs-keyProviders.txt +++ /dev/null @@ -1,59 +0,0 @@ -.. _mongocli-ops-manager-logs-keyProviders: - -====================================== -mongocli ops-manager logs keyProviders -====================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage your key collections. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for keyProviders - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-ops-manager-logs-keyProviders-list` - Lists all key provider configurations found in the encrypted audit log file. - - -.. toctree:: - :titlesonly: - - list - diff --git a/docs/mongocli/command/mongocli-ops-manager-logs.txt b/docs/mongocli/command/mongocli-ops-manager-logs.txt deleted file mode 100644 index 7a07615194..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-logs.txt +++ /dev/null @@ -1,63 +0,0 @@ -.. _mongocli-ops-manager-logs: - -========================= -mongocli ops-manager logs -========================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage log collection jobs 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-ops-manager-logs-decrypt` - Decrypts an audit log file with the provided local key file or with a server that supports KMIP. -* :ref:`mongocli-ops-manager-logs-jobs` - Manage log collection jobs for your project. -* :ref:`mongocli-ops-manager-logs-keyProviders` - Manage your key collections. - - -.. toctree:: - :titlesonly: - - decrypt - jobs - keyProviders - diff --git a/docs/mongocli/command/mongocli-ops-manager-maintenanceWindows-create.txt b/docs/mongocli/command/mongocli-ops-manager-maintenanceWindows-create.txt deleted file mode 100644 index ccbd8bbbc9..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-maintenanceWindows-create.txt +++ /dev/null @@ -1,82 +0,0 @@ -.. _mongocli-ops-manager-maintenanceWindows-create: - -============================================== -mongocli ops-manager maintenanceWindows create -============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create a maintenance window. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager maintenanceWindows 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 - * - --alertType - - strings - - true - - Alert types to silence during the maintenance window. Valid values include HOST, REPLICA_SET, CLUSTER, AGENT, or BACKUP. - * - --desc - - string - - false - - Description of the maintenance window. - * - --endDate - - string - - true - - Timestamp in ISO 8601 date and time format in UTC when the maintenance window ends. - * - -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. - * - --startDate - - string - - true - - Timestamp in ISO 8601 date and time format in UTC when the maintenance window starts. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-maintenanceWindows-delete.txt b/docs/mongocli/command/mongocli-ops-manager-maintenanceWindows-delete.txt deleted file mode 100644 index c0e6081f39..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-maintenanceWindows-delete.txt +++ /dev/null @@ -1,82 +0,0 @@ -.. _mongocli-ops-manager-maintenanceWindows-delete: - -============================================== -mongocli ops-manager maintenanceWindows delete -============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Delete a maintenance window. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager maintenanceWindows 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 - - Maintenance window identifier. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-maintenanceWindows-describe.txt b/docs/mongocli/command/mongocli-ops-manager-maintenanceWindows-describe.txt deleted file mode 100644 index dbf8c9e241..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-maintenanceWindows-describe.txt +++ /dev/null @@ -1,82 +0,0 @@ -.. _mongocli-ops-manager-maintenanceWindows-describe: - -================================================ -mongocli ops-manager maintenanceWindows describe -================================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Get a maintenance window. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager maintenanceWindows 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 - - Maintenance window identifier. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-maintenanceWindows-list.txt b/docs/mongocli/command/mongocli-ops-manager-maintenanceWindows-list.txt deleted file mode 100644 index 601bb68092..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-maintenanceWindows-list.txt +++ /dev/null @@ -1,66 +0,0 @@ -.. _mongocli-ops-manager-maintenanceWindows-list: - -============================================ -mongocli ops-manager maintenanceWindows list -============================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -List maintenance windows. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager maintenanceWindows 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-maintenanceWindows-update.txt b/docs/mongocli/command/mongocli-ops-manager-maintenanceWindows-update.txt deleted file mode 100644 index 0a4fb40e5d..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-maintenanceWindows-update.txt +++ /dev/null @@ -1,98 +0,0 @@ -.. _mongocli-ops-manager-maintenanceWindows-update: - -============================================== -mongocli ops-manager maintenanceWindows update -============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Update a maintenance window. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager maintenanceWindows 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 - - Maintenance window identifier. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --alertType - - strings - - false - - Alert types to silence during the maintenance window. Valid values include HOST, REPLICA_SET, CLUSTER, AGENT, or BACKUP. Passing this flag replaces preexisting data. - * - --desc - - string - - false - - Description of the maintenance window. - * - --endDate - - string - - false - - Timestamp in ISO 8601 date and time format in UTC when the maintenance window ends. - * - -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. - * - --startDate - - string - - false - - Timestamp in ISO 8601 date and time format in UTC when the maintenance window starts. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-maintenanceWindows.txt b/docs/mongocli/command/mongocli-ops-manager-maintenanceWindows.txt deleted file mode 100644 index 6f94d221c6..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-maintenanceWindows.txt +++ /dev/null @@ -1,67 +0,0 @@ -.. _mongocli-ops-manager-maintenanceWindows: - -======================================= -mongocli ops-manager maintenanceWindows -======================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage Ops Manager/Cloud Manager 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-ops-manager-maintenanceWindows-create` - Create a maintenance window. -* :ref:`mongocli-ops-manager-maintenanceWindows-delete` - Delete a maintenance window. -* :ref:`mongocli-ops-manager-maintenanceWindows-describe` - Get a maintenance window. -* :ref:`mongocli-ops-manager-maintenanceWindows-list` - List maintenance windows. -* :ref:`mongocli-ops-manager-maintenanceWindows-update` - Update a maintenance window. - - -.. toctree:: - :titlesonly: - - create - delete - describe - list - update - diff --git a/docs/mongocli/command/mongocli-ops-manager-metrics-databases-describe.txt b/docs/mongocli/command/mongocli-ops-manager-metrics-databases-describe.txt deleted file mode 100644 index b59169a707..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-metrics-databases-describe.txt +++ /dev/null @@ -1,127 +0,0 @@ -.. _mongocli-ops-manager-metrics-databases-describe: - -=============================================== -mongocli ops-manager metrics databases describe -=============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Describe database measurements for a given host database. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager 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 - * - hostId - - string - - true - - Process identifier. You can use mongocli ops-manager processes list to get the ID. - * - name - - string - - true - - Database name. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - # List metrics for the database test of the process e4ac1e57c58cc9c8aaa5a1163a851993 - mongocli ops-manager metrics database describe e4ac1e57c58cc9c8aaa5a1163a851993 test --period P1DT12H --granularity PT5 diff --git a/docs/mongocli/command/mongocli-ops-manager-metrics-databases-list.txt b/docs/mongocli/command/mongocli-ops-manager-metrics-databases-list.txt deleted file mode 100644 index bd1ad28cbb..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-metrics-databases-list.txt +++ /dev/null @@ -1,90 +0,0 @@ -.. _mongocli-ops-manager-metrics-databases-list: - -=========================================== -mongocli ops-manager metrics databases list -=========================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -List available databases for a given host. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager 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 - * - ID - - string - - true - - Process identifier. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-metrics-databases.txt b/docs/mongocli/command/mongocli-ops-manager-metrics-databases.txt deleted file mode 100644 index 46b6524243..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-metrics-databases.txt +++ /dev/null @@ -1,61 +0,0 @@ -.. _mongocli-ops-manager-metrics-databases: - -====================================== -mongocli ops-manager metrics databases -====================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -List available databases or databases measurements 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-ops-manager-metrics-databases-describe` - Describe database measurements for a given host database. -* :ref:`mongocli-ops-manager-metrics-databases-list` - List available databases for a given host. - - -.. toctree:: - :titlesonly: - - describe - list - diff --git a/docs/mongocli/command/mongocli-ops-manager-metrics-disks-describe.txt b/docs/mongocli/command/mongocli-ops-manager-metrics-disks-describe.txt deleted file mode 100644 index b8d9c12e55..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-metrics-disks-describe.txt +++ /dev/null @@ -1,127 +0,0 @@ -.. _mongocli-ops-manager-metrics-disks-describe: - -=========================================== -mongocli ops-manager metrics disks describe -=========================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Describe disks measurements for a given host partition. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager 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 - * - hostId - - string - - true - - Process identifier. You can use mongocli ops-manager processes list to get the ID. - * - name - - string - - true - - Partition name. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - # List metrics for the test partition of the process e4ac1e57c58cc9c8aaa5a1163a851993 - mongocli ops-manager metrics disk describe e4ac1e57c58cc9c8aaa5a1163a851993 test --period P1DT12H --granularity PT5 diff --git a/docs/mongocli/command/mongocli-ops-manager-metrics-disks-list.txt b/docs/mongocli/command/mongocli-ops-manager-metrics-disks-list.txt deleted file mode 100644 index 9c19123371..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-metrics-disks-list.txt +++ /dev/null @@ -1,90 +0,0 @@ -.. _mongocli-ops-manager-metrics-disks-list: - -======================================= -mongocli ops-manager metrics disks list -======================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -List available disks for a given host. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager 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 - * - ID - - string - - true - - Process identifier. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-metrics-disks.txt b/docs/mongocli/command/mongocli-ops-manager-metrics-disks.txt deleted file mode 100644 index a471a9aaf1..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-metrics-disks.txt +++ /dev/null @@ -1,61 +0,0 @@ -.. _mongocli-ops-manager-metrics-disks: - -================================== -mongocli ops-manager metrics disks -================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -List available disks or disks measurements 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-ops-manager-metrics-disks-describe` - Describe disks measurements for a given host partition. -* :ref:`mongocli-ops-manager-metrics-disks-list` - List available disks for a given host. - - -.. toctree:: - :titlesonly: - - describe - list - diff --git a/docs/mongocli/command/mongocli-ops-manager-metrics-process.txt b/docs/mongocli/command/mongocli-ops-manager-metrics-process.txt deleted file mode 100644 index 48697bddeb..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-metrics-process.txt +++ /dev/null @@ -1,115 +0,0 @@ -.. _mongocli-ops-manager-metrics-process: - -==================================== -mongocli ops-manager metrics process -==================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Get measurements for a given host. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager metrics process [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - hostId - - string - - true - - Process identifier. You can use mongocli ops-manager processes list to get the ID. - -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 process - * - -o, --output - - string - - false - - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. - * - --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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - # List metrics for the process e4ac1e57c58cc9c8aaa5a1163a851993 - mongocli ops-manager metrics process e4ac1e57c58cc9c8aaa5a1163a851993 --period P1DT12H --granularity PT5 diff --git a/docs/mongocli/command/mongocli-ops-manager-metrics.txt b/docs/mongocli/command/mongocli-ops-manager-metrics.txt deleted file mode 100644 index 9e4620c5bf..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-metrics.txt +++ /dev/null @@ -1,63 +0,0 @@ -.. _mongocli-ops-manager-metrics: - -============================ -mongocli ops-manager metrics -============================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Get measurements on the state of 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-ops-manager-metrics-databases` - List available databases or databases measurements for a given host. -* :ref:`mongocli-ops-manager-metrics-disks` - List available disks or disks measurements for a given host. -* :ref:`mongocli-ops-manager-metrics-process` - Get measurements for a given host. - - -.. toctree:: - :titlesonly: - - databases - disks - process - diff --git a/docs/mongocli/command/mongocli-ops-manager-monitoring-disable.txt b/docs/mongocli/command/mongocli-ops-manager-monitoring-disable.txt deleted file mode 100644 index 1b37280329..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-monitoring-disable.txt +++ /dev/null @@ -1,78 +0,0 @@ -.. _mongocli-ops-manager-monitoring-disable: - -======================================= -mongocli ops-manager monitoring disable -======================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Disable monitoring for a given hostname - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager monitoring disable [options] - -.. 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 for the hostname. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-monitoring-enable.txt b/docs/mongocli/command/mongocli-ops-manager-monitoring-enable.txt deleted file mode 100644 index 805292d12b..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-monitoring-enable.txt +++ /dev/null @@ -1,78 +0,0 @@ -.. _mongocli-ops-manager-monitoring-enable: - -====================================== -mongocli ops-manager monitoring enable -====================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Enable monitoring for a given hostname - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager monitoring enable [options] - -.. 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 for the hostname. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-monitoring-stop.txt b/docs/mongocli/command/mongocli-ops-manager-monitoring-stop.txt deleted file mode 100644 index 22903d9dc4..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-monitoring-stop.txt +++ /dev/null @@ -1,82 +0,0 @@ -.. _mongocli-ops-manager-monitoring-stop: - -==================================== -mongocli ops-manager monitoring stop -==================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Stops monitoring the MongoDB process specified - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager monitoring stop [options] - -.. 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 - - Process identifier. - -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 stop - * - --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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-monitoring.txt b/docs/mongocli/command/mongocli-ops-manager-monitoring.txt deleted file mode 100644 index 3d80f35ead..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-monitoring.txt +++ /dev/null @@ -1,63 +0,0 @@ -.. _mongocli-ops-manager-monitoring: - -=============================== -mongocli ops-manager monitoring -=============================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage monitoring for your project. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for monitoring - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-ops-manager-monitoring-disable` - Disable monitoring for a given hostname -* :ref:`mongocli-ops-manager-monitoring-enable` - Enable monitoring for a given hostname -* :ref:`mongocli-ops-manager-monitoring-stop` - Stops monitoring the MongoDB process specified - - -.. toctree:: - :titlesonly: - - disable - enable - stop - diff --git a/docs/mongocli/command/mongocli-ops-manager-owner-create.txt b/docs/mongocli/command/mongocli-ops-manager-owner-create.txt deleted file mode 100644 index 04f012349d..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-owner-create.txt +++ /dev/null @@ -1,84 +0,0 @@ -.. _mongocli-ops-manager-owner-create: - -================================= -mongocli ops-manager owner create -================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Create the first user for Ops Manager. - -Create the first user for Ops Manager. Use this command to automate Ops Manager Installations. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager owner 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 addresses to add to the new user's access list. - * - --email - - string - - true - - Email address for the user. - * - --firstName - - string - - true - - First or given name for the user. - * - -h, --help - - - - false - - help for create - * - --lastName - - string - - true - - Last name, family name, or surname for the user. - * - -o, --output - - string - - false - - 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 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-owner.txt b/docs/mongocli/command/mongocli-ops-manager-owner.txt deleted file mode 100644 index d4a3778414..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-owner.txt +++ /dev/null @@ -1,59 +0,0 @@ -.. _mongocli-ops-manager-owner: - -========================== -mongocli ops-manager owner -========================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage Ops Manager owners. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for owner - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-ops-manager-owner-create` - Create the first user for Ops Manager. - - -.. toctree:: - :titlesonly: - - create - diff --git a/docs/mongocli/command/mongocli-ops-manager-performanceAdvisor-namespaces-list.txt b/docs/mongocli/command/mongocli-ops-manager-performanceAdvisor-namespaces-list.txt deleted file mode 100644 index 20e219bf16..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-performanceAdvisor-namespaces-list.txt +++ /dev/null @@ -1,95 +0,0 @@ -.. _mongocli-ops-manager-performanceAdvisor-namespaces-list: - -======================================================= -mongocli ops-manager 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 - - mongocli ops-manager 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 - * - --hostId - - string - - false - - Unique identifier for the host of a MongoDB process. - * - -o, --output - - string - - false - - 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 - - false - - Unique identifier for the host of a MongoDB process in the following format: {hostname}:{port}. - * - --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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - # 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: - mongocli atlas performanceAdvisor namespaces list --processName atlas-111ggi-shard-00-00.111xx.mongodb.net:27017 --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/mongocli/command/mongocli-ops-manager-performanceAdvisor-namespaces.txt b/docs/mongocli/command/mongocli-ops-manager-performanceAdvisor-namespaces.txt deleted file mode 100644 index 4069b720dc..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-performanceAdvisor-namespaces.txt +++ /dev/null @@ -1,59 +0,0 @@ -.. _mongocli-ops-manager-performanceAdvisor-namespaces: - -================================================== -mongocli ops-manager 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-ops-manager-performanceAdvisor-namespaces-list` - Return up to 20 namespaces for collections experiencing slow queries on the specified host. - - -.. toctree:: - :titlesonly: - - list - diff --git a/docs/mongocli/command/mongocli-ops-manager-performanceAdvisor-slowOperationThreshold-disable.txt b/docs/mongocli/command/mongocli-ops-manager-performanceAdvisor-slowOperationThreshold-disable.txt deleted file mode 100644 index e0165b221d..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-performanceAdvisor-slowOperationThreshold-disable.txt +++ /dev/null @@ -1,66 +0,0 @@ -.. _mongocli-ops-manager-performanceAdvisor-slowOperationThreshold-disable: - -====================================================================== -mongocli ops-manager 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 - - mongocli ops-manager 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-performanceAdvisor-slowOperationThreshold-enable.txt b/docs/mongocli/command/mongocli-ops-manager-performanceAdvisor-slowOperationThreshold-enable.txt deleted file mode 100644 index 5921be8d2b..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-performanceAdvisor-slowOperationThreshold-enable.txt +++ /dev/null @@ -1,66 +0,0 @@ -.. _mongocli-ops-manager-performanceAdvisor-slowOperationThreshold-enable: - -===================================================================== -mongocli ops-manager 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 - - mongocli ops-manager 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-performanceAdvisor-slowOperationThreshold.txt b/docs/mongocli/command/mongocli-ops-manager-performanceAdvisor-slowOperationThreshold.txt deleted file mode 100644 index b978e010c4..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-performanceAdvisor-slowOperationThreshold.txt +++ /dev/null @@ -1,61 +0,0 @@ -.. _mongocli-ops-manager-performanceAdvisor-slowOperationThreshold: - -============================================================== -mongocli ops-manager 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-ops-manager-performanceAdvisor-slowOperationThreshold-disable` - Disable the application-managed slow operation threshold for your project. -* :ref:`mongocli-ops-manager-performanceAdvisor-slowOperationThreshold-enable` - Enable the application-managed slow operation threshold for your project. - - -.. toctree:: - :titlesonly: - - disable - enable - diff --git a/docs/mongocli/command/mongocli-ops-manager-performanceAdvisor-slowQueryLogs-list.txt b/docs/mongocli/command/mongocli-ops-manager-performanceAdvisor-slowQueryLogs-list.txt deleted file mode 100644 index 9a48c775e4..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-performanceAdvisor-slowQueryLogs-list.txt +++ /dev/null @@ -1,103 +0,0 @@ -.. _mongocli-ops-manager-performanceAdvisor-slowQueryLogs-list: - -========================================================== -mongocli ops-manager 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 - - mongocli ops-manager 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 - * - --hostId - - string - - false - - Unique identifier for the host of a MongoDB process. - * - --nLog - - int - - false - - Maximum number of log lines to return. This value defaults to 20000. - * - --namespaces - - string - - 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 - - false - - Unique identifier for the host of a MongoDB process in the following format: {hostname}:{port}. - * - --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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - # 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: - mongocli atlas performanceAdvisor slowQueryLogs list --processName atlas-111ggi-shard-00-00.111xx.mongodb.net:27017 --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/mongocli/command/mongocli-ops-manager-performanceAdvisor-slowQueryLogs.txt b/docs/mongocli/command/mongocli-ops-manager-performanceAdvisor-slowQueryLogs.txt deleted file mode 100644 index 6846090c6e..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-performanceAdvisor-slowQueryLogs.txt +++ /dev/null @@ -1,59 +0,0 @@ -.. _mongocli-ops-manager-performanceAdvisor-slowQueryLogs: - -===================================================== -mongocli ops-manager 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-ops-manager-performanceAdvisor-slowQueryLogs-list` - Return log lines for slow queries that the Performance Advisor and Query Profiler identified. - - -.. toctree:: - :titlesonly: - - list - diff --git a/docs/mongocli/command/mongocli-ops-manager-performanceAdvisor-suggestedIndexes-list.txt b/docs/mongocli/command/mongocli-ops-manager-performanceAdvisor-suggestedIndexes-list.txt deleted file mode 100644 index ad75d2ab98..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-performanceAdvisor-suggestedIndexes-list.txt +++ /dev/null @@ -1,105 +0,0 @@ -.. _mongocli-ops-manager-performanceAdvisor-suggestedIndexes-list: - -============================================================= -mongocli ops-manager 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 - - mongocli ops-manager 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 - * - --hostId - - string - - false - - Unique identifier for the host of a MongoDB process. - * - --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 - - string - - 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 - - false - - Unique identifier for the host of a MongoDB process in the following format: {hostname}:{port}. - * - --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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - # 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: - mongocli atlas performanceAdvisor suggestedIndexes list --processName atlas-111ggi-shard-00-00.111xx.mongodb.net:27017 --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/docs/mongocli/command/mongocli-ops-manager-performanceAdvisor-suggestedIndexes.txt b/docs/mongocli/command/mongocli-ops-manager-performanceAdvisor-suggestedIndexes.txt deleted file mode 100644 index f0d670b5cf..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-performanceAdvisor-suggestedIndexes.txt +++ /dev/null @@ -1,59 +0,0 @@ -.. _mongocli-ops-manager-performanceAdvisor-suggestedIndexes: - -======================================================== -mongocli ops-manager 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-ops-manager-performanceAdvisor-suggestedIndexes-list` - Return the suggested indexes for collections experiencing slow queries. - - -.. toctree:: - :titlesonly: - - list - diff --git a/docs/mongocli/command/mongocli-ops-manager-performanceAdvisor.txt b/docs/mongocli/command/mongocli-ops-manager-performanceAdvisor.txt deleted file mode 100644 index 453740ecf7..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-performanceAdvisor.txt +++ /dev/null @@ -1,65 +0,0 @@ -.. _mongocli-ops-manager-performanceAdvisor: - -======================================= -mongocli ops-manager 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-ops-manager-performanceAdvisor-namespaces` - Retrieve namespaces for collections experiencing slow queries -* :ref:`mongocli-ops-manager-performanceAdvisor-slowOperationThreshold` - Enable or disable management of the slow operation threshold for your cluster. -* :ref:`mongocli-ops-manager-performanceAdvisor-slowQueryLogs` - Get log lines for slow queries for a specified host -* :ref:`mongocli-ops-manager-performanceAdvisor-suggestedIndexes` - Get suggested indexes for collections experiencing slow queries - - -.. toctree:: - :titlesonly: - - namespaces - slowOperationThreshold - slowQueryLogs - suggestedIndexes - diff --git a/docs/mongocli/command/mongocli-ops-manager-processes-describe.txt b/docs/mongocli/command/mongocli-ops-manager-processes-describe.txt deleted file mode 100644 index ef35d51458..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-processes-describe.txt +++ /dev/null @@ -1,82 +0,0 @@ -.. _mongocli-ops-manager-processes-describe: - -======================================= -mongocli ops-manager processes describe -======================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Describe MongoDB processes for your project. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager 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 - * - hostId - - string - - true - - Process identifier. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-processes-list.txt b/docs/mongocli/command/mongocli-ops-manager-processes-list.txt deleted file mode 100644 index 647c7c021c..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-processes-list.txt +++ /dev/null @@ -1,78 +0,0 @@ -.. _mongocli-ops-manager-processes-list: - -=================================== -mongocli ops-manager processes list -=================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -List MongoDB processes for your project. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager 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 - * - --clusterId - - string - - false - - Unique identifier of the cluster. - * - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-processes.txt b/docs/mongocli/command/mongocli-ops-manager-processes.txt deleted file mode 100644 index d764ba2144..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-processes.txt +++ /dev/null @@ -1,61 +0,0 @@ -.. _mongocli-ops-manager-processes: - -============================== -mongocli ops-manager 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-ops-manager-processes-describe` - Describe MongoDB processes for your project. -* :ref:`mongocli-ops-manager-processes-list` - List MongoDB processes for your project. - - -.. toctree:: - :titlesonly: - - describe - list - diff --git a/docs/mongocli/command/mongocli-ops-manager-security-enable.txt b/docs/mongocli/command/mongocli-ops-manager-security-enable.txt deleted file mode 100644 index b31f0f169b..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-security-enable.txt +++ /dev/null @@ -1,78 +0,0 @@ -.. _mongocli-ops-manager-security-enable: - -==================================== -mongocli ops-manager security enable -==================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Enable authentication mechanisms for your project. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager security enable [options] - -.. Code end marker, please don't delete this comment - -Arguments ---------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - MONGODB-CR|SCRAM-SHA-256 - - string - - true - - Authentication mechanism. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-security.txt b/docs/mongocli/command/mongocli-ops-manager-security.txt deleted file mode 100644 index 8cd87a192d..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-security.txt +++ /dev/null @@ -1,59 +0,0 @@ -.. _mongocli-ops-manager-security: - -============================= -mongocli ops-manager 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-ops-manager-security-enable` - Enable authentication mechanisms for your project. - - -.. toctree:: - :titlesonly: - - enable - diff --git a/docs/mongocli/command/mongocli-ops-manager-serverUsage-capture.txt b/docs/mongocli/command/mongocli-ops-manager-serverUsage-capture.txt deleted file mode 100644 index d9111289a4..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-serverUsage-capture.txt +++ /dev/null @@ -1,58 +0,0 @@ -.. _mongocli-ops-manager-serverUsage-capture: - -======================================== -mongocli ops-manager serverUsage capture -======================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Capture a snapshot of usage for the processes Ops Manager manages. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager serverUsage capture [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 capture - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-serverUsage-download.txt b/docs/mongocli/command/mongocli-ops-manager-serverUsage-download.txt deleted file mode 100644 index 7253a9258c..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-serverUsage-download.txt +++ /dev/null @@ -1,88 +0,0 @@ -.. _mongocli-ops-manager-serverUsage-download: - -========================================= -mongocli ops-manager serverUsage download -========================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Download the server usage report. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager serverUsage download [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 - * - --endDate - - string - - true - - Timestamp, in ISO 8601 date format, when the list of host assignments ends. - * - --force - - - - false - - Flag that indicates whether to overwrite the destination file. - * - --format - - string - - false - - Compression format of the resulting report. Valid values are ZIP, TAR, or .GZ. This value defaults to "tar.gz". - * - -h, --help - - - - false - - help for download - * - --out - - string - - false - - Output file name. This value defaults to the log name. - * - --skipRedaction - - - - false - - Flag that indicates whether to skip the redaction of sensitive values. If you set this flag, Ops Manager logs the original values for hostnames, IP addresses, and namespaces in API responses for this job. - * - --startDate - - string - - true - - Timestamp, in ISO 8601 date format, when the list of host assignments starts. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - mongocli ops-manager serverUsage download --endDate 2022-12-12 --startDate 2022-01-01 diff --git a/docs/mongocli/command/mongocli-ops-manager-serverUsage-organizations-hosts-list.txt b/docs/mongocli/command/mongocli-ops-manager-serverUsage-organizations-hosts-list.txt deleted file mode 100644 index ff008c1c14..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-serverUsage-organizations-hosts-list.txt +++ /dev/null @@ -1,82 +0,0 @@ -.. _mongocli-ops-manager-serverUsage-organizations-hosts-list: - -========================================================= -mongocli ops-manager serverUsage organizations hosts list -========================================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -List all host assignments for one organization. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager serverUsage organizations hosts 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 - * - --endDate - - string - - true - - Timestamp, in ISO 8601 date format, when the list of host assignments ends. - * - -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. - * - --startDate - - string - - true - - Timestamp, in ISO 8601 date format, when the list of host assignments starts. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-serverUsage-organizations-hosts.txt b/docs/mongocli/command/mongocli-ops-manager-serverUsage-organizations-hosts.txt deleted file mode 100644 index 3472cc57f7..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-serverUsage-organizations-hosts.txt +++ /dev/null @@ -1,59 +0,0 @@ -.. _mongocli-ops-manager-serverUsage-organizations-hosts: - -==================================================== -mongocli ops-manager serverUsage organizations hosts -==================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage host assignment for an organization. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for hosts - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-ops-manager-serverUsage-organizations-hosts-list` - List all host assignments for one organization. - - -.. toctree:: - :titlesonly: - - list - diff --git a/docs/mongocli/command/mongocli-ops-manager-serverUsage-organizations-serverType-describe.txt b/docs/mongocli/command/mongocli-ops-manager-serverUsage-organizations-serverType-describe.txt deleted file mode 100644 index 203cfca7e5..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-serverUsage-organizations-serverType-describe.txt +++ /dev/null @@ -1,66 +0,0 @@ -.. _mongocli-ops-manager-serverUsage-organizations-serverType-describe: - -================================================================== -mongocli ops-manager serverUsage organizations serverType describe -================================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Get the default server type for an organization. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager serverUsage organizations serverType 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-serverUsage-organizations-serverType-set.txt b/docs/mongocli/command/mongocli-ops-manager-serverUsage-organizations-serverType-set.txt deleted file mode 100644 index bf52d43f30..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-serverUsage-organizations-serverType-set.txt +++ /dev/null @@ -1,78 +0,0 @@ -.. _mongocli-ops-manager-serverUsage-organizations-serverType-set: - -============================================================= -mongocli ops-manager serverUsage organizations serverType set -============================================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Set the default server type for an organization. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager serverUsage organizations serverType 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 - * - type - - string - - true - - Server type to set. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for set - * - --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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-serverUsage-organizations-serverType.txt b/docs/mongocli/command/mongocli-ops-manager-serverUsage-organizations-serverType.txt deleted file mode 100644 index 9aab5ca063..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-serverUsage-organizations-serverType.txt +++ /dev/null @@ -1,61 +0,0 @@ -.. _mongocli-ops-manager-serverUsage-organizations-serverType: - -========================================================= -mongocli ops-manager serverUsage organizations serverType -========================================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage your server type for an organization. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for serverType - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-ops-manager-serverUsage-organizations-serverType-describe` - Get the default server type for an organization. -* :ref:`mongocli-ops-manager-serverUsage-organizations-serverType-set` - Set the default server type for an organization. - - -.. toctree:: - :titlesonly: - - describe - set - diff --git a/docs/mongocli/command/mongocli-ops-manager-serverUsage-organizations.txt b/docs/mongocli/command/mongocli-ops-manager-serverUsage-organizations.txt deleted file mode 100644 index b49978e566..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-serverUsage-organizations.txt +++ /dev/null @@ -1,61 +0,0 @@ -.. _mongocli-ops-manager-serverUsage-organizations: - -============================================== -mongocli ops-manager serverUsage organizations -============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage your server usage for an organization. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-ops-manager-serverUsage-organizations-hosts` - Manage host assignment for an organization. -* :ref:`mongocli-ops-manager-serverUsage-organizations-serverType` - Manage your server type for an organization. - - -.. toctree:: - :titlesonly: - - hosts - serverType - diff --git a/docs/mongocli/command/mongocli-ops-manager-serverUsage-projects-hosts-list.txt b/docs/mongocli/command/mongocli-ops-manager-serverUsage-projects-hosts-list.txt deleted file mode 100644 index ff9a7adfd8..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-serverUsage-projects-hosts-list.txt +++ /dev/null @@ -1,82 +0,0 @@ -.. _mongocli-ops-manager-serverUsage-projects-hosts-list: - -==================================================== -mongocli ops-manager serverUsage projects hosts list -==================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -List all host assignments for one project. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager serverUsage projects hosts 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 - * - --endDate - - string - - true - - Timestamp, in ISO 8601 date format, when the list of host assignments ends. - * - -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. - * - --startDate - - string - - true - - Timestamp, in ISO 8601 date format, when the list of host assignments starts. - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-serverUsage-projects-hosts.txt b/docs/mongocli/command/mongocli-ops-manager-serverUsage-projects-hosts.txt deleted file mode 100644 index baa86a4589..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-serverUsage-projects-hosts.txt +++ /dev/null @@ -1,59 +0,0 @@ -.. _mongocli-ops-manager-serverUsage-projects-hosts: - -=============================================== -mongocli ops-manager serverUsage projects hosts -=============================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage host assignment for a project. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for hosts - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-ops-manager-serverUsage-projects-hosts-list` - List all host assignments for one project. - - -.. toctree:: - :titlesonly: - - list - diff --git a/docs/mongocli/command/mongocli-ops-manager-serverUsage-projects-serverType-describe.txt b/docs/mongocli/command/mongocli-ops-manager-serverUsage-projects-serverType-describe.txt deleted file mode 100644 index 44cbd0f81b..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-serverUsage-projects-serverType-describe.txt +++ /dev/null @@ -1,66 +0,0 @@ -.. _mongocli-ops-manager-serverUsage-projects-serverType-describe: - -============================================================= -mongocli ops-manager serverUsage projects serverType describe -============================================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Get the default server type for a project. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager serverUsage projects serverType 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-serverUsage-projects-serverType-set.txt b/docs/mongocli/command/mongocli-ops-manager-serverUsage-projects-serverType-set.txt deleted file mode 100644 index 43b43611a6..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-serverUsage-projects-serverType-set.txt +++ /dev/null @@ -1,78 +0,0 @@ -.. _mongocli-ops-manager-serverUsage-projects-serverType-set: - -======================================================== -mongocli ops-manager serverUsage projects serverType set -======================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Set the default server type for a project. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager serverUsage projects serverType 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 - * - type - - string - - true - - Server type to set. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for set - * - --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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-serverUsage-projects-serverType.txt b/docs/mongocli/command/mongocli-ops-manager-serverUsage-projects-serverType.txt deleted file mode 100644 index 56ffe92c57..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-serverUsage-projects-serverType.txt +++ /dev/null @@ -1,61 +0,0 @@ -.. _mongocli-ops-manager-serverUsage-projects-serverType: - -==================================================== -mongocli ops-manager serverUsage projects serverType -==================================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage your server type for a project. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for serverType - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-ops-manager-serverUsage-projects-serverType-describe` - Get the default server type for a project. -* :ref:`mongocli-ops-manager-serverUsage-projects-serverType-set` - Set the default server type for a project. - - -.. toctree:: - :titlesonly: - - describe - set - diff --git a/docs/mongocli/command/mongocli-ops-manager-serverUsage-projects.txt b/docs/mongocli/command/mongocli-ops-manager-serverUsage-projects.txt deleted file mode 100644 index a633b809eb..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-serverUsage-projects.txt +++ /dev/null @@ -1,61 +0,0 @@ -.. _mongocli-ops-manager-serverUsage-projects: - -========================================= -mongocli ops-manager serverUsage projects -========================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage your server usage for a project. - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-ops-manager-serverUsage-projects-hosts` - Manage host assignment for a project. -* :ref:`mongocli-ops-manager-serverUsage-projects-serverType` - Manage your server type for a project. - - -.. toctree:: - :titlesonly: - - hosts - serverType - diff --git a/docs/mongocli/command/mongocli-ops-manager-serverUsage.txt b/docs/mongocli/command/mongocli-ops-manager-serverUsage.txt deleted file mode 100644 index 4a936e9e6c..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-serverUsage.txt +++ /dev/null @@ -1,65 +0,0 @@ -.. _mongocli-ops-manager-serverUsage: - -================================ -mongocli ops-manager serverUsage -================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage your server usage. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for serverUsage - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-ops-manager-serverUsage-capture` - Capture a snapshot of usage for the processes Ops Manager manages. -* :ref:`mongocli-ops-manager-serverUsage-download` - Download the server usage report. -* :ref:`mongocli-ops-manager-serverUsage-organizations` - Manage your server usage for an organization. -* :ref:`mongocli-ops-manager-serverUsage-projects` - Manage your server usage for a project. - - -.. toctree:: - :titlesonly: - - capture - download - organizations - projects - diff --git a/docs/mongocli/command/mongocli-ops-manager-servers-list.txt b/docs/mongocli/command/mongocli-ops-manager-servers-list.txt deleted file mode 100644 index 6ff8369a51..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-servers-list.txt +++ /dev/null @@ -1,74 +0,0 @@ -.. _mongocli-ops-manager-servers-list: - -================================= -mongocli ops-manager servers list -================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -List all available servers running an automation agent for your project. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager servers 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-servers.txt b/docs/mongocli/command/mongocli-ops-manager-servers.txt deleted file mode 100644 index 582f1fae31..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-servers.txt +++ /dev/null @@ -1,59 +0,0 @@ -.. _mongocli-ops-manager-servers: - -============================ -mongocli ops-manager servers -============================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage automated servers for your project. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for servers - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-ops-manager-servers-list` - List all available servers running an automation agent for your project. - - -.. toctree:: - :titlesonly: - - list - diff --git a/docs/mongocli/command/mongocli-ops-manager-softwareComponents-list.txt b/docs/mongocli/command/mongocli-ops-manager-softwareComponents-list.txt deleted file mode 100644 index 8c88e868c8..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-softwareComponents-list.txt +++ /dev/null @@ -1,62 +0,0 @@ -.. _mongocli-ops-manager-softwareComponents-list: - -============================================ -mongocli ops-manager softwareComponents list -============================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -List versions of MongoDB Agent, MongoDB Tools, and BI Connector in your environment. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager softwareComponents 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-softwareComponents.txt b/docs/mongocli/command/mongocli-ops-manager-softwareComponents.txt deleted file mode 100644 index 0d70b802c0..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-softwareComponents.txt +++ /dev/null @@ -1,59 +0,0 @@ -.. _mongocli-ops-manager-softwareComponents: - -======================================= -mongocli ops-manager softwareComponents -======================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage earliest and latest versions of MongoDB Agent, MongoDB Tools, and BI Connector in your environment. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for softwareComponents - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-ops-manager-softwareComponents-list` - List versions of MongoDB Agent, MongoDB Tools, and BI Connector in your environment. - - -.. toctree:: - :titlesonly: - - list - diff --git a/docs/mongocli/command/mongocli-ops-manager-versionManifest-update.txt b/docs/mongocli/command/mongocli-ops-manager-versionManifest-update.txt deleted file mode 100644 index 02c1e987c1..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-versionManifest-update.txt +++ /dev/null @@ -1,82 +0,0 @@ -.. _mongocli-ops-manager-versionManifest-update: - -=========================================== -mongocli ops-manager versionManifest update -=========================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Update Ops Manager version manifest. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - mongocli ops-manager versionManifest 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 - * - version - - string - - true - - Manifest version. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - --force - - - - false - - Flag that indicates whether to skip the Ops Manager version check. - * - -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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - diff --git a/docs/mongocli/command/mongocli-ops-manager-versionManifest.txt b/docs/mongocli/command/mongocli-ops-manager-versionManifest.txt deleted file mode 100644 index 8cf80a5c2d..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager-versionManifest.txt +++ /dev/null @@ -1,59 +0,0 @@ -.. _mongocli-ops-manager-versionManifest: - -==================================== -mongocli ops-manager versionManifest -==================================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage Ops Manager version manifest. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for versionManifest - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-ops-manager-versionManifest-update` - Update Ops Manager version manifest. - - -.. toctree:: - :titlesonly: - - update - diff --git a/docs/mongocli/command/mongocli-ops-manager.txt b/docs/mongocli/command/mongocli-ops-manager.txt deleted file mode 100644 index 8767f3b092..0000000000 --- a/docs/mongocli/command/mongocli-ops-manager.txt +++ /dev/null @@ -1,103 +0,0 @@ -.. _mongocli-ops-manager: - -==================== -mongocli ops-manager -==================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -MongoDB Ops Manager operations. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for ops-manager - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Related Commands ----------------- - -* :ref:`mongocli-ops-manager-admin` - Manage backup administration. -* :ref:`mongocli-ops-manager-agents` - Manage MongoDB Agents. -* :ref:`mongocli-ops-manager-alerts` - Manage alerts for your project. -* :ref:`mongocli-ops-manager-automation` - Manage automation configuration for your project. -* :ref:`mongocli-ops-manager-backups` - Manage continuous backups for your project. -* :ref:`mongocli-ops-manager-clusters` - Manage clusters for your project. -* :ref:`mongocli-ops-manager-dbusers` - Manage database users for your project. -* :ref:`mongocli-ops-manager-diagnoseArchives` - Manage diagnose archives. -* :ref:`mongocli-ops-manager-events` - Manage events for your organization or project. -* :ref:`mongocli-ops-manager-featurePolicies` - Manage feature control policies. -* :ref:`mongocli-ops-manager-liveMigrations` - Manage a Live Migration to Atlas for your organization. -* :ref:`mongocli-ops-manager-logs` - Manage log collection jobs for your project. -* :ref:`mongocli-ops-manager-maintenanceWindows` - Manage Ops Manager/Cloud Manager maintenance windows. -* :ref:`mongocli-ops-manager-metrics` - Get measurements on the state of the MongoDB process. -* :ref:`mongocli-ops-manager-monitoring` - Manage monitoring for your project. -* :ref:`mongocli-ops-manager-owner` - Manage Ops Manager owners. -* :ref:`mongocli-ops-manager-performanceAdvisor` - Learn more about slow queries and get suggestions to improve database performance. -* :ref:`mongocli-ops-manager-processes` - Manage MongoDB processes for your project. -* :ref:`mongocli-ops-manager-security` - Manage security configuration for your project. -* :ref:`mongocli-ops-manager-serverUsage` - Manage your server usage. -* :ref:`mongocli-ops-manager-servers` - Manage automated servers for your project. -* :ref:`mongocli-ops-manager-softwareComponents` - Manage earliest and latest versions of MongoDB Agent, MongoDB Tools, and BI Connector in your environment. -* :ref:`mongocli-ops-manager-versionManifest` - Manage Ops Manager version manifest. - - -.. toctree:: - :titlesonly: - - admin - agents - alerts - automation - backups - clusters - dbusers - diagnoseArchives - events - featurePolicies - liveMigrations - logs - maintenanceWindows - metrics - monitoring - owner - performanceAdvisor - processes - security - serverUsage - servers - softwareComponents - versionManifest - diff --git a/docs/mongocli/command/mongocli.txt b/docs/mongocli/command/mongocli.txt deleted file mode 100644 index 3b28bb3f31..0000000000 --- a/docs/mongocli/command/mongocli.txt +++ /dev/null @@ -1,67 +0,0 @@ -.. _mongocli: - -======== -mongocli -======== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -CLI tool to manage your MongoDB Cloud - -Use mongocli command help for information on a specific command - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for mongocli - * - -P, --profile - - string - - false - - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. - -Examples --------- - -.. code-block:: - - # Display the help menu for the config command: - mongocli config --help - -Related Commands ----------------- - -* :ref:`mongocli-auth` - Manage the CLI's authentication state. -* :ref:`mongocli-cloud-manager` - MongoDB Cloud Manager operations. -* :ref:`mongocli-completion` - Generate the autocompletion script for the specified shell -* :ref:`mongocli-config` - Configure and manage your user profiles. -* :ref:`mongocli-iam` - Organization and projects operations. -* :ref:`mongocli-ops-manager` - MongoDB Ops Manager operations. - - -.. toctree:: - :titlesonly: - - auth - cloud-manager - completion - config - iam - ops-manager - From 1a5ba6b96419d536826a5c5b56164510d344a1c2 Mon Sep 17 00:00:00 2001 From: Filipe C Menezes Date: Fri, 1 Mar 2024 13:14:31 +0000 Subject: [PATCH 04/16] fix evergreen --- RELEASING.md | 6 ------ build/ci/evergreen.yml | 18 +----------------- 2 files changed, 1 insertion(+), 23 deletions(-) diff --git a/RELEASING.md b/RELEASING.md index 1cff03cb63..4b21790c2d 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -67,12 +67,6 @@ We use `go version` to generate the SBOM for Atlas CLI binaries. You can generat go version -m ``` -## MongoCLI Binary -We use `go version` to generate the SBOM for MongoCLI binaries. You can generate the SBOM via the following command: -```bash -go version -m -``` - ## Atlas CLI Docker image We use `docker sbom` to generate the SBOM for the AtlasCLI docker image. You can generate the SBOM via the following command: ```bash diff --git a/build/ci/evergreen.yml b/build/ci/evergreen.yml index 8304d3b73d..c8148e157b 100644 --- a/build/ci/evergreen.yml +++ b/build/ci/evergreen.yml @@ -970,7 +970,7 @@ tasks: patch_optional: true commands: - func: "install gotestsum" - - func: "build mongocli" + - func: "build" - func: "e2e test" vars: MCLI_ORG_ID: ${atlas_org_id} @@ -1355,14 +1355,6 @@ buildvariants: <<: *go_linux_version tasks: - name: ".e2e .backup .atlas" - - name: e2e_cloud_manager_remote - display_name: "E2E Cloud Manager Remote Host Tests" - run_on: - - rhel80-small - expansions: - <<: *go_linux_version - tasks: - - name: ".e2e .clusters .cloudmanager" - name: e2e_cleanup display_name: "E2E Cleanup Resources" run_on: @@ -1372,14 +1364,6 @@ buildvariants: tasks: - name: ".e2e .cleanup" cron: "0 2 * * *" # 2am daily - - name: e2e_ops_manager_60 - display_name: "E2E Ops Manager 6.0 Tests" - run_on: - - rhel80-small - expansions: - <<: *go_linux_version - tasks: - - name: ".ops-manager-60" - name: e2e_atlas_deployments display_name: "E2E Atlas Deployments Tests" run_on: From 666adbdb7d87fa55442f31631d51a29b9657803c Mon Sep 17 00:00:00 2001 From: Filipe C Menezes Date: Fri, 1 Mar 2024 13:21:46 +0000 Subject: [PATCH 05/16] fix makefile --- Makefile | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/Makefile b/Makefile index f959a10ca0..4fbd314301 100644 --- a/Makefile +++ b/Makefile @@ -3,6 +3,8 @@ GOLANGCI_VERSION=v1.56.1 COVERAGE=coverage.out +MCLI_GIT_SHA?=$(shell git rev-parse HEAD) + ATLAS_SOURCE_FILES?=./cmd/atlas ATLAS_BINARY_NAME=atlas ATLAS_VERSION?=$(shell git describe --match "atlascli/v*" | cut -d "v" -f 2) @@ -105,14 +107,17 @@ gen-mocks: ## Generate mocks go generate ./internal... .PHONY: gen-docs +gen-docs: @echo "==> Generating docs" go run -ldflags "$(ATLAS_LINKER_FLAGS)" ./tools/atlasclidocs/main.go .PHONY: build +build: @echo "==> Building $(ATLAS_BINARY_NAME) binary" go build -ldflags "$(ATLAS_LINKER_FLAGS)" -o $(ATLAS_DESTINATION) $(ATLAS_SOURCE_FILES) .PHONY: build-debug +build-debug: @echo "==> Building $(ATLAS_BINARY_NAME) binary for debugging" go build -gcflags="$(DEBUG_FLAGS)" -ldflags "$(ATLAS_LINKER_FLAGS)" -o $(ATLAS_DESTINATION) $(ATLAS_SOURCE_FILES) From 370e7c400ef65ffcf0de88b78b84fe5d5805d8a0 Mon Sep 17 00:00:00 2001 From: Filipe C Menezes Date: Fri, 1 Mar 2024 13:25:44 +0000 Subject: [PATCH 06/16] fix build-all --- Makefile | 2 +- build/ci/evergreen.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/Makefile b/Makefile index 4fbd314301..81c120129d 100644 --- a/Makefile +++ b/Makefile @@ -122,7 +122,7 @@ build-debug: go build -gcflags="$(DEBUG_FLAGS)" -ldflags "$(ATLAS_LINKER_FLAGS)" -o $(ATLAS_DESTINATION) $(ATLAS_SOURCE_FILES) .PHONY: e2e-test -e2e-test: build-all ## Run E2E tests +e2e-test: build ## Run E2E tests @echo "==> Running E2E tests..." # the target assumes the MCLI_* environment variables are exported $(TEST_CMD) -v -p 1 -parallel $(E2E_PARALLEL) -timeout $(E2E_TIMEOUT) -tags="$(E2E_TAGS)" ./test/e2e... $(E2E_EXTRA_ARGS) diff --git a/build/ci/evergreen.yml b/build/ci/evergreen.yml index c8148e157b..0e0ed80956 100644 --- a/build/ci/evergreen.yml +++ b/build/ci/evergreen.yml @@ -52,7 +52,7 @@ functions: type: test params: <<: *go_options - command: make build-all + command: make build "e2e test": - command: subprocess.exec type: test From ca4877b179510dca1959b63572314529833e21d7 Mon Sep 17 00:00:00 2001 From: Filipe C Menezes Date: Fri, 1 Mar 2024 13:56:42 +0000 Subject: [PATCH 07/16] fix iam tests --- test/e2e/cli.go | 13 ------------- test/e2e/config/autocomplete_test.go | 17 ----------------- test/e2e/config/config_test.go | 2 +- test/e2e/helper.go | 7 ++----- test/e2e/iam/atlas_project_invitations_test.go | 8 +------- test/e2e/iam/helper_test.go | 17 ++++++----------- test/e2e/iam/org_api_key_access_list_test.go | 9 ++++----- test/e2e/iam/org_api_keys_test.go | 9 +++------ test/e2e/iam/org_invitations_test.go | 8 +------- test/e2e/iam/orgs_test.go | 5 +---- test/e2e/iam/project_api_keys_test.go | 8 +++----- test/e2e/iam/project_invitations_test.go | 8 +------- test/e2e/iam/project_teams_test.go | 6 +----- test/e2e/iam/projects_test.go | 7 +------ test/e2e/iam/team_users_test.go | 5 +---- test/e2e/iam/teams_test.go | 7 +------ 16 files changed, 27 insertions(+), 109 deletions(-) diff --git a/test/e2e/cli.go b/test/e2e/cli.go index cfbf5ed01a..b1bdd2871e 100644 --- a/test/e2e/cli.go +++ b/test/e2e/cli.go @@ -22,19 +22,6 @@ import ( "path/filepath" ) -func Bin() (string, error) { - path := os.Getenv("MCLI_E2E_BINARY") - cliPath, err := filepath.Abs(path) - if err != nil { - return "", fmt.Errorf("%w: invalid bin path %q", err, path) - } - - if _, err := os.Stat(cliPath); err != nil { - return "", fmt.Errorf("%w: invalid bin %q", err, path) - } - return cliPath, nil -} - func AtlasCLIBin() (string, error) { path := os.Getenv("ATLAS_E2E_BINARY") cliPath, err := filepath.Abs(path) diff --git a/test/e2e/config/autocomplete_test.go b/test/e2e/config/autocomplete_test.go index 7338690aa8..643e3bece9 100644 --- a/test/e2e/config/autocomplete_test.go +++ b/test/e2e/config/autocomplete_test.go @@ -25,23 +25,6 @@ import ( const completionEntity = "completion" -func TestAutocomplete(t *testing.T) { - cliPath, err := e2e.Bin() - if err != nil { - t.Fatalf("unexpected error: %v", err) - } - options := []string{"zsh", "bash", "fish", "powershell"} - for _, option := range options { - t.Run(option, func(t *testing.T) { - cmd := exec.Command(cliPath, completionEntity, option) - cmd.Env = os.Environ() - if resp, err := cmd.CombinedOutput(); err != nil { - t.Fatalf("unexpected error: %v, resp: %v", err, string(resp)) - } - }) - } -} - func TestAtlasCLIAutocomplete(t *testing.T) { cliPath, err := e2e.AtlasCLIBin() if err != nil { diff --git a/test/e2e/config/config_test.go b/test/e2e/config/config_test.go index d9de7a0152..aad310d5a2 100644 --- a/test/e2e/config/config_test.go +++ b/test/e2e/config/config_test.go @@ -35,7 +35,7 @@ const ( ) func TestConfig(t *testing.T) { - cliPath, err := e2e.Bin() + cliPath, err := e2e.AtlasCLIBin() if err != nil { t.Fatalf("unexpected error: %v", err) } diff --git a/test/e2e/helper.go b/test/e2e/helper.go index b040a1addd..9510f0c16c 100644 --- a/test/e2e/helper.go +++ b/test/e2e/helper.go @@ -26,17 +26,15 @@ import ( ) const ( - iamEntity = "iam" projectsEntity = "projects" ) func CreateProject(projectName string) (string, error) { - cliPath, err := Bin() + cliPath, err := AtlasCLIBin() if err != nil { return "", err } cmd := exec.Command(cliPath, - iamEntity, projectsEntity, "create", projectName, @@ -56,12 +54,11 @@ func CreateProject(projectName string) (string, error) { } func deleteProject(projectID string) error { - cliPath, err := Bin() + cliPath, err := AtlasCLIBin() if err != nil { return err } cmd := exec.Command(cliPath, - iamEntity, projectsEntity, "delete", projectID, diff --git a/test/e2e/iam/atlas_project_invitations_test.go b/test/e2e/iam/atlas_project_invitations_test.go index 4125dfa1db..f61ce240a8 100644 --- a/test/e2e/iam/atlas_project_invitations_test.go +++ b/test/e2e/iam/atlas_project_invitations_test.go @@ -29,7 +29,7 @@ import ( ) func TestAtlasProjectInvitations(t *testing.T) { - cliPath, err := e2e.Bin() + cliPath, err := e2e.AtlasCLIBin() require.NoError(t, err) var invitationID string @@ -48,7 +48,6 @@ func TestAtlasProjectInvitations(t *testing.T) { t.Run("Invite", func(t *testing.T) { cmd := exec.Command(cliPath, - iamEntity, projectsEntity, invitationsEntity, "invite", @@ -72,7 +71,6 @@ func TestAtlasProjectInvitations(t *testing.T) { t.Run("List", func(t *testing.T) { cmd := exec.Command(cliPath, - iamEntity, projectsEntity, invitationsEntity, "ls", @@ -91,7 +89,6 @@ func TestAtlasProjectInvitations(t *testing.T) { t.Run("Describe", func(t *testing.T) { cmd := exec.Command(cliPath, - iamEntity, projectsEntity, invitationsEntity, "get", @@ -112,7 +109,6 @@ func TestAtlasProjectInvitations(t *testing.T) { t.Run("Update by email", func(t *testing.T) { cmd := exec.Command(cliPath, - iamEntity, projectsEntity, invitationsEntity, "update", @@ -138,7 +134,6 @@ func TestAtlasProjectInvitations(t *testing.T) { t.Run("Update by ID", func(t *testing.T) { cmd := exec.Command(cliPath, - iamEntity, projectsEntity, invitationsEntity, "update", @@ -163,7 +158,6 @@ func TestAtlasProjectInvitations(t *testing.T) { t.Run("Delete", func(t *testing.T) { cmd := exec.Command(cliPath, - iamEntity, projectsEntity, invitationsEntity, "delete", diff --git a/test/e2e/iam/helper_test.go b/test/e2e/iam/helper_test.go index 90002d7ae5..6e0586674b 100644 --- a/test/e2e/iam/helper_test.go +++ b/test/e2e/iam/helper_test.go @@ -28,7 +28,6 @@ import ( ) const ( - iamEntity = "iam" orgEntity = "orgs" apiKeysEntity = "apikeys" apiKeyAccessListEntity = "accessLists" @@ -47,12 +46,12 @@ const ( var errNoAPIKey = errors.New("the apiKey ID is empty") func createOrgAPIKey() (string, error) { - cliPath, err := e2e.Bin() + cliPath, err := e2e.AtlasCLIBin() if err != nil { return "", err } - cmd := exec.Command(cliPath, iamEntity, + cmd := exec.Command(cliPath, orgEntity, apiKeysEntity, "create", @@ -79,12 +78,11 @@ func createOrgAPIKey() (string, error) { } func deleteOrgAPIKey(id string) error { - cliPath, err := e2e.Bin() + cliPath, err := e2e.AtlasCLIBin() if err != nil { return err } cmd := exec.Command(cliPath, - iamEntity, orgEntity, apiKeysEntity, "rm", @@ -95,7 +93,7 @@ func deleteOrgAPIKey(id string) error { } func createTeam(teamName string) (string, error) { - cliPath, err := e2e.Bin() + cliPath, err := e2e.AtlasCLIBin() if err != nil { return "", err } @@ -105,7 +103,6 @@ func createTeam(teamName string) (string, error) { return "", err } cmd := exec.Command(cliPath, - iamEntity, teamsEntity, "create", teamName, @@ -127,12 +124,11 @@ func createTeam(teamName string) (string, error) { } func deleteTeam(teamID string) error { - cliPath, err := e2e.Bin() + cliPath, err := e2e.AtlasCLIBin() if err != nil { return err } cmd := exec.Command(cliPath, - iamEntity, teamsEntity, "delete", teamID, @@ -147,12 +143,11 @@ var errInvalidIndex = errors.New("invalid index") // We need to pass the userIndex because the command iam teams users add would not work // if the user is already in the team. func OrgNUser(n int) (username, userID string, err error) { - cliPath, err := e2e.Bin() + cliPath, err := e2e.AtlasCLIBin() if err != nil { return "", "", err } cmd := exec.Command(cliPath, - iamEntity, orgEntity, usersEntity, "list", diff --git a/test/e2e/iam/org_api_key_access_list_test.go b/test/e2e/iam/org_api_key_access_list_test.go index 41e670d69e..07e997f705 100644 --- a/test/e2e/iam/org_api_key_access_list_test.go +++ b/test/e2e/iam/org_api_key_access_list_test.go @@ -30,7 +30,7 @@ import ( ) func TestOrgAPIKeyAccessList(t *testing.T) { - cliPath, er := e2e.Bin() + cliPath, er := e2e.AtlasCLIBin() require.NoError(t, er) apiKeyID, e := createOrgAPIKey() @@ -45,7 +45,7 @@ func TestOrgAPIKeyAccessList(t *testing.T) { entry := fmt.Sprintf("192.168.0.%d", n) t.Run("Create", func(t *testing.T) { - cmd := exec.Command(cliPath, iamEntity, + cmd := exec.Command(cliPath, orgEntity, apiKeysEntity, apiKeyAccessListEntity, @@ -64,7 +64,7 @@ func TestOrgAPIKeyAccessList(t *testing.T) { }) t.Run("List", func(t *testing.T) { - cmd := exec.Command(cliPath, iamEntity, + cmd := exec.Command(cliPath, orgEntity, apiKeysEntity, apiKeyAccessListEntity, @@ -85,7 +85,7 @@ func TestOrgAPIKeyAccessList(t *testing.T) { t.Run("Create Current IP", func(t *testing.T) { t.Skip("400 (request \"CANNOT_REMOVE_CALLER_FROM_ACCESS_LIST\") Cannot remove caller's IP address from access list") - cmd := exec.Command(cliPath, iamEntity, + cmd := exec.Command(cliPath, orgEntity, apiKeysEntity, apiKeyAccessListEntity, @@ -113,7 +113,6 @@ func TestOrgAPIKeyAccessList(t *testing.T) { func deleteAccessListEntry(t *testing.T, cliPath, entry, apiKeyID string) { t.Helper() cmd := exec.Command(cliPath, - iamEntity, orgEntity, apiKeysEntity, apiKeyAccessListEntity, diff --git a/test/e2e/iam/org_api_keys_test.go b/test/e2e/iam/org_api_keys_test.go index 0b7b083c49..8b8a588212 100644 --- a/test/e2e/iam/org_api_keys_test.go +++ b/test/e2e/iam/org_api_keys_test.go @@ -29,7 +29,7 @@ import ( ) func TestOrgAPIKeys(t *testing.T) { - cliPath, err := e2e.Bin() + cliPath, err := e2e.AtlasCLIBin() if err != nil { t.Fatalf("unexpected error: %v", err) } @@ -39,7 +39,7 @@ func TestOrgAPIKeys(t *testing.T) { // This test must run first to grab the ID of the org to later describe t.Run("Create", func(t *testing.T) { desc := "e2e-test-org" - cmd := exec.Command(cliPath, iamEntity, + cmd := exec.Command(cliPath, orgEntity, apiKeysEntity, "create", @@ -62,7 +62,6 @@ func TestOrgAPIKeys(t *testing.T) { t.Run("List", func(t *testing.T) { cmd := exec.Command(cliPath, - iamEntity, orgEntity, apiKeysEntity, "ls", @@ -82,7 +81,7 @@ func TestOrgAPIKeys(t *testing.T) { t.Run("Update", func(t *testing.T) { newDesc := "e2e-test-org-updated" - cmd := exec.Command(cliPath, iamEntity, + cmd := exec.Command(cliPath, orgEntity, apiKeysEntity, "updates", @@ -102,7 +101,6 @@ func TestOrgAPIKeys(t *testing.T) { t.Run("Describe", func(t *testing.T) { cmd := exec.Command(cliPath, - iamEntity, orgEntity, apiKeysEntity, "describe", @@ -120,7 +118,6 @@ func TestOrgAPIKeys(t *testing.T) { t.Run("Delete", func(t *testing.T) { cmd := exec.Command(cliPath, - iamEntity, orgEntity, apiKeysEntity, "rm", diff --git a/test/e2e/iam/org_invitations_test.go b/test/e2e/iam/org_invitations_test.go index 237ed26284..5d449d9e5e 100644 --- a/test/e2e/iam/org_invitations_test.go +++ b/test/e2e/iam/org_invitations_test.go @@ -29,7 +29,7 @@ import ( ) func TestOrgInvitations(t *testing.T) { - cliPath, err := e2e.Bin() + cliPath, err := e2e.AtlasCLIBin() if err != nil { t.Fatalf("unexpected error: %v", err) } @@ -42,7 +42,6 @@ func TestOrgInvitations(t *testing.T) { t.Run("Invite", func(t *testing.T) { cmd := exec.Command(cliPath, - iamEntity, orgEntity, invitationsEntity, "invite", @@ -64,7 +63,6 @@ func TestOrgInvitations(t *testing.T) { t.Run("List", func(t *testing.T) { cmd := exec.Command(cliPath, - iamEntity, orgEntity, invitationsEntity, "ls", @@ -82,7 +80,6 @@ func TestOrgInvitations(t *testing.T) { t.Run("Describe", func(t *testing.T) { cmd := exec.Command(cliPath, - iamEntity, orgEntity, invitationsEntity, "get", @@ -101,7 +98,6 @@ func TestOrgInvitations(t *testing.T) { t.Run("Update by email", func(t *testing.T) { cmd := exec.Command(cliPath, - iamEntity, orgEntity, invitationsEntity, "update", @@ -124,7 +120,6 @@ func TestOrgInvitations(t *testing.T) { t.Run("Update by ID", func(t *testing.T) { cmd := exec.Command(cliPath, - iamEntity, orgEntity, invitationsEntity, "update", @@ -145,7 +140,6 @@ func TestOrgInvitations(t *testing.T) { t.Run("Delete", func(t *testing.T) { cmd := exec.Command(cliPath, - iamEntity, orgEntity, invitationsEntity, "delete", diff --git a/test/e2e/iam/orgs_test.go b/test/e2e/iam/orgs_test.go index 6ce612d389..24144083e4 100644 --- a/test/e2e/iam/orgs_test.go +++ b/test/e2e/iam/orgs_test.go @@ -29,7 +29,7 @@ import ( ) func TestOrgs(t *testing.T) { - cliPath, err := e2e.Bin() + cliPath, err := e2e.AtlasCLIBin() require.NoError(t, err) var orgID string @@ -37,7 +37,6 @@ func TestOrgs(t *testing.T) { // This test must run first to grab the ID of the org to later describe t.Run("List", func(t *testing.T) { cmd := exec.Command(cliPath, - iamEntity, orgEntity, "ls", "-o=json") @@ -55,7 +54,6 @@ func TestOrgs(t *testing.T) { t.Run("Describe", func(t *testing.T) { cmd := exec.Command(cliPath, - iamEntity, orgEntity, "describe", orgID, @@ -67,7 +65,6 @@ func TestOrgs(t *testing.T) { t.Run("List Org Users", func(t *testing.T) { cmd := exec.Command(cliPath, - iamEntity, orgEntity, usersEntity, "ls", diff --git a/test/e2e/iam/project_api_keys_test.go b/test/e2e/iam/project_api_keys_test.go index 876a196ffa..dd784383e6 100644 --- a/test/e2e/iam/project_api_keys_test.go +++ b/test/e2e/iam/project_api_keys_test.go @@ -30,7 +30,7 @@ import ( ) func TestProjectAPIKeys(t *testing.T) { - cliPath, err := e2e.Bin() + cliPath, err := e2e.AtlasCLIBin() require.NoError(t, err) var ID string @@ -38,7 +38,7 @@ func TestProjectAPIKeys(t *testing.T) { // This test must run first to grab the ID of the project to later describe t.Run("Create", func(t *testing.T) { const desc = "e2e-test" - cmd := exec.Command(cliPath, iamEntity, + cmd := exec.Command(cliPath, projectsEntity, apiKeysEntity, "create", @@ -67,7 +67,7 @@ func TestProjectAPIKeys(t *testing.T) { }() t.Run("Assign", func(t *testing.T) { - cmd := exec.Command(cliPath, iamEntity, + cmd := exec.Command(cliPath, projectsEntity, apiKeysEntity, "assign", @@ -81,7 +81,6 @@ func TestProjectAPIKeys(t *testing.T) { t.Run("List", func(t *testing.T) { cmd := exec.Command(cliPath, - iamEntity, projectsEntity, apiKeysEntity, "ls", @@ -96,7 +95,6 @@ func TestProjectAPIKeys(t *testing.T) { t.Run("Delete", func(t *testing.T) { cmd := exec.Command(cliPath, - iamEntity, projectsEntity, apiKeysEntity, "rm", diff --git a/test/e2e/iam/project_invitations_test.go b/test/e2e/iam/project_invitations_test.go index 6ab56e8e83..c0e383e954 100644 --- a/test/e2e/iam/project_invitations_test.go +++ b/test/e2e/iam/project_invitations_test.go @@ -29,7 +29,7 @@ import ( ) func TestProjectInvitations(t *testing.T) { - cliPath, err := e2e.Bin() + cliPath, err := e2e.AtlasCLIBin() require.NoError(t, err) var invitationID string @@ -48,7 +48,6 @@ func TestProjectInvitations(t *testing.T) { t.Run("Invite", func(t *testing.T) { cmd := exec.Command(cliPath, - iamEntity, projectsEntity, invitationsEntity, "invite", @@ -72,7 +71,6 @@ func TestProjectInvitations(t *testing.T) { t.Run("List", func(t *testing.T) { cmd := exec.Command(cliPath, - iamEntity, projectsEntity, invitationsEntity, "ls", @@ -91,7 +89,6 @@ func TestProjectInvitations(t *testing.T) { t.Run("Describe", func(t *testing.T) { cmd := exec.Command(cliPath, - iamEntity, projectsEntity, invitationsEntity, "get", @@ -111,7 +108,6 @@ func TestProjectInvitations(t *testing.T) { t.Run("Update by email", func(t *testing.T) { cmd := exec.Command(cliPath, - iamEntity, projectsEntity, invitationsEntity, "update", @@ -137,7 +133,6 @@ func TestProjectInvitations(t *testing.T) { t.Run("Update by ID", func(t *testing.T) { cmd := exec.Command(cliPath, - iamEntity, projectsEntity, invitationsEntity, "update", @@ -162,7 +157,6 @@ func TestProjectInvitations(t *testing.T) { t.Run("Delete", func(t *testing.T) { cmd := exec.Command(cliPath, - iamEntity, projectsEntity, invitationsEntity, "delete", diff --git a/test/e2e/iam/project_teams_test.go b/test/e2e/iam/project_teams_test.go index 2a0e0598e7..c29a7f28cf 100644 --- a/test/e2e/iam/project_teams_test.go +++ b/test/e2e/iam/project_teams_test.go @@ -30,7 +30,7 @@ import ( ) func TestProjectTeams(t *testing.T) { - cliPath, err := e2e.Bin() + cliPath, err := e2e.AtlasCLIBin() require.NoError(t, err) n, err := e2e.RandInt(1000) @@ -53,7 +53,6 @@ func TestProjectTeams(t *testing.T) { t.Run("Add", func(t *testing.T) { cmd := exec.Command(cliPath, - iamEntity, projectsEntity, teamsEntity, "add", @@ -84,7 +83,6 @@ func TestProjectTeams(t *testing.T) { roleName1 := "GROUP_READ_ONLY" roleName2 := "GROUP_DATA_ACCESS_READ_ONLY" cmd := exec.Command(cliPath, - iamEntity, projectsEntity, teamsEntity, "update", @@ -113,7 +111,6 @@ func TestProjectTeams(t *testing.T) { t.Run("List", func(t *testing.T) { cmd := exec.Command(cliPath, - iamEntity, projectsEntity, teamsEntity, "ls", @@ -132,7 +129,6 @@ func TestProjectTeams(t *testing.T) { t.Run("Delete", func(t *testing.T) { cmd := exec.Command(cliPath, - iamEntity, projectsEntity, teamsEntity, "delete", diff --git a/test/e2e/iam/projects_test.go b/test/e2e/iam/projects_test.go index 70106a3a22..fe5542fb0a 100644 --- a/test/e2e/iam/projects_test.go +++ b/test/e2e/iam/projects_test.go @@ -29,7 +29,7 @@ import ( ) func TestProjects(t *testing.T) { - cliPath, err := e2e.Bin() + cliPath, err := e2e.AtlasCLIBin() if err != nil { t.Fatalf("unexpected error: %v", err) } @@ -44,7 +44,6 @@ func TestProjects(t *testing.T) { t.Run("Create", func(t *testing.T) { // This depends on a ORG_ID ENV cmd := exec.Command(cliPath, - iamEntity, projectsEntity, "create", projectName, @@ -67,7 +66,6 @@ func TestProjects(t *testing.T) { t.Run("List", func(t *testing.T) { cmd := exec.Command(cliPath, - iamEntity, projectsEntity, "ls", "-o=json") @@ -79,7 +77,6 @@ func TestProjects(t *testing.T) { t.Run("Describe", func(t *testing.T) { cmd := exec.Command(cliPath, - iamEntity, projectsEntity, "describe", projectID, @@ -92,7 +89,6 @@ func TestProjects(t *testing.T) { t.Run("Users", func(t *testing.T) { cmd := exec.Command(cliPath, - iamEntity, projectsEntity, usersEntity, "ls", @@ -106,7 +102,6 @@ func TestProjects(t *testing.T) { t.Run("Delete", func(t *testing.T) { cmd := exec.Command(cliPath, - iamEntity, projectsEntity, "delete", projectID, diff --git a/test/e2e/iam/team_users_test.go b/test/e2e/iam/team_users_test.go index f25f143244..2596fdd9c0 100644 --- a/test/e2e/iam/team_users_test.go +++ b/test/e2e/iam/team_users_test.go @@ -30,7 +30,7 @@ import ( ) func TestTeamUsers(t *testing.T) { - cliPath, err := e2e.Bin() + cliPath, err := e2e.AtlasCLIBin() require.NoError(t, err) n, err := e2e.RandInt(1000) @@ -50,7 +50,6 @@ func TestTeamUsers(t *testing.T) { t.Run("Add", func(t *testing.T) { cmd := exec.Command(cliPath, - iamEntity, teamsEntity, usersEntity, "add", @@ -78,7 +77,6 @@ func TestTeamUsers(t *testing.T) { t.Run("List", func(t *testing.T) { cmd := exec.Command(cliPath, - iamEntity, teamsEntity, usersEntity, "ls", @@ -96,7 +94,6 @@ func TestTeamUsers(t *testing.T) { t.Run("Delete", func(t *testing.T) { cmd := exec.Command(cliPath, - iamEntity, teamsEntity, usersEntity, "delete", diff --git a/test/e2e/iam/teams_test.go b/test/e2e/iam/teams_test.go index 7e5d01f4c6..40a0a0271b 100644 --- a/test/e2e/iam/teams_test.go +++ b/test/e2e/iam/teams_test.go @@ -30,7 +30,7 @@ import ( ) func TestTeams(t *testing.T) { - cliPath, err := e2e.Bin() + cliPath, err := e2e.AtlasCLIBin() require.NoError(t, err) n, err := e2e.RandInt(1000) @@ -44,7 +44,6 @@ func TestTeams(t *testing.T) { require.NoError(t, err) cmd := exec.Command(cliPath, - iamEntity, teamsEntity, "create", teamName, @@ -66,7 +65,6 @@ func TestTeams(t *testing.T) { t.Run("Describe By ID", func(t *testing.T) { cmd := exec.Command(cliPath, - iamEntity, teamsEntity, "describe", "--id", @@ -85,7 +83,6 @@ func TestTeams(t *testing.T) { t.Run("Describe By Name", func(t *testing.T) { cmd := exec.Command(cliPath, - iamEntity, teamsEntity, "describe", "--name", @@ -104,7 +101,6 @@ func TestTeams(t *testing.T) { t.Run("List", func(t *testing.T) { cmd := exec.Command(cliPath, - iamEntity, teamsEntity, "ls", "-o=json") @@ -121,7 +117,6 @@ func TestTeams(t *testing.T) { t.Run("Delete", func(t *testing.T) { cmd := exec.Command(cliPath, - iamEntity, teamsEntity, "delete", teamID, From e19c471c9f9bcf5e32ee6341d53f670912250ac1 Mon Sep 17 00:00:00 2001 From: Filipe C Menezes Date: Fri, 1 Mar 2024 14:02:35 +0000 Subject: [PATCH 08/16] delete more files --- build/ci/clean-up-cloud-manager.sh | 48 -- build/ci/ego | 501 --------------------- build/ci/evergreen.yml | 105 ----- build/ci/install-agent-spawn-host.sh | 72 --- build/ci/install-ops-manager-spawn-host.sh | 70 --- build/ci/kmip/install.sh | 67 --- build/ci/kmip/kmip.db | Bin 81920 -> 0 bytes build/ci/kmip/start.py | 293 ------------ build/ci/set-up-cloud-manager.sh | 61 --- build/ci/set-up-ops-manager.sh | 100 ---- build/ci/ssh-ready.sh | 65 --- build/package/.mongocli.goreleaser.yml | 120 ----- build/package/generate-notices.sh | 2 +- build/package/mongocli_mac_notarize.sh | 35 -- 14 files changed, 1 insertion(+), 1538 deletions(-) delete mode 100755 build/ci/clean-up-cloud-manager.sh delete mode 100755 build/ci/ego delete mode 100755 build/ci/install-agent-spawn-host.sh delete mode 100755 build/ci/install-ops-manager-spawn-host.sh delete mode 100755 build/ci/kmip/install.sh delete mode 100644 build/ci/kmip/kmip.db delete mode 100644 build/ci/kmip/start.py delete mode 100755 build/ci/set-up-cloud-manager.sh delete mode 100755 build/ci/set-up-ops-manager.sh delete mode 100755 build/ci/ssh-ready.sh delete mode 100644 build/package/.mongocli.goreleaser.yml delete mode 100755 build/package/mongocli_mac_notarize.sh diff --git a/build/ci/clean-up-cloud-manager.sh b/build/ci/clean-up-cloud-manager.sh deleted file mode 100755 index 80b3258fa7..0000000000 --- a/build/ci/clean-up-cloud-manager.sh +++ /dev/null @@ -1,48 +0,0 @@ -#!/bin/bash - -# Copyright 2021 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. - -set -euo pipefail - -# shellcheck disable=SC1091 -if [[ -f project.sh ]]; then - source project.sh -fi - -if [[ "${MUST_CLEANUP_CM-}" != "true" ]]; then - echo "skipping cloud manager clean up post task" - exit 0 -fi - -if [[ -z "${MCLI_PROJECT_ID-}" ]]; then - echo "MCLI_PROJECT_ID not set" - exit 1 -fi - -delete_project() { - mongocli iam projects delete "${MCLI_PROJECT_ID-}" --force -} - -for _ in {1..10}; do - echo "attempting to delete cloud manager project ${MCLI_PROJECT_ID-}" - if [[ $(delete_project) ]]; then - echo "cloud manager project ${MCLI_PROJECT_ID-} was deleted successfully" - exit 0 - fi - sleep 30 -done - -echo "cloud manager project ${MCLI_PROJECT_ID-} was unable to be deleted" -exit 1 diff --git a/build/ci/ego b/build/ci/ego deleted file mode 100755 index 9a54e2c8c9..0000000000 --- a/build/ci/ego +++ /dev/null @@ -1,501 +0,0 @@ -#!/bin/bash - -# Copyright 2020 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. - -set -o nounset -set -o errexit - -DIR= -DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" -readonly DIR -SCRIPT= -SCRIPT=$(basename "${BASH_SOURCE[0]}") -readonly SCRIPT - -declare -a ssh_opts -ssh_opts[0]="-o" -ssh_opts[1]="UserKnownHostsFile=/dev/null" -ssh_opts[2]="-o" -ssh_opts[3]="StrictHostKeyChecking=no" -ssh_opts[4]="-q" -ssh_opts[5]="-o" -ssh_opts[6]="ConnectTimeout=30" -ssh_opts[7]="-o" -ssh_opts[8]="TCPKeepAlive=yes" -ssh_opts[9]="-o" -ssh_opts[10]="ServerAliveInterval=15" -ssh_opts[11]="-o" -ssh_opts[12]="ServerAliveCountMax=20" -#ssh_opts[13]="-vvv" # DEBUG mode -readonly ssh_opts -readonly timeout_duration="25m" - -# Commands -LSB_RELEASE="$(command -v lsb_release || echo "lsb_release")" -SCP="$(command -v scp || echo "scp")" -SSH="$(command -v ssh || echo "ssh")" -UNAME="$(command -v uname || echo "uname")" - - -_fix_term() { - # Set a TERM env var - if [[ -z "${TERM+x}" ]]; then - export TERM=xterm - fi - - # Do not allow Debian distros to have an interactive term - if [[ "${PLATFORM}" = "debian" || "${PLATFORM}" = "ubuntu" ]]; then - export DEBIAN_FRONTEND="noninteractive" - fi -} - -# ####################################################### -# SYSTEM DEPENDENCIES -# ####################################################### -readonly E_UNSUPPORTED_DISTRO=145 -_unsupported_distro() { - echo "Unsupported distro..." - if "$UNAME" > /dev/null 2>&1; then - echo - echo "uname:" - uname -a - fi - if "$LSB_RELEASE" > /dev/null 2>&1; then - echo - echo "lsb_release:" - "$LSB_RELEASE" -a - fi - if [[ -f /etc/SuSe-release ]]; then - echo - echo "/etc/SuSe-release:" - cat /etc/SuSE-release - fi - if [[ -f /etc/os-release ]]; then - echo - echo "/etc/os-release:" - cat /etc/os-release - fi - exit ${E_UNSUPPORTED_DISTRO} -} -system_info() { - echo - echo "System information" - echo "---------------------" - echo "Platform: ${PLATFORM}" - if [[ "${OSVER}" != -1 ]]; then - echo "OS version: ${OSVER}" - fi - echo "---------------------" - echo -} -# Determine architecture and version -_determine_architecture() { - PLATFORM="" - OSVER=-1 - if [[ -n ${OS+x} && "Windows_NT" = "${OS}" ]]; then - PLATFORM="windows" - - elif uname -a | grep -q Debian > /dev/null 2>&1; then # Debian - PLATFORM="debian" - if grep -qE '^10' /etc/debian_version; then - OSVER=10 - - elif grep -qE '^9' /etc/debian_version; then - OSVER=9 - - elif grep -qE '^8' /etc/debian_version; then - OSVER=8 - - else - _unsupported_distro - fi - - elif uname -a | grep -q Ubuntu > /dev/null 2>&1; then # Ubuntu - PLATFORM="ubuntu" - - if "$LSB_RELEASE" -a 2>&1 | grep 20.04 > /dev/null 2>&1; then - OSVER=20 - - elif "$LSB_RELEASE" -a 2>&1 | grep 19.04 > /dev/null 2>&1; then - OSVER=19 - - elif "$LSB_RELEASE" -a 2>&1 | grep 18.04 > /dev/null 2>&1; then - OSVER=18 - - else - _unsupported_distro - fi - - elif uname -a | grep -q Darwin; then # Darwin/MacOS - PLATFORM="macos" - - elif "$LSB_RELEASE" -a 2>&1 | grep -qE "^Description:\\s+Red Hat.+ 8" > /dev/null; then # Red Hat 8 - PLATFORM="rhel" - OSVER="8" - - elif "$LSB_RELEASE" -a 2>&1 | grep -qE "^Description:\\s+Red Hat.+ 7" > /dev/null; then # Red Hat 7 - PLATFORM="rhel" - OSVER="7" - - elif [[ -f /etc/os-release ]] && grep PRETTY /etc/os-release | grep -qE 'Red Hat.+ 8' > /dev/null; then # Red Hat 8 - PLATFORM="rhel" - OSVER="8" - - elif [[ -f /etc/os-release ]] && grep PRETTY /etc/os-release | grep -qE 'Red Hat.+ 7' > /dev/null; then # Red Hat 7 - PLATFORM="rhel" - OSVER="7" - - elif [[ -f /etc/system-release ]] && grep -qE 'Red Hat.+ 8' /etc/system-release > /dev/null; then # Red Hat 8 - PLATFORM="rhel" - OSVER="8" - - elif [[ -f /etc/system-release ]] && grep -qE 'Red Hat.+ 7' /etc/system-release > /dev/null; then # Red Hat 7 - PLATFORM="rhel" - OSVER="7" - - elif "$LSB_RELEASE" -a 2>&1 | grep -qE "^Description:\\s+Red Hat.+ 6" > /dev/null; then - PLATFORM="rhel" - OSVER="6" - - elif [[ -f /etc/os-release ]] && grep PRETTY /etc/os-release | grep -qE 'Red Hat.+ 6' > /dev/null; then # Red Hat 6 - PLATFORM="rhel" - OSVER="6" - - elif [[ -f /etc/os-release ]] && grep PRETTY /etc/os-release | grep -qE 'SUSE.+15' > /dev/null; then # SUSE 15 - PLATFORM="suse" - OSVER=15 - - elif [[ -f /etc/system-release ]] && grep -qE 'Red Hat.+ 6' /etc/system-release > /dev/null; then # Red Hat 6 - PLATFORM="rhel" - OSVER="6" - - elif [[ -f /etc/SuSE-release ]] && grep -q SUSE /etc/SuSE-release > /dev/null; then # SUSE - PLATFORM="suse" - if grep VERSION /etc/SuSE-release | grep -q 12 > /dev/null; then # SUSE 12 - OSVER=12 - elif grep VERSION /etc/SuSE-release | grep -q 15 > /dev/null; then # SUSE 15 - OSVER=15 - else - _unsupported_distro - fi - - elif [[ -f /etc/issue ]] && grep -qE 'SUSE.+ 12' /etc/issue > /dev/null; then # SUSE 12 - PLATFORM="suse" - OSVER=12 - - elif [[ -f /etc/issue ]] && grep -qE 'SUSE.+ 15' /etc/issue > /dev/null; then # SUSE 15 - PLATFORM="suse" - OSVER=15 - - elif [[ -f /etc/os-release ]] && grep PRETTY /etc/os-release | grep -q 'Amazon Linux 2' > /dev/null; then # Amazon Linux 2 - PLATFORM="amazon" - OSVER=2 - - else - _unsupported_distro - fi - - # Declare vars are readonly - readonly PLATFORM - readonly OSVER - - # Print platform details - system_info -} - - -# ####################################################### -# HELPERS -# ####################################################### - - -replace_property_in_file() { - # Parameter check - if [[ "$#" -lt 3 ]]; then - echo "Invalid call: 'replace_property_in_file $*'" - echo "Usage: replace_property_in_file FILENAME PROPERTY VALUE" - echo - exit 1 - fi - - # Set the new property - temp_file=$(mktemp) - grep -vE "^\\s*${2}\\s*=" "${1}" > "${temp_file}" # Export contents minus any lines containing the specified property - echo "${2}=${3}" >> "${temp_file}" # Set the new property value - cat "${temp_file}" > "${1}" # Replace the contents of the original file, while preserving any permissions - rm "${temp_file}" -} - -# ####################################################### -# SYSTEM/TEST DEPENDENCIES -# ####################################################### - -_wait_for_process_to_finish() { - echo "Waiting for ${timeout_duration} for $1 to complete any running jobs..." - - timeout ${timeout_duration} bash -c 'while pgrep '"$1"' > /dev/null 2>&1; do printf .; sleep 5; done' -} - -resolve_system_dependencies() { - # Update host system - if [[ "${PLATFORM}" = "debian" ]] || [[ "${PLATFORM}" = "ubuntu" ]]; then # Debian/Ubuntu - _wait_for_process_to_finish apt - _wait_for_process_to_finish dpkg - apt-get update - apt-get install -y -q --no-install-recommends openssl - - elif [[ "${PLATFORM}" = "rhel" ]] || [[ "${PLATFORM}" = "amazon" ]]; then # Red Hat / Amazon Linux - _wait_for_process_to_finish yum - - elif [[ "${PLATFORM}" = "suse" ]]; then # SuSe - _wait_for_process_to_finish zypper - - elif [[ "${PLATFORM}" = "windows" ]]; then # Windows - echo "Cannot update System Dependencies in Cygwin..." - return - fi -} - -install_agent() { - # Parameter check - if [[ "$#" -eq 0 ]]; then - echo "An baseUrl was not specified!" - echo "Usage: install_agent BASE_URL" - echo - exit 1 - fi - - echo "Downloading and extracting the automation agent" - - if [[ "${PLATFORM}" = "debian" ]] || [[ ${PLATFORM} = "ubuntu" ]]; then # Debian/Ubuntu - curl -OL "$1download/agent/automation/mongodb-mms-automation-agent-manager_latest_amd64.ubuntu1604.deb" - dpkg -i mongodb-mms-automation-agent-manager_latest_amd64.ubuntu1604.deb - - elif [[ "${PLATFORM}" = "rhel" ]] || [[ ${PLATFORM} = "amazon" ]] || [[ "${PLATFORM}" = "suse" ]]; then # Red Hat / Amazon Linux / SUSE - curl -OL "$1download/agent/automation/mongodb-mms-automation-agent-manager-latest.x86_64.rhel7.rpm" - rpm -U mongodb-mms-automation-agent-manager-latest.x86_64.rhel7.rpm - - else - echo "Could not install $1. Unsupported package manager or distribution!" - echo - _unsupported_distro - fi -} - -_user_dir() { - if [[ -n ${SUDO_USER+x} ]]; then - # If executing through sudo, retrieve the calling user's dir - eval echo "~${SUDO_USER}" - else - # Otherwise use the home dir - echo "${HOME}" - fi -} - -# ####################################################### -# SCENARIOS -# ####################################################### - -scenario_install_agent() { - local baseUrl="https://cloud.mongodb.com" - local ops_manager=0 - - while [[ "$#" -gt 0 ]]; do - case "$1" in - --baseUrl) baseUrl=$2; shift 2 ;; - --ops-manager) ops_manager=1; shift;; - * ) echo "Invalid option for installing mongodb $1"; return 1 ;; - esac - done - if [[ ! "${LC_AGENT_KEY:-}" || ! "${LC_GROUP_ID:-}" ]]; then - { - echo 'error: LC_AGENT_KEY or LC_GROUP_ID was not specified' - echo - } >&2 - exit 1 - fi - - resolve_system_dependencies - install_agent "${baseUrl}" - - echo "Replacing mmsGroupId and mmsApiKey" - replace_property_in_file /etc/mongodb-mms/automation-agent.config mmsGroupId "${LC_GROUP_ID}" - replace_property_in_file /etc/mongodb-mms/automation-agent.config mmsApiKey "${LC_AGENT_KEY}" - - if [[ "${ops_manager}" -eq 1 ]]; then - echo "Replacing mmsBaseUrl with ${baseUrl::-1}" - replace_property_in_file /etc/mongodb-mms/automation-agent.config mmsBaseUrl "${baseUrl::-1}" - fi - - echo "Preparing the /data directory to store your MongoDB data" - mkdir -p /data - chown -R mongodb:mongodb /data - - echo "Starting the agent" - systemctl start mongodb-mms-automation-agent.service -} - -readonly NON_ROOT_FUNCTIONS="run seed ssh system_info" - -# ####################################################### -# SEED THE TARGET ENVIRONMENT -# ####################################################### -run() { - # Print usage info - if [[ "$#" -lt 2 ]]; then - echo "Usage: run user@hostname [args...]" - echo - exit 1 - fi - - # Determine args - host=$1 - shift - args=$* - - echo "Running remote command '${args}' on ${host}..." - - # shellcheck disable=SC2086 - "$SSH" -tt -A "${ssh_opts[@]}" ${SSH_OPTS-} "${host}" ${args} -} - -scp() { - # Print usage info - if [[ "$#" -lt 2 ]]; then - echo "Usage: scp " - echo - exit 1 - fi - - # shellcheck disable=SC2016,SC2086 - if ! "$SCP" -r "${ssh_opts[@]}" ${SSH_OPTS-} "$1" "$2"; then - # Retry once, with increased verbosity - # shellcheck disable=SC2016,SC2086 - "$SCP" -r -vvv "${ssh_opts[@]}" ${SSH_OPTS-} "$1" "$2" - fi -} - -update_bin_path() { - if [[ "$#" -lt 1 ]]; then - echo "An output filename was not specified!" - echo - exit 1 - fi - - for f in "$@"; do - PATHFILE="$(_user_dir)/$f" - - # Check that the output file is writeable - if [[ -f "${PATHFILE}" && ! -w "${PATHFILE}" ]]; then - echo "Could not write to ${PATHFILE}!" - echo - return 1 - fi - - # Do not append bin/ to PATH, if already set - CONF_HEADER="# EGO env settings" - if grep -q "${CONF_HEADER}" "${PATHFILE}"; then - return 0 - fi - - echo "" | tee -a "${PATHFILE}" - echo "${CONF_HEADER}" | tee -a "${PATHFILE}" - # shellcheck disable=SC2016 - echo 'export PATH=$HOME/bin:$PATH' | tee -a "${PATHFILE}" - echo "Updated system path to include ${HOME}/bin (via ${PATHFILE})" - done -} - -seed() { - # Print usage info - if [[ "$#" -lt 1 ]]; then - echo "Usage: seed user@hostname" - echo - exit 1 - fi - - echo "Deploying ${SCRIPT} to $1..." - scp "${DIR}/${SCRIPT}" "$1:" - - # shellcheck disable=SC2016 - exec_cmd='mkdir -p $HOME/bin; mv '${SCRIPT}' $HOME/bin/; $HOME/bin/'${SCRIPT}' update_bin_path .bashrc .bash_profile' - - # shellcheck disable=SC2016,SC2086 - if ! "$SSH" -tt "${ssh_opts[@]}" ${SSH_OPTS-} "$1" ${exec_cmd}; then - # Retry once, with increased verbosity - - # shellcheck disable=SC2016,SC2086 - "$SSH" -vvv -tt "${ssh_opts[@]}" ${SSH_OPTS-} "$1" ${exec_cmd} - fi - echo "Deployed ${SCRIPT} to $1..." -} - -ssh() { - # Parameter check - if [[ "$#" -lt 1 ]]; then - echo "Invalid call 'ssh $*'" - echo "Usage: ssh user@hostname" - echo - exit 1 - fi - - # Connects to remote host - echo "Connecting to $1..." - # shellcheck disable=SC2086 - if ! "$SSH" -tt -A "${ssh_opts[@]}" ${SSH_OPTS-} "$1" /bin/bash; then - # Retry once, with increased verbosity - "$SSH" -vvv -tt -A "${ssh_opts[@]}" ${SSH_OPTS-} "$1" /bin/bash - fi -} - - -# ####################################################### -# MAIN -# ####################################################### -_available_functions() { - declare -F | awk '{print $3}' | grep -vE '^_' -} -_usage() { - echo "Usage: ${0} FUNCTION" - echo - echo "Available functions:" - echo "------------------" - for func in $(_available_functions); do echo "$func"; done - echo "------------------" - echo - exit 1 -} - -main() { - # If no parameters were specified, print the usage help - if [[ "$#" -eq 0 ]]; then - _usage - fi - - _determine_architecture - - # Run as super user, unless the functions do not require it, or the script is run without any parameters - if [[ ${NON_ROOT_FUNCTIONS} != *"$1"* ]]; then - [[ "$UID" -eq 0 || "${PLATFORM}" = "windows" ]] || exec sudo -SE "$0" "$@" - fi - - # Set a TERM var if not already in the env - _fix_term - - "$@" -} - -main "$@" - diff --git a/build/ci/evergreen.yml b/build/ci/evergreen.yml index 0e0ed80956..4ff3e8eedd 100644 --- a/build/ci/evergreen.yml +++ b/build/ci/evergreen.yml @@ -90,90 +90,6 @@ functions: MCLI_SKIP_UPDATE_CHECK: "yes" TEST_CMD: gotestsum --junitfile e2e-tests.xml --format standard-verbose -- command: make e2e-test - "deploy spawn host": - - command: shell.exec - type: setup - params: - shell: bash - silent: true - script: | - set -e - keyfile="src/github.com/mongodb/mongodb-atlas-cli/build/ci/ssh_id" - echo '${__project_aws_ssh_key_value}' > "$keyfile" - chmod 600 "$keyfile" - - command: host.create - type: system - params: - provider: ec2 - distro: ubuntu2004-large - num_hosts: 1 - security_group_ids: [sg-097bff6dd0d1d31d0] # Allows hosts to talk to each other for MongoDB - - command: host.list - params: - wait: true - timeout_seconds: 300 - num_hosts: 1 - path: src/github.com/mongodb/mongodb-atlas-cli/build/ci/hosts.json - ssh-ready: - - command: subprocess.exec - type: setup - params: - working_dir: src/github.com/mongodb/mongodb-atlas-cli/build/ci - binary: ./ssh-ready.sh - args: ['-u', 'ubuntu', '-i', 'ssh_id', '-h', 'hosts.json'] - "install automation agent": - - command: subprocess.exec - type: setup - params: - working_dir: src/github.com/mongodb/mongodb-atlas-cli/build/ci - binary: ./install-agent-spawn-host.sh - env: - LC_AGENT_KEY: ${automation_agent_mms_api_key} - LC_GROUP_ID: ${automation_agent_mms_group_id} - BASE_URL: ${mcli_ops_manager_url} - args: ['-u', 'ubuntu', '-i', 'ssh_id', '-h', 'hosts.json'] - "install ops manager": - - command: subprocess.exec - type: setup - params: - include_expansions_in_env: - - ARCHIVE - working_dir: src/github.com/mongodb/mongodb-atlas-cli/build/ci - binary: ./install-ops-manager-spawn-host.sh - args: ['-u', 'ubuntu', '-i', 'ssh_id', '-h', 'hosts.json'] - "set-up ops manager": - - command: subprocess.exec - type: setup - params: - <<: *go_options - include_expansions_in_env: - - go_base_path - - workdir - - ops_manager_service - working_dir: src/github.com/mongodb/mongodb-atlas-cli/build/ci - binary: ./set-up-ops-manager.sh - args: ['-h', 'hosts.json'] - "set-up cloud manager": - - command: subprocess.exec - type: setup - params: - <<: *go_options - include_expansions_in_env: - - go_base_path - - workdir - - cloud_manager_service - - revision - working_dir: src/github.com/mongodb/mongodb-atlas-cli/build/ci - binary: ./set-up-cloud-manager.sh - args: ['-h', 'hosts.json'] - env: - <<: *go_env - MCLI_ORG_ID: ${cloud_manager_org_id} - MCLI_PROJECT_ID: ${cloud_manager_project_id} - MCLI_PRIVATE_API_KEY: ${cloud_manager_private_api_key} - MCLI_PUBLIC_API_KEY: ${cloud_manager_public_api_key} - MCLI_OPS_MANAGER_URL: ${mcli_ops_manager_url} - MCLI_SERVICE: cloud-manager "install gotestsum": - command: shell.exec type: setup @@ -185,25 +101,12 @@ functions: set -Eeou pipefail export PATH="$ADD_PATH:$PATH" curl -sfL https://github.com/gotestyourself/gotestsum/releases/download/v${gotestsum_ver}/gotestsum_${gotestsum_ver}_linux_amd64.tar.gz | tar zx - "install podman": - command: subprocess.exec type: setup params: working_dir: src/github.com/mongodb/mongodb-atlas-cli/bin binary: ../build/ci/install_podman.sh - "install pykmip": - - command: subprocess.exec - type: setup - params: - <<: *go_options - working_dir: /src/github.com/mongodb/mongodb-atlas-cli/build/ci/kmip - binary: ./install.sh - args: ["-h", "hosts.json"] - env: - <<: *go_env - KMIP_CA: ${logs_decrypt_kmip_ca} - KMIP_CERT: ${logs_decrypt_kmip_cert} "setup operator": command: subprocess.exec type: setup @@ -243,17 +146,9 @@ functions: params: files: - tasks.json - pre: - func: "clone" post: - - command: subprocess.exec - type: setup - params: - <<: *go_options - working_dir: src/github.com/mongodb/mongodb-atlas-cli/build/ci - binary: ./clean-up-cloud-manager.sh - args: ['-h', 'hosts.json'] - command: attach.xunit_results params: files: ["src/github.com/mongodb/mongodb-atlas-cli/*.xml"] diff --git a/build/ci/install-agent-spawn-host.sh b/build/ci/install-agent-spawn-host.sh deleted file mode 100755 index a508c22ce0..0000000000 --- a/build/ci/install-agent-spawn-host.sh +++ /dev/null @@ -1,72 +0,0 @@ -#!/bin/bash - -# Copyright 2020 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. - -# automation_agent_settings.sh constains the configurations needed -# to install the automation agent with ops manager. -# this script is created in set-up-ops-manager.sh -# run this script before setting set - so it's safe if it is not there -# shellcheck disable=SC1091 -source automation_agent_settings.sh - -set -euo pipefail - -_print_usage() { - echo - echo ' -i SSH identity file' - echo ' -u Username on the remote host' - echo ' -h Output of Evergreen host.list' -} - -while getopts 'i:h:g:u:a:b:' opt; do - case ${opt} in - i) keyfile="${OPTARG}" ;; # SSH identity file - u) user="${OPTARG}" ;; # Username on the remote host - h) hostsFile="${OPTARG}" ;; # Output of Evergreen host.list - *) - echo "invalid option for install-agent-spawn-host $1" - _print_usage "$@" - exit 1 - ;; - esac -done - -flags=() -if [[ -n "${MCLI_SERVICE+x}" ]]; then - flags+=("--ops-manager") -fi - -flags+=("--baseUrl ${BASE_URL}") - -export SSH_OPTS="-i ${keyfile} -o SendEnv=LC_GROUP_ID -o SendEnv=LC_AGENT_KEY" - -hosts=$( - cat < SSH identity file' - echo ' -u Username on the remote host' - echo ' -h Output of Evergreen host.list' -} - -while getopts 'i:h:g:u:a:b:' opt; do - case ${opt} in - i) keyfile="${OPTARG}" ;; # SSH identity file - u) user="${OPTARG}" ;; # Username on the remote host - h) hostsFile="${OPTARG}" ;; # Output of Evergreen host.list - *) - echo "invalid option for install-ops-manager-spawn-host $1" - _print_usage "$@" - exit 1 - ;; - esac -done - -# Install ego -curl -sL https://raw.githubusercontent.com/mongodb-labs/ego/master/install.sh | bash -export EGO_DEBUG=1 - -export SSH_OPTS="-i ${keyfile} -o SendEnv=LC_GROUP_ID -o SendEnv=LC_AGENT_KEY" - -hosts=$( - cat <"${PYKMIP_HOME}/tls-rootCA.pem" -echo "${KMIP_CERT}" | base64 --decode >"${PYKMIP_HOME}/tls-localhost.pem" -echo "CA and server cert copied to ${PYKMIP_HOME}" - -mv kmip.db "${PYKMIP_HOME}/kmip.db" -echo "KMIP db moved to ${PYKMIP_HOME}/kmip.db" - -mv start.py "${PYKMIP_HOME}/start.py" -echo "start KMIP script moved to ${PYKMIP_HOME}/start.py" - -cat <"${PYKMIP_HOME}/pykmip.service" -[Unit] -Description=PyKMIP service - -[Service] -User=root -Restart=always -ExecStart="${PYKMIP_HOME}/venv/bin/python" "${PYKMIP_HOME}/start.py" "${PYKMIP_HOME}" - -[Install] -WantedBy=multi-user.target -EOF -sudo cp "${PYKMIP_HOME}/pykmip.service" "/etc/systemd/system/pykmip.service" -echo "PyKMIP systemd service created" - -sudo systemctl daemon-reload -echo "systemctl daemon-reload done" - -sudo systemctl start pykmip.service -echo "PyKMIP started" - -sleep 5s -sudo systemctl status pykmip.service -sudo netstat -tunlp | grep python diff --git a/build/ci/kmip/kmip.db b/build/ci/kmip/kmip.db deleted file mode 100644 index 835f8e9090aafc8583d5bdc8eabd13d2fa95737f..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 81920 zcmeI(Pi!1l9l-IK^`Esjwl_^vtx$=WstUD9(i(yrRaKQb?j{(!>)^OZ0Y$@jcDy_F z?#yOp)`<}uY$73qsKSX82PhX#NFY^6s7Ih&IdMf?kN^plOQa&;&CHH>-tKz6AzNgu z@5uJ<&il=q_df6K%sjp4TVGnW154X-y}A)-mzC3ssw%H*nxZIYTfgEZ+D?nVqpkPh zi<)|W*xR$pi!0wB3xo3?g)yh&m&3x@j{pJ)AbpM2#H&tA30Ztnf~%zN+7fBVv-h0m0&Eu&cr%G-Y}*Id)6Rb4+= zQ4h)No!|U9_?J2V@M3*IS^03}Phb1>$lor$yY-Lv?i7Cc&7Xen=k3hCdXQN-{#WyV zQN#}$0tg_000IagfB*srAbkyGJgtsgQ0s=bOi(uKmY** z5I_I{1Q0*~0R&FI0OS9Y-^SDs0R#|0009ILKmY**5I_I{#{cvI1Q0*~0R#|0009IL zKmY**PQE}m{?Fw9uH+wyKWqpffB*srAbsH)*t z!>FDWKPa6D3@homHLG_OTjwm>6+19$x^Gt;BWQZo(fJPGpDu=HIAyo4+dJB|wYAma zVyV-|-qE{TD4j!KRE~()vhQ1ET{J?id_<(}?6{^8*se2Bxal^XKr~zb0@{up*a9($ z-Z5&;?pCh*1NE9HY@lwFL>|#^lCYyYP7>L_=Oj^&({++#2JJgZ{NbG^i8#FXBoTeO zPZBaf|4Bjz?LbL<(kBk-K}pzvUC1!o-_-DWb8We_xPE)~v-6+({M^C!N{}RHbzH}^ z4h^&%(~Yh;ZX^6gq%VUv*O%WEIcqD$+uE$S5=XgTUt2FO-zbGUqkY$~mtihd$xCYIr268p!Pm@v&b?Wb2fx7iSdXv7-r&l6G|J5$42%8ugxn68F&fSi=>TwQt0rMsG( z+UjfCT1k7OxLOpC5lf4=mKNVAhTn&DrXA;&vP`Fm3`O7V&M!B&e|=h9zwppad#=5Jgo+!i45uPXg&=!6c?O3+%r@L&lx9`=Z$JH@DnWQ5Z zw|#}ok7f%myrAyg>H7ZpQm-77DlaAVsdYLosjI{yT}R?;_LY%r;iZ?<{d2v0c~>)! zN+s(`?o&DuTeDk_V^OO&jQDnyJV&Pk%0^%$RS27}yW}@B`5;A6I&Qcc7J2QpwKFWDCzfukN{V$(oyDmNqU}`|VS5 zx!MUIU$M?jM~kBN;zd#ZZe6sN*D9I(DK8aHPW$-Ew=$J2T)wRCzZUm=%k->34;K(5 z%e(yUUDI+&y94?aH_E$nn*OnyzH`l3*pbB|y4Oxc-LqAj^ff2_eo88TI;CI1Q*m7j zg@;sr{{R0t-_|G_0tg_000IagfB*srAbz^+5I_I{1Q0*~0R#|0 z;5Z8~{y)yGL)j2O009ILKmY**5I_I{1P~aG0OSARIFbtj2q1s}0tg_000IagfB*u= GS>Qi$P^c>a diff --git a/build/ci/kmip/start.py b/build/ci/kmip/start.py deleted file mode 100644 index e57d4f8f85..0000000000 --- a/build/ci/kmip/start.py +++ /dev/null @@ -1,293 +0,0 @@ -import copy -import functools -import multiprocessing -import signal -import socket -import ssl -import sys -import six -from kmip.services.server import KmipServer, engine, monitor - -# Monkey patch the KMIP server and engine classes with the following fixes: -# - When the KMIP engine processes an encrypt request with empty cryptographic parameters, it will use a set of default cryptographic parameters to process the request. -# - The default socket timeout on the server is removed -- servers shouldn't just kill a connection after 10 seconds of inactivity. - - -def patch_server(): - from kmip.core import enums - from kmip.core import exceptions - from kmip.core.messages import payloads - from kmip.core import policy as operation_policy - from kmip.core.attributes import CryptographicParameters - - def _process_encrypt_patched(self, payload): - self._logger.info("Processing operation: Encrypt") - - unique_identifier = self._id_placeholder - if payload.unique_identifier: - unique_identifier = payload.unique_identifier - - # The KMIP spec does not indicate that the Encrypt operation should - # have it's own operation policy entry. Rather, the cryptographic - # usage mask should be used to determine if the object can be used - # to encrypt data (see below). - managed_object = self._get_object_with_access_controls( - unique_identifier, enums.Operation.GET - ) - - cryptographic_parameters = payload.cryptographic_parameters - - if cryptographic_parameters is None: - # Monkey patched here -- rather than exception, we set to default params. - default_crypto_params = CryptographicParameters( - block_cipher_mode=enums.BlockCipherMode.CBC, - padding_method=enums.PaddingMethod.PKCS5, - cryptographic_algorithm=enums.CryptographicAlgorithm.AES, - ) - cryptographic_parameters = default_crypto_params - - if managed_object._object_type != enums.ObjectType.SYMMETRIC_KEY: - raise exceptions.PermissionDenied( - "The requested encryption key is not a symmetric key. " - "Only symmetric encryption is currently supported." - ) - - if managed_object.state != enums.State.ACTIVE: - raise exceptions.PermissionDenied( - "The encryption key must be in the Active state to be used " - "for encryption." - ) - - masks = managed_object.cryptographic_usage_masks - if enums.CryptographicUsageMask.ENCRYPT not in masks: - raise exceptions.PermissionDenied( - "The Encrypt bit must be set in the encryption key's " - "cryptographic usage mask." - ) - - result = self._cryptography_engine.encrypt( - cryptographic_parameters.cryptographic_algorithm, - managed_object.value, - payload.data, - cipher_mode=cryptographic_parameters.block_cipher_mode, - padding_method=cryptographic_parameters.padding_method, - iv_nonce=payload.iv_counter_nonce, - auth_additional_data=payload.auth_additional_data, - auth_tag_length=cryptographic_parameters.tag_length, - ) - - response_payload = payloads.EncryptResponsePayload( - unique_identifier, - result.get("cipher_text"), - result.get("iv_nonce"), - result.get("auth_tag"), - ) - return response_payload - - _process_encrypt_patched = engine.KmipEngine._kmip_version_supported("1.2")( - _process_encrypt_patched - ) - - def _process_decrypt_patched(self, payload): - self._logger.info("Processing operation: Decrypt") - - unique_identifier = self._id_placeholder - if payload.unique_identifier: - unique_identifier = payload.unique_identifier - - # The KMIP spec does not indicate that the Decrypt operation should - # have it's own operation policy entry. Rather, the cryptographic - # usage mask should be used to determine if the object can be used - # to decrypt data (see below). - managed_object = self._get_object_with_access_controls( - unique_identifier, enums.Operation.GET - ) - - cryptographic_parameters = payload.cryptographic_parameters - if cryptographic_parameters is None: - # Monkey patched here -- rather than exception, we set to default params. - default_crypto_params = CryptographicParameters( - block_cipher_mode=enums.BlockCipherMode.CBC, - padding_method=enums.PaddingMethod.PKCS5, - cryptographic_algorithm=enums.CryptographicAlgorithm.AES, - ) - cryptographic_parameters = default_crypto_params - - if managed_object._object_type != enums.ObjectType.SYMMETRIC_KEY: - raise exceptions.PermissionDenied( - "The requested decryption key is not a symmetric key. " - "Only symmetric decryption is currently supported." - ) - - if managed_object.state != enums.State.ACTIVE: - raise exceptions.PermissionDenied( - "The decryption key must be in the Active state to be used " - "for decryption." - ) - - masks = managed_object.cryptographic_usage_masks - if enums.CryptographicUsageMask.DECRYPT not in masks: - raise exceptions.PermissionDenied( - "The Decrypt bit must be set in the decryption key's " - "cryptographic usage mask." - ) - - result = self._cryptography_engine.decrypt( - cryptographic_parameters.cryptographic_algorithm, - managed_object.value, - payload.data, - cipher_mode=cryptographic_parameters.block_cipher_mode, - padding_method=cryptographic_parameters.padding_method, - iv_nonce=payload.iv_counter_nonce, - auth_additional_data=payload.auth_additional_data, - auth_tag=payload.auth_tag, - ) - - response_payload = payloads.DecryptResponsePayload(unique_identifier, result) - return response_payload - - _process_decrypt_patched = engine.KmipEngine._kmip_version_supported("1.2")( - _process_decrypt_patched - ) - - def no_placeholder(fn): - @functools.wraps(fn) - def inner(self, *args, **kwargs): - self._logger.info("Clearing out the current _id_placeholder value") - self._id_placeholder = None - return fn(self, *args, **kwargs) - - return inner - - def start_patched(self): - """ - Prepare the server to start serving connections. - - Configure the server socket handler and establish a TLS wrapping - socket from which all client connections descend. Bind this TLS - socket to the specified network address for the server. - - Raises: - NetworkingError: Raised if the TLS socket cannot be bound to the - network address. - """ - self.manager = multiprocessing.Manager() - self.policies = self.manager.dict() - policies = copy.deepcopy(operation_policy.policies) - for policy_name, policy_set in six.iteritems(policies): - self.policies[policy_name] = policy_set - - self.policy_monitor = monitor.PolicyDirectoryMonitor( - self.config.settings.get("policy_path"), self.policies, self.live_policies - ) - - def interrupt_handler(trigger, frame): - self.policy_monitor.stop() - - signal.signal(signal.SIGINT, interrupt_handler) - signal.signal(signal.SIGTERM, interrupt_handler) - - self.policy_monitor.start() - - self._engine = engine.KmipEngine( - policies=self.policies, - database_path=self.config.settings.get("database_path"), - ) - - self._logger.info("Starting server socket handler.") - - # Create a TCP stream socket and configure it for immediate reuse. - # Monkey patched here - remove default socket timeout. - # socket.setdefaulttimeout(10) - self._socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM) - self._socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1) - - self._logger.debug( - "Configured cipher suites: {0}".format( - len(self.config.settings.get("tls_cipher_suites")) - ) - ) - for cipher in self.config.settings.get("tls_cipher_suites"): - self._logger.debug(cipher) - auth_suite_ciphers = self.auth_suite.ciphers.split(":") - self._logger.debug( - "Authentication suite ciphers to use: {0}".format(len(auth_suite_ciphers)) - ) - for cipher in auth_suite_ciphers: - self._logger.debug(cipher) - - self._socket = ssl.wrap_socket( - self._socket, - keyfile=self.config.settings.get("key_path"), - certfile=self.config.settings.get("certificate_path"), - server_side=True, - cert_reqs=ssl.CERT_REQUIRED, - ssl_version=self.auth_suite.protocol, - ca_certs=self.config.settings.get("ca_path"), - do_handshake_on_connect=False, - suppress_ragged_eofs=True, - ciphers=self.auth_suite.ciphers, - ) - - try: - self._socket.bind( - ( - self.config.settings.get("hostname"), - int(self.config.settings.get("port")), - ) - ) - except Exception as e: - self._logger.exception(e) - raise exceptions.NetworkingError( - "Server failed to bind socket handler to {0}:{1}".format( - self.config.settings.get("hostname"), - self.config.settings.get("port"), - ) - ) - else: - self._logger.info( - "Server successfully bound socket handler to {0}:{1}".format( - self.config.settings.get("hostname"), - self.config.settings.get("port"), - ) - ) - self._is_serving = True - - engine.KmipEngine._process_encrypt = _process_encrypt_patched - engine.KmipEngine._process_decrypt = _process_decrypt_patched - engine.KmipEngine._process_get = no_placeholder(engine.KmipEngine._process_get) - engine.KmipEngine._process_get_attributes = no_placeholder( - engine.KmipEngine._process_get_attributes - ) - KmipServer.start = start_patched - - -patch_server() - - -def main(): - if len(sys.argv) != 2: - print("missing : start.py ") - sys.exit() - config_folder = sys.argv[1] - server = KmipServer( - hostname="localhost", - port=8081, - key_path=f"{config_folder}/tls-localhost.pem", - certificate_path=f"{config_folder}/tls-localhost.pem", - ca_path=f"{config_folder}/tls-rootCA.pem", - config_path=None, - policy_path="", - log_path=f"{config_folder}/log", - logging_level="DEBUG", - database_path=f"{config_folder}/kmip.db", - auth_suite="TLS1.2", - enable_tls_client_auth=False, - ) - - server.start() - server.serve() - - -if __name__ == "__main__": - main() diff --git a/build/ci/set-up-cloud-manager.sh b/build/ci/set-up-cloud-manager.sh deleted file mode 100755 index 9a408cd885..0000000000 --- a/build/ci/set-up-cloud-manager.sh +++ /dev/null @@ -1,61 +0,0 @@ -#!/bin/bash - -# Copyright 2021 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. - -set -euo pipefail - -export MCLI_SERVICE="${cloud_manager_service:?}" - -mkdir "${XDG_CONFIG_HOME}/mongocli" -cat <"${XDG_CONFIG_HOME}/mongocli/config.toml" -skip_update_check = true -[default] - service = "${MCLI_SERVICE}" - public_api_key = "${MCLI_PUBLIC_API_KEY}" - private_api_key = "${MCLI_PRIVATE_API_KEY}" - org_id = "${MCLI_ORG_ID}" - ops_manager_url = "${MCLI_OPS_MANAGER_URL}" - -EOF - -echo "create project" - -cat <project.tmpl -#!/bin/bash - -set -euo pipefail - -export AGENT_API_KEY="{{.AgentAPIKey}}" -export MCLI_PROJECT_ID="{{.ID}}" -export MUST_CLEANUP_CM="true" -EOF - -# shellcheck disable=SC2154 -GROUP_NAME="cloudManager-e2e-$((1 + RANDOM % 1000))-$revision" -mongocli iam projects create "$GROUP_NAME" -o="go-template-file=project.tmpl" >project.sh - -chmod +x project.sh - -# shellcheck disable=SC1091 -source project.sh - -mongocli config set project_id "$MCLI_PROJECT_ID" - -cat <automation_agent_settings.sh -export BASE_URL=${MCLI_OPS_MANAGER_URL} -export LC_AGENT_KEY=${AGENT_API_KEY} -export LC_GROUP_ID=${MCLI_PROJECT_ID} -export MCLI_SERVICE=${MCLI_SERVICE} -EOF diff --git a/build/ci/set-up-ops-manager.sh b/build/ci/set-up-ops-manager.sh deleted file mode 100755 index b01f92b742..0000000000 --- a/build/ci/set-up-ops-manager.sh +++ /dev/null @@ -1,100 +0,0 @@ -#!/bin/bash - -# Copyright 2021 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. - -set -euo pipefail - -_print_usage() { - echo - echo ' -h Output of Evergreen host.list' -} - -while getopts 'h:' opt; do - case ${opt} in - h) hostsFile="${OPTARG}" ;; # Output of Evergreen host.list - *) - echo "invalid option for set-up-ops-manager $1" - _print_usage "$@" - exit 1 - ;; - esac -done - -host=$( - cat <credentials.tmpl -#!/bin/bash - -set -euo pipefail - -export MCLI_PUBLIC_API_KEY={{.ProgrammaticAPIKey.PublicKey}} -export MCLI_PRIVATE_API_KEY={{.ProgrammaticAPIKey.PrivateKey}} -EOF - -./bin/mongocli om owner create --firstName evergreen --lastName evergreen --email "${email}" --password "${password}" --accessListIp "127.0.0.1/1" -o="go-template-file=credentials.tmpl" >credentials.sh - -chmod +x credentials.sh - -# shellcheck disable=SC1091 -source credentials.sh - -echo "create organization" -MCLI_ORG_ID=$(./bin/mongocli iam organizations create myOrg -o="go-template={{.ID}}") -export MCLI_ORG_ID -echo "create project" -AGENT_API_KEY=$(./bin/mongocli iam projects create myProj -o="go-template={{.AgentAPIKey}}") -MCLI_PROJECT_ID=$(./bin/mongocli iam project list -o="go-template={{ (index .Results 0).ID }}") - -mkdir "${XDG_CONFIG_HOME}/mongocli" -cat <"${XDG_CONFIG_HOME}/mongocli/config.toml" -skip_update_check = true -[default] - ops_manager_url = "${MCLI_OPS_MANAGER_URL}" - service = "${MCLI_SERVICE}" - public_api_key = "${MCLI_PUBLIC_API_KEY}" - private_api_key = "${MCLI_PRIVATE_API_KEY}" - org_id = "${MCLI_ORG_ID}" - project_id = "${MCLI_PROJECT_ID}" - -EOF - -popd -cat <automation_agent_settings.sh -export BASE_URL=${MCLI_OPS_MANAGER_URL} -export LC_AGENT_KEY=${AGENT_API_KEY} -export LC_GROUP_ID=${MCLI_PROJECT_ID} -export MCLI_SERVICE=ops-manager -EOF diff --git a/build/ci/ssh-ready.sh b/build/ci/ssh-ready.sh deleted file mode 100755 index 23b666c948..0000000000 --- a/build/ci/ssh-ready.sh +++ /dev/null @@ -1,65 +0,0 @@ -#!/bin/bash - -# Copyright 2020 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. - -set -euo pipefail - -declare -i attempts -declare -i connection_attempts -declare -ri timeout=10 - -while getopts 'i:h:t:u:' opt; do - case ${opt} in - i) keyfile="${OPTARG}" ;; # SSH identity file - u) user="${OPTARG}" ;; # Username on the remote host - h) hostsfile="${OPTARG}" ;; # Output of Evergreen host.list - t) connection_attempts="${OPTARG}" ;; # How many times to attempt to connect via SSH - *) - echo "Invalid option" - exit 1 - ;; - esac -done - -hosts=$( - cat </dev/null; do - if [[ "${attempts}" -ge "${connection_attempts}" ]]; then - echo 'Connect to spawn host failed' - exit 1 - fi - ((attempts++)) - - echo "SSH connection attempt $attempts/$connection_attempts failed. Retrying ($host)..." - # sleep for Permission denied (publickey) errors - sleep "$timeout" - done - set -e -done diff --git a/build/package/.mongocli.goreleaser.yml b/build/package/.mongocli.goreleaser.yml deleted file mode 100644 index 159012b8ff..0000000000 --- a/build/package/.mongocli.goreleaser.yml +++ /dev/null @@ -1,120 +0,0 @@ -project_name: mongocli - -monorepo: - tag_prefix: mongocli/ - -before: - hooks: - - go mod tidy - -builds: - - <<: &build_defaults - env: - - CGO_ENABLED=0 - binary: bin/mongocli - main: ./cmd/mongocli - ldflags: - - -s -w -X github.com/mongodb/mongodb-atlas-cli/internal/version.Version={{.Version}} -X github.com/mongodb/mongodb-atlas-cli/internal/version.GitCommit={{.FullCommit}} - id: linux - goos: [linux] - goarch: [amd64,arm64] - - <<: *build_defaults - id: macos - goos: [darwin] - goarch: [amd64,arm64] - hooks: - # This will notarize Apple binaries and replace goreleaser bins with the notarized ones - post: - - cmd: ./build/package/mongocli_mac_notarize.sh - output: true - - <<: *build_defaults - builder: prebuilt - id: windows - goos: [windows] - goarch: [amd64] - goamd64: [v1] - prebuilt: - path: ./bin/mongocli.exe - hooks: - post: - - cmd: ./build/package/windows_notarize.sh - env: - - TOOL_NAME=mongocli - - VERSION={{ .Version }} - output: true -gomod: # https://goreleaser.com/customization/verifiable_builds/ - # Proxy a module from proxy.golang.org, making the builds verifiable. - # This will only be effective if running against a tag. Snapshots will ignore - # this setting. - # Notice: for this to work your `build.main` must be a package, not a `.go` file. - proxy: false # it will be enabled in CLOUDP-228737 - # Sets the `-mod` flag value. - # - # Since: v1.7 - mod: mod -archives: -- id: linux_archives - name_template: mongocli_{{ .Version }}_{{ .Os }}_{{- if eq .Arch "amd64" }}x86_64{{- else }}{{ .Arch }}{{ end }} - builds: [linux] - <<: &archive_defaults - files: - - README.md - - mongocli.md - - LICENSE - - third_party_notices/**/* - wrap_in_directory: true - format: tar.gz - rlcp: false -- id: macos - name_template: mongocli_{{ .Version }}_{{- if eq .Os "darwin" }}macos{{- else }}{{ .Os }}{{ end }}_{{- if eq .Arch "amd64" }}x86_64{{- else }}{{ .Arch }}{{ end }} - builds: [macos] - <<: *archive_defaults - format: zip - wrap_in_directory: false -- id: windows - name_template: mongocli_{{ .Version }}_{{ .Os }}_{{- if eq .Arch "amd64" }}x86_64{{- else }}{{ .Arch }}{{ end }} - builds: [windows] - <<: *archive_defaults - wrap_in_directory: false - format: zip - rlcp: false -nfpms: -- id: linux_package - package_name: mongocli - file_name_template: mongocli_{{ .Version }}_{{ .Os }}_{{- if eq .Arch "amd64" }}x86_64{{- else }}{{ .Arch }}{{ end }} - vendor: MongoDB Inc. - homepage: https://www.mongodb.com/ - maintainer: MongoDB Inc. - description: MongoDB Command Line Interface (mongocli) is a tool for managing your MongoDB cloud services, like MongoDB Atlas, MongoDB Cloud Manager, and MongoDB Ops Manager. - license: Apache 2.0 - bindir: /usr - builds: [linux] - formats: [deb,rpm] -checksum: - name_template: checksums.txt -snapshot: - name_template: "{{ .Env.VERSION_GIT }}-next" -changelog: - sort: asc - filters: - exclude: - - '^docs:' - - '^test:' - - '^task:' - - '^build(deps):' -signs: - - id: linux_artifacts - signature: "${artifact}.sig" - cmd: "./build/package/linux_notarize.sh" - ids: - - linux_archives - - linux_package - env: - - TOOL_NAME=mongocli - artifacts: all - output: true -release: - prerelease: auto - name_template: "MongoDB CLI {{.Version}}" - extra_files: - - glob: ./bin/*.msi diff --git a/build/package/generate-notices.sh b/build/package/generate-notices.sh index 2f277e4b95..2d5c23a596 100755 --- a/build/package/generate-notices.sh +++ b/build/package/generate-notices.sh @@ -18,6 +18,6 @@ set -Eeou pipefail go install github.com/google/go-licenses@latest -go-licenses save "github.com/mongodb/mongodb-atlas-cli/cmd/mongocli" --save_path=third_party_notices +go-licenses save "github.com/mongodb/mongodb-atlas-cli/cmd/atlas" --save_path=third_party_notices # For HCL, a dependency of viper, go-license adds the source code with restricted permissions, this is a problem for some linux users sudo chmod -R 755 ./third_party_notices diff --git a/build/package/mongocli_mac_notarize.sh b/build/package/mongocli_mac_notarize.sh deleted file mode 100755 index a15da2f1b5..0000000000 --- a/build/package/mongocli_mac_notarize.sh +++ /dev/null @@ -1,35 +0,0 @@ -#!/usr/bin/env bash - -# Copyright 2021 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. - -set -Eeou pipefail - -# Notarize generated binaries with Apple and replace the original binary with the notarized one -# This depends on binaries being generated in a goreleaser manner and gon being set up. -# goreleaser should already take care of calling this script as a hook. - -if [[ -f "./dist/macos_darwin_amd64_v1/bin/mongocli" && -f "./dist/macos_darwin_arm64/bin/mongocli" && ! -f "./dist/mongocli_macos_signed.zip" ]]; then - echo "notarizing macOs binaries" - zip -r ./dist/mongocli_amd64_arm64_bin.zip ./dist/macos_darwin_amd64_v1/bin/mongocli ./dist/macos_darwin_arm64/bin/mongocli # The Notarization Service takes an archive as input - ./linux_amd64/macnotary \ - -f ./dist/mongocli_amd64_arm64_bin.zip \ - -m notarizeAndSign -u https://dev.macos-notary.build.10gen.cc/api \ - -b com.mongodb.mongocli \ - -o ./dist/mongocli_macos_signed.zip - - echo "replacing original files" - unzip -oj ./dist/mongocli_macos_signed.zip dist/macos_darwin_amd64_v1/bin/mongocli -d ./dist/macos_darwin_amd64_v1/bin/ - unzip -oj ./dist/mongocli_macos_signed.zip dist/macos_darwin_arm64/bin/mongocli -d ./dist/macos_darwin_arm64/bin/ -fi From 3376d8029c1f72447c0c153306839b0c64eb5e78 Mon Sep 17 00:00:00 2001 From: Filipe C Menezes Date: Fri, 1 Mar 2024 14:05:18 +0000 Subject: [PATCH 09/16] update docs --- README.md | 6 +- test/README.md | 732 ++++++++++++++++++++++++------------------------- 2 files changed, 363 insertions(+), 375 deletions(-) diff --git a/README.md b/README.md index c2fb46e836..6c35b33cde 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ cd mongodb-atlas-cli To build `atlascli`, run: ```bash -make build-atlascli +make build ``` The resulting `atlas` binary is placed in `./bin`. @@ -39,10 +39,10 @@ The resulting `atlas` binary is placed in `./bin`. To install the `atlas` binary in `$GOPATH/bin`, run: ```bash -make install-atlascli +make install ``` -**Note:** running `make build-atlascli` is not needed when running `make install-atlascli`. +**Note:** running `make build` is not needed when running `make install`. ## Usage diff --git a/test/README.md b/test/README.md index 31d3aa76c9..d83e17a9d2 100644 --- a/test/README.md +++ b/test/README.md @@ -2,385 +2,373 @@ #### Fields Description -- Command: the MongoDB CLI command without `mongocli atlas|om|cm` +- Command: the MongoDB Atlas CLI command without `atlas` - E2E Atlas: - Possible values: `('Y'|'N')` - Indicates if an e2e test for the command is present `('Y')` or not present `('N')` for Atlas -- E2E OM: - - Possible values: `('Y'|'N')` - - Indicates if an e2e test for the command is present `('Y')` or not present `('N')` for Ops Manager -- E2E CM: - - Possible values: `('Y'|'N')` - - Indicates if an e2e test for the command is present `('Y')` or not present `('N')` for Cloud Manager - Atlas: - Possible values: `('Y'|'N'|' ')` - Indicates if the command supports `('Y')` or not support `('N'|' ')` Atlas - - OM: - - Possible values: `('Y'|'N'|' ')` - - Indicates if the command supports `('Y')` or not support `('N'|' ')` Ops Manager - - CM: - - Possible values: `('Y'|'N'|' ')` - - Indicates if the command supports `('Y')` or not support `('N'|' ')` Cloud Manager #### Inventory -| Command | E2E Atlas | E2E OM | E2E CM | Atlas | OM | CM | -|:--------------------------------------------| :---: | :---: | :---: | :---: | :---: | :---: | -| `alerts config create` | Y | N | N | Y | Y | Y | -| `alerts config delete` | Y | N | N | Y | Y | Y | -| `alerts config fields type` | Y | N | N | Y | Y | Y | -| `alerts config list` | Y | N | N | Y | Y | Y | -| `alerts acknowledge` | Y | N | Y | Y | Y | Y | -| `alerts unacknowledge` | Y | N | Y | Y | Y | Y | -| `alerts list` | Y | N | Y | Y | Y | Y | -| `alerts describe` | Y | N | Y | Y | Y | Y | -| `alerts global list` | | N | | | Y | | -| `accessList create` | Y | | | Y | | | -| `accessList delete` | Y | | | Y | | | -| `accessList list` | Y | | | Y | | | -| `backup snapshots create` | Y | | | Y | | | -| `backup snapshots delete` | Y | | | Y | | | -| `backup snapshots describe` | Y | | | Y | | | -| `backup snapshots list` | Y | | | Y | | | -| `backup snapshots watch` | Y | | | Y | | | -| `backup exports buckets create` | Y | | | Y | | | -| `backup exports buckets list` | Y | | | Y | | | -| `backup exports buckets describe` | Y | | | Y | | | -| `backup exports buckets delete` | Y | | | Y | | | -| `backup exports jobs create` | Y | | | Y | | | -| `backup exports jobs list` | Y | | | Y | | | -| `backup exports jobs describe` | Y | | | Y | | | -| `backup exports jobs delete` | Y | | | Y | | | -| `backup exports jobs watch` | Y | | | Y | | | -| `backup restores list` | Y | | | Y | | | -| `backup restores describe` | Y | | | Y | | | -| `backup restores start` | Y | | | Y | | | -| `backup restores watch` | Y | | | Y | | | -| `backup schedule describe` | Y | | | Y | | | -| `backup schedule delete` | Y | | | Y | | | -| `backup schedule update` | Y | | | Y | | | -| `backup compliancepolicy describe` | Y | | | Y | | | -| `backup compliancepolicy enable` | Y | | | Y | | | -| `backup compliancepolicy copyprotection` | Y | | | Y | | | -| `backup compliancepolicy setup` | Y | | | Y | | | -| `backup compliancepolicy pointintimerestore enable` | Y | | | Y | | | -| `backup compliancepolicy policies describe` | Y | | | Y | | | -| `backup compliancepolicy encryptionAtRest enable` | N | | | N | | | -| `backup compliancepolicy encryptionAtRest disable` | N | | | N | | | -| `cloudProvider aws accessRoles authorize` | N | | | Y | | | -| `cloudProvider aws accessRoles deauthorize` | N | | | Y | | | -| `cloudProvider aws accessRoles create` | Y | | | Y | | | -| `cloudProvider accessRoles list` | Y | | | Y | | | -| `cluster connectionString describe` | Y | | | Y | | | -| `cluster index create` | Y | | | Y | | | -| `cluster create` | Y | | | Y | | | -| `cluster delete` | Y | | | Y | | | -| `cluster describe` | Y | | | Y | | | -| `cluster list` | Y | | | Y | | | -| `cluster start` | N | | | Y | | | -| `cluster pause` | N | | | Y | | | -| `cluster update` | Y | Y | Y | Y | Y | Y | -| `cluster watch` | Y | | | Y | | | -| `cluster onlineArchive create` | Y | | | Y | N | N | -| `cluster onlineArchive delete` | Y | | | Y | N | N | -| `cluster onlineArchive describe` | Y | | | Y | N | N | -| `cluster onlineArchive list` | Y | | | Y | N | N | -| `cluster onlineArchive pause` | Y | | | Y | N | N | -| `cluster onlineArchive start` | Y | | | Y | N | N | -| `cluster onlineArchive update` | Y | | | Y | N | N | -| `cluster search index create` | Y | | | Y | N | N | -| `cluster search index delete` | Y | | | Y | N | N | -| `cluster search index describe` | Y | | | Y | N | N | -| `cluster search index list` | Y | | | Y | N | N | -| `cluster search index update` | Y | | | Y | N | N | -| `cluster search nodes list` | Y | | | Y | N | N | -| `cluster search nodes create` | Y | | | Y | N | N | -| `cluster search nodes update` | Y | | | Y | N | N | -| `cluster search nodes delete` | Y | | | Y | N | N | -| `cluster advancedSettings describe` | Y | | | Y | N | N | -| `cluster advancedSettings update` | Y | | | Y | N | N | -| `dbrole create` | Y | | | Y | | | -| `dbrole delete` | Y | | | Y | | | -| `dbrole describe` | Y | | | Y | | | -| `dbrole list` | Y | | | Y | | | -| `dbrole update` | Y | | | Y | | | -| `customDns aws describe` | Y | | | Y | | | -| `customDns aws disable` | Y | | | Y | | | -| `customDns aws enable` | Y | | | Y | | | -| `datalake create` | Y | | | Y | | | -| `datalake delete` | Y | | | Y | | | -| `datalake describe` | Y | | | Y | | | -| `datalake list` | Y | | | Y | | | -| `datalake update` | Y | | | Y | | | -| `dbuser certs create` | Y | | | Y | | | -| `dbuser certs list` | Y | | | Y | | | -| `dbuser create` | Y | | | Y | | | -| `dbuser delete` | Y | | | Y | | | -| `dbuser describe` | Y | | | Y | | | -| `dbuser list` | Y | | | Y | | | -| `dbuser update` | Y | | | Y | | | -| `integration create DATADOG` | Y | | | Y | | | -| `integration create FLOWDOCK` | Y | | | Y | | | -| `integration create OPS_GENIE` | Y | | | Y | | | -| `integration create PAGER_DUTY` | Y | | | Y | | | -| `integration create VICTOR_OPS` | Y | | | Y | | | -| `integration create WEBHOOK` | Y | | | Y | | | -| `integration create VICTOR_OPS` | Y | | | Y | | | -| `integration create VICTOR_OPS` | Y | | | Y | | | -| `integration delete` | Y | | | Y | | | -| `integration describe` | Y | | | Y | | | -| `integration list` | Y | | | Y | | | -| `logs download` | Y | | | Y | | | -| `accesslogs list` | Y | | | Y | | | -| `maintenanceWindow clear` | Y | | | Y | | | -| `maintenanceWindow defer` | N | | | Y | | | -| `maintenanceWindow describe` | Y | | | Y | | | -| `maintenanceWindow update` | Y | | | Y | | | -| `metric database describe` | Y | | | Y | | | -| `metric database list` | N | | | Y | | | -| `metric disk describe` | Y | | | Y | | | -| `metric disk list` | N | | | Y | | | -| `metric processes` | Y | | | Y | | | -| `networking container delete` | N | | | Y | | | -| `networking container list` | N | | | Y | | | -| `networking peering create aws` | N | | | Y | | | -| `networking peering create azure` | N | | | Y | | | -| `networking peering create gcp` | N | | | Y | | | -| `networking peering delete` | N | | | Y | | | -| `networking peering list` | N | | | Y | | | -| `networking peering watch` | N | | | Y | | | -| `privateEndpoint aws interface create` | N | | | Y | | | -| `privateEndpoint aws interface delete` | N | | | Y | | | -| `privateEndpoint aws interface describe` | N | | | Y | | | -| `privateEndpoint aws create` | Y | | | Y | | | -| `privateEndpoint aws delete` | Y | | | Y | | | -| `privateEndpoint aws describe` | Y | | | Y | | | -| `privateEndpoint aws list` | Y | | | Y | | | -| `privateEndpoint aws watch` | Y | | | Y | | | -| `privateEndpoint azure interface create` | N | | | Y | | | -| `privateEndpoint azure interface delete` | N | | | Y | | | -| `privateEndpoint azure interface describe` | N | | | Y | | | -| `privateEndpoint azure create` | Y | | | Y | | | -| `privateEndpoint azure delete` | Y | | | Y | | | -| `privateEndpoint azure describe` | Y | | | Y | | | -| `privateEndpoint azure list` | Y | | | Y | | | -| `privateEndpoint azure watch` | Y | | | Y | | | -| `privateEndpoint gcp create` | Y | | | Y | | | -| `privateEndpoint gcp delete` | Y | | | Y | | | -| `privateEndpoint gcp list` | Y | | | Y | | | -| `privateEndpoint gcp descibe` | Y | | | Y | | | -| `privateEndpoint gcp watch` | Y | | | Y | | | -| `privateEndpoint dataLake aws create` | Y | | | Y | | | -| `privateEndpoint dataLake aws list` | Y | | | Y | | | -| `privateEndpoint dataLake aws delete` | Y | | | Y | | | -| `privateEndpoint dataLake aws describe` | Y | | | Y | | | -| `privateEndpoint interface create` | N | | | Y | | | -| `privateEndpoint interface delete` | N | | | Y | | | -| `privateEndpoint interface describe` | N | | | Y | | | -| `privateEndpoint regionalMode describe` | Y | | | Y | | | -| `privateEndpoint regionalMode enable` | Y | | | Y | | | -| `privateEndpoint regionalMode disable` | Y | | | Y | | | -| `process list` | Y | | | Y | | | -| `quickstart` | Y | | | Y | | | -| `security customercert create` | N | | | Y | | | -| `security customercert disable` | N | | | Y | | | -| `security customercert describe` | N | | | Y | | | -| `security ldap delete` | Y | | | Y | | | -| `security ldap describe` | Y | | | Y | | | -| `security ldap save` | Y | | | Y | | | -| `security ldap status` | Y | | | Y | | | -| `security ldap verify` | Y | | | Y | | | -| `security ldap watch` | Y | | | Y | | | -| `streams` | | | | | | | -| `streams connection` | | | | | | | -| `streams connection create` | Y | | | Y | | | -| `streams connection delete` | Y | | | Y | | | -| `streams connection describe` | Y | | | Y | | | -| `streams connection list` | Y | | | Y | | | -| `streams connection update` | Y | | | Y | | | -| `streams instance` | | | | | | | -| `streams instance create` | Y | | | Y | | | -| `streams instance delete` | Y | | | Y | | | -| `streams instance describe` | Y | | | Y | | | -| `streams instance list` | Y | | | Y | | | -| `streams instance update` | Y | | | Y | | | -| `config` | | | | | | | -| `completion` | Y | Y | Y | Y | Y | Y | -| `config delete` | Y | Y | Y | Y | Y | Y | -| `config list` | Y | Y | Y | Y | Y | Y | -| `config describe` | Y | Y | Y | Y | Y | Y | -| `config rename` | Y | Y | Y | Y | Y | Y | -| `config set` | | | | | | | -| `event list` | Y | N |Y | Y | Y | Y | -| `iam globalAccessList create` | | N | | | Y | | -| `iam globalAccessList delete` | | N | | | Y | | -| `iam globalAccessList describe` | | N | | | Y | | -| `iam globalAccessList list` | | N | | | Y | | -| `iam globalApiKey create` | | N | | | Y | | -| `iam globalApiKey delete` | | N | | | Y | | -| `iam globalApiKey describe` | | N | | | Y | | -| `iam globalApiKey list` | | N | | | Y | | -| `iam globalApiKey update` | | N | | | Y | | -| `iam orgs apiKey accessList create` | Y | Y | Y | Y | Y | Y | -| `iam orgs apiKey accessList delete` | Y | Y | Y | Y | Y | Y | -| `iam orgs apiKey accessList list` | Y | Y | Y | Y | Y | Y | -| `iam orgs apiKey create` | Y | Y | Y | Y | Y | Y | -| `iam orgs apiKey delete` | Y | Y | Y | Y | Y | Y | -| `iam orgs apiKey describe` | Y | Y | Y | Y | Y | Y | -| `iam orgs apiKey list` | Y | Y | Y | Y | Y | Y | -| `iam orgs apiKey update` | Y | Y | Y | Y | Y | Y | -| `iam orgs users list` | N | N | N | Y | Y | Y | -| `iam orgs create` | | Y | N | | Y | Y | -| `iam orgs delete` | N | Y | N | Y | Y | Y | -| `iam orgs describe` | Y | Y | N | Y | Y | Y | -| `iam orgs list` | Y | Y | N | Y | Y | Y | -| `iam orgs invitations list` | Y | Y | N | Y | N | N | -| `iam orgs invitations describe` | Y | Y | N | Y | N | N | -| `iam orgs invitations invite` | Y | Y | N | Y | N | N | -| `iam orgs invitations update` | Y | Y | N | Y | N | N | -| `iam orgs invitations delete` | Y | Y | N | Y | N | N | -| `iam project apiKey create` | Y | N | Y | Y | Y | Y | -| `iam project apiKey delete` | Y | N | Y | Y | Y | Y | -| `iam project apiKey describe` | N | N | N | Y | Y | Y | -| `iam project apiKey list` | Y | N | Y | Y | Y | Y | -| `iam project apiKey assign` | Y | N | Y | Y | Y | Y | -| `iam project users list` | Y | N | Y | Y | Y | Y | -| `iam project users delete` | N | N | N | Y | Y | Y | -| `iam project team add` | N | N | N | Y | Y | Y | -| `iam project team delete` | N | N | N | Y | Y | Y | -| `iam project team list` | N | N | N | Y | Y | Y | -| `iam project team update` | N | N | N | Y | Y | Y | -| `iam project create` | Y | Y | Y | Y | Y | Y | -| `iam project delete` | N | Y | N | Y | Y | Y | -| `iam project describe` | N | Y | N | Y | Y | Y | -| `iam project list` | N | Y | N | Y | Y | Y | -| `iam project invitations list` | Y | Y | N | Y | N | N | -| `iam project invitations describe` | Y | Y | N | Y | N | N | -| `iam project invitations invite` | Y | Y | N | Y | N | N | -| `iam project invitations update` | Y | Y | N | Y | N | N | -| `iam project invitations delete` | Y | Y | N | Y | N | N | -| `iam team user add` | Y | N | Y | Y | Y | Y | -| `iam team user delete` | Y | N | Y | Y | Y | Y | -| `iam team user list` | Y | N | Y | Y | Y | Y | -| `iam team create` | Y | N | Y | Y | Y | Y | -| `iam team delete` | Y | N | Y | Y | Y | Y | -| `iam team describe` | Y | N | Y | Y | Y | Y | -| `iam team list` | Y | N | Y | Y | Y | Y | -| `iam user invite` | N | N | N | Y | Y | Y | -| `iam user delete` | N | N | N | Y | Y | Y | -| `iam user describe` | Y | N | Y | Y | Y | Y | -| `admin backup blockstore create` | | N | | | N | | -| `admin backup blockstore delete` | | N | | | N | | -| `admin backup blockstore describe` | | N | | | N | | -| `admin backup blockstore list` | | N | | | N | | -| `admin backup blockstore update` | | N | | | N | | -| `admin backup fileSystem create` | | N | | | N | | -| `admin backup fileSystem delete` | | N | | | N | | -| `admin backup fileSystem describe` | | N | | | N | | -| `admin backup fileSystem list` | | N | | | N | | -| `admin backup fileSystem update` | | N | | | N | | -| `admin backup oplog create` | | N | | | N | | -| `admin backup oplog delete` | | N | | | N | | -| `admin backup oplog describe` | | N | | | N | | -| `admin backup oplog list` | | N | | | N | | -| `admin backup oplog update` | | N | | | N | | -| `admin backup s3 create` | | N | | | N | | -| `admin backup s3 delete` | | N | | | N | | -| `admin backup s3 describe` | | N | | | N | | -| `admin backup s3 list` | | N | | | N | | -| `admin backup s3 update` | | N | | | N | | -| `admin backup sync create` | | N | | | N | | -| `admin backup sync delete` | | N | | | N | | -| `admin backup sync describe` | | N | | | N | | -| `admin backup sync list` | | N | | | N | | -| `admin backup sync update` | | N | | | N | | -| `agent apikeys create` | | N | N | | Y | Y | -| `agent apikeys delete` | | N | N | | Y | Y | -| `agent apikeys list` | | Y | Y | | Y | Y | -| `agent version list` | | Y | Y | | Y | Y | -| `agent list` | | Y | Y | | Y | Y | -| `agent upgrade` | | Y | Y | | Y | Y | -| `automation describe` | | N | N | | Y | Y | -| `automation status` | | N | N | | Y | Y | -| `automation update` | | N | N | | Y | Y | -| `automation watch` | | N | N | | Y | Y | -| `cluster apply` | | Y | Y | | Y | Y | -| `cluster create` | | Y | Y | | Y | Y | -| `cluster delete` | | Y | Y | | Y | Y | -| `cluster describe` | | Y | Y | | Y | Y | -| `cluster list` | | Y | Y | | Y | Y | -| `cluster restart` | | Y | Y | | Y | Y | -| `cluster shutdown` | | Y | Y | | Y | Y | -| `cluster startup` | | N | N | | Y | Y | -| `cluster unmanage` | | Y | Y | | Y | Y | -| `cluster update` | | N | N | | Y | Y | -| `cluster reclaimFreeSpace` | | Y | Y | | Y | Y | -| `cluster index create` | | N | N | | Y | Y | -| `dbuser create` | | N | Y | | Y | Y | -| `dbuser delete` | | N | Y | | Y | Y | -| `dbuser list` | | N | Y | | Y | Y | -| `diagnose-archive download` | | N | N | | Y | Y | -| `featurePolicy list` | | Y | Y | | Y | Y | -| `featurePolicy update` | | Y | Y | | Y | Y | -| `logs jobs collect` | | N | N | | Y | Y | -| `logs jobs download` | | N | N | | Y | Y | -| `logs jobs delete` | | N | N | | Y | Y | -| `logs jobs list` | | N | N | | Y | Y | -| `logs decrypt` | | | Y | | | Y | -| `logs keyProvider list` | | | Y | | | Y | -| `maintenanceWindows create` | | Y | Y | | Y | Y | -| `maintenanceWindows delete` | | Y | Y | | Y | Y | -| `maintenanceWindows list` | | Y | Y | | Y | Y | -| `maintenanceWindows update` | | Y | Y | | Y | Y | -| `database describe` | | N | N | | Y | Y | -| `database list` | | N | N | | Y | Y | -| `disk describe` | | N | N | | Y | Y | -| `disk list` | | N | N | | Y | Y | -| `process` | | N | N | | Y | Y | -| `process describe` | | N | N | | Y | Y | -| `process list` | | N | N | | Y | Y | -| `security enable` | | Y | Y | | Y | Y | -| `monitoring enable` | | Y | Y | | Y | Y | -| `monitoring disable` | | Y | Y | | Y | Y | -| `monitoring stop` | | Y | Y | | Y | Y | -| `owner create` | | Y | | | Y | | -| `server list` | | Y | Y | | Y | Y | -| `softwareComponent list` | | N | N | | Y | Y | -| `versionManifest update` | | N | | | Y | | -| `serverUsage orgs hosts list` | | N | | | Y | | -| `serverUsage orgs serverType get` | | N | | | Y | | -| `serverUsage orgs serverType set` | | N | | | Y | | -| `serverUsage project hosts list` | | N | | | Y | | -| `serverUsage project serverType get` | | N | | | Y | | -| `serverUsage projet serverType set` | | N | | | Y | | -| `serverUsage capture` | | N | | | Y | | -| `serverUsage download` | | N | | | Y | | -| `performanceAdvisor namespace list` | Y | N | N | Y | Y | Y | -| `performanceAdvisor slowQueryLogs list` | Y | N | N | Y | Y | Y | -| `performanceAdvisor suggestedIndexes list` | Y | N | N | Y | Y | Y | -| `performanceAdvisor slowOT enable` | Y | | | Y | N | N | -| `performanceAdvisor slowOT disable` | Y | | | Y | N | N | -| `serverless create` | Y | | | Y | | | -| `serverless delete` | Y | | | Y | | | -| `serverless describe` | Y | | | Y | | | -| `serverless list` | Y | | | Y | | | -| `serverless watch` | Y | | | Y | | | -| `serverless update` | Y | | | Y | | | -| `serverless backup snapshots list` | Y | | | Y | | | -| `serverless backup snapshots describe` | Y | | | Y | | | -| `serverless backup snapshots watch` | Y | | | Y | | | -| `livemigrations link create` | Y | | | Y | N | N | -| `livemigrations link delete` | Y | | | Y | Y | Y | -| `livemigrations validation create` | | | | Y | | | -| `livemigrations create` | | | | Y | | | -| `livemigrations cutover` | N | | | Y | N | N | -| `completion bash` | Y | Y | Y | Y | Y | Y | -| `completion zsh` | Y | Y | Y | Y | Y | Y | -| `completion fish` | Y | Y | Y | Y | Y | Y | -| `completion powershell` | Y | Y | Y | Y | Y | Y | -| `setup` | Y | | | Y | | | -| `register` | N | | | Y | | | -| `kubernetes config generate` | Y | | | Y | N | | -| `kubernetes config apply` | Y | | | Y | N | | -| `kubernetes operator install` | Y | | | Y | N | | +| Command | E2E Atlas | Atlas +| :-----------------------------------------------------: | :-------: | :---: +| `alerts config create` | Y | Y +| `alerts config delete` | Y | Y +| `alerts config fields type` | Y | Y +| `alerts config list` | Y | Y +| `alerts acknowledge` | Y | Y +| `alerts unacknowledge` | Y | Y +| `alerts list` | Y | Y +| `alerts describe` | Y | Y +| `alerts global list` | | +| `accessList create` | Y | Y +| `accessList delete` | Y | Y +| `accessList list` | Y | Y +| `backup snapshots create` | Y | Y +| `backup snapshots delete` | Y | Y +| `backup snapshots describe` | Y | Y +| `backup snapshots list` | Y | Y +| `backup snapshots watch` | Y | Y +| `backup exports buckets create` | Y | Y +| `backup exports buckets list` | Y | Y +| `backup exports buckets describe` | Y | Y +| `backup exports buckets delete` | Y | Y +| `backup exports jobs create` | Y | Y +| `backup exports jobs list` | Y | Y +| `backup exports jobs describe` | Y | Y +| `backup exports jobs delete` | Y | Y +| `backup exports jobs watch` | Y | Y +| `backup restores list` | Y | Y +| `backup restores describe` | Y | Y +| `backup restores start` | Y | Y +| `backup restores watch` | Y | Y +| `backup schedule describe` | Y | Y +| `backup schedule delete` | Y | Y +| `backup schedule update` | Y | Y +| `backup compliancepolicy describe` | Y | Y +| `backup compliancepolicy enable` | Y | Y +| `backup compliancepolicy copyprotection` | Y | Y +| `backup compliancepolicy setup` | Y | Y +| `backup compliancepolicy pointintimerestore enable` | Y | Y +| `backup compliancepolicy policies describe` | Y | Y +| `backup compliancepolicy encryptionAtRest enable` | N | N +| `backup compliancepolicy encryptionAtRest disable` | N | N +| `cloudProvider aws accessRoles authorize` | N | Y +| `cloudProvider aws accessRoles deauthorize` | N | Y +| `cloudProvider aws accessRoles create` | Y | Y +| `cloudProvider accessRoles list` | Y | Y +| `cluster connectionString describe` | Y | Y +| `cluster index create` | Y | Y +| `cluster create` | Y | Y +| `cluster delete` | Y | Y +| `cluster describe` | Y | Y +| `cluster list` | Y | Y +| `cluster start` | N | Y +| `cluster pause` | N | Y +| `cluster update` | Y | Y +| `cluster watch` | Y | Y +| `cluster onlineArchive create` | Y | Y +| `cluster onlineArchive delete` | Y | Y +| `cluster onlineArchive describe` | Y | Y +| `cluster onlineArchive list` | Y | Y +| `cluster onlineArchive pause` | Y | Y +| `cluster onlineArchive start` | Y | Y +| `cluster onlineArchive update` | Y | Y +| `cluster search index create` | Y | Y +| `cluster search index delete` | Y | Y +| `cluster search index describe` | Y | Y +| `cluster search index list` | Y | Y +| `cluster search index update` | Y | Y +| `cluster search nodes list` | Y | Y +| `cluster search nodes create` | Y | Y +| `cluster search nodes update` | Y | Y +| `cluster search nodes delete` | Y | Y +| `cluster advancedSettings describe` | Y | Y +| `cluster advancedSettings update` | Y | Y +| `dbrole create` | Y | Y +| `dbrole delete` | Y | Y +| `dbrole describe` | Y | Y +| `dbrole list` | Y | Y +| `dbrole update` | Y | Y +| `customDns aws describe` | Y | Y +| `customDns aws disable` | Y | Y +| `customDns aws enable` | Y | Y +| `datalake create` | Y | Y +| `datalake delete` | Y | Y +| `datalake describe` | Y | Y +| `datalake list` | Y | Y +| `datalake update` | Y | Y +| `dbuser certs create` | Y | Y +| `dbuser certs list` | Y | Y +| `dbuser create` | Y | Y +| `dbuser delete` | Y | Y +| `dbuser describe` | Y | Y +| `dbuser list` | Y | Y +| `dbuser update` | Y | Y +| `integration create DATADOG` | Y | Y +| `integration create FLOWDOCK` | Y | Y +| `integration create OPS_GENIE` | Y | Y +| `integration create PAGER_DUTY` | Y | Y +| `integration create VICTOR_OPS` | Y | Y +| `integration create WEBHOOK` | Y | Y +| `integration create VICTOR_OPS` | Y | Y +| `integration create VICTOR_OPS` | Y | Y +| `integration delete` | Y | Y +| `integration describe` | Y | Y +| `integration list` | Y | Y +| `logs download` | Y | Y +| `accesslogs list` | Y | Y +| `maintenanceWindow clear` | Y | Y +| `maintenanceWindow defer` | N | Y +| `maintenanceWindow describe` | Y | Y +| `maintenanceWindow update` | Y | Y +| `metric database describe` | Y | Y +| `metric database list` | N | Y +| `metric disk describe` | Y | Y +| `metric disk list` | N | Y +| `metric processes` | Y | Y +| `networking container delete` | N | Y +| `networking container list` | N | Y +| `networking peering create aws` | N | Y +| `networking peering create azure` | N | Y +| `networking peering create gcp` | N | Y +| `networking peering delete` | N | Y +| `networking peering list` | N | Y +| `networking peering watch` | N | Y +| `privateEndpoint aws interface create` | N | Y +| `privateEndpoint aws interface delete` | N | Y +| `privateEndpoint aws interface describe` | N | Y +| `privateEndpoint aws create` | Y | Y +| `privateEndpoint aws delete` | Y | Y +| `privateEndpoint aws describe` | Y | Y +| `privateEndpoint aws list` | Y | Y +| `privateEndpoint aws watch` | Y | Y +| `privateEndpoint azure interface create` | N | Y +| `privateEndpoint azure interface delete` | N | Y +| `privateEndpoint azure interface describe` | N | Y +| `privateEndpoint azure create` | Y | Y +| `privateEndpoint azure delete` | Y | Y +| `privateEndpoint azure describe` | Y | Y +| `privateEndpoint azure list` | Y | Y +| `privateEndpoint azure watch` | Y | Y +| `privateEndpoint gcp create` | Y | Y +| `privateEndpoint gcp delete` | Y | Y +| `privateEndpoint gcp list` | Y | Y +| `privateEndpoint gcp descibe` | Y | Y +| `privateEndpoint gcp watch` | Y | Y +| `privateEndpoint dataLake aws create` | Y | Y +| `privateEndpoint dataLake aws list` | Y | Y +| `privateEndpoint dataLake aws delete` | Y | Y +| `privateEndpoint dataLake aws describe` | Y | Y +| `privateEndpoint interface create` | N | Y +| `privateEndpoint interface delete` | N | Y +| `privateEndpoint interface describe` | N | Y +| `privateEndpoint regionalMode describe` | Y | Y +| `privateEndpoint regionalMode enable` | Y | Y +| `privateEndpoint regionalMode disable` | Y | Y +| `process list` | Y | Y +| `quickstart` | Y | Y +| `security customercert create` | N | Y +| `security customercert disable` | N | Y +| `security customercert describe` | N | Y +| `security ldap delete` | Y | Y +| `security ldap describe` | Y | Y +| `security ldap save` | Y | Y +| `security ldap status` | Y | Y +| `security ldap verify` | Y | Y +| `security ldap watch` | Y | Y +| `streams` | | +| `streams connection` | | +| `streams connection create` | Y | Y +| `streams connection delete` | Y | Y +| `streams connection describe` | Y | Y +| `streams connection list` | Y | Y +| `streams connection update` | Y | Y +| `streams instance` | | +| `streams instance create` | Y | Y +| `streams instance delete` | Y | Y +| `streams instance describe` | Y | Y +| `streams instance list` | Y | Y +| `streams instance update` | Y | Y +| `config` | | +| `completion` | Y | Y +| `config delete` | Y | Y +| `config list` | Y | Y +| `config describe` | Y | Y +| `config rename` | Y | Y +| `config set` | | +| `event list` | Y | Y +| `globalAccessList create` | | +| `globalAccessList delete` | | +| `globalAccessList describe` | | +| `globalAccessList list` | | +| `globalApiKey create` | | +| `globalApiKey delete` | | +| `globalApiKey describe` | | +| `globalApiKey list` | | +| `globalApiKey update` | | +| `orgs apiKey accessList create` | Y | Y +| `orgs apiKey accessList delete` | Y | Y +| `orgs apiKey accessList list` | Y | Y +| `orgs apiKey create` | Y | Y +| `orgs apiKey delete` | Y | Y +| `orgs apiKey describe` | Y | Y +| `orgs apiKey list` | Y | Y +| `orgs apiKey update` | Y | Y +| `orgs users list` | N | Y +| `orgs create` | | +| `orgs delete` | N | Y +| `orgs describe` | Y | Y +| `orgs list` | Y | Y +| `orgs invitations list` | Y | Y +| `orgs invitations describe` | Y | Y +| `orgs invitations invite` | Y | Y +| `orgs invitations update` | Y | Y +| `orgs invitations delete` | Y | Y +| `project apiKey create` | Y | Y +| `project apiKey delete` | Y | Y +| `project apiKey describe` | N | Y +| `project apiKey list` | Y | Y +| `project apiKey assign` | Y | Y +| `project users list` | Y | Y +| `project users delete` | N | Y +| `project team add` | N | Y +| `project team delete` | N | Y +| `project team list` | N | Y +| `project team update` | N | Y +| `project create` | Y | Y +| `project delete` | N | Y +| `project describe` | N | Y +| `project list` | N | Y +| `project invitations list` | Y | Y +| `project invitations describe` | Y | Y +| `project invitations invite` | Y | Y +| `project invitations update` | Y | Y +| `project invitations delete` | Y | Y +| `team user add` | Y | Y +| `team user delete` | Y | Y +| `team user list` | Y | Y +| `team create` | Y | Y +| `team delete` | Y | Y +| `team describe` | Y | Y +| `team list` | Y | Y +| `user invite` | N | Y +| `user delete` | N | Y +| `user describe` | Y | Y +| `admin backup blockstore create` | | +| `admin backup blockstore delete` | | +| `admin backup blockstore describe` | | +| `admin backup blockstore list` | | +| `admin backup blockstore update` | | +| `admin backup fileSystem create` | | +| `admin backup fileSystem delete` | | +| `admin backup fileSystem describe` | | +| `admin backup fileSystem list` | | +| `admin backup fileSystem update` | | +| `admin backup oplog create` | | +| `admin backup oplog delete` | | +| `admin backup oplog describe` | | +| `admin backup oplog list` | | +| `admin backup oplog update` | | +| `admin backup s3 create` | | +| `admin backup s3 delete` | | +| `admin backup s3 describe` | | +| `admin backup s3 list` | | +| `admin backup s3 update` | | +| `admin backup sync create` | | +| `admin backup sync delete` | | +| `admin backup sync describe` | | +| `admin backup sync list` | | +| `admin backup sync update` | | +| `agent apikeys create` | | +| `agent apikeys delete` | | +| `agent apikeys list` | | +| `agent version list` | | +| `agent list` | | +| `agent upgrade` | | +| `automation describe` | | +| `automation status` | | +| `automation update` | | +| `automation watch` | | +| `cluster apply` | | +| `cluster create` | | +| `cluster delete` | | +| `cluster describe` | | +| `cluster list` | | +| `cluster restart` | | +| `cluster shutdown` | | +| `cluster startup` | | +| `cluster unmanage` | | +| `cluster update` | | +| `cluster reclaimFreeSpace` | | +| `cluster index create` | | +| `dbuser create` | | +| `dbuser delete` | | +| `dbuser list` | | +| `diagnose-archive download` | | +| `featurePolicy list` | | +| `featurePolicy update` | | +| `logs jobs collect` | | +| `logs jobs download` | | +| `logs jobs delete` | | +| `logs jobs list` | | +| `logs decrypt` | | +| `logs keyProvider list` | | +| `maintenanceWindows create` | | +| `maintenanceWindows delete` | | +| `maintenanceWindows list` | | +| `maintenanceWindows update` | | +| `database describe` | | +| `database list` | | +| `disk describe` | | +| `disk list` | | +| `process` | | +| `process describe` | | +| `process list` | | +| `security enable` | | +| `monitoring enable` | | +| `monitoring disable` | | +| `monitoring stop` | | +| `owner create` | | +| `server list` | | +| `softwareComponent list` | | +| `versionManifest update` | | +| `serverUsage orgs hosts list` | | +| `serverUsage orgs serverType get` | | +| `serverUsage orgs serverType set` | | +| `serverUsage project hosts list` | | +| `serverUsage project serverType get` | | +| `serverUsage projet serverType set` | | +| `serverUsage capture` | | +| `serverUsage download` | | +| `performanceAdvisor namespace list` | Y | Y +| `performanceAdvisor slowQueryLogs list` | Y | Y +| `performanceAdvisor suggestedIndexes list` | Y | Y +| `performanceAdvisor slowOT enable` | Y | Y +| `performanceAdvisor slowOT disable` | Y | Y +| `serverless create` | Y | Y +| `serverless delete` | Y | Y +| `serverless describe` | Y | Y +| `serverless list` | Y | Y +| `serverless watch` | Y | Y +| `serverless update` | Y | Y +| `serverless backup snapshots list` | Y | Y +| `serverless backup snapshots describe` | Y | Y +| `serverless backup snapshots watch` | Y | Y +| `livemigrations link create` | Y | Y +| `livemigrations link delete` | Y | Y +| `livemigrations validation create` | | Y +| `livemigrations create` | | Y +| `livemigrations cutover` | N | Y +| `completion bash` | Y | Y +| `completion zsh` | Y | Y +| `completion fish` | Y | Y +| `completion powershell` | Y | Y +| `setup` | Y | Y +| `register` | N | Y +| `kubernetes config generate` | Y | Y +| `kubernetes config apply` | Y | Y +| `kubernetes operator install` | Y | Y From 7b333d90fda018cc6a0dde3f8ed872d1bd387369 Mon Sep 17 00:00:00 2001 From: Filipe C Menezes Date: Fri, 1 Mar 2024 14:25:02 +0000 Subject: [PATCH 10/16] file renames --- CHANGELOG_ATLASCLI.md => CHANGELOG.md | 0 CONTRIBUTING.md | 4 +- Makefile | 2 +- build/ci/release.yml | 8 --- ...tlascli.goreleaser.yml => .goreleaser.yml} | 3 +- ...lascli_mac_notarize.sh => mac_notarize.sh} | 0 build/package/package.sh | 4 +- tools/{atlasclidocs => docs}/main.go | 0 tools/mongoclidocs/main.go | 61 ------------------- 9 files changed, 6 insertions(+), 76 deletions(-) rename CHANGELOG_ATLASCLI.md => CHANGELOG.md (100%) rename build/package/{.atlascli.goreleaser.yml => .goreleaser.yml} (98%) rename build/package/{atlascli_mac_notarize.sh => mac_notarize.sh} (100%) rename tools/{atlasclidocs => docs}/main.go (100%) delete mode 100644 tools/mongoclidocs/main.go diff --git a/CHANGELOG_ATLASCLI.md b/CHANGELOG.md similarity index 100% rename from CHANGELOG_ATLASCLI.md rename to CHANGELOG.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 104f5e5978..17c50f98f9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -158,8 +158,8 @@ For example please edit `./root/atlas/builder.go` to add your command builder me ### Adding a New Command -`atlascli` and `mongocli` have defined a basic structure for individual commands that should be followed. -For a `mongocli scope newCommand` command, a file `internal/cli/scope/new_command.go` should implement: +`atlascli` have defined a basic structure for individual commands that should be followed. +For a `atlas scope newCommand` command, a file `internal/cli/scope/new_command.go` should implement: - A `ScopeNewCommandOpts` struct which handles the different options for the command. - At least a `func (opts *ScopeNewCommandOpts) Run() error` function with the main command logic. diff --git a/Makefile b/Makefile index 81c120129d..8953642f4b 100644 --- a/Makefile +++ b/Makefile @@ -109,7 +109,7 @@ gen-mocks: ## Generate mocks .PHONY: gen-docs gen-docs: @echo "==> Generating docs" - go run -ldflags "$(ATLAS_LINKER_FLAGS)" ./tools/atlasclidocs/main.go + go run -ldflags "$(ATLAS_LINKER_FLAGS)" ./tools/docs/main.go .PHONY: build build: diff --git a/build/ci/release.yml b/build/ci/release.yml index f39f0ff2d1..42bf772563 100644 --- a/build/ci/release.yml +++ b/build/ci/release.yml @@ -87,8 +87,6 @@ functions: - notary_service_url - goreleaser_key - tool_name - - goreleaser_config - - changelog_file - github_token - unstable binary: build/package/package.sh @@ -314,8 +312,6 @@ tasks: vars: unstable: ${unstable} tool_name: ${tool_name} - goreleaser_config: ${goreleaser_file} - changelog_file: ${changelog_file} ARTIFACTORY_USERNAME: ${artifactory_username} ARTIFACTORY_PASSWORD: ${artifactory_password} GRS_USERNAME: ${garasign_username} @@ -447,8 +443,6 @@ buildvariants: expansions: <<: *go_linux_version server_version: "4.4.0-rc3" - goreleaser_file: "build/package/.atlascli.goreleaser.yml" - changelog_file: CHANGELOG_ATLASCLI.md package_name: "mongodb-atlas-cli" meta_package_name: "mongodb-atlas" tool_name: "atlascli" @@ -476,8 +470,6 @@ buildvariants: expansions: <<: *go_linux_version server_version: "4.4.0-rc3" - goreleaser_file: "build/package/.atlascli.goreleaser.yml" - changelog_file: CHANGELOG_ATLASCLI.md package_name: "mongodb-atlas-cli" meta_package_name: "mongodb-atlas" tool_name: "atlascli" diff --git a/build/package/.atlascli.goreleaser.yml b/build/package/.goreleaser.yml similarity index 98% rename from build/package/.atlascli.goreleaser.yml rename to build/package/.goreleaser.yml index a2b62a23d9..0fb58b5833 100644 --- a/build/package/.atlascli.goreleaser.yml +++ b/build/package/.goreleaser.yml @@ -26,7 +26,7 @@ builds: hooks: # This will notarize Apple binaries and replace goreleaser bins with the notarized ones post: - - cmd: ./build/package/atlascli_mac_notarize.sh + - cmd: ./build/package/mac_notarize.sh output: true - <<: *build_defaults builder: prebuilt @@ -60,7 +60,6 @@ archives: <<: &archive_defaults files: - README.md - - atlascli.md - LICENSE - LICENSING-NOTES.txt - third_party_notices/**/* diff --git a/build/package/atlascli_mac_notarize.sh b/build/package/mac_notarize.sh similarity index 100% rename from build/package/atlascli_mac_notarize.sh rename to build/package/mac_notarize.sh diff --git a/build/package/package.sh b/build/package/package.sh index a714e92d61..e7c44d136b 100755 --- a/build/package/package.sh +++ b/build/package/package.sh @@ -28,10 +28,10 @@ VERSION_GIT="$(git tag --list "${tool_name:?}/v*" --sort=taggerdate | tail -1 | if [[ "${unstable-}" == "-unstable" ]]; then # avoid race conditions on the notarization step by using `-p 1` - ./bin/goreleaser --config "${goreleaser_config:?}" --rm-dist --release-notes "${changelog_file:?}" --snapshot -p 1 + ./bin/goreleaser --config "build/package/.goreleaser.yml" --rm-dist --release-notes "CHANGELOG.md" --snapshot -p 1 else # avoid race conditions on the notarization step by using `-p 1` - ./bin/goreleaser --config "${goreleaser_config:?}" --rm-dist --release-notes "${changelog_file:?}" -p 1 + ./bin/goreleaser --config "build/package/.goreleaser.yml" --rm-dist --release-notes "CHANGELOG.md" -p 1 fi # check that the notarization service signed the mac binaries diff --git a/tools/atlasclidocs/main.go b/tools/docs/main.go similarity index 100% rename from tools/atlasclidocs/main.go rename to tools/docs/main.go diff --git a/tools/mongoclidocs/main.go b/tools/mongoclidocs/main.go deleted file mode 100644 index c0b852d118..0000000000 --- a/tools/mongoclidocs/main.go +++ /dev/null @@ -1,61 +0,0 @@ -// Copyright 2021 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 main - -import ( - "log" - "os" - - "github.com/mongodb-labs/cobra2snooty" - "github.com/mongodb/mongodb-atlas-cli/internal/cli/root/mongocli" - "github.com/spf13/cobra" -) - -func setDisableAutoGenTag(cmd *cobra.Command) { - cmd.DisableAutoGenTag = true - for _, cmd := range cmd.Commands() { - setDisableAutoGenTag(cmd) - } -} - -func main() { - if err := os.RemoveAll("./docs/mongocli/command"); err != nil { - log.Fatal(err) - } - - var profile string - const docsPermissions = 0766 - if err := os.MkdirAll("./docs/mongocli/command", docsPermissions); err != nil { - log.Fatal(err) - } - - mongocliBuilder := mongocli.Builder(&profile, []string{}) - mongocliBuilder.InitDefaultCompletionCmd() - removeDeprecateStringAtlasCommand(mongocliBuilder) - setDisableAutoGenTag(mongocliBuilder) - - if err := cobra2snooty.GenTreeDocs(mongocliBuilder, "./docs/mongocli/command"); err != nil { - log.Fatal(err) - } -} - -func removeDeprecateStringAtlasCommand(cmd *cobra.Command) { - for _, c := range cmd.Commands() { - if c.Use == "atlas" { - c.Long = "" - return - } - } -} From e7aa18179288ea7d0a97dc91461de9fbfef42fa9 Mon Sep 17 00:00:00 2001 From: Filipe C Menezes Date: Fri, 1 Mar 2024 14:33:35 +0000 Subject: [PATCH 11/16] simplify some files --- build/package/docker/docker-build.sh | 8 ++------ build/package/generate-msi.sh | 12 +++--------- build/package/rename-pkg.sh | 25 +++++++++---------------- build/package/windows_notarize.sh | 8 ++------ build/package/wix/mongocli.json | 27 --------------------------- 5 files changed, 16 insertions(+), 64 deletions(-) delete mode 100644 build/package/wix/mongocli.json diff --git a/build/package/docker/docker-build.sh b/build/package/docker/docker-build.sh index 01eb14964d..75752d4e18 100755 --- a/build/package/docker/docker-build.sh +++ b/build/package/docker/docker-build.sh @@ -23,12 +23,8 @@ if [[ "${image-}" =~ "rpm" ]]; then FILE_EXT=rpm fi -URL=https://mongodb-mongocli-build.s3.amazonaws.com/${project-}/dist/${revision-}_${created_at-}/mongocli_${VERSION}-next_linux_x86_64.${FILE_EXT} -ENTRYPOINT=mongocli -if [[ "${tool_name:?}" == atlascli ]]; then - URL=https://mongodb-mongocli-build.s3.amazonaws.com/${project-}/dist/${revision-}_${created_at-}/mongodb-atlas-cli_${VERSION}-next_linux_x86_64.${FILE_EXT} - ENTRYPOINT=atlas -fi +URL=https://mongodb-mongocli-build.s3.amazonaws.com/${project-}/dist/${revision-}_${created_at-}/mongodb-atlas-cli_${VERSION}-next_linux_x86_64.${FILE_EXT} +ENTRYPOINT=atlas docker build \ --build-arg url="${URL-}" \ diff --git a/build/package/generate-msi.sh b/build/package/generate-msi.sh index 5470492746..083e4eb506 100755 --- a/build/package/generate-msi.sh +++ b/build/package/generate-msi.sh @@ -30,18 +30,12 @@ fi COMMIT=$(git log -n1 --format=format:"%H") -SOURCE_FILES=./cmd/mongocli -PACKAGE_NAME=mongocli_${VERSION_NAME}_windows_x86_64.msi -OUTPUT=./bin/mongocli.exe +SOURCE_FILES=./cmd/atlas +PACKAGE_NAME=mongodb-atlas-cli_${VERSION_NAME}_windows_x86_64.msi +OUTPUT=./bin/atlas.exe LINKER_FLAGS="-s -w -X github.com/mongodb/mongodb-atlas-cli/internal/version.Version=${VERSION_GIT} -X github.com/mongodb/mongodb-atlas-cli/internal/version.GitCommit=${COMMIT} -X github.com/mongodb/mongodb-atlas-cli/internal/config.ToolName=${TOOL_NAME:?}" WIX_MANIFEST_FILE="./build/package/wix/${TOOL_NAME:?}.json" -if [[ "${TOOL_NAME:?}" == atlascli ]]; then - SOURCE_FILES=./cmd/atlas - PACKAGE_NAME=mongodb-atlas-cli_${VERSION_NAME}_windows_x86_64.msi - OUTPUT=./bin/atlas.exe -fi - env GOOS=windows GOARCH=amd64 go build \ -ldflags "${LINKER_FLAGS}" -o ${OUTPUT} "${SOURCE_FILES}" diff --git a/build/package/rename-pkg.sh b/build/package/rename-pkg.sh index 00e161934f..37f3da42c2 100755 --- a/build/package/rename-pkg.sh +++ b/build/package/rename-pkg.sh @@ -41,19 +41,12 @@ function rename { } # we could generate a similar name with goreleaser but we want to keep the vars evg compatible to use later -if [[ "${package_name:?}" == mongocli ]]; then - rename "${FILENAME}.deb" "apt/x86_64/mongodb-cli${unstable-}_${VERSION}${latest_deb-}_amd64.deb" - rename "${FILENAME_ARM}.deb" "apt/arm64/mongodb-cli${unstable-}_${VERSION}${latest_deb-}_arm64.deb" - rename "${FILENAME}.rpm" "yum/x86_64/mongodb-cli${unstable-}-${VERSION}${latest_rpm-}.x86_64.rpm" - rename "${FILENAME_ARM}.rpm" "yum/arm64/mongodb-cli${unstable-}-${VERSION}${latest_rpm-}.aarch64.rpm" -else - rename "${FILENAME}.deb" "apt/x86_64/mongodb-atlas-cli${unstable-}_${VERSION}${latest_deb-}_amd64.deb" - rename "${FILENAME_ARM}.deb" "apt/arm64/mongodb-atlas-cli${unstable-}_${VERSION}${latest_deb-}_arm64.deb" - rename "${FILENAME}.rpm" "yum/x86_64/mongodb-atlas-cli${unstable-}-${VERSION}${latest_rpm-}.x86_64.rpm" - rename "${FILENAME_ARM}.rpm" "yum/arm64/mongodb-atlas-cli${unstable-}-${VERSION}${latest_rpm-}.aarch64.rpm" - - rename "${META_FILENAME}.deb" "apt/x86_64/mongodb-atlas${unstable-}_${VERSION}${latest_deb-}_amd64.deb" - rename "${META_FILENAME_ARM}.deb" "apt/arm64/mongodb-atlas${unstable-}_${VERSION}${latest_deb-}_arm64.deb" - rename "${META_FILENAME}.rpm" "yum/x86_64/mongodb-atlas${unstable-}-${VERSION}${latest_rpm-}.x86_64.rpm" - rename "${META_FILENAME_ARM}.rpm" "yum/arm64/mongodb-atlas${unstable-}-${VERSION}${latest_rpm-}.aarch64.rpm" -fi +rename "${FILENAME}.deb" "apt/x86_64/mongodb-atlas-cli${unstable-}_${VERSION}${latest_deb-}_amd64.deb" +rename "${FILENAME_ARM}.deb" "apt/arm64/mongodb-atlas-cli${unstable-}_${VERSION}${latest_deb-}_arm64.deb" +rename "${FILENAME}.rpm" "yum/x86_64/mongodb-atlas-cli${unstable-}-${VERSION}${latest_rpm-}.x86_64.rpm" +rename "${FILENAME_ARM}.rpm" "yum/arm64/mongodb-atlas-cli${unstable-}-${VERSION}${latest_rpm-}.aarch64.rpm" + +rename "${META_FILENAME}.deb" "apt/x86_64/mongodb-atlas${unstable-}_${VERSION}${latest_deb-}_amd64.deb" +rename "${META_FILENAME_ARM}.deb" "apt/arm64/mongodb-atlas${unstable-}_${VERSION}${latest_deb-}_arm64.deb" +rename "${META_FILENAME}.rpm" "yum/x86_64/mongodb-atlas${unstable-}-${VERSION}${latest_rpm-}.x86_64.rpm" +rename "${META_FILENAME_ARM}.rpm" "yum/arm64/mongodb-atlas${unstable-}-${VERSION}${latest_rpm-}.aarch64.rpm" diff --git a/build/package/windows_notarize.sh b/build/package/windows_notarize.sh index 9d9eb73f2e..20904f915e 100755 --- a/build/package/windows_notarize.sh +++ b/build/package/windows_notarize.sh @@ -16,12 +16,8 @@ set -Eeou pipefail -EXE_FILE="dist/windows_windows_amd64_v1/bin/mongocli.exe" -MSI_FILE="bin/mongocli_${VERSION}_windows_x86_64.msi" -if [[ "${TOOL_NAME:?}" == atlascli ]]; then - EXE_FILE="dist/windows_windows_amd64_v1/bin/atlas.exe" - MSI_FILE="bin/mongodb-atlas-cli_${VERSION}_windows_x86_64.msi" -fi +EXE_FILE="dist/windows_windows_amd64_v1/bin/atlas.exe" +MSI_FILE="bin/mongodb-atlas-cli_${VERSION}_windows_x86_64.msi" if [[ -f "$EXE_FILE" && -f "$MSI_FILE" ]]; then echo "${ARTIFACTORY_PASSWORD}" | podman login --password-stdin --username "${ARTIFACTORY_USERNAME}" artifactory.corp.mongodb.com diff --git a/build/package/wix/mongocli.json b/build/package/wix/mongocli.json deleted file mode 100644 index 590569e3a5..0000000000 --- a/build/package/wix/mongocli.json +++ /dev/null @@ -1,27 +0,0 @@ -{ - "product": "MongoDB CLI", - "company": "MongoDB, Inc.", - "license": "LICENSE", - "upgrade-code": "a995cda5-9731-4158-910c-c8d15371dbda", - "files": { - "guid": "c7b0df57-c3c1-4591-becd-f0f73a912eb8", - "items": [ - "bin/mongocli.exe" - ] - }, - "env": { - "guid": "94faac3d-4478-431c-8497-fba55dcfb249", - "vars": [ - { - "name": "PATH", - "value": "[INSTALLDIR]", - "permanent": "yes", - "system": "no", - "action": "set", - "part": "last" - } - ] - }, - "shortcuts": {}, - "choco": {} -} From 47eb9091eca43da0cfd38dba92eb6c828f7be68c Mon Sep 17 00:00:00 2001 From: Filipe C Menezes Date: Fri, 1 Mar 2024 15:51:44 +0000 Subject: [PATCH 12/16] fix config test --- test/e2e/config/config_test.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/e2e/config/config_test.go b/test/e2e/config/config_test.go index aad310d5a2..dfe66b0d4d 100644 --- a/test/e2e/config/config_test.go +++ b/test/e2e/config/config_test.go @@ -59,7 +59,7 @@ func TestConfig(t *testing.T) { } defer c.Close() - cmd := exec.Command(cliPath, configEntity, "-P", "e2e-expect") + cmd := exec.Command(cliPath, configEntity, "init", "-P", "e2e-expect") cmd.Stdin = c.Tty() cmd.Stdout = c.Tty() cmd.Stderr = c.Tty() From 40e13904e880663805a53e789aa066ca5a6cc13b Mon Sep 17 00:00:00 2001 From: Filipe C Menezes Date: Fri, 1 Mar 2024 16:34:41 +0000 Subject: [PATCH 13/16] remove mongocli iam tests --- Makefile | 6 +- examples/ops-manager/create-replica-set.md | 11 -- .../ops-manager/create-sharded-cluster.md | 14 -- examples/ops-manager/replica-set.json | 31 ---- examples/ops-manager/sharded-cluster.json | 93 ---------- examples/ops-manager/update_all_agents.md | 5 - test/e2e/iam/org_api_key_access_list_test.go | 129 ------------- test/e2e/iam/org_api_keys_test.go | 134 -------------- test/e2e/iam/org_invitations_test.go | 155 ---------------- test/e2e/iam/orgs_test.go | 78 -------- test/e2e/iam/project_api_keys_test.go | 111 ----------- test/e2e/iam/project_invitations_test.go | 174 ------------------ test/e2e/iam/project_teams_test.go | 146 --------------- test/e2e/iam/projects_test.go | 119 ------------ test/e2e/iam/team_users_test.go | 113 ------------ test/e2e/iam/teams_test.go | 131 ------------- 16 files changed, 3 insertions(+), 1447 deletions(-) delete mode 100644 examples/ops-manager/create-replica-set.md delete mode 100644 examples/ops-manager/create-sharded-cluster.md delete mode 100644 examples/ops-manager/replica-set.json delete mode 100644 examples/ops-manager/sharded-cluster.json delete mode 100644 examples/ops-manager/update_all_agents.md delete mode 100644 test/e2e/iam/org_api_key_access_list_test.go delete mode 100644 test/e2e/iam/org_api_keys_test.go delete mode 100644 test/e2e/iam/org_invitations_test.go delete mode 100644 test/e2e/iam/orgs_test.go delete mode 100644 test/e2e/iam/project_api_keys_test.go delete mode 100644 test/e2e/iam/project_invitations_test.go delete mode 100644 test/e2e/iam/project_teams_test.go delete mode 100644 test/e2e/iam/projects_test.go delete mode 100644 test/e2e/iam/team_users_test.go delete mode 100644 test/e2e/iam/teams_test.go diff --git a/Makefile b/Makefile index 8953642f4b..f479270f0d 100644 --- a/Makefile +++ b/Makefile @@ -107,17 +107,17 @@ gen-mocks: ## Generate mocks go generate ./internal... .PHONY: gen-docs -gen-docs: +gen-docs: ## Generate docs for atlascli commands @echo "==> Generating docs" go run -ldflags "$(ATLAS_LINKER_FLAGS)" ./tools/docs/main.go .PHONY: build -build: +build: ## Generate an atlas binary in ./bin @echo "==> Building $(ATLAS_BINARY_NAME) binary" go build -ldflags "$(ATLAS_LINKER_FLAGS)" -o $(ATLAS_DESTINATION) $(ATLAS_SOURCE_FILES) .PHONY: build-debug -build-debug: +build-debug: ## Generate a binary in ./bin for debugging atlascli @echo "==> Building $(ATLAS_BINARY_NAME) binary for debugging" go build -gcflags="$(DEBUG_FLAGS)" -ldflags "$(ATLAS_LINKER_FLAGS)" -o $(ATLAS_DESTINATION) $(ATLAS_SOURCE_FILES) diff --git a/examples/ops-manager/create-replica-set.md b/examples/ops-manager/create-replica-set.md deleted file mode 100644 index 469750828b..0000000000 --- a/examples/ops-manager/create-replica-set.md +++ /dev/null @@ -1,11 +0,0 @@ -# Creating a Replica Set Cluster - -To create a replica set cluster you'll need to define a list of process. - -The included [replica-set.json](examples/ops-manager/replica-set.json), -defines a replica set with three members. -This file can be modified according to your needs and applied using: - -```bash -mongocli om clusters create -f replica-set.json --projectId -``` diff --git a/examples/ops-manager/create-sharded-cluster.md b/examples/ops-manager/create-sharded-cluster.md deleted file mode 100644 index 07d66fea6c..0000000000 --- a/examples/ops-manager/create-sharded-cluster.md +++ /dev/null @@ -1,14 +0,0 @@ -# Creating a Sharded Cluster - -To create a sharded cluster you'll need to define a configuration file that includes -a list of shards, each one with their list of process, -a configuration replica set, also with its list of process -and finally a list of mongos process definitions. - -The included [sharded-cluster.json](examples/ops-manager/sharded-cluster.json), -defines a sharded cluster with two shards, each as a three members replica set -and a single mongos. This file can be modified according to your needs and applied using: - -```bash -mongocli om clusters create -f sharded-cluster.json --projectId -``` diff --git a/examples/ops-manager/replica-set.json b/examples/ops-manager/replica-set.json deleted file mode 100644 index 3f28a1f9ac..0000000000 --- a/examples/ops-manager/replica-set.json +++ /dev/null @@ -1,31 +0,0 @@ -{ - "name": "myReplicaSet", - "version": "4.2.2", - "featureCompatibilityVersion": "4.2", - "processes": [ - { - "hostname": "host0.example", - "dbPath": "/data/myReplicaSet/30010", - "logPath": "/data/myReplicaSet/30010/mongodb.log", - "priority": 1, - "votes": 1, - "port": 30010 - }, - { - "hostname": "host1.example", - "dbPath": "/data/myReplicaSet/30020", - "logPath": "/data/myReplicaSet/30020/mongodb.log", - "priority": 1, - "votes": 1, - "port": 30020 - }, - { - "hostname": "host2.example", - "dbPath": "/data/myReplicaSet/30030", - "logPath": "/data/myReplicaSet/30030/mongodb.log", - "priority": 1, - "votes": 1, - "port": 30030 - } - ] -} diff --git a/examples/ops-manager/sharded-cluster.json b/examples/ops-manager/sharded-cluster.json deleted file mode 100644 index a4f7e9aa60..0000000000 --- a/examples/ops-manager/sharded-cluster.json +++ /dev/null @@ -1,93 +0,0 @@ -{ - "name": "myCluster", - "featureCompatibilityVersion": "4.2", - "version": "4.2.8-ent", - "shards": [ - { - "name": "myShard_0", - "processes": [ - { - "dbPath": "/data/myCluster/myShard_0/27000", - "hostname": "host0.example", - "logPath": "/data/myCluster/myShard_0/27000/mongodb.log", - "port": 27000, - "votes": 1 - }, - { - "dbPath": "/data/myCluster/myShard_0/27001", - "hostname": "host1.example", - "logPath": "/data/myCluster/myShard_0/27001/mongodb.log", - "port": 27001, - "votes": 1 - }, - { - "dbPath": "/data/myCluster/myShard_0/27002", - "hostname": "host2.example", - "logPath": "/data/myCluster/myShard_0/27002/mongodb.log", - "port": 27002, - "version": "4.2.8-ent", - "votes": 1 - } - ] - }, - { - "name": "myShard_1", - "processes": [ - { - "dbPath": "/data/myCluster/myShard_1/28000", - "hostname": "host3.example", - "logPath": "/data/myCluster/myShard_1/28000/mongodb.log", - "port": 28000, - "votes": 1 - }, - { - "dbPath": "/data/myCluster/myShard_1/28001", - "hostname": "host4.example", - "logPath": "/data/myCluster/myShard_1/28001/mongodb.log", - "port": 28001, - "votes": 1 - }, - { - "dbPath": "/data/myCluster/myShard_1/28002", - "hostname": "host5.example", - "logPath": "/data/myCluster/myShard_1/28002/mongodb.log", - "port": 28002, - "votes": 1 - } - ] - } - ], - "config": { - "name": "configRS", - "processes": [ - { - "dbPath": "/data/myCluster/configRS/29000", - "hostname": "host6.example", - "logPath": "/data/myCluster/configRS/29000/mongodb.log", - "port": 29000, - "votes": 1 - }, - { - "dbPath": "/data/myCluster/configRS/29001", - "hostname": "host7.example", - "logPath": "/data/myCluster/configRS/29001/mongodb.log", - "port": 29001, - "votes": 1 - }, - { - "dbPath": "/data/myCluster/configRS/29002", - "hostname": "host8.example", - "logPath": "/data/myCluster/configRS/29002/mongodb.log", - "port": 29002, - "votes": 1 - } - ] - }, - "mongos": [ - { - "hostname": "host9.example", - "logPath": "/data/myCluster/mongoses/27015/mongodb.log", - "port": 27015 - } - ] -} diff --git a/examples/ops-manager/update_all_agents.md b/examples/ops-manager/update_all_agents.md deleted file mode 100644 index 6769e4a3fe..0000000000 --- a/examples/ops-manager/update_all_agents.md +++ /dev/null @@ -1,5 +0,0 @@ -# Update all automation agents - -```bash -mongocli iam projects list | awk '{if (NR!=1) {print $1}}' | xargs -I % sh -c "echo 'Updating agents for Project %'; mongocli om agents upgrade --projectId %" -``` diff --git a/test/e2e/iam/org_api_key_access_list_test.go b/test/e2e/iam/org_api_key_access_list_test.go deleted file mode 100644 index 07e997f705..0000000000 --- a/test/e2e/iam/org_api_key_access_list_test.go +++ /dev/null @@ -1,129 +0,0 @@ -// Copyright 2020 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. - -//go:build e2e || (iam && !atlas) - -package iam_test - -import ( - "encoding/json" - "fmt" - "os" - "os/exec" - "testing" - - "github.com/mongodb/mongodb-atlas-cli/test/e2e" - "github.com/stretchr/testify/assert" - "github.com/stretchr/testify/require" - "go.mongodb.org/atlas/mongodbatlas" -) - -func TestOrgAPIKeyAccessList(t *testing.T) { - cliPath, er := e2e.AtlasCLIBin() - require.NoError(t, er) - - apiKeyID, e := createOrgAPIKey() - require.NoError(t, e) - - t.Cleanup(func() { - require.NoError(t, deleteOrgAPIKey(apiKeyID)) - }) - - n, err := e2e.RandInt(255) - require.NoError(t, err) - entry := fmt.Sprintf("192.168.0.%d", n) - - t.Run("Create", func(t *testing.T) { - cmd := exec.Command(cliPath, - orgEntity, - apiKeysEntity, - apiKeyAccessListEntity, - "create", - "--apiKey", - apiKeyID, - "--ip", - entry, - "-o=json") - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - require.NoError(t, err, string(resp)) - var key mongodbatlas.AccessListAPIKeys - require.NoError(t, json.Unmarshal(resp, &key)) - assert.NotEmpty(t, key.Results) - }) - - t.Run("List", func(t *testing.T) { - cmd := exec.Command(cliPath, - orgEntity, - apiKeysEntity, - apiKeyAccessListEntity, - "list", - apiKeyID, - "-o=json") - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - require.NoError(t, err, string(resp)) - var key mongodbatlas.AccessListAPIKeys - require.NoError(t, json.Unmarshal(resp, &key)) - assert.NotEmpty(t, key.Results) - }) - - t.Run("Delete", func(t *testing.T) { - deleteAccessListEntry(t, cliPath, entry, apiKeyID) - }) - - t.Run("Create Current IP", func(t *testing.T) { - t.Skip("400 (request \"CANNOT_REMOVE_CALLER_FROM_ACCESS_LIST\") Cannot remove caller's IP address from access list") - cmd := exec.Command(cliPath, - orgEntity, - apiKeysEntity, - apiKeyAccessListEntity, - "create", - "--apiKey", - apiKeyID, - "--currentIp", - "-o=json") - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - a := assert.New(t) - require.NoError(t, err, string(resp)) - var key mongodbatlas.AccessListAPIKeys - require.NoError(t, json.Unmarshal(resp, &key)) - a.NotEmpty(key.Results) - entry = key.Results[0].IPAddress - }) - - t.Run("Delete", func(t *testing.T) { - t.Skip("400 (request \"CANNOT_REMOVE_CALLER_FROM_ACCESS_LIST\") Cannot remove caller's IP address from access list") - deleteAccessListEntry(t, cliPath, entry, apiKeyID) - }) -} - -func deleteAccessListEntry(t *testing.T, cliPath, entry, apiKeyID string) { - t.Helper() - cmd := exec.Command(cliPath, - orgEntity, - apiKeysEntity, - apiKeyAccessListEntity, - "rm", - entry, - "--apiKey", - apiKeyID, - "--force") - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - require.NoError(t, err, string(resp)) - expected := fmt.Sprintf("Access list entry '%s' deleted\n", entry) - assert.Equal(t, expected, string(resp)) -} diff --git a/test/e2e/iam/org_api_keys_test.go b/test/e2e/iam/org_api_keys_test.go deleted file mode 100644 index 8b8a588212..0000000000 --- a/test/e2e/iam/org_api_keys_test.go +++ /dev/null @@ -1,134 +0,0 @@ -// Copyright 2020 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. -//go:build e2e || (iam && !atlas) - -package iam_test - -import ( - "encoding/json" - "fmt" - "os" - "os/exec" - "testing" - - "github.com/mongodb/mongodb-atlas-cli/test/e2e" - "github.com/stretchr/testify/assert" - "github.com/stretchr/testify/require" - "go.mongodb.org/atlas/mongodbatlas" -) - -func TestOrgAPIKeys(t *testing.T) { - cliPath, err := e2e.AtlasCLIBin() - if err != nil { - t.Fatalf("unexpected error: %v", err) - } - - var ID string - - // This test must run first to grab the ID of the org to later describe - t.Run("Create", func(t *testing.T) { - desc := "e2e-test-org" - cmd := exec.Command(cliPath, - orgEntity, - apiKeysEntity, - "create", - "--desc", - desc, - "--role=ORG_READ_ONLY", - "-o=json") - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - a := assert.New(t) - require.NoError(t, err, string(resp)) - var key mongodbatlas.APIKey - require.NoError(t, json.Unmarshal(resp, &key)) - a.Equal(desc, key.Desc) - ID = key.ID - }) - if ID == "" { - assert.FailNow(t, "Failed to create API key") - } - - t.Run("List", func(t *testing.T) { - cmd := exec.Command(cliPath, - orgEntity, - apiKeysEntity, - "ls", - "-o=json") - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - - if err != nil { - t.Fatalf("unexpected error: %v, resp: %v", err, string(resp)) - } - var keys []mongodbatlas.APIKey - if err := json.Unmarshal(resp, &keys); err != nil { - t.Fatalf("unexpected error: %v", err) - } - assert.NotEmpty(t, keys) - }) - - t.Run("Update", func(t *testing.T) { - newDesc := "e2e-test-org-updated" - cmd := exec.Command(cliPath, - orgEntity, - apiKeysEntity, - "updates", - ID, - "--desc", - newDesc, - "--role=ORG_READ_ONLY", - "-o=json") - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - a := assert.New(t) - require.NoError(t, err, string(resp)) - var key mongodbatlas.APIKey - require.NoError(t, json.Unmarshal(resp, &key)) - a.Equal(newDesc, key.Desc) - }) - - t.Run("Describe", func(t *testing.T) { - cmd := exec.Command(cliPath, - orgEntity, - apiKeysEntity, - "describe", - ID, - "-o=json") - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - - a := assert.New(t) - require.NoError(t, err, string(resp)) - var key mongodbatlas.APIKey - require.NoError(t, json.Unmarshal(resp, &key)) - a.Equal(ID, key.ID) - }) - - t.Run("Delete", func(t *testing.T) { - cmd := exec.Command(cliPath, - orgEntity, - apiKeysEntity, - "rm", - ID, - "--force") - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - - a := assert.New(t) - require.NoError(t, err, string(resp)) - expected := fmt.Sprintf("API Key '%s' deleted\n", ID) - a.Equal(expected, string(resp)) - }) -} diff --git a/test/e2e/iam/org_invitations_test.go b/test/e2e/iam/org_invitations_test.go deleted file mode 100644 index 5d449d9e5e..0000000000 --- a/test/e2e/iam/org_invitations_test.go +++ /dev/null @@ -1,155 +0,0 @@ -// Copyright 2021 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. -//go:build e2e || (iam && !atlas) - -package iam_test - -import ( - "encoding/json" - "fmt" - "os" - "os/exec" - "testing" - - "github.com/mongodb/mongodb-atlas-cli/test/e2e" - "github.com/stretchr/testify/assert" - "github.com/stretchr/testify/require" - "go.mongodb.org/atlas/mongodbatlas" -) - -func TestOrgInvitations(t *testing.T) { - cliPath, err := e2e.AtlasCLIBin() - if err != nil { - t.Fatalf("unexpected error: %v", err) - } - - n, err := e2e.RandInt(1000) - require.NoError(t, err) - - emailOrg := fmt.Sprintf("test-%v@mongodb.com", n) - var orgInvitationID string - - t.Run("Invite", func(t *testing.T) { - cmd := exec.Command(cliPath, - orgEntity, - invitationsEntity, - "invite", - emailOrg, - "--role", - "ORG_MEMBER", - "-o=json") - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - a := assert.New(t) - require.NoError(t, err, string(resp)) - - var invitation mongodbatlas.Invitation - require.NoError(t, json.Unmarshal(resp, &invitation)) - a.Equal(emailOrg, invitation.Username) - require.NotEmpty(t, invitation.ID) - orgInvitationID = invitation.ID - }) - - t.Run("List", func(t *testing.T) { - cmd := exec.Command(cliPath, - orgEntity, - invitationsEntity, - "ls", - "-o=json") - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - require.NoError(t, err, string(resp)) - - a := assert.New(t) - - var invitations []mongodbatlas.Invitation - require.NoError(t, json.Unmarshal(resp, &invitations)) - a.NotEmpty(invitations) - }) - - t.Run("Describe", func(t *testing.T) { - cmd := exec.Command(cliPath, - orgEntity, - invitationsEntity, - "get", - orgInvitationID, - "-o=json") - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - require.NoError(t, err, string(resp)) - - a := assert.New(t) - - var invitation mongodbatlas.Invitation - require.NoError(t, json.Unmarshal(resp, &invitation)) - a.Equal(orgInvitationID, invitation.ID) - }) - - t.Run("Update by email", func(t *testing.T) { - cmd := exec.Command(cliPath, - orgEntity, - invitationsEntity, - "update", - "--email", - emailOrg, - "--role", - roleNameOrg, - "-o=json") - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - require.NoError(t, err, string(resp)) - - a := assert.New(t) - - var invitation mongodbatlas.Invitation - require.NoError(t, json.Unmarshal(resp, &invitation)) - a.Equal(emailOrg, invitation.Username) - a.ElementsMatch([]string{roleNameOrg}, invitation.Roles) - }) - - t.Run("Update by ID", func(t *testing.T) { - cmd := exec.Command(cliPath, - orgEntity, - invitationsEntity, - "update", - orgInvitationID, - "--role", - roleNameOrg, - "-o=json") - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - require.NoError(t, err, string(resp)) - - a := assert.New(t) - var invitation mongodbatlas.Invitation - require.NoError(t, json.Unmarshal(resp, &invitation)) - a.Equal(emailOrg, invitation.Username) - a.ElementsMatch([]string{roleNameOrg}, invitation.Roles) - }) - - t.Run("Delete", func(t *testing.T) { - cmd := exec.Command(cliPath, - orgEntity, - invitationsEntity, - "delete", - orgInvitationID, - "--force") - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - a := assert.New(t) - require.NoError(t, err, string(resp)) - expected := fmt.Sprintf("Invitation '%s' deleted\n", orgInvitationID) - a.Equal(expected, string(resp)) - }) -} diff --git a/test/e2e/iam/orgs_test.go b/test/e2e/iam/orgs_test.go deleted file mode 100644 index 24144083e4..0000000000 --- a/test/e2e/iam/orgs_test.go +++ /dev/null @@ -1,78 +0,0 @@ -// Copyright 2020 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. - -//go:build e2e || (iam && !atlas) - -package iam_test - -import ( - "encoding/json" - "os" - "os/exec" - "testing" - - "github.com/mongodb/mongodb-atlas-cli/test/e2e" - "github.com/stretchr/testify/assert" - "github.com/stretchr/testify/require" - atlasv2 "go.mongodb.org/atlas-sdk/v20231115007/admin" -) - -func TestOrgs(t *testing.T) { - cliPath, err := e2e.AtlasCLIBin() - require.NoError(t, err) - - var orgID string - - // This test must run first to grab the ID of the org to later describe - t.Run("List", func(t *testing.T) { - cmd := exec.Command(cliPath, - orgEntity, - "ls", - "-o=json") - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - require.NoError(t, err, string(resp)) - var orgs atlasv2.PaginatedOrganization - err = json.Unmarshal(resp, &orgs) - require.NoError(t, err, string(resp)) - assert.NotEmpty(t, orgs.Results) - orgID = *orgs.GetResults()[0].Id - require.NotEmpty(t, orgID, "orgID not set, resp: %s", resp) - }) - require.NotEmpty(t, orgID) - - t.Run("Describe", func(t *testing.T) { - cmd := exec.Command(cliPath, - orgEntity, - "describe", - orgID, - "-o=json") - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - require.NoError(t, err, string(resp)) - }) - - t.Run("List Org Users", func(t *testing.T) { - cmd := exec.Command(cliPath, - orgEntity, - usersEntity, - "ls", - "--orgId", - orgID, - "-o=json") - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - require.NoError(t, err, string(resp)) - }) -} diff --git a/test/e2e/iam/project_api_keys_test.go b/test/e2e/iam/project_api_keys_test.go deleted file mode 100644 index dd784383e6..0000000000 --- a/test/e2e/iam/project_api_keys_test.go +++ /dev/null @@ -1,111 +0,0 @@ -// Copyright 2020 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. - -//go:build e2e || (iam && !atlas) - -package iam_test - -import ( - "encoding/json" - "fmt" - "os" - "os/exec" - "testing" - - "github.com/mongodb/mongodb-atlas-cli/test/e2e" - "github.com/stretchr/testify/assert" - "github.com/stretchr/testify/require" - "go.mongodb.org/atlas/mongodbatlas" -) - -func TestProjectAPIKeys(t *testing.T) { - cliPath, err := e2e.AtlasCLIBin() - require.NoError(t, err) - - var ID string - - // This test must run first to grab the ID of the project to later describe - t.Run("Create", func(t *testing.T) { - const desc = "e2e-test" - cmd := exec.Command(cliPath, - projectsEntity, - apiKeysEntity, - "create", - "--desc", - desc, - "--role=GROUP_READ_ONLY", - "-o=json") - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - a := assert.New(t) - require.NoError(t, err, string(resp)) - var key mongodbatlas.APIKey - require.NoError(t, json.Unmarshal(resp, &key)) - a.Equal(desc, key.Desc) - ID = key.ID - }) - - if ID == "" { - assert.FailNow(t, "Failed to create API key") - } - - defer func() { - if e := deleteOrgAPIKey(ID); e != nil { - t.Errorf("error deleting test apikey: %v", e) - } - }() - - t.Run("Assign", func(t *testing.T) { - cmd := exec.Command(cliPath, - projectsEntity, - apiKeysEntity, - "assign", - ID, - "--role=GROUP_DATA_ACCESS_READ_ONLY", - "-o=json") - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - require.NoError(t, err, string(resp)) - }) - - t.Run("List", func(t *testing.T) { - cmd := exec.Command(cliPath, - projectsEntity, - apiKeysEntity, - "ls", - "-o=json") - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - require.NoError(t, err, string(resp)) - var keys []mongodbatlas.APIKey - require.NoError(t, json.Unmarshal(resp, &keys)) - assert.NotEmpty(t, keys) - }) - - t.Run("Delete", func(t *testing.T) { - cmd := exec.Command(cliPath, - projectsEntity, - apiKeysEntity, - "rm", - ID, - "--force") - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - - a := assert.New(t) - require.NoError(t, err, string(resp)) - expected := fmt.Sprintf("API Key '%s' deleted\n", ID) - a.Equal(expected, string(resp)) - }) -} diff --git a/test/e2e/iam/project_invitations_test.go b/test/e2e/iam/project_invitations_test.go deleted file mode 100644 index c0e383e954..0000000000 --- a/test/e2e/iam/project_invitations_test.go +++ /dev/null @@ -1,174 +0,0 @@ -// Copyright 2021 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. -//go:build e2e || (iam && !atlas) - -package iam_test - -import ( - "encoding/json" - "fmt" - "os" - "os/exec" - "testing" - - "github.com/mongodb/mongodb-atlas-cli/test/e2e" - "github.com/stretchr/testify/assert" - "github.com/stretchr/testify/require" - "go.mongodb.org/atlas/mongodbatlas" -) - -func TestProjectInvitations(t *testing.T) { - cliPath, err := e2e.AtlasCLIBin() - require.NoError(t, err) - - var invitationID string - - n, err := e2e.RandInt(1000) - require.NoError(t, err) - - projectName := fmt.Sprintf("e2e-proj-%v", n) - projectID, err := e2e.CreateProject(projectName) - require.NoError(t, err) - - emailProject := fmt.Sprintf("test-%v@mongodb.com", n) - t.Cleanup(func() { - e2e.DeleteProjectWithRetry(t, projectID) - }) - - t.Run("Invite", func(t *testing.T) { - cmd := exec.Command(cliPath, - projectsEntity, - invitationsEntity, - "invite", - emailProject, - "--role", - "GROUP_READ_ONLY", - "--projectId", - projectID, - "-o=json") - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - require.NoError(t, err, string(resp)) - a := assert.New(t) - - var invitation mongodbatlas.Invitation - require.NoError(t, json.Unmarshal(resp, &invitation)) - a.Equal(emailProject, invitation.Username) - require.NotEmpty(t, invitation.ID) - invitationID = invitation.ID - }) - - t.Run("List", func(t *testing.T) { - cmd := exec.Command(cliPath, - projectsEntity, - invitationsEntity, - "ls", - "--projectId", - projectID, - "-o=json") - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - require.NoError(t, err, string(resp)) - a := assert.New(t) - - var invitations []mongodbatlas.Invitation - require.NoError(t, json.Unmarshal(resp, &invitations)) - a.NotEmpty(invitations) - }) - - t.Run("Describe", func(t *testing.T) { - cmd := exec.Command(cliPath, - projectsEntity, - invitationsEntity, - "get", - invitationID, - "--projectId", - projectID, - "-o=json") - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - require.NoError(t, err, string(resp)) - a := assert.New(t) - - var invitation mongodbatlas.Invitation - require.NoError(t, json.Unmarshal(resp, &invitation)) - a.Equal(invitationID, invitation.ID) - }) - - t.Run("Update by email", func(t *testing.T) { - cmd := exec.Command(cliPath, - projectsEntity, - invitationsEntity, - "update", - "--email", - emailProject, - "--role", - roleName1, - "--role", - roleName2, - "--projectId", - projectID, - "-o=json") - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - require.NoError(t, err, string(resp)) - a := assert.New(t) - - var invitation mongodbatlas.Invitation - require.NoError(t, json.Unmarshal(resp, &invitation)) - a.Equal(emailProject, invitation.Username) - a.ElementsMatch([]string{roleName1, roleName2}, invitation.Roles) - }) - - t.Run("Update by ID", func(t *testing.T) { - cmd := exec.Command(cliPath, - projectsEntity, - invitationsEntity, - "update", - invitationID, - "--role", - roleName1, - "--role", - roleName2, - "--projectId", - projectID, - "-o=json") - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - require.NoError(t, err, string(resp)) - a := assert.New(t) - - var invitation mongodbatlas.Invitation - require.NoError(t, json.Unmarshal(resp, &invitation)) - a.Equal(emailProject, invitation.Username) - a.ElementsMatch([]string{roleName1, roleName2}, invitation.Roles) - }) - - t.Run("Delete", func(t *testing.T) { - cmd := exec.Command(cliPath, - projectsEntity, - invitationsEntity, - "delete", - invitationID, - "--force", - "--projectId", - projectID) - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - a := assert.New(t) - require.NoError(t, err, string(resp)) - expected := fmt.Sprintf("Invitation '%s' deleted\n", invitationID) - a.Equal(expected, string(resp)) - }) -} diff --git a/test/e2e/iam/project_teams_test.go b/test/e2e/iam/project_teams_test.go deleted file mode 100644 index c29a7f28cf..0000000000 --- a/test/e2e/iam/project_teams_test.go +++ /dev/null @@ -1,146 +0,0 @@ -// Copyright 2020 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. - -//go:build e2e || (iam && !om60 && !atlas) - -package iam_test - -import ( - "encoding/json" - "fmt" - "os" - "os/exec" - "testing" - - "github.com/mongodb/mongodb-atlas-cli/test/e2e" - "github.com/stretchr/testify/assert" - "github.com/stretchr/testify/require" - "go.mongodb.org/atlas/mongodbatlas" -) - -func TestProjectTeams(t *testing.T) { - cliPath, err := e2e.AtlasCLIBin() - require.NoError(t, err) - - n, err := e2e.RandInt(1000) - require.NoError(t, err) - - projectName := fmt.Sprintf("e2e-proj-%v", n) - projectID, err := e2e.CreateProject(projectName) - require.NoError(t, err) - t.Cleanup(func() { - e2e.DeleteProjectWithRetry(t, projectID) - }) - - teamName := fmt.Sprintf("e2e-teams-%v", n) - teamID, err := createTeam(teamName) - require.NoError(t, err) - t.Cleanup(func() { - e := deleteTeam(teamID) - require.NoError(t, e) - }) - - t.Run("Add", func(t *testing.T) { - cmd := exec.Command(cliPath, - projectsEntity, - teamsEntity, - "add", - teamID, - "--role", - "GROUP_READ_ONLY", - "--projectId", - projectID, - "-o=json") - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - a := assert.New(t) - require.NoError(t, err, string(resp)) - - var teams mongodbatlas.TeamsAssigned - require.NoError(t, json.Unmarshal(resp, &teams)) - found := false - for _, team := range teams.Results { - if team.TeamID == teamID { - found = true - break - } - } - a.True(found) - }) - - t.Run("Update", func(t *testing.T) { - roleName1 := "GROUP_READ_ONLY" - roleName2 := "GROUP_DATA_ACCESS_READ_ONLY" - cmd := exec.Command(cliPath, - projectsEntity, - teamsEntity, - "update", - teamID, - "--role", - roleName1, - "--role", - roleName2, - "--projectId", - projectID, - "-o=json") - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - a := assert.New(t) - require.NoError(t, err, string(resp)) - - var roles []mongodbatlas.TeamRoles - require.NoError(t, json.Unmarshal(resp, &roles)) - a.Len(roles, 1) - - role := roles[0] - a.Equal(teamID, role.TeamID) - a.Len(role.RoleNames, 2) - a.ElementsMatch([]string{roleName1, roleName2}, role.RoleNames) - }) - - t.Run("List", func(t *testing.T) { - cmd := exec.Command(cliPath, - projectsEntity, - teamsEntity, - "ls", - "--projectId", - projectID, - "-o=json") - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - a := assert.New(t) - require.NoError(t, err, string(resp)) - - var teams mongodbatlas.TeamsAssigned - require.NoError(t, json.Unmarshal(resp, &teams)) - a.NotEmpty(teams.Results) - }) - - t.Run("Delete", func(t *testing.T) { - cmd := exec.Command(cliPath, - projectsEntity, - teamsEntity, - "delete", - teamID, - "--force", - "--projectId", - projectID) - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - a := assert.New(t) - require.NoError(t, err, string(resp)) - expected := fmt.Sprintf("Team '%s' deleted\n", teamID) - a.Equal(expected, string(resp)) - }) -} diff --git a/test/e2e/iam/projects_test.go b/test/e2e/iam/projects_test.go deleted file mode 100644 index fe5542fb0a..0000000000 --- a/test/e2e/iam/projects_test.go +++ /dev/null @@ -1,119 +0,0 @@ -// Copyright 2020 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. - -//go:build e2e || (iam && !atlas) - -package iam_test - -import ( - "encoding/json" - "fmt" - "os" - "os/exec" - "testing" - - "github.com/mongodb/mongodb-atlas-cli/test/e2e" - "github.com/stretchr/testify/require" - "go.mongodb.org/atlas/mongodbatlas" -) - -func TestProjects(t *testing.T) { - cliPath, err := e2e.AtlasCLIBin() - if err != nil { - t.Fatalf("unexpected error: %v", err) - } - - n, err := e2e.RandInt(1000) - if err != nil { - t.Fatalf("unexpected error: %v", err) - } - projectName := fmt.Sprintf("e2e-proj-%v", n) - - var projectID string - t.Run("Create", func(t *testing.T) { - // This depends on a ORG_ID ENV - cmd := exec.Command(cliPath, - projectsEntity, - "create", - projectName, - "-o=json") - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - - require.NoError(t, err, string(resp)) - - var project mongodbatlas.Project - if err = json.Unmarshal(resp, &project); err != nil { - t.Fatalf("unexpected error: %v", err) - } - - if project.Name != projectName { - t.Errorf("got=%#v\nwant=%#v\n", project.Name, projectName) - } - projectID = project.ID - }) - - t.Run("List", func(t *testing.T) { - cmd := exec.Command(cliPath, - projectsEntity, - "ls", - "-o=json") - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - - require.NoError(t, err, string(resp)) - }) - - t.Run("Describe", func(t *testing.T) { - cmd := exec.Command(cliPath, - projectsEntity, - "describe", - projectID, - "-o=json") - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - - require.NoError(t, err, string(resp)) - }) - - t.Run("Users", func(t *testing.T) { - cmd := exec.Command(cliPath, - projectsEntity, - usersEntity, - "ls", - "--projectId", - projectID, - "-o=json") - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - require.NoError(t, err, string(resp)) - }) - - t.Run("Delete", func(t *testing.T) { - cmd := exec.Command(cliPath, - projectsEntity, - "delete", - projectID, - "--force") - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - - require.NoError(t, err, string(resp)) - - expected := fmt.Sprintf("Project '%s' deleted\n", projectID) - if string(resp) != expected { - t.Errorf("got=%#v\nwant=%#v\n", string(resp), expected) - } - }) -} diff --git a/test/e2e/iam/team_users_test.go b/test/e2e/iam/team_users_test.go deleted file mode 100644 index 2596fdd9c0..0000000000 --- a/test/e2e/iam/team_users_test.go +++ /dev/null @@ -1,113 +0,0 @@ -// Copyright 2020 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. - -//go:build e2e || (iam && !om60 && !atlas) - -package iam_test - -import ( - "encoding/json" - "fmt" - "os" - "os/exec" - "testing" - - "github.com/mongodb/mongodb-atlas-cli/test/e2e" - "github.com/stretchr/testify/assert" - "github.com/stretchr/testify/require" - "go.mongodb.org/atlas/mongodbatlas" -) - -func TestTeamUsers(t *testing.T) { - cliPath, err := e2e.AtlasCLIBin() - require.NoError(t, err) - - n, err := e2e.RandInt(1000) - require.NoError(t, err) - - teamName := fmt.Sprintf("teams%v", n) - teamID, err := createTeam(teamName) - require.NoError(t, err) - defer func() { - if e := deleteTeam(teamID); e != nil { - t.Errorf("error deleting project: %v", e) - } - }() - - username, userID, err := OrgNUser(1) - require.NoError(t, err) - - t.Run("Add", func(t *testing.T) { - cmd := exec.Command(cliPath, - teamsEntity, - usersEntity, - "add", - userID, - "--teamId", - teamID, - "-o=json", - ) - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - require.NoError(t, err, string(resp)) - a := assert.New(t) - - var users []mongodbatlas.AtlasUser - require.NoError(t, json.Unmarshal(resp, &users)) - found := false - for _, user := range users { - if user.Username == username { - found = true - break - } - } - a.True(found) - }) - - t.Run("List", func(t *testing.T) { - cmd := exec.Command(cliPath, - teamsEntity, - usersEntity, - "ls", - "--teamId", - teamID, - "-o=json") - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - require.NoError(t, err, string(resp)) - a := assert.New(t) - var teams []mongodbatlas.AtlasUser - require.NoError(t, json.Unmarshal(resp, &teams)) - a.NotEmpty(teams) - }) - - t.Run("Delete", func(t *testing.T) { - cmd := exec.Command(cliPath, - teamsEntity, - usersEntity, - "delete", - userID, - "--teamId", - teamID, - "--force") - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - require.NoError(t, err, string(resp)) - - a := assert.New(t) - require.NoError(t, err, string(resp)) - expected := fmt.Sprintf("User '%s' deleted from the team\n", userID) - a.Equal(expected, string(resp)) - }) -} diff --git a/test/e2e/iam/teams_test.go b/test/e2e/iam/teams_test.go deleted file mode 100644 index 40a0a0271b..0000000000 --- a/test/e2e/iam/teams_test.go +++ /dev/null @@ -1,131 +0,0 @@ -// Copyright 2020 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. - -//go:build e2e || (iam && !om60 && !atlas) - -package iam_test - -import ( - "encoding/json" - "fmt" - "os" - "os/exec" - "testing" - - "github.com/mongodb/mongodb-atlas-cli/test/e2e" - "github.com/stretchr/testify/assert" - "github.com/stretchr/testify/require" - "go.mongodb.org/atlas/mongodbatlas" -) - -func TestTeams(t *testing.T) { - cliPath, err := e2e.AtlasCLIBin() - require.NoError(t, err) - - n, err := e2e.RandInt(1000) - require.NoError(t, err) - - teamName := fmt.Sprintf("teams%v", n) - var teamID string - - t.Run("Create", func(t *testing.T) { - username, _, err := OrgNUser(0) - require.NoError(t, err) - - cmd := exec.Command(cliPath, - teamsEntity, - "create", - teamName, - "--username", - username, - "-o=json") - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - - a := assert.New(t) - require.NoError(t, err, string(resp)) - - var team mongodbatlas.Team - require.NoError(t, json.Unmarshal(resp, &team)) - a.Equal(teamName, team.Name) - teamID = team.ID - }) - require.NotEmpty(t, teamID) - - t.Run("Describe By ID", func(t *testing.T) { - cmd := exec.Command(cliPath, - teamsEntity, - "describe", - "--id", - teamID, - "-o=json") - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - - a := assert.New(t) - require.NoError(t, err, string(resp)) - - var team mongodbatlas.Team - require.NoError(t, json.Unmarshal(resp, &team)) - a.Equal(teamID, team.ID) - }) - - t.Run("Describe By Name", func(t *testing.T) { - cmd := exec.Command(cliPath, - teamsEntity, - "describe", - "--name", - teamName, - "-o=json") - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - - a := assert.New(t) - require.NoError(t, err, string(resp)) - - var team mongodbatlas.Team - require.NoError(t, json.Unmarshal(resp, &team)) - a.Equal(teamName, team.Name) - }) - - t.Run("List", func(t *testing.T) { - cmd := exec.Command(cliPath, - teamsEntity, - "ls", - "-o=json") - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - - a := assert.New(t) - require.NoError(t, err, string(resp)) - - var teams []mongodbatlas.Team - require.NoError(t, json.Unmarshal(resp, &teams)) - a.NotEmpty(t, teams) - }) - - t.Run("Delete", func(t *testing.T) { - cmd := exec.Command(cliPath, - teamsEntity, - "delete", - teamID, - "--force") - cmd.Env = os.Environ() - resp, err := cmd.CombinedOutput() - a := assert.New(t) - require.NoError(t, err, string(resp)) - expected := fmt.Sprintf("Team '%s' deleted\n", teamID) - a.Equal(expected, string(resp)) - }) -} From 18262deae912006dd06965abd8c16e600c758091 Mon Sep 17 00:00:00 2001 From: Filipe C Menezes Date: Fri, 1 Mar 2024 16:43:07 +0000 Subject: [PATCH 14/16] fix dependencies for autogenerated tests --- tools/genevergreen/generate/generate.go | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tools/genevergreen/generate/generate.go b/tools/genevergreen/generate/generate.go index f2b1fabcf3..043cad59df 100644 --- a/tools/genevergreen/generate/generate.go +++ b/tools/genevergreen/generate/generate.go @@ -181,7 +181,7 @@ func PostPkgMetaTasks(c *shrub.Configuration, toolName string) { func PublishStableTasks(c *shrub.Configuration, toolName string) { dependency := []shrub.TaskDependency{ { - Name: fmt.Sprintf("compile_%s", toolName), + Name: "compile", Variant: "code_health", }, { @@ -210,7 +210,7 @@ func PublishStableTasks(c *shrub.Configuration, toolName string) { func PublishSnapshotTasks(c *shrub.Configuration, toolName string) { dependency := []shrub.TaskDependency{ { - Name: fmt.Sprintf("compile_%s", toolName), + Name: "compile", Variant: "code_health", }, { From 1c5efaccc6e715637a8de71280f17368a24e347f Mon Sep 17 00:00:00 2001 From: Filipe C Menezes Date: Mon, 4 Mar 2024 11:21:55 +0000 Subject: [PATCH 15/16] comments --- README.md | 2 +- build/ci/release.yml | 9 --------- build/package/download-win-binaries.sh | 8 ++------ build/package/linux_notarize.sh | 9 ++------- build/package/package.sh | 6 +----- build/package/send-slack-notification.sh | 6 +----- 6 files changed, 7 insertions(+), 33 deletions(-) diff --git a/README.md b/README.md index 6c35b33cde..1e0718dad9 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Atlas CLI +## MongoDB Atlas CLI The MongoDB Atlas CLI is a modern command line interface that enables you to manage MongoDB Atlas from the terminal. diff --git a/build/ci/release.yml b/build/ci/release.yml index 42bf772563..a822f07a67 100644 --- a/build/ci/release.yml +++ b/build/ci/release.yml @@ -68,17 +68,10 @@ functions: <<: *go_options env: <<: *go_env - NOTARY_SIGNING_KEY_ATLASCLI: ${notary_service_signing_key_atlascli} - NOTARY_SIGNING_KEY_MONGOCLI: ${notary_service_signing_key_mongocli} - NOTARY_SIGNING_COMMENT: "Evergreen Automatic Signing (${tool_name})" - NOTARY_AUTH_TOKEN: ${signing_auth_token_50} - NOTARY_URL: ${notary_service_notary_url} ARTIFACTORY_USERNAME: ${artifactory_username} ARTIFACTORY_PASSWORD: ${artifactory_password} GRS_USERNAME: ${garasign_username} GRS_PASSWORD: ${garasign_password} - GRS_USERNAME_MONGOCLI: ${garasign_username_mongocli} - GRS_PASSWORD_MONGOCLI: ${garasign_password_mongocli} include_expansions_in_env: - go_base_path - workdir @@ -316,8 +309,6 @@ tasks: ARTIFACTORY_PASSWORD: ${artifactory_password} GRS_USERNAME: ${garasign_username} GRS_PASSWORD: ${garasign_password} - GRS_USERNAME_MONGOCLI: ${garasign_username_mongocli} - GRS_PASSWORD_MONGOCLI: ${garasign_password_mongocli} - func: "rename pkg" vars: unstable: ${unstable} diff --git a/build/package/download-win-binaries.sh b/build/package/download-win-binaries.sh index 2b19b48627..c1b45d0fa6 100755 --- a/build/package/download-win-binaries.sh +++ b/build/package/download-win-binaries.sh @@ -25,12 +25,8 @@ if [[ "${unstable-}" == "-unstable" ]]; then VERSION_NAME="$VERSION_GIT-next" fi -PACKAGE_NAME="mongocli_${VERSION_NAME}_windows_x86_64.msi" -BINARY_NAME="mongocli.exe" -if [[ "${TOOL_NAME:?}" == atlascli ]]; then - PACKAGE_NAME="mongodb-atlas-cli_${VERSION_NAME}_windows_x86_64.msi" - BINARY_NAME="atlas.exe" -fi +PACKAGE_NAME="mongodb-atlas-cli_${VERSION_NAME}_windows_x86_64.msi" +BINARY_NAME="atlas.exe" pushd bin diff --git a/build/package/linux_notarize.sh b/build/package/linux_notarize.sh index da5a163582..1ba245fd2d 100755 --- a/build/package/linux_notarize.sh +++ b/build/package/linux_notarize.sh @@ -20,13 +20,8 @@ set -Eeou pipefail # This depends on binaries being generated in a goreleaser manner and gon being set up. # goreleaser should already take care of calling this script as a part of a custom publisher. -if [ "${TOOL_NAME}" == "atlascli" ]; then - echo "GRS_CONFIG_USER1_USERNAME=${GRS_USERNAME}" >> "signing-envfile" - echo "GRS_CONFIG_USER1_PASSWORD=${GRS_PASSWORD}" >> "signing-envfile" -else - echo "GRS_CONFIG_USER1_USERNAME=${GRS_USERNAME_MONGOCLI}" >> "signing-envfile" - echo "GRS_CONFIG_USER1_PASSWORD=${GRS_PASSWORD_MONGOCLI}" >> "signing-envfile" -fi +echo "GRS_CONFIG_USER1_USERNAME=${GRS_USERNAME}" >> "signing-envfile" +echo "GRS_CONFIG_USER1_PASSWORD=${GRS_PASSWORD}" >> "signing-envfile" if [[ -f "${artifact:?}" ]]; then echo "${ARTIFACTORY_PASSWORD}" | podman login --password-stdin --username "${ARTIFACTORY_USERNAME}" artifactory.corp.mongodb.com diff --git a/build/package/package.sh b/build/package/package.sh index e7c44d136b..53997fe76b 100755 --- a/build/package/package.sh +++ b/build/package/package.sh @@ -35,11 +35,7 @@ else fi # check that the notarization service signed the mac binaries -SIGNED_FILE_NAME=mongocli_macos_signed.zip -if [[ "${tool_name-}" == "atlascli" ]]; then - SIGNED_FILE_NAME=mongodb-atlas-cli_macos_signed.zip -fi - +SIGNED_FILE_NAME=mongodb-atlas-cli_macos_signed.zip if [[ -f "dist/$SIGNED_FILE_NAME" ]]; then echo "$SIGNED_FILE_NAME exists. The Mac notarization service has run." else diff --git a/build/package/send-slack-notification.sh b/build/package/send-slack-notification.sh index 0d0745916f..2d69841989 100755 --- a/build/package/send-slack-notification.sh +++ b/build/package/send-slack-notification.sh @@ -22,11 +22,7 @@ fi VERSION="$(git tag --list "${TOOL_NAME:?}/v*" --sort=taggerdate | tail -1 | cut -d "v" -f 2)" -TOOL_NAME_MESSAGE="MongoDB CLI" - -if [[ "${TOOL_NAME:?}" == atlascli ]]; then - TOOL_NAME_MESSAGE="MongoDB Atlas CLI" -fi +TOOL_NAME_MESSAGE="MongoDB Atlas CLI" curl --header "Api-User:${evergreen_user:?}" \ --header "Api-Key:${evergreen_api_key:?}" \ From 78fe65686bc4c3c56ad9dd387fc80bd791e1e029 Mon Sep 17 00:00:00 2001 From: Filipe C Menezes Date: Mon, 4 Mar 2024 11:35:37 +0000 Subject: [PATCH 16/16] comments --- RELEASING.md | 2 +- scripts/release.sh | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/RELEASING.md b/RELEASING.md index 4b21790c2d..c63e4bc7d1 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -49,7 +49,7 @@ To manually generate a new stable release you can run: ./scripts/release.sh atlascli/v1.0.0 ``` -**Note:** Please use the `atlascli/vX.Y.Z` or `mongocli/vX.Y.Z` format for the version to release +**Note:** Please use the `atlascli/vX.Y.Z` format for the version to release This will do the following things: 1. Tag a new version, ie: `git tag -a -s atlascli/v1.0.0 -m "atlascli/v1.0.0"` diff --git a/scripts/release.sh b/scripts/release.sh index f5aa53356e..8628226d5b 100755 --- a/scripts/release.sh +++ b/scripts/release.sh @@ -19,12 +19,12 @@ set -euo pipefail VERSION="${1-}" if [[ -z "${VERSION}" ]]; then - echo "Please provide a tag version in the format 'mongocli/vX.Y.Z' or 'atlascli/vX.Y.Z'" + echo "Please provide a tag version in the format 'atlascli/vX.Y.Z'" exit 1 fi if [[ "${VERSION}" != mongocli/v* ]] && [[ "${VERSION}" != atlascli/v* ]]; then - echo "Please provide a tag version in the format 'mongocli/vX.Y.Z' or 'atlascli/vX.Y.Z'" + echo "Please provide a tag version in the format 'atlascli/vX.Y.Z'" exit 1 fi