github.com/swisscom/cloudfoundry-cli@v7.1.0+incompatible/command/common/command_list_v7.go (about) 1 package common 2 3 import ( 4 "reflect" 5 6 "code.cloudfoundry.org/cli/command/plugin" 7 v6 "code.cloudfoundry.org/cli/command/v6" 8 v7 "code.cloudfoundry.org/cli/command/v7" 9 ) 10 11 var Commands commandList 12 var ShouldFallbackToLegacy = false 13 14 type commandList struct { 15 VerboseOrVersion bool `short:"v" long:"version" description:"verbose and version flag"` 16 17 V3Push v7.PushCommand `command:"v3-push" description:"Push a new app or sync changes to an existing app" hidden:"true"` 18 19 API v7.APICommand `command:"api" description:"Set or view target api url"` 20 AddNetworkPolicy v7.AddNetworkPolicyCommand `command:"add-network-policy" description:"Create policy to allow direct network traffic from one app to another"` 21 AddPluginRepo plugin.AddPluginRepoCommand `command:"add-plugin-repo" description:"Add a new plugin repository"` 22 AllowSpaceSSH v7.AllowSpaceSSHCommand `command:"allow-space-ssh" description:"Allow SSH access for the space"` 23 App v7.AppCommand `command:"app" description:"Display health and status for an app"` 24 ApplyManifest v7.ApplyManifestCommand `command:"apply-manifest" description:"Apply manifest properties to a space"` 25 Apps v7.AppsCommand `command:"apps" alias:"a" description:"List all apps in the target space"` 26 Auth v7.AuthCommand `command:"auth" description:"Authenticate non-interactively"` 27 BindRouteService v6.BindRouteServiceCommand `command:"bind-route-service" alias:"brs" description:"Bind a service instance to an HTTP route"` 28 BindRunningSecurityGroup v7.BindRunningSecurityGroupCommand `command:"bind-running-security-group" description:"Bind a security group to the list of security groups to be used for running applications"` 29 BindSecurityGroup v7.BindSecurityGroupCommand `command:"bind-security-group" description:"Bind a security group to a particular space, or all existing spaces of an org"` 30 BindService v6.BindServiceCommand `command:"bind-service" alias:"bs" description:"Bind a service instance to an app"` 31 BindStagingSecurityGroup v7.BindStagingSecurityGroupCommand `command:"bind-staging-security-group" description:"Bind a security group to the list of security groups to be used for staging applications globally"` 32 Buildpacks v7.BuildpacksCommand `command:"buildpacks" description:"List all buildpacks"` 33 CancelDeployment v7.CancelDeploymentCommand `command:"cancel-deployment" description:"Cancel the most recent deployment for an app. Resets the current droplet to the previous deployment's droplet."` 34 CheckRoute v7.CheckRouteCommand `command:"check-route" description:"Perform a check to determine whether a route currently exists or not"` 35 Config v7.ConfigCommand `command:"config" description:"Write default values to the config"` 36 CopySource v7.CopySourceCommand `command:"copy-source" description:"Copies the source code of an application to another existing application and restages that application"` 37 CreateApp v7.CreateAppCommand `command:"create-app" description:"Create an Application in the target space"` 38 CreateAppManifest v7.CreateAppManifestCommand `command:"create-app-manifest" description:"Create an app manifest for an app that has been pushed successfully"` 39 CreateBuildpack v7.CreateBuildpackCommand `command:"create-buildpack" description:"Create a buildpack"` 40 CreatePackage v7.CreatePackageCommand `command:"create-package" description:"Uploads a Package"` 41 CreateIsolationSegment v7.CreateIsolationSegmentCommand `command:"create-isolation-segment" description:"Create an isolation segment"` 42 CreateOrg v7.CreateOrgCommand `command:"create-org" alias:"co" description:"Create an org"` 43 CreateOrgQuota v7.CreateOrgQuotaCommand `command:"create-org-quota" alias:"create-quota" description:"Define a new quota for an organization"` 44 CreatePrivateDomain v7.CreatePrivateDomainCommand `command:"create-private-domain" alias:"create-domain" description:"Create a private domain for a specific org"` 45 CreateRoute v7.CreateRouteCommand `command:"create-route" description:"Create a route for later use"` 46 CreateSecurityGroup v7.CreateSecurityGroupCommand `command:"create-security-group" description:"Create a security group"` 47 CreateService v6.CreateServiceCommand `command:"create-service" alias:"cs" description:"Create a service instance"` 48 CreateServiceBroker v7.CreateServiceBrokerCommand `command:"create-service-broker" alias:"csb" description:"Create a service broker"` 49 CreateServiceKey v6.CreateServiceKeyCommand `command:"create-service-key" alias:"csk" description:"Create key for a service instance"` 50 CreateSharedDomain v7.CreateSharedDomainCommand `command:"create-shared-domain" description:"Create a domain that can be used by all orgs (admin-only)"` 51 CreateSpace v7.CreateSpaceCommand `command:"create-space" alias:"csp" description:"Create a space"` 52 CreateSpaceQuota v7.CreateSpaceQuotaCommand `command:"create-space-quota" description:"Define a new quota for a space"` 53 CreateUser v7.CreateUserCommand `command:"create-user" description:"Create a new user"` 54 CreateUserProvidedService v6.CreateUserProvidedServiceCommand `command:"create-user-provided-service" alias:"cups" description:"Make a user-provided service instance available to CF apps"` 55 Curl v6.CurlCommand `command:"curl" description:"Executes a request to the targeted API endpoint"` 56 Delete v7.DeleteCommand `command:"delete" alias:"d" description:"Delete an app"` 57 DeleteBuildpack v7.DeleteBuildpackCommand `command:"delete-buildpack" description:"Delete a buildpack"` 58 DeleteIsolationSegment v7.DeleteIsolationSegmentCommand `command:"delete-isolation-segment" description:"Delete an isolation segment"` 59 DeleteOrg v7.DeleteOrgCommand `command:"delete-org" description:"Delete an org"` 60 DeleteOrgQuota v7.DeleteOrgQuotaCommand `command:"delete-org-quota" alias:"delete-quota" description:"Delete an organization quota"` 61 DeleteOrphanedRoutes v7.DeleteOrphanedRoutesCommand `command:"delete-orphaned-routes" description:"Delete all orphaned routes in the currently targeted space (i.e. those that are not mapped to an app or service instance)"` 62 DeletePrivateDomain v7.DeletePrivateDomainCommand `command:"delete-private-domain" alias:"delete-domain" description:"Delete a private domain"` 63 DeleteRoute v7.DeleteRouteCommand `command:"delete-route" description:"Delete a route"` 64 DeleteSecurityGroup v7.DeleteSecurityGroupCommand `command:"delete-security-group" description:"Deletes a security group"` 65 DeleteService v6.DeleteServiceCommand `command:"delete-service" alias:"ds" description:"Delete a service instance"` 66 DeleteServiceBroker v7.DeleteServiceBrokerCommand `command:"delete-service-broker" description:"Delete a service broker"` 67 DeleteServiceKey v6.DeleteServiceKeyCommand `command:"delete-service-key" alias:"dsk" description:"Delete a service key"` 68 DeleteSharedDomain v7.DeleteSharedDomainCommand `command:"delete-shared-domain" description:"Delete a shared domain"` 69 DeleteSpace v7.DeleteSpaceCommand `command:"delete-space" description:"Delete a space"` 70 DeleteSpaceQuota v7.DeleteSpaceQuotaCommand `command:"delete-space-quota" description:"Delete a space quota"` 71 DeleteUser v7.DeleteUserCommand `command:"delete-user" description:"Delete a user"` 72 DisableFeatureFlag v7.DisableFeatureFlagCommand `command:"disable-feature-flag" description:"Prevent use of a feature"` 73 DisableOrgIsolation v7.DisableOrgIsolationCommand `command:"disable-org-isolation" description:"Revoke an organization's entitlement to an isolation segment"` 74 DisableSSH v7.DisableSSHCommand `command:"disable-ssh" description:"Disable ssh for the application"` 75 DisableServiceAccess v7.DisableServiceAccessCommand `command:"disable-service-access" description:"Disable access to a service offering or service plan for one or all orgs"` 76 DisallowSpaceSSH v7.DisallowSpaceSSHCommand `command:"disallow-space-ssh" description:"Disallow SSH access for the space"` 77 Domains v7.DomainsCommand `command:"domains" description:"List domains in the target org"` 78 DownloadDroplet v7.DownloadDropletCommand `command:"download-droplet" description:"Download an application droplet"` 79 Droplets v7.DropletsCommand `command:"droplets" description:"List droplets of an app"` 80 EnableFeatureFlag v7.EnableFeatureFlagCommand `command:"enable-feature-flag" description:"Allow use of a feature"` 81 EnableOrgIsolation v7.EnableOrgIsolationCommand `command:"enable-org-isolation" description:"Entitle an organization to an isolation segment"` 82 EnableSSH v7.EnableSSHCommand `command:"enable-ssh" description:"Enable ssh for the application"` 83 EnableServiceAccess v7.EnableServiceAccessCommand `command:"enable-service-access" description:"Enable access to a service offering or service plan for one or all orgs"` 84 Env v7.EnvCommand `command:"env" alias:"e" description:"Show all env variables for an app"` 85 Events v7.EventsCommand `command:"events" description:"Show recent app events"` 86 FeatureFlag v7.FeatureFlagCommand `command:"feature-flag" description:"Retrieve an individual feature flag with status"` 87 FeatureFlags v7.FeatureFlagsCommand `command:"feature-flags" description:"Retrieve list of feature flags with status"` 88 GetHealthCheck v7.GetHealthCheckCommand `command:"get-health-check" description:"Show the type of health check performed on an app"` 89 Help HelpCommand `command:"help" alias:"h" description:"Show help"` 90 InstallPlugin InstallPluginCommand `command:"install-plugin" description:"Install CLI plugin"` 91 IsolationSegments v7.IsolationSegmentsCommand `command:"isolation-segments" description:"List all isolation segments"` 92 Labels v7.LabelsCommand `command:"labels" description:"List all labels (key-value pairs) for an API resource"` 93 ListPluginRepos plugin.ListPluginReposCommand `command:"list-plugin-repos" description:"List all the added plugin repositories"` 94 Login v7.LoginCommand `command:"login" alias:"l" description:"Log user in"` 95 Logout v7.LogoutCommand `command:"logout" alias:"lo" description:"Log user out"` 96 Logs v7.LogsCommand `command:"logs" description:"Tail or show recent logs for an app"` 97 MapRoute v7.MapRouteCommand `command:"map-route" description:"Map a route to an app"` 98 Marketplace v7.MarketplaceCommand `command:"marketplace" alias:"m" description:"List available offerings in the marketplace"` 99 NetworkPolicies v7.NetworkPoliciesCommand `command:"network-policies" description:"List direct network traffic policies"` 100 OauthToken v7.OauthTokenCommand `command:"oauth-token" description:"Display the OAuth token for the current session and refresh the token if necessary"` 101 Org v7.OrgCommand `command:"org" description:"Show org info"` 102 OrgQuotas v7.OrgQuotasCommand `command:"org-quotas" alias:"quotas" description:"List available organization quotas"` 103 OrgQuota v7.OrgQuotaCommand `command:"org-quota" alias:"quota" description:"Show organization quota"` 104 OrgUsers v7.OrgUsersCommand `command:"org-users" description:"Show org users by role"` 105 Orgs v7.OrgsCommand `command:"orgs" alias:"o" description:"List all orgs"` 106 Packages v7.PackagesCommand `command:"packages" description:"List packages of an app"` 107 Passwd v7.PasswdCommand `command:"passwd" alias:"pw" description:"Change user password"` 108 Plugins plugin.PluginsCommand `command:"plugins" description:"List commands of installed plugins"` 109 PurgeServiceInstance v6.PurgeServiceInstanceCommand `command:"purge-service-instance" description:"Recursively remove a service instance and child objects from Cloud Foundry database without making requests to a service broker"` 110 PurgeServiceOffering v7.PurgeServiceOfferingCommand `command:"purge-service-offering" description:"Recursively remove a service offering and child objects from Cloud Foundry database without making requests to a service broker"` 111 Push v7.PushCommand `command:"push" alias:"p" description:"Push a new app or sync changes to an existing app"` 112 RemoveNetworkPolicy v7.RemoveNetworkPolicyCommand `command:"remove-network-policy" description:"Remove network traffic policy of an app"` 113 RemovePluginRepo plugin.RemovePluginRepoCommand `command:"remove-plugin-repo" description:"Remove a plugin repository"` 114 Rename v7.RenameCommand `command:"rename" description:"Rename an app"` 115 RenameOrg v7.RenameOrgCommand `command:"rename-org" description:"Rename an org"` 116 RenameService v6.RenameServiceCommand `command:"rename-service" description:"Rename a service instance"` 117 RenameServiceBroker v7.RenameServiceBrokerCommand `command:"rename-service-broker" description:"Rename a service broker"` 118 RenameSpace v7.RenameSpaceCommand `command:"rename-space" description:"Rename a space"` 119 RepoPlugins plugin.RepoPluginsCommand `command:"repo-plugins" description:"List all available plugins in specified repository or in all added repositories"` 120 ResetOrgDefaultIsolationSegment v7.ResetOrgDefaultIsolationSegmentCommand `command:"reset-org-default-isolation-segment" description:"Reset the default isolation segment used for apps in spaces of an org"` 121 ResetSpaceIsolationSegment v7.ResetSpaceIsolationSegmentCommand `command:"reset-space-isolation-segment" description:"Reset the space's isolation segment to the org default"` 122 Restage v7.RestageCommand `command:"restage" alias:"rg" description:"Stage the app's latest package into a droplet and restart the app with this new droplet and updated configuration (environment variables, service bindings, buildpack, stack, etc.)."` 123 Revisions v7.RevisionsCommand `command:"revisions" description:"Lists revisions for an app"` 124 Rollback v7.RollbackCommand `command:"rollback" description:"Rollback to the specified revision of an app"` 125 StagePackage v7.StagePackageCommand `command:"stage-package" alias:"stage" description:"Stage a package into a droplet"` 126 Restart v7.RestartCommand `command:"restart" alias:"rs" description:"Stop all instances of the app, then start them again."` 127 RestartAppInstance v7.RestartAppInstanceCommand `command:"restart-app-instance" description:"Terminate, then instantiate an app instance"` 128 RouterGroups v7.RouterGroupsCommand `command:"router-groups" description:"List router groups"` 129 Routes v7.RoutesCommand `command:"routes" alias:"r" description:"List all routes in the current space or the current organization"` 130 RunTask v7.RunTaskCommand `command:"run-task" alias:"rt" description:"Run a one-off task on an app"` 131 RunningEnvironmentVariableGroup v7.RunningEnvironmentVariableGroupCommand `command:"running-environment-variable-group" alias:"revg" description:"Retrieve the contents of the running environment variable group"` 132 RunningSecurityGroups v7.RunningSecurityGroupsCommand `command:"running-security-groups" description:"List security groups globally configured for running applications"` 133 SSH v7.SSHCommand `command:"ssh" description:"SSH to an application container instance"` 134 SSHCode v7.SSHCodeCommand `command:"ssh-code" description:"Get a one time password for ssh clients"` 135 SSHEnabled v7.SSHEnabledCommand `command:"ssh-enabled" description:"Reports whether SSH is enabled on an application container instance"` 136 Scale v7.ScaleCommand `command:"scale" description:"Change or view the instance count, disk space limit, and memory limit for an app"` 137 SecurityGroup v7.SecurityGroupCommand `command:"security-group" description:"Show a single security group"` 138 SecurityGroups v7.SecurityGroupsCommand `command:"security-groups" description:"List all security groups"` 139 Service v6.ServiceCommand `command:"service" description:"Show service instance info"` 140 ServiceAccess v7.ServiceAccessCommand `command:"service-access" description:"List service access settings"` 141 ServiceBrokers v7.ServiceBrokersCommand `command:"service-brokers" description:"List service brokers"` 142 ServiceKey v6.ServiceKeyCommand `command:"service-key" description:"Show service key info"` 143 ServiceKeys v6.ServiceKeysCommand `command:"service-keys" alias:"sk" description:"List keys for a service instance"` 144 Services v6.ServicesCommand `command:"services" alias:"s" description:"List all service instances in the target space"` 145 SetDroplet v7.SetDropletCommand `command:"set-droplet" description:"Set the droplet used to run an app"` 146 SetEnv v7.SetEnvCommand `command:"set-env" alias:"se" description:"Set an env variable for an app"` 147 SetHealthCheck v7.SetHealthCheckCommand `command:"set-health-check" description:"Change type of health check performed on an app's process"` 148 SetLabel v7.SetLabelCommand `command:"set-label" description:"Set a label (key-value pairs) for an API resource"` 149 SetOrgDefaultIsolationSegment v7.SetOrgDefaultIsolationSegmentCommand `command:"set-org-default-isolation-segment" description:"Set the default isolation segment used for apps in spaces in an org"` 150 SetOrgRole v7.SetOrgRoleCommand `command:"set-org-role" description:"Assign an org role to a user"` 151 SetOrgQuota v7.SetOrgQuotaCommand `command:"set-org-quota" alias:"set-quota" description:"Assign a quota to an organization"` 152 SetRunningEnvironmentVariableGroup v7.SetRunningEnvironmentVariableGroupCommand `command:"set-running-environment-variable-group" alias:"srevg" description:"Pass parameters as JSON to create a running environment variable group"` 153 SetSpaceIsolationSegment v7.SetSpaceIsolationSegmentCommand `command:"set-space-isolation-segment" description:"Assign the isolation segment for a space"` 154 SetSpaceQuota v7.SetSpaceQuotaCommand `command:"set-space-quota" description:"Assign a quota to a space"` 155 SetSpaceRole v7.SetSpaceRoleCommand `command:"set-space-role" description:"Assign a space role to a user"` 156 SetStagingEnvironmentVariableGroup v7.SetStagingEnvironmentVariableGroupCommand `command:"set-staging-environment-variable-group" alias:"ssevg" description:"Pass parameters as JSON to create a staging environment variable group"` 157 SharePrivateDomain v7.SharePrivateDomainCommand `command:"share-private-domain" description:"Share a private domain with a specific org"` 158 ShareService v6.ShareServiceCommand `command:"share-service" description:"Share a service instance with another space"` 159 Space v7.SpaceCommand `command:"space" description:"Show space info"` 160 SpaceQuota v7.SpaceQuotaCommand `command:"space-quota" description:"Show space quota info"` 161 SpaceQuotas v7.SpaceQuotasCommand `command:"space-quotas" description:"List available space quotas"` 162 SpaceSSHAllowed v7.SpaceSSHAllowedCommand `command:"space-ssh-allowed" description:"Reports whether SSH is allowed in a space"` 163 SpaceUsers v7.SpaceUsersCommand `command:"space-users" description:"Show space users by role"` 164 Spaces v7.SpacesCommand `command:"spaces" description:"List all spaces in an org"` 165 Stack v7.StackCommand `command:"stack" description:"Show information for a stack (a stack is a pre-built file system, including an operating system, that can run apps)"` 166 Stacks v7.StacksCommand `command:"stacks" description:"List all stacks (a stack is a pre-built file system, including an operating system, that can run apps)"` 167 StagingEnvironmentVariableGroup v7.StagingEnvironmentVariableGroupCommand `command:"staging-environment-variable-group" alias:"sevg" description:"Retrieve the contents of the staging environment variable group"` 168 StagingSecurityGroups v7.StagingSecurityGroupsCommand `command:"staging-security-groups" description:"List security groups globally configured for staging applications"` 169 Start v7.StartCommand `command:"start" alias:"st" description:"Start an app"` 170 Stop v7.StopCommand `command:"stop" alias:"sp" description:"Stop an app"` 171 Target v7.TargetCommand `command:"target" alias:"t" description:"Set or view the targeted org or space"` 172 Tasks v7.TasksCommand `command:"tasks" description:"List tasks of an app"` 173 TerminateTask v7.TerminateTaskCommand `command:"terminate-task" description:"Terminate a running task of an app"` 174 UnbindRouteService v6.UnbindRouteServiceCommand `command:"unbind-route-service" alias:"urs" description:"Unbind a service instance from an HTTP route"` 175 UnbindRunningSecurityGroup v7.UnbindRunningSecurityGroupCommand `command:"unbind-running-security-group" description:"Unbind a security group from the set of security groups for running applications globally"` 176 UnbindSecurityGroup v7.UnbindSecurityGroupCommand `command:"unbind-security-group" description:"Unbind a security group from a space"` 177 UnbindService v6.UnbindServiceCommand `command:"unbind-service" alias:"us" description:"Unbind a service instance from an app"` 178 UnbindStagingSecurityGroup v7.UnbindStagingSecurityGroupCommand `command:"unbind-staging-security-group" description:"Unbind a security group from the set of security groups for staging applications globally"` 179 UninstallPlugin plugin.UninstallPluginCommand `command:"uninstall-plugin" description:"Uninstall CLI plugin"` 180 UnmapRoute v7.UnmapRouteCommand `command:"unmap-route" description:"Remove a route from an app"` 181 UnsetEnv v7.UnsetEnvCommand `command:"unset-env" alias:"ue" description:"Remove an env variable from an app"` 182 UnsetLabel v7.UnsetLabelCommand `command:"unset-label" description:"Unset a label (key-value pairs) for an API resource"` 183 UnsetOrgRole v7.UnsetOrgRoleCommand `command:"unset-org-role" description:"Remove an org role from a user"` 184 UnsetSpaceQuota v7.UnsetSpaceQuotaCommand `command:"unset-space-quota" description:"Unassign a quota from a space"` 185 UnsetSpaceRole v7.UnsetSpaceRoleCommand `command:"unset-space-role" description:"Remove a space role from a user"` 186 UnsharePrivateDomain v7.UnsharePrivateDomainCommand `command:"unshare-private-domain" description:"Unshare a private domain with a specific org"` 187 UnshareService v6.UnshareServiceCommand `command:"unshare-service" description:"Unshare a shared service instance from a space"` 188 UpdateBuildpack v7.UpdateBuildpackCommand `command:"update-buildpack" description:"Update a buildpack"` 189 UpdateOrgQuota v7.UpdateOrgQuotaCommand `command:"update-org-quota" alias:"update-quota" description:"Update an existing organization quota"` 190 UpdateSecurityGroup v7.UpdateSecurityGroupCommand `command:"update-security-group" description:"Update a security group"` 191 UpdateService v6.UpdateServiceCommand `command:"update-service" description:"Update a service instance"` 192 UpdateServiceBroker v7.UpdateServiceBrokerCommand `command:"update-service-broker" description:"Update a service broker"` 193 UpdateSpaceQuota v7.UpdateSpaceQuotaCommand `command:"update-space-quota" description:"Update an existing space quota"` 194 UpdateUserProvidedService v6.UpdateUserProvidedServiceCommand `command:"update-user-provided-service" alias:"uups" description:"Update user-provided service instance"` 195 Version VersionCommand `command:"version" description:"Print the version"` 196 } 197 198 // HasCommand returns true if the command name is in the command list. 199 func (c commandList) HasCommand(name string) bool { 200 if name == "" { 201 return false 202 } 203 204 cType := reflect.TypeOf(c) 205 _, found := cType.FieldByNameFunc( 206 func(fieldName string) bool { 207 field, _ := cType.FieldByName(fieldName) 208 return field.Tag.Get("command") == name 209 }, 210 ) 211 212 return found 213 } 214 215 // HasAlias returns true if the command alias is in the command list. 216 func (c commandList) HasAlias(alias string) bool { 217 if alias == "" { 218 return false 219 } 220 221 cType := reflect.TypeOf(c) 222 _, found := cType.FieldByNameFunc( 223 func(fieldName string) bool { 224 field, _ := cType.FieldByName(fieldName) 225 return field.Tag.Get("alias") == alias 226 }, 227 ) 228 229 return found 230 }