Documentation
¶
Index ¶
Constants ¶
const ( //CmdCloudUse command CmdCloudUse = "cloud" //CmdCloudShort short description CmdCloudShort = "Manage Cloud Accounts" //CmdCloudLong long description CmdCloudLong = `Connect to your cloud accounts.` //CmdCloudListShort short description CmdCloudListShort = "Show list of tokens" //CmdCloudListLong long description CmdCloudListLong = `Show list of tokens.` //CmdCloudTestShort short description CmdCloudTestShort = "test role" //CmdCloudTestLong long description CmdCloudTestLong = "test whether role is valid" //CmdCloudAddShort short description CmdCloudAddShort = "Add a cloud account" //CmdCloudAddLong long description CmdCloudAddLong = `` /* 541-byte string literal not displayed */ //CmdCloudUpdateShort short description CmdCloudUpdateShort = "Update cloud account info" //CmdCloudUpdateLong long description CmdCloudUpdateLong = "Update cloud account info" //CmdCloudScanShort short description CmdCloudScanShort = "Scan your root account and create skeletons" //CmdCloudScanLong long description CmdCloudScanLong = "Scan your root account, get organization and create skeletons for each account" //CmdCloudAddExample ... CmdCloudAddExample = `` /* 173-byte string literal not displayed */ //CmdCloudShowShort short description CmdCloudShowShort = "Show a cloud account" //CmdCloudShowLong long description CmdCloudShowLong = `Show a cloud account.` //CmdCloudDeleteShort short description CmdCloudDeleteShort = "Delete a cloud account" //CmdCloudDeleteLong long description CmdCloudDeleteLong = `Delete a cloud account.` //CmdFlagCloudIDLong flag CmdFlagCloudIDLong = "cloud-id" //CmdFlagRoleName is the name of the role to add a cloud account CmdFlagRoleName = "role" //CmdFlagRoleNameDescription is description for --role CmdFlagRoleNameDescription = "The name of the role you want to create" //CmdFlagRoleArn is flag for the Arn of the role you'd like to add for a new cloud account CmdFlagRoleArn = "arn" //CmdFlagRoleArnDescription is description for --arn CmdFlagRoleArnDescription = "The arn of the role to connect" //CmdFlagRoleExternalID is flag for external-id used to assume the provided role CmdFlagRoleExternalID = "external-id" //CmdFlagRoleSessionName is the name of session for cloud scan command CmdFlagRoleSessionName = "role-session" //CmdFlagRoleSessionNameDescription is the description of flag roleSessionName CmdFlagRoleSessionNameDescription = "The session name to assume the role" //CmdFlagIgnoreMissingTrails will make CLI skip on current region of which cloudTrail is not enabled and go on. CmdFlagIgnoreMissingTrails = "ignore-missing-trails" //CmdFlagIgnoreMissingTrailsDescription describes the usage of CmdFlagIgnoreMissingTrails flag CmdFlagIgnoreMissingTrailsDescription = "CLI will continue on event steam setup even if CloudTrail is not enabled in all regions" //CmdFlagDuration is the duration of session keys for cloud scan command CmdFlagDuration = "duration" //CmdFlagDurationDescription describes the flag duration CmdFlagDurationDescription = "The duration for session in seconds" //CmdFlagAwsProfile = "aws-profile" CmdFlagAwsProfile = "aws-profile" //CmdFlagAwsProfileDescription ... CmdFlagAwsProfileDescription = "Aws shared credential file. If empty default provider chain will be used to look for credentials with the following order.\n" + " 1. Environment variables.\n" + " 2. Shared credentials file.\n" + " 3. If your application is running on an Amazon EC2 instance, IAM role for Amazon EC2." //CmdFlagAwsProfilePath ... CmdFlagAwsProfilePath = "aws-profile-path" //CmdFlagAwsProfilePathDescription ... CmdFlagAwsProfilePathDescription = "The file path of aws profile. If empty will look for AWS_SHARED_CREDENTIALS_FILE env variable. " + "If the env value is empty will default to current user's home directory.\n" + " Linux/OSX: \"$HOME/.aws/credentials\"\n" + " Windows: \"%USERPROFILE%\\.aws\\credentials\"" //CmdFlagAwsPolicy is the flag for policy CmdFlagAwsPolicy = "policy-arn" //CmdFlagAwsPolicyDefault is the default policy arn cli will use CmdFlagAwsPolicyDefault = "arn:aws:iam::aws:policy/SecurityAudit" //CmdFlagAwsPolicyDescription describes flag policy-arn CmdFlagAwsPolicyDescription = "The arn of the policy you'd like to attach for role creation, SecurityAudit policy arn by default" //CmdFlagIsDraft will add a draft account CmdFlagIsDraft = "draft" //CmdFlagIsDraftDescription describes the usage of draft flag CmdFlagIsDraftDescription = "Create a draft" //CmdFlagUserName is the owner username when adding a cloud account, optional CmdFlagUserName = "username" //CmdFlagUserNameDescription describes the username flag CmdFlagUserNameDescription = "User name of account owner" //CmdFlagEnvironmentShort is the short flag for environment flag CmdFlagEnvironmentShort = "e" //CmdFlagEnvironmentLong is the long flag for environment flag CmdFlagEnvironmentLong = "environment" //CmdFlagEnvironmentDescription describes the usage of environment flag CmdFlagEnvironmentDescription = "Environment label for cloud account, four options available: Production, Staging, Development, Test" //CmdFlagProvider is the cloud account provider CmdFlagProvider = "provider" //CmdFlagProviderDescription describes the usage of provider flag CmdFlagProviderDescription = "Your cloud account provider, AWS or Azure" //CmdFlagEmail is the owner email when adding cloud accounts, optional CmdFlagEmail = "email" //CmdFlagEmailDescription describes the usage of email flag CmdFlagEmailDescription = "Email address of account owner" //CmdFlagAwsAssumeRolePolicy is the flag for assume role policy CmdFlagAwsAssumeRolePolicy = "policy" //CmdFlagAwsAssumeRolePolicyDescription describes the usage of flag policy CmdFlagAwsAssumeRolePolicyDescription = "The policy you'd like to use to assume that role" //CmdFlagRoleExternalIDDescription is description for flag --external-id CmdFlagRoleExternalIDDescription = "The external-id used to assume the provided role" //CmdFlagCloudIDDescription flag description CmdFlagCloudIDDescription = "Vss cloud id" //InfoCloudAccountDeleted info InfoCloudAccountDeleted = "Cloud account was deleted" //InfoUsingCloudAccount info InfoUsingCloudAccount = "[ OK ] Using Cloud Account ID %s\n" //ErrorCloudIDRequired error message ErrorCloudIDRequired = "Cloud Account ID is required for this command. Use flag '--cloud-id'\n" //CmdFlagDeleteRole is a flag to delete the role while deleting a cloud account CmdFlagDeleteRole = "role" //CmdFlagDeleteRoleDescription describes flag --role CmdFLagDeleteRoleDescription = "Use this flag to delete the role while deleting a cloud account" //CmdFlagKeyValue is the flag for key value CmdFlagKeyValue = "key-value" //CmdFlagKeyValueDescription is the description for flag --key-value CmdFlagKeyValueDescription = "Key required for adding Azure cloud accounts" //CmdFlagApplicationID is the flag for application ID CmdFlagApplicationID = "application-id" //CmdFlagApplicationIDDescription is the description for flag --application-id CmdFlagApplicationIDDescription = "Application ID required for adding Azure cloud accounts" //CmdFlagDirectoryID is the flag for directory ID CmdFlagDirectoryID = "directory-id" //CmdFlagDirectoryIDDescription is the description for flag --directory-id CmdFlagDirectoryIDDescription = "Directory ID required for adding Azure cloud accounts" //CmdFlagSubscriptionID is the flag for subscription ID CmdFlagSubscriptionID = "subscription-id" //CmdFlagSubscriptionID is the description for flag --subscription-id CmdFlagSubscriptionIDDescription = "Subscription ID required for adding Azure cloud accounts" CmdFlagTags = "tags" CmdFlagTagsDescription = "Set tags for account" )
const ( //CmdCompletionUse docs command CmdCompletionUse = "completion" //CmdCompletionShort short description CmdCompletionShort = "Generate bash autocompletions script" //CmdCompletionLong long description CmdCompletionLong = `` /* 175-byte string literal not displayed */ )
const ( //CmdConfigureShort short description CmdConfigureShort = "Configure CLI options" //CmdConfigureLong long description CmdConfigureLong = `` /* 834-byte string literal not displayed */ //CmdConfigureExample is examples for vss configure command CmdConfigureExample = ` vss configure vss configure --api-key VSS_API_KEY --api-secret VSS_API_SECRET --team-id VSS_TEAM_ID vss configure list` //CmdConfigurePromptAPIKEY prompt for api key CmdConfigurePromptAPIKEY = "Enter your VMware Secure State api token key (available on https://app.cloudcoreo.com under Settings -> API Tokens) [%s]: " //CmdConfigurePromptSecretKEY prompt for secret key CmdConfigurePromptSecretKEY = "" /* 129-byte string literal not displayed */ //CmdConfigurePromptTeamID prompt for team ID CmdConfigurePromptTeamID = "Enter your default VMware Secure State team ID (available on https://app.cloudcoreo.com under Settings -> Team) [%s]: " //CmdConfigureListShort short description CmdConfigureListShort = "List all user profiles" //CmdConfigureListLong long description CmdConfigureListLong = `List all user profiles.` )
const ( //CmdFlagTypeLong cmd CmdFlagTypeLong = "type" //CmdFlagTypeShort cmd CmdFlagTypeShort = "t" //CmdFlagTypeDescription cmd CmdFlagTypeDescription = "the type of documentation to generate (markdown, man, bash)" //CmdDocsUse docs command CmdDocsUse = "docs" //CmdDocsShort short description CmdDocsShort = "Generate documentation as markdown or man pages" //CmdDocsLong long description CmdDocsLong = `` /* 258-byte string literal not displayed */ //ErrorDocGeneration description ErrorDocGeneration = "unknown doc type %q. Try 'markdown' or 'man'" )
const ( //CmdLintUse command CmdLintUse = "coreo lint [flags] PATH" //CmdLintShort short description CmdLintShort = "examines a composite for possible issues" //CmdLintLong long description CmdLintLong = `` /* 342-byte string literal not displayed */ )
const ( //CmdResultUse ... CmdResultUse = "result" //CmdResultShort ... CmdResultShort = "Show the violation results (Deprecated, please follow the link to swagger API doc https://api.securestate.vmware.com)" //CmdResultLong ... CmdResultLong = "Show the violation results (Deprecated, please follow the link to swagger API doc https://api.securestate.vmware.com)" //CmdResultRuleUse ... CmdResultRuleUse = "rule" //CmdResultRuleShort ... CmdResultRuleShort = "Show violating rules (Deprecated)" //CmdResultRuleLong ... CmdResultRuleLong = "Show violating rules (Deprecated)" //CmdResultObjectUse ... CmdResultObjectUse = "object" //CmdResultObjectShort ... CmdResultObjectShort = "Show violating objects (Deprecated)" //CmdResultObjectLong ... CmdResultObjectLong = "Show violating objects (Deprecated)" )
const ( //AccessKey api key AccessKey = "API_KEY" //TeamID team id TeamID = "TEAM_ID" //DefaultFolder default folder DefaultFolder = ".vss" //DefaultFile default file DefaultFile = "profiles.yaml" //None none None = "None" //MaskLength mask length MaskLength = 4 //Mask mask Mask = "****************" //ErrorAPIKeyMissing error ErrorAPIKeyMissing = "VMware Secure State API Key is required for this command. Use flag --api-key\n" //ErrorSecretMissing error ErrorSecretMissing = "Secret is required for this command. Use flag --secret\n" //ErrorAPISecretMissing error ErrorAPISecretMissing = "API Secret is required for this command. Use flag --api-secret\n" //ErrorGitInitNotRan error ErrorGitInitNotRan = "Not a git repository (or any of the parent directories): .git\n" //ErrorNoUserProfileFound error ErrorNoUserProfileFound = "No user profile found. Set profile using 'vss configure' command" //ErrorAcceptsNoArgs error ErrorAcceptsNoArgs = "This command accepts no argument(s).\n" //InfoCreatingGitSubmodule info InfoCreatingGitSubmodule = "Creating gitsubmodule %s in %s...\n" //CmdFlagDirectoryLong cmd CmdFlagDirectoryLong = "directory" //CmdFlagDirectoryShort cmd CmdFlagDirectoryShort = "d" //CmdFlagDirectoryDescription cmd CmdFlagDirectoryDescription = "The working directory <fully-qualified-path>" //CmdFlagNameLong cmd CmdFlagNameLong = "name" //CmdFlagNameShort cmd CmdFlagNameShort = "n" //CmdFlagDescriptionLong cmd CmdFlagDescriptionLong = "description" //CmdFlagDescriptionShort cmd CmdFlagDescriptionShort = "d" //CmdFlagNameDescription cmd CmdFlagNameDescription = "Name flag" //CmdFlagKeyLong cmd CmdFlagKeyLong = "key" //CmdFlagKeyShort cmd CmdFlagKeyShort = "K" //CmdFlagKeyDescription cmd CmdFlagKeyDescription = "Resource key" //CmdFlagSecretLong secret flag long CmdFlagSecretLong = "secret" //CmdFlagSecretShort secret flag short CmdFlagSecretShort = "S" //CmdFlagSecretDescription secret flag description CmdFlagSecretDescription = "Resource secret" //CmdFlagAPISecretLong secret flag long CmdFlagAPISecretLong = "api-secret" //CmdFlagAPISecretDescription api secret flag description CmdFlagAPISecretDescription = "VMware Secure State API Secret" //CmdFlagAPIKeyLong api key flag long CmdFlagAPIKeyLong = "api-key" //CmdFlagAPIKeyDescription api key flag description CmdFlagAPIKeyDescription = "VMware Secure State API Key" //CmdFlagTeamIDLong team id long CmdFlagTeamIDLong = "team-id" //CmdFlagTeamIDDescription team id flag description CmdFlagTeamIDDescription = "VMware Secure State team id" //CmdFlagJSONLong json long CmdFlagJSONLong = "json" //CmdFlagJSONDescription json flag description CmdFlagJSONDescription = "Output in json format" //CmdFlagVerboseLong verbose long CmdFlagVerboseLong = "verbose" //CmdFlagVerboseDescription verbose flag description CmdFlagVerboseDescription = "Enable verbose output" //CmdFlagFileLong JSON file flag CmdFlagFileLong = "file" //CmdFlagFileShort JSON file flag CmdFlagFileShort = "f" //CmdFlagConfigLong config flag long CmdFlagConfigLong = "home" //CmdFlagConfigDescription config flag description CmdFlagConfigDescription = "Location of your VMware Secure State config. Overrides $VSS_HOME." //CmdFlagProfileLong profile flag long CmdFlagProfileLong = "profile" //CmdFlagProfileDescription secret flag description CmdFlagProfileDescription = "VMware Secure State CLI profile to use. Overrides $VSS_PROFILE." //CmdFlagAPIEndpointLong api endpoint flag long CmdFlagAPIEndpointLong = "endpoint" //CmdFlagAPIEndpointDescription api endpoint description CmdFlagAPIEndpointDescription = "VMware Secure State API endpoint. Overrides $VSS_API_ENDPOINT." //CmdCoreoUse Coreo cmd CmdCoreoUse = "vss" //CmdCoreoShort Coreo short description CmdCoreoShort = "VMware Secure State CLI" //CmdCoreoLong Coreo long description CmdCoreoLong = `VMware Secure State CLI.` //CmdConfigureUse configure cmd CmdConfigureUse = "configure" //CmdListUse list cmd CmdListUse = "list" //CmdAddUse add cmd CmdAddUse = "add" //CmdUpdateUse update cmd CmdUpdateUse = "update" //CmdTestUse test cmd CmdTestUse = "test" //CmdScanUse scan cmd CmdScanUse = "scan" //CmdDeleteUse delete cmd CmdDeleteUse = "delete [flags]" //CmdShowUse show cmd CmdShowUse = "show [flags]" //InfoUsingProfile info using profile InfoUsingProfile = "[ OK ] Using Profile %s\n" //InfoCommandSuccess info command was executed successfully InfoCommandSuccess = "[ OK ] Command was executed successfully" )
const ( //CmdTeamUse team command CmdTeamUse = "team" //CmdTeamShort short description CmdTeamShort = "Manage Teams" //CmdTeamLong long description CmdTeamLong = `Manage Teams.` //CmdTeamListShort short description CmdTeamListShort = "Show list of team" //CmdTeamListLong long description CmdTeamListLong = `Show list of team.` //CmdTeamListExample is the use case for command team list CmdTeamListExample = "vss team list" //CmdTeamShowShort short description CmdTeamShowShort = "Show a team" //CmdTeamShowLong long description CmdTeamShowLong = `Show a team.` //CmdTeamAddShort add a team short description CmdTeamAddShort = "Add a team" //CmdTeamAddLong add a team long description CmdTeamAddLong = `Add a team.` //CmdTeamNameDescription provide team name CmdTeamNameDescription = "Provide team name" //CmdTeamDescriptionDescription provide team description CmdTeamDescriptionDescription = "Provide team description" ErrorProviderNotSupported = "Provider not supported, either input AWS or Azure\n" )
const ( //CmdTokenUse token command CmdTokenUse = "token" //CmdTokenShort short description CmdTokenShort = "Manage API Tokens" //CmdTokenLong long description CmdTokenLong = `Manage API Tokens.` //CmdTokenListShort short description CmdTokenListShort = "Show list of tokens" //CmdTokenListLong long description CmdTokenListLong = `Show list of tokens.` //CmdTokenAddShort short description CmdTokenAddShort = "Add a token" //CmdTokenAddLong long description CmdTokenAddLong = `Add a token.` //CmdTokenShowShort short description CmdTokenShowShort = "Show a token" //CmdTokenShowLong long description CmdTokenShowLong = `Show a token.` //CmdTokenDeleteShort short description CmdTokenDeleteShort = "Delete a token" //CmdTokenDeleteLong long description CmdTokenDeleteLong = `Delete a token.` //CmdFlagTokenIDLong flag CmdFlagTokenIDLong = "token-id" //CmdFlagTokenIDDescription flag description CmdFlagTokenIDDescription = "VMware Secure State token id" //InfoUsingTokenID informational using Token id InfoUsingTokenID = "[ OK ] Using Token ID %s\n" //InfoTokenDeleted information InfoTokenDeleted = "[ DONE ] Token was deleted.\n" //ErrorTokenIDMissing error ErrorTokenIDMissing = "Token ID is required for this command. Use flag --token-id\n" )
const ( // CmdVersionUse command CmdVersionUse = "version" //CmdVersionShort command CmdVersionShort = "Print the version number of VMware Secure State CLI" //CmdVersionLong command CmdVersionLong = `Print the version number of VMware Secure State CLI.` )
const CmdEventAuthFile = "auth-file"
const CmdEventAuthFileDescription = "auth file for azure authentication"
const CmdEventLong = "Manage event stream"
CmdEventLong is the long version description for vss event command
const CmdEventRegion = "region"
const CmdEventRegionDescription = "The region in which you'd like to create Azure resource group in"
const CmdEventRemoveExample = `vss event remove
vss event remove --aws-profile YOUR_AWS_PROFILE --cloud-id YOUR_CLOUD_ID`
CmdEventRemoveExample is the use case for command event remove
const CmdEventRemoveLong = "Run this command to remove event stream." +
"You will need to run this script for each cloud account." +
"Make sure your aws credentials have been configured before run this command."
CmdEventRemoveLong is the long version description for vss event remove command
const CmdEventRemoveShort = "Remove event stream"
CmdEventRemoveShort is the short version description for vss event remove command
const CmdEventRemoveUse = "remove"
CmdEventRemoveUse is the command name for command event remove
const CmdEventSetupExample = ` vss event setup
vss event setup --aws-profile YOUR_AWS_PROFILE --cloud-id YOUR_CLOUD_ID`
CmdEventSetupExample is the use case for command event setup
const CmdEventSetupLong = "Run this command to setup event stream. " +
"It will create a CloudFormation stack with an event rule and SNS topic. " +
"You will need to run this script for each cloud account. " +
"Make sure your aws credentials have been configured before run this command."
CmdEventSetupLong is the long version description for vss event setup command
const CmdEventSetupShort = "Setup event stream"
CmdEventSetupShort is the short version description for vss event setup command
const CmdEventSetupUse = "setup"
CmdEventSetupUse is a command to setup event stream
const CmdEventShort = "Manage event stream"
CmdEventShort is the short version description for vss event command
const CmdEventUse = "event"
CmdEventUse is command for event stream
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
This section is empty.