Index
addResourcePoolToEnvironmentTieraddResourceTemplateToEnvironmentTemplateTieraddResourceToEnvironmentTemplateTiercreateEnvironmentTemplatecreateEnvironmentTemplateTiercreateEnvironmentTemplateTierMapcreateHookcreateResourceTemplatedeleteEnvironmentTemplatedeleteEnvironmentTemplateTierdeleteEnvironmentTemplateTierMapdeleteEnvironmentTemplateTierMappingdeleteHookdeleteResourceTemplategetAvailableResourcesForEnvironmentgetEnvironmentTemplategetEnvironmentTemplatesgetEnvironmentTemplateTiergetEnvironmentTemplateTierMapsgetEnvironmentTemplateTiersgetHookgetHooksgetProvisionedEnvironmentsgetResourcePoolsInEnvironmentTiergetResourcesInEnvironmentTemplateTiergetResourceTemplategetResourceTemplatesgetResourceTemplatesInEnvironmentTemplateTiermodifyEnvironmentTemplatemodifyEnvironmentTemplateTiermodifyEnvironmentTemplateTierMapmodifyEnvTemplTierResourceTemplMappingmodifyHookmodifyResourceTemplateprovisionEnvironmentprovisionResourcePoolremoveResourceFromEnvironmentTemplateTierremoveResourcePoolFromEnvironmentTierremoveResourceTemplateFromEnvironmentTemplateTier
getPluginCatalog
getServerSettingsCategories
processWebhookTrigger
getWorkItems

login

Back to index

Summary

Login the client with the given credentials.

The session ID is saved for subsequent ectool use. The userName provided determines the permissions for commands that can be run during the session.

userName
Stringrequired
User name under which you wish to login.
password
Stringrequired
Secret value used to identify the account for a particular user.
token
Stringoptional
User access token.

Usage

Perl

$cmdr->login(
  "test-userName", # userName
  "test-password" # password
  # optionals
);
▼

ectool

ectool login \
  "test-userName" `# userName` \
  "test-password" `# password` \
  # optionals
▼

Examples

Perl

$cmdr->login("Ellen Ernst", "ee123");
▼

ectool

ectool prompts for the password if it is not supplied. 
ectool --server EAVMXP login "Ellen Ernst" "ee123"
▼