description

Documentation

Overview

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.

Index

• Constants

Constants

const (
	Atlas                    = "Atlas operations."
	Alerts                   = "Manage alerts for your project."
	AcknowledgeAlerts        = "Acknowledge an alert for your project."
	UnacknowledgeAlerts      = "Unacknowledge an alert for your project."
	Config                   = "Manage alerts configuration for your project."
	ConfigLong               = "The configs command provides access to your alerts configurations. You can create, edit, and delete alert configurations."
	CreateAlertsConfig       = "Create an alert configuration for your project."
	DeleteAlertsConfig       = "Delete an alert configuration from your project."
	AlertsConfigFields       = "Manage alert configuration fields for your project."
	AlertsConfigFieldsType   = "List alert configurations available field types."
	ListAlertsConfigs        = "List alert configurations for a project."
	UpdateAlertsConfig       = "Update an alert configuration for a project."
	DescribeAlert            = "Describe an alert for a project."
	ListAlerts               = "List alerts for a project."
	Backup                   = "Manage backups for your project."
	Checkpoints              = "Manage backup checkpoints for your project."
	ListCheckpoints          = "List continuous backup checkpoints for your project."
	Restores                 = "Manage restore jobs for your project."
	ListRestores             = "Lists restore jobs for a project and cluster."
	StartRestore             = "Start a restore job for a project and cluster."
	Snapshots                = "Manage backup snapshots for your project."
	ListSnapshots            = "List snapshots for a project and cluster."
	Logs                     = "Download host logs for your project."
	LogsDownload             = "Download a host mongodb logs."
	DataLakes                = "Manage data lakes for your project."
	DataLakesLong            = "The datalakes command provides access to your projects data lakes. You can create, edit, and delete data lakes."
	ListDataLakes            = "List data lakes for your project."
	DescribeDataLake         = "Return a specific data lake."
	CreateDataLake           = "Create a new data lake."
	UpdateDataLake           = "Update a data lake."
	DeleteDataLake           = "Delete a data lake."
	Certs                    = "Manage customer x509 certificates for your database users."
	DescribeCertConfig       = "Get the current customer-managed X.509 configuration details for an Atlas project."
	SaveCertConfig           = "Saves a customer-managed X.509 configuration for an Atlas project."
	DisableCertConfig        = "Disables customer-managed X.509 for a project."
	Clusters                 = "Manage clusters for your project."
	ClustersIndexes          = "Manage cluster rolling indexes for your project."
	ClustersLong             = "The clusters command provides access to your cluster configurations. You can create, edit, and delete clusters."
	CreateCluster            = "Create a MongoDB cluster."
	CreateIndex              = "Create a rolling index for your MongoDB cluster."
	ApplyCluster             = "Apply a new cluster configuration for your project."
	DeleteCluster            = "Delete a cluster from your project."
	DescribeCluster          = "Describe a cluster."
	ListClusters             = "List clusters for your project."
	UpdateCluster            = "Update a MongoDB cluster."
	PauseCluster             = "Pause a running MongoDB cluster in Atlas."
	StartCluster             = "Start a paused MongoDB cluster in Atlas."
	WatchCluster             = "Watch for a cluster to be available."
	Processes                = "Manage MongoDB processes for your project."
	ListProcesses            = "List MongoDB processes for a project."
	DBUsers                  = "Manage database users for your project."
	DiagnoseArchive          = "Manage diagnose archives."
	DownloadDiagnoseArchive  = "Download diagnose archives."
	CreateDBUser             = "Create a database user for a project."
	DeleteDBUser             = "Delete a database user for a project."
	ListDBUsers              = "List Atlas database users for a project."
	DescribeDBUser           = "Return a single Atlas database user for a project."
	DBUserCerts              = "Manage Atlas x509 certificates for your database users."
	ListDBUserCerts          = "Get a list of all Atlas-managed, unexpired certificates for a database user."
	CreateDBUserCerts        = "Create a new Atlas-managed X.509 certificate for the specified database user."
	ListEvents               = "List events for an organization or project."
	UpdateDBUser             = "Update a MongoDB dbuser in Atlas."
	ProcessMeasurements      = "Get measurements for a given host."
	Disks                    = "List available disks or disks measurements for a given host."
	ListDisks                = "List available disks for a given host."
	DescribeDisks            = "Describe disks measurements for a given host partition."
	Databases                = "List available databases or databases measurements for a given host."
	ListDatabases            = "List available databases for a given host."
	Whitelist                = "Manage the IP whitelist for a project."
	CreateWhitelist          = "Create an IP whitelist for a project."
	DeleteWhitelist          = "Delete a database user for a project."
	DescribeWhitelist        = "Describe an Atlas whitelist."
	ListWhitelist            = "List Atlas whitelist for a project."
	CloudManager             = "Cloud Manager operations."
	ShutdownCluster          = "Shutdown a cluster."
	StartUpCluster           = "Start up a cluster."
	OnlineArchives           = "Manage online archives for your cluster."
	ListOnlineArchive        = "List online archives for a cluster."
	DescribeOnlineArchive    = "Describe an online archive for a cluster."
	CreateOnlineArchive      = "Create an online archive for a cluster."
	DeleteOnlineArchive      = "Delete an online archive from a cluster."
	PauseOnlineArchive       = "Pause an online archive from a cluster."
	StartOnlineArchive       = "Start a paused online archive from a cluster."
	UpdateOnlineArchive      = "Update an online archive for a cluster."
	Search                   = "Manage search for your cluster."
	Indexes                  = "Manage search indexes for your cluster."
	ListSearchIndexes        = "List search indexes for a cluster."
	CreateSearchIndexes      = "Create a search index for a cluster."
	UpdateSearchIndex        = "Update a search index for a cluster."
	DescribeSearchIndexes    = "Describe a search index for a cluster."
	DeleteSearchIndexes      = "Delete a search index from a cluster."
	ConfigDescription        = "Configure a profile to store access settings for your MongoDB deployment."
	ConfigSetDescription     = "Configure specific properties of a profile."
	ConfigRenameDescription  = "Rename a profile."
	ConfigDeleteDescription  = "Delete a profile."
	ConfigList               = "List available profiles."
	ConfigDescribe           = "Return a specific profile"
	IAM                      = "Organization and projects operations."
	Organization             = "Organization operations."
	OrganizationLong         = "Create, list and manage your MongoDB organizations."
	CreateOrganization       = "Create an organization."
	DeleteOrganization       = "Delete an organization."
	ListOrganizations        = "List organizations."
	DescribeOrganizations    = "Describe an organizations."
	Projects                 = "Project operations."
	ProjectsLong             = "Create, list and manage your MongoDB projects."
	CreateProject            = "Create a project."
	DeleteProject            = "Delete a project."
	ListProjects             = "List projects."
	DescribeProject          = "Describe a project."
	DownloadLogCollectionJob = "Download logs generated by a log collection job."
	OpsManager               = "Ops Manager operations."
	Agents                   = "Manage Ops Manager agents."
	ListGlobalAlerts         = "List global alerts."
	Automation               = "Manage Ops Manager automation config."
	ShowAutomationStatus     = "Show the current status of the automation config."
	WatchAutomationStatus    = "Watch for automation changes."
	Global                   = "Manage Ops Manager global properties."
	Owner                    = "Manage Ops Manager owners."
	CreateOwner              = "Create the first user for Ops Manager."
	Servers                  = "Manage Ops Manager servers."
	ListServer               = "List all available servers running an automation agent for the given project."
	Security                 = "Manage security configuration for a project."
	EnableSecurity           = "Enable authentication mechanisms for the project."
	Events                   = "Manage events for your project."
	Metrics                  = "Get measurements on the state of the MongoDB process."
	LogCollection            = "Manage log collection jobs."
	StartLogCollectionJob    = "Start a job to collect logs."
	ListLogCollectionJobs    = "List log collection jobs."
	DeleteLogCollectionJob   = "Delete a log collection job."
	LogsDownloadLong         = `` /* 305-byte string literal not displayed */

	DBUsersLong = `` /* 234-byte string literal not displayed */

	ConfigLongDescription = `` /* 335-byte string literal not displayed */

	ConfigSetLong = `Configure specific properties of the profile.
Available properties include: %v.`
	CreateClusterLong = `` /* 404-byte string literal not displayed */

)