cli

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.

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

• func AtlasAlertConfigCreateBuilder() *cobra.Command
• func AtlasAlertConfigDeleteBuilder() *cobra.Command
• func AtlasAlertConfigListBuilder() *cobra.Command
• func AtlasAlertConfigsBuilder() *cobra.Command
• func AtlasAlertsBuilder() *cobra.Command
• func AtlasBuilder() *cobra.Command
• func AtlasClustersBuilder() *cobra.Command
• func AtlasClustersCreateBuilder() *cobra.Command
• func AtlasClustersDeleteBuilder() *cobra.Command
• func AtlasClustersDescribeBuilder() *cobra.Command
• func AtlasClustersListBuilder() *cobra.Command
• func AtlasClustersUpdateBuilder() *cobra.Command
• func AtlasDBUsersBuilder() *cobra.Command
• func AtlasDBUsersCreateBuilder() *cobra.Command
• func AtlasDBUsersDeleteBuilder() *cobra.Command
• func AtlasDBUsersListBuilder() *cobra.Command
• func AtlasDBUsersUpdateBuilder() *cobra.Command
• func AtlasWhitelistBuilder() *cobra.Command
• func AtlasWhitelistCreateBuilder() *cobra.Command
• func AtlasWhitelistDeleteBuilder() *cobra.Command
• func AtlasWhitelistDescribeBuilder() *cobra.Command
• func AtlasWhitelistListBuilder() *cobra.Command
• func CloudManagerBuilder() *cobra.Command
• func CloudManagerClustersApplyBuilder() *cobra.Command
• func CloudManagerClustersBuilder() *cobra.Command
• func CloudManagerClustersCreateBuilder() *cobra.Command
• func CloudManagerClustersDescribeBuilder() *cobra.Command
• func CloudManagerClustersListBuilder() *cobra.Command
• func CloudManagerClustersShutdownBuilder() *cobra.Command
• func CloudManagerClustersStartupBuilder() *cobra.Command
• func CloudManagerClustersUpdateBuilder() *cobra.Command
• func ConfigBuilder() *cobra.Command
• func ConfigSetBuilder() *cobra.Command
• func IAMBuilder() *cobra.Command
• func IAMOrganizationsBuilder() *cobra.Command
• func IAMOrganizationsCreateBuilder() *cobra.Command
• func IAMOrganizationsDeleteBuilder() *cobra.Command
• func IAMOrganizationsListBuilder() *cobra.Command
• func IAMProjectsBuilder() *cobra.Command
• func IAMProjectsCreateBuilder() *cobra.Command
• func IAMProjectsDeleteOpts() *cobra.Command
• func IAMProjectsListBuilder() *cobra.Command
• func OpsManagerBuilder() *cobra.Command
• func OpsManagerOwnerBuilder() *cobra.Command
• func OpsManagerOwnerCreateBuilder() *cobra.Command
• type Deleter
• type DeleterFromProject

Functions

func AtlasAlertConfigCreateBuilder

func AtlasAlertConfigCreateBuilder() *cobra.Command

mongocli atlas alerts config(s) create -event event --enabled [--matcherField fieldName --matcherOperator operator --matcherValue value] [--notificationType type --notificationDelayMin min --notificationEmailEnabled --notificationSmsEnabled --notificationUsername username --notificationTeamID id --notificationEmailAddress email --notificationMobileNumber number --notificationChannelName channel --notificationApiToken --notificationRegion region] [--projectId projectId]

func AtlasAlertConfigDeleteBuilder

func AtlasAlertConfigDeleteBuilder() *cobra.Command

mongocli atlas alerts config(s) delete id --projectId projectId [--confirm]

func AtlasAlertConfigListBuilder

func AtlasAlertConfigListBuilder() *cobra.Command

mongocli atlas alerts config(s) list --projectId projectId [--page N] [--limit N]

func AtlasAlertConfigsBuilder

func AtlasAlertConfigsBuilder() *cobra.Command

func AtlasAlertsBuilder

func AtlasAlertsBuilder() *cobra.Command

func AtlasBuilder

func AtlasBuilder() *cobra.Command

func AtlasClustersBuilder

func AtlasClustersBuilder() *cobra.Command

func AtlasClustersCreateBuilder

func AtlasClustersCreateBuilder() *cobra.Command

AtlasClustersCreateBuilder builds a cobra.Command that can run as: create <name> --projectId projectId --provider AWS|GCP|AZURE --region regionName [--members N] [--instanceSize M#] [--diskSizeGB N] [--backup] [--mdbVersion]

func AtlasClustersDeleteBuilder

func AtlasClustersDeleteBuilder() *cobra.Command

mongocli atlas cluster(s) delete name --projectId projectId [--confirm]

func AtlasClustersDescribeBuilder

func AtlasClustersDescribeBuilder() *cobra.Command

mongocli atlas cluster(s) describe [name] --projectId projectId

func AtlasClustersListBuilder

func AtlasClustersListBuilder() *cobra.Command

mongocli atlas cluster(s) list --projectId projectId [--page N] [--limit N]

func AtlasClustersUpdateBuilder

func AtlasClustersUpdateBuilder() *cobra.Command

mongocli atlas cluster(s) update name --projectId projectId [--instanceSize M#] [--diskSizeGB N] [--mdbVersion]

func AtlasDBUsersBuilder

func AtlasDBUsersBuilder() *cobra.Command

func AtlasDBUsersCreateBuilder

func AtlasDBUsersCreateBuilder() *cobra.Command

mongocli atlas dbuser(s) create --username username --password password --role roleName@dbName [--projectId projectId]

func AtlasDBUsersDeleteBuilder

func AtlasDBUsersDeleteBuilder() *cobra.Command

mongocli atlas dbuser(s) delete <username> --force

func AtlasDBUsersListBuilder

func AtlasDBUsersListBuilder() *cobra.Command

mongocli atlas dbuser(s) list --projectId projectId [--page N] [--limit N]

func AtlasDBUsersUpdateBuilder

func AtlasDBUsersUpdateBuilder() *cobra.Command

mongocli atlas dbuser(s) update username [--password password] [--role roleName@dbName] [--projectId projectId]

func AtlasWhitelistBuilder

func AtlasWhitelistBuilder() *cobra.Command

func AtlasWhitelistCreateBuilder

func AtlasWhitelistCreateBuilder() *cobra.Command

mongocli atlas whitelist(s) create value --type cidrBlock|ipAddress [--comment comment] [--projectId projectId]

func AtlasWhitelistDeleteBuilder

func AtlasWhitelistDeleteBuilder() *cobra.Command

mongocli atlas whitelist delete <entry> --force

func AtlasWhitelistDescribeBuilder

func AtlasWhitelistDescribeBuilder() *cobra.Command

mongocli atlas whitelist(s) describe [name] --projectId projectId

func AtlasWhitelistListBuilder

func AtlasWhitelistListBuilder() *cobra.Command

mongocli atlas whitelist(s) list --projectId projectId [--page N] [--limit N]

func CloudManagerBuilder

func CloudManagerBuilder() *cobra.Command

func CloudManagerClustersApplyBuilder

func CloudManagerClustersApplyBuilder() *cobra.Command

mongocli cloud-manager cluster(s) apply --projectId projectId --file myfile.yaml

func CloudManagerClustersBuilder

func CloudManagerClustersBuilder() *cobra.Command

func CloudManagerClustersCreateBuilder

func CloudManagerClustersCreateBuilder() *cobra.Command

mongocli cloud-manager cluster(s) create --projectId projectId --file myfile.yaml

func CloudManagerClustersDescribeBuilder

func CloudManagerClustersDescribeBuilder() *cobra.Command

mongocli cloud-manager cluster(s) describe [name] --projectId projectId

func CloudManagerClustersListBuilder

func CloudManagerClustersListBuilder() *cobra.Command

mongocli cloud-manager cluster(s) list --projectId projectId

func CloudManagerClustersShutdownBuilder

func CloudManagerClustersShutdownBuilder() *cobra.Command

mongocli cloud-manager cluster(s) shutdown [name] --projectId projectId [--force]

func CloudManagerClustersStartupBuilder

func CloudManagerClustersStartupBuilder() *cobra.Command

mongocli cloud-manager cluster(s) startup [name] --projectId projectId [--force]

func CloudManagerClustersUpdateBuilder

func CloudManagerClustersUpdateBuilder() *cobra.Command

mongocli cloud-manager cluster(s) update --projectId projectId --file myfile.yaml

func ConfigBuilder

func ConfigBuilder() *cobra.Command

func ConfigSetBuilder

func ConfigSetBuilder() *cobra.Command

func IAMBuilder

func IAMBuilder() *cobra.Command

func IAMOrganizationsBuilder

func IAMOrganizationsBuilder() *cobra.Command

func IAMOrganizationsCreateBuilder

func IAMOrganizationsCreateBuilder() *cobra.Command

mongocli iam organization(s) create name [--orgId orgId]

func IAMOrganizationsDeleteBuilder

func IAMOrganizationsDeleteBuilder() *cobra.Command

mongocli iam organization(s) delete [id] [--orgId orgId]

func IAMOrganizationsListBuilder

func IAMOrganizationsListBuilder() *cobra.Command

mongocli iam organizations(s) list [--orgId orgId]

func IAMProjectsBuilder

func IAMProjectsBuilder() *cobra.Command

func IAMProjectsCreateBuilder

func IAMProjectsCreateBuilder() *cobra.Command

mongocli iam project(s) create name [--orgId orgId]

func IAMProjectsDeleteOpts

func IAMProjectsDeleteOpts() *cobra.Command

mongocli iam project(s) delete [id] [--orgId orgId]

func IAMProjectsListBuilder

func IAMProjectsListBuilder() *cobra.Command

mongocli iam project(s) list [--orgId orgId]

func OpsManagerBuilder

func OpsManagerBuilder() *cobra.Command

func OpsManagerOwnerBuilder

func OpsManagerOwnerBuilder() *cobra.Command

func OpsManagerOwnerCreateBuilder

func OpsManagerOwnerCreateBuilder() *cobra.Command

mongocli ops-manager owner create --email username --password password --firstName firstName --lastName lastName --whitelistIps whitelistIp

Types

type Deleter

type Deleter func(entry string) error

Deleter a function to delete from the store.

type DeleterFromProject

type DeleterFromProject func(projectID string, entry string) error

DeleterFromProject a function to delete from the store.