Package: yeedu-cli
Yeedu Command-Line-Interface v4.5.4Yeedu CLI(Command Line Interface) is a standard CLI to run interactively
with Yeedu’sRESTful-API.Table of ContentsRequirementsCLI SetupWindowsGenerate Executable file for yeedu
CLILinuxEnvironment Variable SetupAuthentication SetupStoring the credentials as Environment
VariablesStoring the credentials inside a yeedu_credentials.config
fileStoring the Yeedu Session Token inside a
fileconfigurelist-tenantsassociate-tenantResourcesLookuplist-providersget-providerlist-provider-availability-zonesget-provider-availability-zonelist-provider-machine-typesget-provider-machine-typelist-disk-machine-typeslist-credential-typeslist-engine-cluster-instance-statuslist-spark-compute-typeslist-spark-infra-versionslist-spark-job-statuslist-workflow-execution-stateslist-workflow-typesVolume Configurationcreate-volume-conflist-volume-confsget-volume-confedit-volume-confNetwork Configurationcreate-network-conflist-network-confsget-network-confedit-network-confBoot Disk Image Configcreate-boot-disk-image-confget-boot-disk-image-conflist-boot-disk-image-confsMachine Configurationcreate-machine-conflist-machine-confsget-machine-confedit-machine-confCredentials Configurationcreate-credential-conflist-credential-confsget-credential-confedit-credential-confdelete-credential-confObject Storage Managercreate-object-storage-managerlist-object-storage-managersget-object-storage-manageredit-object-storage-managerdelete-object-storage-managerObject Storage Manager Filescreate-object-storage-manager-filelist-object-storage-manager-filesget-object-storage-manager-filedelete-object-storage-manager-fileHive Metastore Configurationcreate-hive-metastore-conflist-hive-metastore-confsget-hive-metastore-confedit-hive-metastore-confdelete-hive-metastore-confClusterCluster Configurationcreate-conflist-confsget-confedit-confCluster Instancecreatelistgeteditstartstopdestroyget-statslogsJobSpark Job Configurationcreate-conflist-confsget-confedit-confdelete-confSpark Job InstancestartlistgetkilllogsWorkflow Details By Spark Job Application
IDget-workflow-job-instanceIAM (Identity and Access
Management)Userget-user-infoget-user-rolesShared Platform and Adminsync-usersync-grouplist-user-groupslist-userslist-group-userslist-groupsLookuplist-resourcesget-resourcelist-permissionsget-permissionlist-rolesget-rolelist-rulesget-rulePlatform-AdminTenantcreate-tenantlist-tenantsget-tenantedit-tenantdelete-tenantUserlist-user-tenantslist-tenant-usersget-tenant-userget-user-roleslist-users-rolesget-role-userscreate-user-roledelete-user-roleGrouplist-tenant-groupsget-tenant-groupget-group-roleslist-groups-rolesget-role-groupscreate-group-roledelete-group-roleAdminUserlist-usersget-userget-user-roleslist-users-rolesget-role-userscreate-user-roledelete-user-roleGrouplist-groupsget-groupget-group-roleslist-groups-rolesget-role-groupscreate-group-roledelete-group-roleRequirementsThe yeedu-cli package works on Python version:3.8.x and greaterCLI SetupNeed to run below command from the project directory to setup the yeedu
CLI on the environment.Windowspipinstall--editable.Generate Executable file for yeedu CLINeed to installpyinstallerusing below mentioned commandpipinstallpyinstallerFrom project directory execute below mention commandpyinstaller--onefileyeedu.pyTraverse to\distdirectory and get the executable fileyeedu.exeThe yeedu.exe commands can be formed as shown below:yeedu.exe[-h]yeedu.exe<command>[-h]yeedu.exe<command><subcommand>[-h]Example of yeedu CLI command using executable fileyeedu.exeresourcelist-providersLinuxWSLsudoaptinstallpython3-pippip3install--editable.Bashsudopython3setup.pydevelopEnvironment Variable SetupCreate a.envfile in the project directory and provide below
environment variables.# Below mentioned values are the default values of Environment VariablesYEEDU_RESTAPI_URL="http://localhost:8080"YEEDU_CLI_LOG_DIR=~/.yeedu/cli/logs/YEEDU_CLI_MAX_LOG_FILES=5# Number 0f log files as an integerYEEDU_CLI_MAX_LOG_FILE_SIZE=30# Log file size in MB as an integerYEEDU_USERNAME=USERYEEDU_PASSWORD=PASSYEEDU_RESTAPI_TOKEN=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6ImFiY2RlZiIsImlkIjoiMSIsImlhdCI6MTY2NzgwOTYwMX0.HwhdTHBttnR0NFtmUDjcxTLMSLfyNuBs7t7GO9zOf08YEEDU_RESTAPI_TOKEN_FILE_PATH=/home/user/yeedu_cli.configAlternative of.envfileWindows CMDSETYEEDU_RESTAPI_URL="http://localhost:8080"SETYEEDU_CLI_LOG_DIR=~/.yeedu/cli/logs/SETYEEDU_CLI_MAX_LOG_FILES=5SETYEEDU_CLI_MAX_LOG_FILE_SIZE=30SETYEEDU_USERNAME=USERSETYEEDU_PASSWORD=PASSSETYEEDU_RESTAPI_TOKEN=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6ImFiY2RlZiIsImlkIjoiMSIsImlhdCI6MTY2NzgwOTYwMX0.HwhdTHBttnR0NFtmUDjcxTLMSLfyNuBs7t7GO9zOf08SETYEEDU_RESTAPI_TOKEN_FILE_PATH=/home/user/yeedu_cli.configLinuxexportYEEDU_RESTAPI_URL="http://localhost:8080"exportYEEDU_CLI_LOG_DIR=~/.yeedu/cli/logs/exportYEEDU_CLI_MAX_LOG_FILES=5exportYEEDU_CLI_MAX_LOG_FILE_SIZE=30exportYEEDU_USERNAME=USERexportYEEDU_PASSWORD=PASSexportYEEDU_RESTAPI_TOKEN=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6ImFiY2RlZiIsImlkIjoiMSIsImlhdCI6MTY2NzgwOTYwMX0.HwhdTHBttnR0NFtmUDjcxTLMSLfyNuBs7t7GO9zOf08exportYEEDU_RESTAPI_TOKEN_FILE_PATH=/home/user/yeedu_cli.configAuthentication SetupBelow mentions ways of storing the credentials which will be used
[Environment Variables will be given a priority] to generate the
token.Storing the credentials as Environment VariablesYEEDU_USERNAME=USERYEEDU_PASSWORD=PASSStoring the credentials inside ayeedu_credentials.configfileThe yeedu_credentials.config file needs to be created inside the
directoryhome/user/.yeedu/which consists of JSON as shown
below:{"YEEDU_USERNAME":"USER","YEEDU_PASSWORD":"PASS"}Storing the Yeedu Session Token inside a fileIf the user is already having the Yeedu Session Token. Then user can
save the token at the any location and provide the file path in
enviroment variableYEEDU_RESTAPI_TOKEN_FILE_PATHFor exampleYEEDU_RESTAPI_TOKEN_FILE_PATH="/home/user/Documents/YeeduToken/{FileName}"Format to store the token is as shown below:{"token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoxLCJpYXQiOjE2ODg3MjA0MjIsImV4cCI6MTY4ODg5MzIyMn0.EfxuXKPBISQB4ep-sPQbo6R7tg2irlnAC_krqnuXJ5Q"}Command NameUtilityconfigureUsed to generate the token.list-tenantsTo list all the available
tenants for the session user.associate-tenantTo associate tenant with the
current users session Token.configureyeeduconfigure-hYeeduCLIpositionalarguments:{configure}options:-h,--helpShowthishelpmessageandexit.--timeout[TIMEOUT]ProvidetokenexpirationtimeoutinhourExample:--timeout=24,--timeout=infinity(infinityfornoexpirationtime)togenerateYeeduToken.(default:48)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)User can provide the file path to stored the configured token using
the environment variableYEEDU_RESTAPI_TOKEN_FILE_PATH.For exampleYEEDU_RESTAPI_TOKEN_FILE_PATH="/home/user/Documents/YeeduToken/{FileName}"configure example with optional argument passed.yeeduconfigure--timeout=72Console output{"message":"The token has been configured for the username: USER and stored at location: /home/user/.yeedu/yeedu_cli.config"}The generated token will be used internally for accessing the yeedu
features based on the acess level provided to the given usernameTo list the tenants a user has access to, execute theyeedu iamlist-tenantscommand.list-tenantsyeeduiamlist-tenants-husage:list-tenants[-h][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list-tenants example without optional arguments passed for output
format.yeeduiamlist-tenantsConsole output[{"tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538","name":"tenant1","description":"Yeedu Tenant 1"},{"tenant_id":"066a702d-6b9d-4176-afc5-51c24a651739","name":"tenant2","description":"Yeedu Tenant 2"},{"tenant_id":"328aba9a-92ac-458d-8c27-fe9ea6e5e9ab","name":"tenant3","description":"Yeedu Tenant 3"},{"tenant_id":"6b682ef1-ede4-4d96-bab6-cd008aadd534","name":"tenant4","description":"Yeedu Tenant 4"}]Executeyeedu iamassociate-tenant--tenant_id={tenant_id}to
associate a tenant id from theyeedu iamlist-tenantsresponse to
the session token.associate-tenantyeeduiamassociate-tenant-husage:associate-tenant[-h]--tenant_idTENANT_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--tenant_idTENANT_IDProvidetenant_idtoassociateitwithsessiontoken--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)associate-tenant example with required argument ‘–tenant_id’ passed.yeeduiamassociate-tenant--tenant_id="0b5017a9-6099-497f-81ba-d4e537e23538"Console output{"message":"Successfully associated Tenant"}ResourcesLookupCommand NameUtilitylist-providersTo get information about all
Cloud Providers.get-providerTo get information about a
specific Cloud Provider.list-provider-availability-zonesTo get information about
Availability Zones for a specific
Cloud Provider.get-provider-availability-zoneTo get information about a
specific Availability Zone for a
specific Cloud Provider.list-provider-machine-typesTo get information about Machine
Types for a specific Cloud
Provider.get-provider-machine-typeTo get information about a
specific Machine Type for a
specific Cloud Provider.list-disk-machine-typesTo get information about all
disk machine types.list-credential-typesTo get information about all
credential types.list-engine-cluster-instance-statusTo get information about
available engine cluster
instance status.list-spark-compute-typesTo get information about all
spark compute types.list-spark-infra-versionsTo get information about spark
infra version.list-spark-job-statusTo get information about spark
job status.list-workflow-execution-statesTo get information about
workflow execution state.list-workflow-typesTo get information about
workflow type.list-providersyeeduresourcelist-providers-husage:list-providers[-h][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list-providers example without any optional argument passed for
output format.yeeduresourcelist-providersConsole output[{"cloud_provider_id":"0","name":"gcp","description":"Provider for creating infrastructure on Google Cloud Platform","from_date":"2023-07-14T13:44:16.300Z","to_date":null},{"cloud_provider_id":"1","name":"aws","description":"Provider for creating infrastructure on Amazon Web Services","from_date":"2023-07-14T13:44:16.300Z","to_date":null},{"cloud_provider_id":"2","name":"azure","description":"Provider for creating infrastructure on Azure Cloud Platform","from_date":"2023-07-14T13:44:16.300Z","to_date":null}]get-provideryeeduresourceget-provider-husage:get-provider[-h]--cloud_provider_idCLOUD_PROVIDER_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--cloud_provider_idCLOUD_PROVIDER_IDProvidespecificcloudprovideridtoget-provider.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)get-provider example with required ‘–cloud_provider_id’ argument
passed.yeeduresourceget-provider--cloud_provider_id=0Console output{"cloud_provider_id":"0","name":"gcp","description":"Provider for creating infrastructure on Google Cloud Platform","from_date":"2023-07-14T13:44:16.300Z","to_date":null}list-provider-availability-zonesyeeduresourcelist-provider-availability-zones-husage:list-provider-availability-zones[-h]--cloud_provider_idCLOUD_PROVIDER_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--cloud_provider_idCLOUD_PROVIDER_IDProvidespecificCloudProvideridtolist-provider-availability-zones.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list-provider-availability-zones example with required
‘–cloud_provider_id’ argument passed.yeeduresourcelist-provider-availability-zones--cloud_provider_id=0Console output[{"availability_zone_id":"0","cloud_provider":{"name":"gcp","description":"Provider for creating infrastructure on Google Cloud Platform"},"name":"asia-east1-a","region":"asia-east1","description":"Changhua County, Taiwan, APAC","from_date":"2023-07-14T13:44:19.583Z","to_date":null},...{"availability_zone_id":"102","cloud_provider":{"name":"gcp","description":"Provider for creating infrastructure on Google Cloud Platform"},"name":"us-south1-c","region":"us-south1","description":"Dallas, Texas, North America","from_date":"2023-07-14T13:44:19.583Z","to_date":null}]get-provider-availability-zoneyeeduresourceget-provider-availability-zone-husage:get-provider-availability-zone[-h]--cloud_provider_idCLOUD_PROVIDER_ID--availability_zone_idAVAILABILITY_ZONE_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--cloud_provider_idCLOUD_PROVIDER_IDProvidespecificcloudprovideridtoget-provider-availability-zone.--availability_zone_idAVAILABILITY_ZONE_IDProvidespecificAvailabilityZoneidtoget-provider-availability-zone.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)get-provider-availability-zone example with required arguments
passed.yeeduresourceget-provider-availability-zone--cloud_provider_id=1--availability_zone_id=116Console output{"availability_zone_id":"116","cloud_provider":{"name":"aws","description":"Provider for creating infrastructure on Amazon Web Services"},"name":"Canada","region":"ca-central-1","description":"central","from_date":"2023-07-14T13:44:19.583Z","to_date":null}list-provider-machine-typesyeeduresourcelist-provider-machine-types-husage:list-provider-machine-types[-h]--cloud_provider_idCLOUD_PROVIDER_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--cloud_provider_idCLOUD_PROVIDER_IDProvidespecificcloudprovideridtolist-provider-machine-types.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list-provider-machine-types example with required
‘–cloud_provider_id’ argument passed.yeeduresourcelist-provider-machine-types--cloud_provider_id=0Console output[{"machine_type_id":"0","cloud_provider":{"name":"gcp","description":"Provider for creating infrastructure on Google Cloud Platform"},"name":"a2-highgpu-1g","vcpus":12,"memory":"85 GiB","has_cuda":false,"gpu_model":null,"gpus":null,"gpu_memory":null,"from_date":"2023-07-14T13:44:18.310Z","to_date":null},...{"machine_type_id":"723","cloud_provider":{"name":"gcp","description":"Provider for creating infrastructure on Google Cloud Platform"},"name":"n1-standard-4-4g","vcpus":4,"memory":"15 GiB","has_cuda":true,"gpu_model":"nvidia-tesla-t4","gpus":4,"gpu_memory":"64 GB GDDR6","from_date":"2023-07-14T13:44:18.310Z","to_date":null}]get-provider-machine-typeyeeduresourceget-provider-machine-type-husage:get-provider-machine-type[-h]--cloud_provider_idCLOUD_PROVIDER_ID--machine_type_idMACHINE_TYPE_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--cloud_provider_idCLOUD_PROVIDER_IDProvidespecificcloudprovideridtoget-provider-machine-type.--machine_type_idMACHINE_TYPE_IDProvidespecificmachinetypeidtoget-provider-machine-type.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)get-provider-machine-type example with all the required arguments
passed.yeeduresourceget-provider-machine-type--cloud_provider_id=0--machine_type_id=108Console output{"machine_type_id":"108","cloud_provider":{"name":"gcp","description":"Provider for creating infrastructure on Google Cloud Platform"},"name":"n2d-highmem-64","vcpus":64,"memory":"512 GiB","has_cuda":false,"gpu_model":null,"gpus":null,"gpu_memory":null,"from_date":"2023-07-14T13:44:18.310Z","to_date":null}list-disk-machine-typesyeeduresourcelist-disk-machine-types-husage:list-disk-machine-types[-h][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list-disk-machine-types example without optional argument passed for
output format.yeeduresourcelist-disk-machine-typesConsole output[{"disk_type_id":"0","cloud_provider":{"name":"gcp","description":"Provider for creating infrastructure on Google Cloud Platform"},"name":"pd-ssd","has_fixed_size":false,"min_size":10,"max_size":64000,"from_date":"2023-07-14T13:44:19.081Z","to_date":null},...{"disk_type_id":"15","cloud_provider":{"name":"azure","description":"Provider for creating infrastructure on Azure Cloud Platform"},"name":"UltraSSD_LRS","has_fixed_size":false,"min_size":4,"max_size":65536,"from_date":"2023-07-14T13:44:19.081Z","to_date":null}]list-credential-typesyeeduresourcelist-credential-types-husage:list-credential-types[-h][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list-credential-types example without optional argument passed for
output format.yeeduresourcelist-credential-typesConsole output[{"credential_type_id":"0","name":"gcp","cloud_provider":{"name":"gcp","description":"Provider for creating infrastructure on Google Cloud Platform"},"from_date":"2023-07-14T13:44:17.305Z","to_date":null},{"credential_type_id":"1","name":"aws","cloud_provider":{"name":"aws","description":"Provider for creating infrastructure on Amazon Web Services"},"from_date":"2023-07-14T13:44:17.305Z","to_date":null},{"credential_type_id":"2","name":"azure","cloud_provider":{"name":"azure","description":"Provider for creating infrastructure on Azure Cloud Platform"},"from_date":"2023-07-14T13:44:17.305Z","to_date":null}]list-engine-cluster-instance-statusyeeduresourcelist-engine-cluster-instance-status-husage:list-engine-cluster-instance-status[-h][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list-engine-cluster-instance-status example without optional argument
passed for output format.yeeduresourcelist-engine-cluster-instance-statusConsole output[{"engine_cluster_instance_status_id":"0","name":"INITIATING","description":"Cluster will be eventually created","from_date":"2023-07-14T13:44:16.802Z","to_date":null},...{"engine_cluster_instance_status_id":"8","name":"RESIZING_DOWN","description":"The cluster instance will scale down","from_date":"2023-07-14T13:44:16.802Z","to_date":null}]list-spark-compute-typesyeeduresourcelist-spark-compute-types-husage:list-spark-compute-types[-h][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list-spark-compute-types example without optional argument passed for
output format.yeeduresourcelist-spark-compute-typesConsole output[{"spark_compute_type_id":"0","name":"YEEDU","description":null,"from_date":"2023-07-14T13:44:21.102Z","to_date":null}]list-spark-infra-versionsyeeduresourcelist-spark-infra-versions-husage:list-spark-infra-versions[-h][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list-spark-infra-versions example without optional argument passed
for output format.yeeduresourcelist-spark-infra-versionsConsole output[{"spark_infra_version_id":"0","spark_version":"2.4.8","hive_version":"3.2.3","hadoop_version":"2.10.1","scala_version":"2.11.10","from_date":"2023-07-14T13:44:17.808Z","to_date":null},{"spark_infra_version_id":"1","spark_version":"3.2.2","hive_version":"3.2.3","hadoop_version":"3.2.4","scala_version":"2.12.15","from_date":"2023-07-14T13:44:17.808Z","to_date":null}]list-spark-job-statusyeeduresourcelist-spark-job-status-husage:list-spark-job-status[-h][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list-spark-job-status example without optional argument passed for
output format.yeeduresourcelist-spark-job-statusConsole output[{"spark_job_status_id":"0","name":"SUBMITTED","description":"Job was submitted, waiting for Application ID","from_date":"2023-07-14T13:44:21.604Z","to_date":null},...{"spark_job_status_id":"8","name":"KILLED","description":"The process was killed","from_date":"2023-07-14T13:44:21.604Z","to_date":null}]list-workflow-execution-statesyeeduresourcelist-workflow-execution-states-husage:list-workflow-execution-states[-h][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list-workflow-execution-states example without optional argument
passed for output format.yeeduresourcelist-workflow-execution-statesConsole output[{"workflow_execution_state_id":-1,"name":"NONE","description":"NONE","from_date":"2023-07-14T13:44:20.097Z","to_date":null},...{"workflow_execution_state_id":99,"name":"DONE","description":"NONE","from_date":"2023-07-14T13:44:20.097Z","to_date":null}]list-workflow-typesyeeduresourcelist-workflow-types-husage:list-workflow-types[-h][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list-workflow-types example without optional argument passed for
output format.yeeduresourcelist-workflow-typesConsole output[{"workflow_type_id":"0","name":"spark_start","queue_name":"yeedu.workflows.usi.start","description":null,"from_date":"2023-07-14T13:44:20.600Z","to_date":null},...{"workflow_type_id":"8","name":"cosi_resize_down","queue_name":"yeedu.workflows.cosi","description":null,"from_date":"2023-07-14T13:44:20.600Z","to_date":null}]Volume ConfigurationCommand NameUtilitycreate-volume-confTo create the Volume
Configuration.list-volume-confsTo list all the available Volume
Configurations.get-volume-confTo get information about a
specific Volume Configuration.edit-volume-confTo edit a specific Volume
Configuration.create-volume-confyeeduresourcecreate-volume-conf-husage:create-volume-conf[-h]--name[NAME]--availability_zone_idAVAILABILITY_ZONE_ID--encryptedtrue,false[--size[SIZE]]--disk_type_idDISK_TYPE_ID--machine_volume_numMACHINE_VOLUME_NUM--machine_volume_strip_numMACHINE_VOLUME_STRIP_NUM[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--name[NAME]Providenametocreate-volume-conf.--availability_zone_idAVAILABILITY_ZONE_IDProvideavailability_zone_idtocreate-volume-conf.--encryptedtrue,falseProvideencryptedtocreate-volume-conf.--size[SIZE]Providesizetocreate-volume-conf.--disk_type_idDISK_TYPE_IDProvidedisk_typetocreate-volume-conf.--machine_volume_numMACHINE_VOLUME_NUMProvidemachine_volume_numtocreate-volume-conf.--machine_volume_strip_numMACHINE_VOLUME_STRIP_NUMProvidemachine_volume_strip_numtocreate-volume-conf.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)create-volume-conf example with all the required arguments passed.yeeduresourcecreate-volume-conf--name="yeedu volume"--availability_zone_id=75--encrypted=false--disk_type_id=4--machine_volume_num=1--machine_volume_strip_num=1Console output{"volume_conf_id":"1","name":"yeedu volume","availability_zone_id":"75","encrypted":false,"size":"375","disk_type_id":"4","disk_type_name":"local-ssd","machine_volume_num":1,"machine_volume_strip_num":1,"tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538","created_by_id":"1","modified_by_id":"1","last_update_date":"2023-07-20T10:57:08.387Z","from_date":"2023-07-20T10:57:08.387Z","to_date":null}list-volume-confsyeeduresourcelist-volume-confs-husage:list-volume-confs[-h][--cloud_provider[{GCP,AWS,AZURE}]][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--cloud_provider[{GCP,AWS,AZURE}]CloudProviderthatwillbeusedforfilteringlist.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list-volume-confs example with optional arguments passed for output
format.yeeduresourcelist-volume-confs--cloud_provider="GCP"Console output[{"volume_conf_id":"1","name":"yeedu volume","availability_zone":{"name":"us-central1-a","region":"us-central1","description":"Council Bluffs, Iowa, North America"},"encrypted":false,"size":"375","disk_type":{"name":"local-ssd","has_fixed_size":true,"min_size":375,"max_size":375},"machine_volume_num":1,"machine_volume_strip_num":1,"tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538","created_by":{"user_id":"1","username":"YSU0000"},"modified_by":{"user_id":"1","username":"YSU0000"},"last_update_date":"2023-07-20T10:57:08.387Z","from_date":"2023-07-20T10:57:08.387Z","to_date":null}]get-volume-confyeeduresourceget-volume-conf-husage:get-volume-conf[-h]--volume_conf_idVOLUME_CONF_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--volume_conf_idVOLUME_CONF_IDProvidevolume_conf_idtogetinformationaboutaspecificVolumeConfiguration.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)get-volume-conf example with the required argument ‘–volume_conf_id’
passed.yeeduresourceget-volume-conf--volume_conf_id=1Console output{"volume_conf_id":"1","name":"yeedu volume","availability_zone":{"name":"us-central1-a","region":"us-central1","description":"Council Bluffs, Iowa, North America"},"encrypted":false,"size":"375","disk_type":{"name":"local-ssd","has_fixed_size":true,"min_size":375,"max_size":375},"machine_volume_num":1,"machine_volume_strip_num":1,"tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538","created_by":{"user_id":"1","username":"YSU0000"},"modified_by":{"user_id":"1","username":"YSU0000"},"last_update_date":"2023-07-20T10:57:08.387Z","from_date":"2023-07-20T10:57:08.387Z","to_date":null}edit-volume-confyeeduresourceedit-volume-conf-husage:edit-volume-conf[-h]--volume_conf_idVOLUME_CONF_ID[--name[NAME]][--encrypted[true,false]][--machine_volume_numMACHINE_VOLUME_NUM][--machine_volume_strip_numMACHINE_VOLUME_STRIP_NUM][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--volume_conf_idVOLUME_CONF_IDProvidespecificvolume_conf_idtoedit-volume-conf.--name[NAME]Providenametoedit-volume-conf.--encrypted[true,false]Provideencryptedtoedit-volume-conf.--machine_volume_numMACHINE_VOLUME_NUMProvidemachine_volume_numtoedit-volume-conf.--machine_volume_strip_numMACHINE_VOLUME_STRIP_NUMProvidemachine_volume_strip_numtoedit-volume-conf.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)edit-volume-conf example with the required ‘–volume_conf_id’
argument and other optional argument is passed which is to be
updated.yeeduresourceedit-volume-conf--volume_conf_id=1--encrypted=trueConsole output{"volume_conf_id":"1","name":"yeedu volume","availability_zone_id":"75","encrypted":true,"size":"375","disk_type_id":"4","disk_type_name":"local-ssd","machine_volume_num":1,"machine_volume_strip_num":1,"tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538","created_by_id":"1","modified_by_id":"1","last_update_date":"2023-07-20T10:59:12.499Z","from_date":"2023-07-20T10:57:08.387Z","to_date":null}Network ConfigurationCommand NameUtilitycreate-network-confTo create the Network
Configuration.list-network-confsTo get information about Network
Configurations for a specific
Cloud Provider.get-network-confTo get information about a
specific Network Configuration
for a specific Cloud Provider.edit-network-confTo edit a specific Network
Configuration based on cloud
provider Id and network Id.create-network-confyeeduresourcecreate-network-conf-husage:create-network-conf[-h]--network_project_idNETWORK_PROJECT_ID--network_nameNETWORK_NAME--subnetSUBNET--availability_zone_idAVAILABILITY_ZONE_ID--cloud_provider_idCLOUD_PROVIDER_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--network_project_idNETWORK_PROJECT_IDProvidenetwork_project_idtocreate-network-conf.--network_nameNETWORK_NAMEProvidenetwork_nametocreate-network-conf.--subnetSUBNETProvidesubnettocreate-network-conf.--availability_zone_idAVAILABILITY_ZONE_IDProvideavailability_zone_idtocreate-network-conf.--cloud_provider_idCLOUD_PROVIDER_IDProvidecloud_provider_idtocreate-network-conf.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)create-network-conf example with all the required and optional
arguments passed.yeeduresourcecreate-network-conf--network_project_id="yeedu"--network_name='yeedu-spark-vpc'--subnet='custom-subnet-yeedu'--availability_zone_id=75--cloud_provider_id=0Console output{"network_conf_id":"1","network_project_id":"yeedu","network_name":"yeedu-spark-vpc","subnet":"custom-subnet-yeedu","availability_zone_id":"75","cloud_provider_id":"0","tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538","created_by_id":"1","modified_by_id":"1","last_update_date":"2023-07-20T11:00:14.845Z","from_date":"2023-07-20T11:00:14.845Z","to_date":null}list-network-confsyeeduresourcelist-network-confs-husage:list-network-confs[-h][--cloud_provider[{GCP,AWS,AZURE}]][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--cloud_provider[{GCP,AWS,AZURE}]Providespecificcloud_provider_idtogetinformationaboutrelatedNetworkConfigurations.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list-network-confs example with the--cloud_provider_idrequired
arguments passed.yeeduresourcelist-network-confs--cloud_provider="GCP"Console output[{"network_conf_id":"1","network_project_id":"yeedu","network_name":"yeedu-spark-vpc","subnet":"custom-subnet-yeedu","availability_zone":{"name":"us-central1-a","region":"us-central1","description":"Council Bluffs, Iowa, North America"},"cloud_provider":{"name":"gcp","description":"Provider for creating infrastructure on Google Cloud Platform"},"tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538","created_by":{"user_id":"1","username":"YSU0000"},"modified_by":{"user_id":"1","username":"YSU0000"},"last_update_date":"2023-07-20T11:00:14.845Z","from_date":"2023-07-20T11:00:14.845Z","to_date":null}]get-network-confyeeduresourceget-network-conf-husage:get-network-conf[-h]--network_conf_idNETWORK_CONF_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--network_conf_idNETWORK_CONF_IDProvideidtogetinformationaboutaspecificnetworkConfiguration.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)get-network-conf example with the required ‘–network_conf_id’ and
optional ‘–cloud_provider_id’ argument passed.yeeduresourceget-network-conf--network_conf_id=1Console output{"network_conf_id":"1","network_project_id":"yeedu","network_name":"yeedu-spark-vpc","subnet":"custom-subnet-yeedu","availability_zone":{"name":"us-central1-a","region":"us-central1","description":"Council Bluffs, Iowa, North America"},"cloud_provider":{"name":"gcp","description":"Provider for creating infrastructure on Google Cloud Platform"},"tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538","created_by":{"user_id":"1","username":"YSU0000"},"modified_by":{"user_id":"1","username":"YSU0000"},"last_update_date":"2023-07-20T11:00:14.845Z","from_date":"2023-07-20T11:00:14.845Z","to_date":null}edit-network-confyeeduresourceedit-network-conf-husage:edit-network-conf[-h]--network_conf_idNETWORK_CONF_ID[--network_name[NETWORK_NAME]][--subnet[SUBNET]][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--network_conf_idNETWORK_CONF_IDProvideaspecificNetworkConfigurationidtoedit-network-conf.--network_name[NETWORK_NAME]Providenetwork_nametoedit-network-conf.--subnet[SUBNET]Providesubnettoedit-network-conf.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)edit-network-conf example with the required ‘–network_conf_id’ and
‘–cloud_provider_id’ argument and other optional argument is passed
which is to be updated.yeeduresourceedit-network-conf--network_conf_id=1--network_name="yeedu-spark-vpc"Console output{"network_conf_id":"1","network_project_id":"yeedu","network_name":"yeedu-spark-vpc","subnet":"custom-subnet-yeedu","availability_zone_id":"75","cloud_provider_id":"0","tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538","created_by_id":"1","modified_by_id":"1","last_update_date":"2023-07-20T11:02:57.824Z","from_date":"2023-07-20T11:00:14.845Z","to_date":null}Boot Disk Image ConfigCommand NameUtilitycreate-boot-disk-image-confTo create a Boot Disk Image
Configuration.get-boot-disk-image-confTo get the information about a
specific Boot Disk Image
Configuration.list-boot-disk-image-confsTo list all the available Boot
Disk Image Configurations.create-boot-disk-image-confyeeduresourcecreate-boot-disk-image-conf-husage:create-boot-disk-image-conf[-h]--cloud_provider_idCLOUD_PROVIDER_ID--boot_disk_imageBOOT_DISK_IMAGE[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--cloud_provider_idCLOUD_PROVIDER_IDProvideboot_disk_image_configtocreate-boot-disk-image-conf.--boot_disk_imageBOOT_DISK_IMAGEProvideboot_disk_imagetocreate-boot-disk-image-conf.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)create-boot-disk-image-conf example with all the required arguments
passed.yeeduresourcecreate-boot-disk-image-conf--cloud_provider_id=0--boot_disk_image="ubuntu-os-cloud/ubuntu-2004-lts"Console output{"boot_disk_image_id":"1","boot_disk_image":"ubuntu-os-cloud/ubuntu-2004-lts","cloud_provider_id":"0","tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538","created_by_id":"1","modified_by_id":"1","last_update_date":"2023-07-20T11:04:02.811Z","from_date":"2023-07-20T11:04:02.811Z","to_date":null}get-boot-disk-image-confyeeduresourceget-boot-disk-image-conf-husage:get-boot-disk-image-conf[-h]--boot_disk_image_idBOOT_DISK_IMAGE_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--boot_disk_image_idBOOT_DISK_IMAGE_IDProvideBootDiskImageIdtogetinformationaboutaspecificBootDiskImageConfiguration.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)get-boot-disk-image-conf example with required arguments passed.yeeduresourceget-boot-disk-image-conf--boot_disk_image_id=1Console output{"boot_disk_image_id":"1","boot_disk_image":"ubuntu-os-cloud/ubuntu-2004-lts","cloud_provider":{"name":"gcp","description":"Provider for creating infrastructure on Google Cloud Platform"},"tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538","created_by":{"user_id":"1","username":"YSU0000"},"modified_by":{"user_id":"1","username":"YSU0000"},"last_update_date":"2023-07-20T11:04:02.811Z","from_date":"2023-07-20T11:04:02.811Z","to_date":null}list-boot-disk-image-confsyeeduresourcelist-boot-disk-image-confs-husage:list-boot-disk-image-confs[-h][--cloud_provider[{GCP,AWS,AZURE}]][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--cloud_provider[{GCP,AWS,AZURE}]Providecloud_providertolistalltherelatedbootdiskimageconfigsforaspecificCloudProvider.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list-boot-disk-image-confs example with all the required arguments
passed.yeeduresourcelist-boot-disk-image-confs--cloud_provider="GCP"Console output[{"boot_disk_image_id":"1","boot_disk_image":"ubuntu-os-cloud/ubuntu-2004-lts","cloud_provider":{"name":"gcp","description":"Provider for creating infrastructure on Google Cloud Platform"},"tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538","created_by":{"user_id":"1","username":"YSU0000"},"modified_by":{"user_id":"1","username":"YSU0000"},"last_update_date":"2023-07-20T11:04:02.811Z","from_date":"2023-07-20T11:04:02.811Z","to_date":null}]Machine ConfigurationCommand NameUtilitycreate-machine-confTo create the Machine
Configuration.list-machine-confsTo list all the available
Machine Configurations.get-machine-confTo get information about a
specific Machine Configuration.edit-machine-confTo edit a specific Machine
Configuration.create-machine-confyeeduresourcecreate-machine-conf-husage:create-machine-conf[-h][--network_tags['value1,value2']][--labelsLABELS[LABELS...]]--service_account_instance_profileSERVICE_ACCOUNT_INSTANCE_PROFILE--boot_disk_image_idBOOT_DISK_IMAGE_ID--machine_type_idMACHINE_TYPE_ID[--is_spot_instance[true,false]][--enable_public_ip[true,false]][--block_project_ssh_keys[true,false]][--bootstrap_shell_script_file_pathBOOTSTRAP_SHELL_SCRIPT_FILE_PATH]--network_conf_idNETWORK_CONF_ID--volume_conf_idVOLUME_CONF_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--network_tags['value1,value2']Providenetwork_tagstocreate-machine-conf.(default:[])--labelsLABELS[LABELS...]Providelabelstocreate-machine-conf.--service_account_instance_profileSERVICE_ACCOUNT_INSTANCE_PROFILEProvideservice_account_instance_profiletocreate-machine-conf.--boot_disk_image_idBOOT_DISK_IMAGE_IDProvideboot_disk_image_idtocreate-machine-conf.--machine_type_idMACHINE_TYPE_IDProvidemachine_type_idtocreate-machine-conf.--is_spot_instance[true,false]Provideis_spot_instancetocreate-machine-conf.(default:false)--enable_public_ip[true,false]Provideenable_public_iptocreate-machine-conf.(default:false)--block_project_ssh_keys[true,false]Provideblock_project_ssh_keystocreate-machine-conf.(default:true)--bootstrap_shell_script_file_pathBOOTSTRAP_SHELL_SCRIPT_FILE_PATHProvidebootstrap_shell_script_file_pathtocreate-machine-conf.--network_conf_idNETWORK_CONF_IDProvidenetwork_conf_idtocreate-machine-conf.--volume_conf_idVOLUME_CONF_IDProvidevolume_conf_idtocreate-machine-conf.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)create-machine-conf example with all the required and optional
arguments passed.yeeduresourcecreate-machine-conf--network_tags="yeedu,iap-allow"--labels="env=test"--labels="test=dev"--service_account_instance_profile="yeedu@yeedu.iam.gserviceaccount.com"--boot_disk_image_id=1--machine_type_id=15--is_spot_instance=false--enable_public_ip=true--block_project_ssh_keys=true--network_conf_id=1--volume_conf_id=1Console output{"machine_conf_id":"1","network_tags":["yeedu","iap-allow"],"labels":{"env":"test","test":"dev","resource":"yeedu","tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538"},"service_account_instance_profile":"yeedu@yeedu.iam.gserviceaccount.com","boot_disk_image_id":"1","machine_type_id":"15","is_spot_instance":false,"enable_public_ip":true,"block_project_ssh_keys":true,"bootstrap_shell_script":null,"network_conf_id":"1","volume_conf_id":"1","tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538","created_by_id":"1","modified_by_id":"1","last_update_date":"2023-07-20T11:06:21.454Z","from_date":"2023-07-20T11:06:21.454Z","to_date":null}list-machine-confsyeeduresourcelist-machine-confs-husage:list-machine-confs[-h][--cloud_provider[{GCP,AWS,AZURE}]][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--cloud_provider[{GCP,AWS,AZURE}]CloudProviderthatwillbeusedforfilteringlist.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list-machine-confs example without optional arguments passed for
output format.yeeduresourcelist-machine-confs--cloud_provider="GCP"Console output[{"machine_conf_id":"1","network_tags":["yeedu","iap-allow"],"labels":{"env":"test","test":"dev","resource":"yeedu","tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538"},"service_account_instance_profile":"yeedu@yeedu.iam.gserviceaccount.com","boot_disk_image_config":{"boot_disk_image_id":"1","boot_disk_image":"ubuntu-os-cloud/ubuntu-2004-lts","cloud_provider":{"name":"gcp","description":"Provider for creating infrastructure on Google Cloud Platform"}},"machine_type":{"machine_type_id":"15","name":"c2d-highcpu-16","vcpus":16,"memory":"32 GiB","has_cuda":false,"gpu_model":null,"gpus":null,"gpu_memory":null},"is_spot_instance":false,"enable_public_ip":true,"block_project_ssh_keys":true,"bootstrap_shell_script":null,"machine_network":{"network_conf_id":"1","network_project_id":"yeedu","network_name":"yeedu-spark-vpc","subnet":"custom-subnet-yeedu","availability_zone":{"name":"us-central1-a","region":"us-central1","description":"Council Bluffs, Iowa, North America"}},"machine_volume_config":{"volume_conf_id":"1","name":"yeedu volume","encrypted":false,"size":"375","machine_volume_num":1,"machine_volume_strip_num":1,"availability_zone":{"name":"us-central1-a","region":"us-central1","description":"Council Bluffs, Iowa, North America"},"disk_type":{"name":"local-ssd","has_fixed_size":true,"min_size":375,"max_size":375}},"tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538","created_by":{"user_id":"1","username":"YSU0000"},"modified_by":{"user_id":"1","username":"YSU0000"},"last_update_date":"2023-07-20T11:06:21.454Z","from_date":"2023-07-20T11:06:21.454Z","to_date":null}]get-machine-confyeeduresourceget-machine-conf-husage:get-machine-conf[-h]--machine_conf_idMACHINE_CONF_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--machine_conf_idMACHINE_CONF_IDProvidemachineconfigidtogetinformationaboutaspecificMachineConfiguration.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)get-machine-conf example with the required ‘–machine_conf_id’
arguments passed.yeeduresourceget-machine-conf--machine_conf_id=1Console output{"machine_conf_id":"1","network_tags":["yeedu","iap-allow"],"labels":{"env":"test","test":"dev","resource":"yeedu","tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538"},"service_account_instance_profile":"yeedu@yeedu.iam.gserviceaccount.com","boot_disk_image_config":{"boot_disk_image_id":"1","boot_disk_image":"ubuntu-os-cloud/ubuntu-2004-lts","cloud_provider":{"name":"gcp","description":"Provider for creating infrastructure on Google Cloud Platform"}},"machine_type":{"machine_type_id":"15","name":"c2d-highcpu-16","vcpus":16,"memory":"32 GiB","has_cuda":false,"gpu_model":null,"gpus":null,"gpu_memory":null},"is_spot_instance":false,"enable_public_ip":true,"block_project_ssh_keys":true,"bootstrap_shell_script":null,"machine_network":{"network_conf_id":"1","network_project_id":"yeedu","network_name":"yeedu-spark-vpc","subnet":"custom-subnet-yeedu","availability_zone":{"name":"us-central1-a","region":"us-central1","description":"Council Bluffs, Iowa, North America"}},"machine_volume_config":{"volume_conf_id":"1","name":"yeedu volume","encrypted":false,"size":"375","machine_volume_num":1,"machine_volume_strip_num":1,"availability_zone":{"name":"us-central1-a","region":"us-central1","description":"Council Bluffs, Iowa, North America"},"disk_type":{"name":"local-ssd","has_fixed_size":true,"min_size":375,"max_size":375}},"tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538","created_by":{"user_id":"1","username":"YSU0000"},"modified_by":{"user_id":"1","username":"YSU0000"},"last_update_date":"2023-07-20T11:06:21.454Z","from_date":"2023-07-20T11:06:21.454Z","to_date":null}edit-machine-confyeeduresourceedit-machine-conf-husage:edit-machine-conf[-h]--machine_conf_idMACHINE_CONF_ID[--network_tags['value1,value2']][--labelsLABELS[LABELS...]][--service_account_instance_profile[SERVICE_ACCOUNT_INSTANCE_PROFILE]][--is_spot_instance[true,false]][--enable_public_ip[true,false]][--block_project_ssh_keys[true,false]][--bootstrap_shell_script_file_path[BOOTSTRAP_SHELL_SCRIPT_FILE_PATH]][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--machine_conf_idMACHINE_CONF_IDProvideaspecificmachineconfigurationidtoedit-machine-conf.--network_tags['value1,value2']Providenetwork_tagstoedit-machine-conf.--labelsLABELS[LABELS...]Providelabelstoedit-machine-conf.--service_account_instance_profile[SERVICE_ACCOUNT_INSTANCE_PROFILE]Provideservice_account_instance_profiletoedit-machine-conf.--is_spot_instance[true,false]Provideis_spot_instancetoedit-machine-conf.--enable_public_ip[true,false]Provideenable_public_iptoedit-machine-conf.--block_project_ssh_keys[true,false]Provideblock_project_ssh_keystoedit-machine-conf.--bootstrap_shell_script_file_path[BOOTSTRAP_SHELL_SCRIPT_FILE_PATH]Providebootstrap_shell_script_file_pathtoedit-machine-conf.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)edit-machine-conf example with the required ‘–machine_conf_id’
argument argument and other optional argument is passed which is to
be updated.yeeduresourceedit-machine-conf--machine_conf_id=1--network_tags='yeedu,network'Console output{"machine_conf_id":"1","network_tags":["yeedu","network"],"labels":{"env":"test","test":"dev","resource":"yeedu","tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538"},"service_account_instance_profile":"yeedu@yeedu.iam.gserviceaccount.com","boot_disk_image_id":"1","machine_type_id":"15","is_spot_instance":false,"enable_public_ip":true,"block_project_ssh_keys":true,"bootstrap_shell_script":null,"network_conf_id":"1","volume_conf_id":"1","tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538","created_by_id":"1","modified_by_id":"1","last_update_date":"2023-07-20T11:11:29.210Z","from_date":"2023-07-20T11:06:21.454Z","to_date":null}Credentials ConfigurationCommand NameUtilitycreate-credential-confTo create a Credential
Configuration.list-credential-confsTo list all the available
Credential Configurations.get-credential-confTo get the information about a
specific Credential
Configuration.edit-credential-confTo edit a specific Credential
Configuration.delete-credential-confTo delete a specific Credential
Configuration.create-credential-confyeeduresourcecreate-credential-conf-husage:create-credential-conf[-h]--credential_type_idCREDENTIAL_TYPE_ID--base64_encoded_credentialsBASE64_ENCODED_CREDENTIALS--nameNAME[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--credential_type_idCREDENTIAL_TYPE_IDProvidecredential_type_idtocreate-credential-conf.--base64_encoded_credentialsBASE64_ENCODED_CREDENTIALSProvidebase64_encoded_credentialstocreate-credential-conf.--nameNAMEProvidenametocreate-credential-conf.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)create-credential-conf example with all the required arguments
passed.yeeduresourcecreate-credential-conf--credential_type_id=0--base64_encoded_credentials='ew0KICAieWVlZHVfY3JlZGVudGlhbHMiOiAiRHVtbXkgQ3JlZGVudGlhbHMgQ29uZmlndXJhdGlvbiINCn0'--name='yeedu'Console output{"credentials_conf_id":"1","credential_type_id":"0","name":"yeedu","tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538","created_by_id":"1","modified_by_id":"1","last_update_date":"2023-07-20T11:14:16.832Z","from_date":"2023-07-20T11:14:16.832Z","to_date":null}list-credential-confsyeeduresourcelist-credential-confs-husage:list-credential-confs[-h][--cloud_provider[{GCP,AWS,AZURE}]][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--cloud_provider[{GCP,AWS,AZURE}]CloudProviderthatwillbeusedforfilteringlist.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list-credential-confs example without optional arguments passed for
output format.yeeduresourcelist-credential-confs--cloud_provider="GCP"Console output[{"credentials_conf_id":"1","credential_type":{"name":"gcp","cloud_provider":{"name":"gcp","description":"Provider for creating infrastructure on Google Cloud Platform"}},"name":"yeedu","tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538","created_by":{"user_id":"1","username":"YSU0000"},"modified_by":{"user_id":"1","username":"YSU0000"},"last_update_date":"2023-07-20T11:14:16.832Z","from_date":"2023-07-20T11:14:16.832Z","to_date":null}]get-credential-confyeeduresourceget-credential-conf-husage:get-credential-conf[-h]--credentials_conf_idCREDENTIALS_CONF_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--credentials_conf_idCREDENTIALS_CONF_IDProvidecredentials_conf_idtogetinformationaboutaspecificcredentialconfiguration.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)get-credential-conf example with the required ‘–credentials_conf_id’
arguments passed.yeeduresourceget-credential-conf--credentials_conf_id=1Console output{"credentials_conf_id":"1","credential_type":{"name":"gcp","cloud_provider":{"name":"gcp","description":"Provider for creating infrastructure on Google Cloud Platform"}},"name":"yeedu","tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538","created_by":{"user_id":"1","username":"YSU0000"},"modified_by":{"user_id":"1","username":"YSU0000"},"last_update_date":"2023-07-20T11:14:16.832Z","from_date":"2023-07-20T11:14:16.832Z","to_date":null}edit-credential-confyeeduresourceedit-credential-conf-husage:edit-credential-conf[-h]--credentials_conf_idCREDENTIALS_CONF_ID[--base64_encoded_credentialsBASE64_ENCODED_CREDENTIALS][--name[NAME]][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--credentials_conf_idCREDENTIALS_CONF_IDProvideaspecificcredentialscofigidtoedit-credential-conf.--base64_encoded_credentialsBASE64_ENCODED_CREDENTIALSProvidebase64_encoded_credentialstoedit-credential-conf.--name[NAME]Providenametoedit-credential-conf.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)edit-credential-conf example with the required
‘–credentials_conf_id’ argument and other optional argument is
passed which is to be updated.yeeduresourceedit-credential-conf--credentials_conf_id=1--name='yeedu-svc'Console output{"credentials_conf_id":"1","credential_type_id":"0","name":"yeedu-svc","tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538","created_by_id":"1","modified_by_id":"1","last_update_date":"2023-07-20T11:16:35.568Z","from_date":"2023-07-20T11:14:16.832Z","to_date":null}delete-credential-confyeeduresourcedelete-credential-conf-husage:delete-credential-conf[-h]--credentials_conf_idCREDENTIALS_CONF_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--credentials_conf_idCREDENTIALS_CONF_IDProvidecredentials_conf_idtodeleteaspecificCredentialConfiguration.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)delete-credential-conf example with the required
‘–credentials_conf_id’ argument passed.yeeduresourcedelete-credential-conf--credentials_conf_id=1Console output{"message":"Deleted Credentials Configuration: 1"}Object Storage ManagerCommand NameUtilitycreate-object-storage-managerTo create a Object Storage
Manager.list-object-storage-managersTo list all the available Object
Storage Manager Configurations.get-object-storage-managerTo get information about a
specific Object Storage Manager.edit-object-storage-managerTo edit a specific Object
Storage Manager Configuration.delete-object-storage-managerTo delete a specific Object
Storage Manager.create-object-storage-manageryeeduresourcecreate-object-storage-manager-husage:create-object-storage-manager[-h]--nameNAME--credentials_conf_idCREDENTIALS_CONF_ID--object_storage_bucket_nameOBJECT_STORAGE_BUCKET_NAME[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--nameNAMEProvidenametocreate-object-storage-manager.--credentials_conf_idCREDENTIALS_CONF_IDProvidecredentials_conf_idtocreate-object-storage-manager.--object_storage_bucket_nameOBJECT_STORAGE_BUCKET_NAMEProvideobject_storage_bucket_nametocreate-object-storage-manager.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)create-object-storage-manager example with all the required arguments
passed.yeeduresourcecreate-object-storage-manager--name="Yeedu Object Storage Manager"--credentials_conf_id=1--object_storage_bucket_name="yeedu"Console output{"object_storage_manager_id":"1","name":"Yeedu Object Storage Manager","credentials_conf_id":"1","object_storage_bucket_name":"yeedu","tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538","created_by_id":"1","modified_by_id":"1","last_update_date":"2023-07-20T11:17:58.442Z","from_date":"2023-07-20T11:17:58.442Z","to_date":null}list-object-storage-managersyeeduresourcelist-object-storage-managers-husage:list-object-storage-managers[-h][--cloud_provider[{GCP,AWS,AZURE}]][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--cloud_provider[{GCP,AWS,AZURE}]CloudProviderthatwillbeusedforfilteringlist.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list-object-storage-managers example with all the required arguments
passed.yeeduresourcelist-object-storage-managers--cloud_provider="GCP"Console output[{"object_storage_manager_id":"1","name":"Yeedu Object Storage Manager","credentials_config":{"name":"yeedu-svc","credential_type":{"name":"gcp","cloud_provider":{"name":"gcp","description":"Provider for creating infrastructure on Google Cloud Platform"}}},"object_storage_bucket_name":"yeedu","tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538","created_by":{"user_id":"1","username":"YSU0000"},"modified_by":{"user_id":"1","username":"YSU0000"},"last_update_date":"2023-07-20T11:17:58.442Z","from_date":"2023-07-20T11:17:58.442Z","to_date":null}]get-object-storage-manageryeeduresourceget-object-storage-manager-husage:get-object-storage-manager[-h]--object_storage_manager_idOBJECT_STORAGE_MANAGER_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--object_storage_manager_idOBJECT_STORAGE_MANAGER_IDProvideObjectStorageManagerIdtogetinformationaboutaspecificObjectStorageManager.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)get-object-storage-manager example with required arguments passed.yeeduresourceget-object-storage-manager--object_storage_manager_id=1Console output{"object_storage_manager_id":"1","name":"Yeedu Object Storage Manager","credentials_config":{"name":"yeedu-svc","credential_type":{"name":"gcp","cloud_provider":{"name":"gcp","description":"Provider for creating infrastructure on Google Cloud Platform"}}},"object_storage_bucket_name":"yeedu","tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538","created_by":{"user_id":"1","username":"YSU0000"},"modified_by":{"user_id":"1","username":"YSU0000"},"last_update_date":"2023-07-20T11:17:58.442Z","from_date":"2023-07-20T11:17:58.442Z","to_date":null}edit-object-storage-manageryeeduresourceedit-object-storage-manager-husage:edit-object-storage-manager[-h]--object_storage_manager_idOBJECT_STORAGE_MANAGER_ID[--nameNAME][--object_storage_bucket_name[OBJECT_STORAGE_BUCKET_NAME]][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--object_storage_manager_idOBJECT_STORAGE_MANAGER_IDProvideobject_storage_manager_idtoeditinformationaboutaspecificObjectStorageManager.--nameNAMEProvidenametoedit-object-storage-manager.--object_storage_bucket_name[OBJECT_STORAGE_BUCKET_NAME]Provideobject_storage_bucket_nametoedit-object-storage-manager.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)edit-object-storage-manager example with all the required arguments
passed which needs to be updated.yeeduresourceedit-object-storage-manager--object_storage_manager_id=1--object_storage_bucket_name="yeedu-test"Console output{"object_storage_manager_id":"1","name":"Yeedu Object Storage Manager","credentials_conf_id":"1","object_storage_bucket_name":"yeedu-test","tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538","created_by_id":"1","modified_by_id":"1","last_update_date":"2023-07-20T11:20:36.654Z","from_date":"2023-07-20T11:17:58.442Z","to_date":null}delete-object-storage-manageryeeduresourcedelete-object-storage-manager-husage:delete-object-storage-manager[-h]--object_storage_manager_idOBJECT_STORAGE_MANAGER_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--object_storage_manager_idOBJECT_STORAGE_MANAGER_IDProvideobject_storage_manager_idtodeleteaspecificObjectStorageManager.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)delete-object-storage-manager example with required arguments passed.yeeduresourcedelete-object-storage-manager--object_storage_manager_id=1Console output{"message":"Deleted Object Storage Manager Configuration: 1"}Object Storage Manager FilesCommand NameUtilitycreate-object-storage-manager-fileTo create a Object Storage Manager
Files.list-object-storage-manager-filesTo list all the available Object
Storage Manager Files.get-object-storage-manager-fileTo get information about a specific
Object Storage Manager File.delete-object-storage-manager-fileTo delete a specific Object Storage
Manager File.create-object-storage-manager-fileyeeduresourcecreate-object-storage-manager-file-husage:create-object-storage-manager-file[-h]--object_storage_manager_idOBJECT_STORAGE_MANAGER_ID--local_file_pathLOCAL_FILE_PATH[--preserve_path[{true,false}]][--overwrite[{true,false}]][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--object_storage_manager_idOBJECT_STORAGE_MANAGER_IDProvidecredential_fileig_idtocreate-object-storage-manager-file.--local_file_pathLOCAL_FILE_PATHProvidelocal_file_pathtocreate-object-storage-manager-file.--preserve_path[{true,false}]Providepreserve_pathtocreate-object-storage-manager-file.(default:false)--overwrite[{true,false}]Provideoverwritetocreate-object-storage-manager-file.(default:false)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)create-object-storage-manager-file example with all the required
arguments passed.yeeduresourcecreate-object-storage-manager-file--object_storage_manager_id=1--local_file_path='/home/user/spark-examples_2.11-2.4.8.jar'Console output{"object_storage_manager_file_id":"1","object_storage_manager_id":"1","file_name":"spark-examples_2.11-2.4.8.jar","full_file_path":"file:///yeedu/object-storage-manager/spark-examples_2.11-2.4.8.jar","file_size_bytes":"2017856","file_type":"jar","local_file_path":null,"tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538","created_by_id":"1","modified_by_id":"1","last_update_date":"2023-07-20T11:22:40.313Z","from_date":"2023-07-20T11:22:40.313Z","to_date":null}list-object-storage-manager-filesyeeduresourcelist-object-storage-manager-files-husage:list-object-storage-manager-files[-h]--object_storage_manager_idOBJECT_STORAGE_MANAGER_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--object_storage_manager_idOBJECT_STORAGE_MANAGER_IDProvideObjectStorageManagerIdtolistalltheavailableObjectStorageManagerFiles.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list-object-storage-manager-files example with required arguments
passed.yeeduresourcelist-object-storage-manager-files--object_storage_manager_id=1Console output[{"object_storage_manager_file_id":"1","object_storage_manager":{"object_storage_manager_id":"1","object_storage_bucket_name":"yeedu","credentials_config":{"name":"yeedu-svc","credential_type":{"name":"gcp"}}},"file_name":"spark-examples_2.11-2.4.8.jar","full_file_path":"file:///yeedu/object-storage-manager/spark-examples_2.11-2.4.8.jar","file_size_bytes":"2017856","file_type":"jar","local_file_path":null,"tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538","created_by":{"user_id":"1","username":"YSU0000"},"modified_by":{"user_id":"1","username":"YSU0000"},"last_update_date":"2023-07-20T11:22:40.313Z","from_date":"2023-07-20T11:22:40.313Z","to_date":null}]get-object-storage-manager-fileyeeduresourceget-object-storage-manager-file-husage:get-object-storage-manager-file[-h]--object_storage_manager_idOBJECT_STORAGE_MANAGER_ID--file_idFILE_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--object_storage_manager_idOBJECT_STORAGE_MANAGER_IDProvideObjectStorageManagerIdtogetinformationaboutaspecificObjectStorageManagerFiles.--file_idFILE_IDProvideFileIdtogetinformationaboutaspecificObjectStorageManagerFiles.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)get-object-storage-manager-file example with all the required
arguments passed.yeeduresourceget-object-storage-manager-file--object_storage_manager_id=1--file_id=1Console output{"object_storage_manager_file_id":"1","object_storage_manager":{"object_storage_manager_id":"1","object_storage_bucket_name":"yeedu","credentials_config":{"name":"yeedu-svc","credential_type":{"name":"gcp"}}},"file_name":"spark-examples_2.11-2.4.8.jar","full_file_path":"file:///yeedu/object-storage-manager/spark-examples_2.11-2.4.8.jar","file_size_bytes":"2017856","file_type":"jar","local_file_path":null,"tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538","created_by":{"user_id":"1","username":"YSU0000"},"modified_by":{"user_id":"1","username":"YSU0000"},"last_update_date":"2023-07-20T11:22:40.313Z","from_date":"2023-07-20T11:22:40.313Z","to_date":null}delete-object-storage-manager-fileyeeduresourcedelete-object-storage-manager-file-husage:delete-object-storage-manager-file[-h]--object_storage_manager_idOBJECT_STORAGE_MANAGER_ID--file_idFILE_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--object_storage_manager_idOBJECT_STORAGE_MANAGER_IDProvideObjectStorageManagerIdtodeleteaspecificObjectStorageManagerFile.--file_idFILE_IDProvideFileIdtodeleteaspecificObjectStorageManagerFiles.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)delete-object-storage-manager-file example with all the required
arguments passed.yeeduresourcedelete-object-storage-manager-file--object_storage_manager_id=1--file_id=1Console output{"message":"The File spark-examples_2.11-2.4.8.jar has been deleted."}Hive Metastore ConfigurationCommand NameUtilitycreate-hive-metastore-confTo create a Hive Metastore
Configuration.list-hive-metastore-confsTo list all the available Hive
Metastore Configurations.get-hive-metastore-confTo get the information about a
specific Hive Metastore
Configuration.edit-hive-metastore-confTo edit a specific Hive
Metastore Configuration.delete-hive-metastore-confTo delete a specific Hive
Metastore Configuration.create-hive-metastore-confyeeduresourcecreate-hive-metastore-conf-husage:create-hive-metastore-conf[-h][--hive_site_xml_file_pathHIVE_SITE_XML_FILE_PATH][--core_site_xml_file_pathCORE_SITE_XML_FILE_PATH][--hdfs_site_xml_file_pathHDFS_SITE_XML_FILE_PATH][--krb5_conf_file_pathKRB5_CONF_FILE_PATH][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--hive_site_xml_file_pathHIVE_SITE_XML_FILE_PATHProvidehive_site_xml_file_pathtocreate-hive-metastore-conf.--core_site_xml_file_pathCORE_SITE_XML_FILE_PATHProvidecore_site_xml_file_pathtocreate-hive-metastore-conf.--hdfs_site_xml_file_pathHDFS_SITE_XML_FILE_PATHProvidehdfs_site_xml_file_pathtocreate-hive-metastore-conf.--krb5_conf_file_pathKRB5_CONF_FILE_PATHProvidekrb5_conf_file_pathtocreate-hive-metastore-conf.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)create-hive-metastore-conf example with all the required arguments
passed.yeeduresourcecreate-hive-metastore-conf--hive_site_xml_file_path="/home/user/Documents/hive-site.xml"--core_site_xml_file_path="/home/user/Documents/core-site.xml"--hdfs_site_xml_file_path="/home/user/Documents/hdfs-site.xml"Console output{"hive_metastore_conf_id":"1","tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538","created_by_id":"1","modified_by_id":"1","last_update_date":"2023-07-20T11:34:53.896Z","from_date":"2023-07-20T11:34:53.896Z","to_date":null}list-hive-metastore-confsyeeduresourcelist-hive-metastore-confs-husage:list-hive-metastore-confs[-h][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list-hive-metastore-confs example without any optional argument
passed for output format.yeeduresourcelist-hive-metastore-confsConsole output[{"hive_metastore_conf_id":"1","hive-site.xml":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<?xml-stylesheet type=\"text/xsl\" href=\"configuration.xsl\"?>\n<configuration>\n  <property>\n    <name>javax.jdo.option.ConnectionURL</name>\n    <value>jdbc:postgresql://localhost:5432/metastore</value>\n    <description>JDBC connect string for a JDBC metastore</description>\n  </property>\n  <property>\n    <name>javax.jdo.option.ConnectionDriverName</name>\n    <value>org.postgresql.Driver</value>\n    <description>Driver class name for a JDBC metastore</description>\n  </property>\n  <property>\n    <name>javax.jdo.option.ConnectionUserName</name>\n    <value>hive</value>\n    <description>username to use against metastore database</description>\n  </property>\n  <property>\n    <name>javax.jdo.option.ConnectionPassword</name>\n    <value>hive</value>\n    <description>password to use against metastore database</description>\n  </property>\n  <property>\n    <name>hive.metastore.schema.verification</name>\n    <value>false</value>\n  </property>\n  <property>\n     <name>datanucleus.autoCreateSchema</name>\n     <value>false</value>\n     <description>Creates necessary schema on a startup if one doesn't exist</description>\n  </property>\n  <property>\n     <name>hive.server2.enable.doAs </name>\n     <value>false</value>\n  </property>\n  <property>\n         <name>hive.security.authorization.enabled</name>\n         <value>false</value>\n </property>\n</configuration>\n\n","core-site.xml":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<?xml-stylesheet type=\"text/xsl\" href=\"configuration.xsl\"?>\n<!--\n  Licensed under the Apache License, Version 2.0 (the \"License\");\n  you may not use this file except in compliance with the License.\n  You may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\n  Unless required by applicable law or agreed to in writing, software\n  distributed under the License is distributed on an \"AS IS\" BASIS,\n  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n  See the License for the specific language governing permissions and\n  limitations under the License. See accompanying LICENSE file.\n-->\n\n<!-- Put site-specific property overrides in this file. -->\n\n<configuration>\n    <property>\n        <name>hadoop.tmp.dir</name>\n        <value>/usr/bin/data/tmp</value>\n    </property>\n    <property>\n        <name>fs.defaultFS</name>\n        <value>hdfs://localhost:9000</value>\n    </property>\n    <property>\n        <name>fs.default.name</name>\n        <value>hdfs://localhost:9000</value>\n    </property>\n        <property>\n            <name>hadoop.proxyuser.username.groups</name>\n        <value>*</value>\n        </property>\n        <property>\n                <name>hadoop.proxyuser.username.hosts</name>\n                <value>*</value>\n        </property>\n                <property>\n            <name>hadoop.proxyuser.hue.groups</name>\n        <value>*</value>\n        </property>\n        <property>\n                <name>hadoop.proxyuser.hue.hosts</name>\n                <value>*</value>\n        </property>\n</configuration>\n\n","hdfs-site.xml":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<?xml-stylesheet type=\"text/xsl\" href=\"configuration.xsl\"?>\n<!--\n  Licensed under the Apache License, Version 2.0 (the \"License\");\n  you may not use this file except in compliance with the License.\n  You may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\n  Unless required by applicable law or agreed to in writing, software\n  distributed under the License is distributed on an \"AS IS\" BASIS,\n  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n  See the License for the specific language governing permissions and\n  limitations under the License. See accompanying LICENSE file.\n-->\n\n<!-- Put site-specific property overrides in this file. -->\n\n<configuration>\n    <property>\n                <name>dfs.permissions</name>\n                <value>false</value>\n        </property>\n    <property>\n            <name>dfs.namenode.name.dir</name>\n            <value>/usr/bin/data/nameNode</value>\n    </property>\n    <property>\n            <name>dfs.datanode.data.dir</name>\n            <value>/usr/bin/data/dataNode</value>\n    </property>\n    <property>\n                <name>dfs.datanode.max.transfer.threads</name>\n                <value>8192</value>\n        </property>\n    <property>\n          <name>dfs.namenode.checkpoint.dir</name>\n          <value>/usr/bin/data/nameNodeSecondary</value>\n    </property>\n    <property>\n        <name>dfs.safemode.threshold.pct</name>\n        <value>0</value>\n    </property>\n        <property>\n                <name>dfs.namenode.http-address</name>\n                <value>localhost:50070</value>\n        </property>\n    <property>\n                <name>dfs.namenode.secondary.http-address</name>\n                <value>localhost:50090</value>\n        </property>\n    <property>\n        <name>dfs.namenode.acls.enabled</name>\n        <value>true</value>\n    </property>\n    <property>\n        <name>dfs.replication</name>\n        <value>1</value>\n    </property>\n        <property>\n                <name>dfs.webhdfs.enabled</name>\n                <value>true</value>\n        </property>\n</configuration>\n\n","krb5.conf":null,"tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538","created_by":{"user_id":1,"username":"YSU0000"},"modified_by":{"user_id":1,"username":"YSU0000"},"last_update_date":"2023-07-20T11:34:53.896774+00:00","from_date":"2023-07-20T11:34:53.896774+00:00","to_date":"infinity"}]get-hive-metastore-confyeeduresourceget-hive-metastore-conf-husage:get-hive-metastore-conf[-h]--hive_metastore_conf_idHIVE_METASTORE_CONF_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--hive_metastore_conf_idHIVE_METASTORE_CONF_IDProvidehive_metastore_conf_idtogetinformationaboutaspecificHiveMetastoreConfiguration.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)get-hive-metastore-conf example with the required
‘–hive_metastore_conf_id’ argument passed.yeeduresourceget-hive-metastore-conf--hive_metastore_conf_id=1Console output{"hive_metastore_conf_id":"1","hive-site.xml":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<?xml-stylesheet type=\"text/xsl\" href=\"configuration.xsl\"?>\n<configuration>\n  <property>\n    <name>javax.jdo.option.ConnectionURL</name>\n    <value>jdbc:postgresql://localhost:5432/metastore</value>\n    <description>JDBC connect string for a JDBC metastore</description>\n  </property>\n  <property>\n    <name>javax.jdo.option.ConnectionDriverName</name>\n    <value>org.postgresql.Driver</value>\n    <description>Driver class name for a JDBC metastore</description>\n  </property>\n  <property>\n    <name>javax.jdo.option.ConnectionUserName</name>\n    <value>hive</value>\n    <description>username to use against metastore database</description>\n  </property>\n  <property>\n    <name>javax.jdo.option.ConnectionPassword</name>\n    <value>hive</value>\n    <description>password to use against metastore database</description>\n  </property>\n  <property>\n    <name>hive.metastore.schema.verification</name>\n    <value>false</value>\n  </property>\n  <property>\n     <name>datanucleus.autoCreateSchema</name>\n     <value>false</value>\n     <description>Creates necessary schema on a startup if one doesn't exist</description>\n  </property>\n  <property>\n     <name>hive.server2.enable.doAs </name>\n     <value>false</value>\n  </property>\n  <property>\n         <name>hive.security.authorization.enabled</name>\n         <value>false</value>\n </property>\n</configuration>\n\n","core-site.xml":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<?xml-stylesheet type=\"text/xsl\" href=\"configuration.xsl\"?>\n<!--\n  Licensed under the Apache License, Version 2.0 (the \"License\");\n  you may not use this file except in compliance with the License.\n  You may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\n  Unless required by applicable law or agreed to in writing, software\n  distributed under the License is distributed on an \"AS IS\" BASIS,\n  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n  See the License for the specific language governing permissions and\n  limitations under the License. See accompanying LICENSE file.\n-->\n\n<!-- Put site-specific property overrides in this file. -->\n\n<configuration>\n    <property>\n        <name>hadoop.tmp.dir</name>\n        <value>/usr/bin/data/tmp</value>\n    </property>\n    <property>\n        <name>fs.defaultFS</name>\n        <value>hdfs://localhost:9000</value>\n    </property>\n    <property>\n        <name>fs.default.name</name>\n        <value>hdfs://localhost:9000</value>\n    </property>\n        <property>\n            <name>hadoop.proxyuser.username.groups</name>\n        <value>*</value>\n        </property>\n        <property>\n                <name>hadoop.proxyuser.username.hosts</name>\n                <value>*</value>\n        </property>\n                <property>\n            <name>hadoop.proxyuser.hue.groups</name>\n        <value>*</value>\n        </property>\n        <property>\n                <name>hadoop.proxyuser.hue.hosts</name>\n                <value>*</value>\n        </property>\n</configuration>\n\n","hdfs-site.xml":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<?xml-stylesheet type=\"text/xsl\" href=\"configuration.xsl\"?>\n<!--\n  Licensed under the Apache License, Version 2.0 (the \"License\");\n  you may not use this file except in compliance with the License.\n  You may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\n  Unless required by applicable law or agreed to in writing, software\n  distributed under the License is distributed on an \"AS IS\" BASIS,\n  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n  See the License for the specific language governing permissions and\n  limitations under the License. See accompanying LICENSE file.\n-->\n\n<!-- Put site-specific property overrides in this file. -->\n\n<configuration>\n    <property>\n                <name>dfs.permissions</name>\n                <value>false</value>\n        </property>\n    <property>\n            <name>dfs.namenode.name.dir</name>\n            <value>/usr/bin/data/nameNode</value>\n    </property>\n    <property>\n            <name>dfs.datanode.data.dir</name>\n            <value>/usr/bin/data/dataNode</value>\n    </property>\n    <property>\n                <name>dfs.datanode.max.transfer.threads</name>\n                <value>8192</value>\n        </property>\n    <property>\n          <name>dfs.namenode.checkpoint.dir</name>\n          <value>/usr/bin/data/nameNodeSecondary</value>\n    </property>\n    <property>\n        <name>dfs.safemode.threshold.pct</name>\n        <value>0</value>\n    </property>\n        <property>\n                <name>dfs.namenode.http-address</name>\n                <value>localhost:50070</value>\n        </property>\n    <property>\n                <name>dfs.namenode.secondary.http-address</name>\n                <value>localhost:50090</value>\n        </property>\n    <property>\n        <name>dfs.namenode.acls.enabled</name>\n        <value>true</value>\n    </property>\n    <property>\n        <name>dfs.replication</name>\n        <value>1</value>\n    </property>\n        <property>\n                <name>dfs.webhdfs.enabled</name>\n                <value>true</value>\n        </property>\n</configuration>\n\n","krb5.conf":null,"tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538","created_by":{"user_id":1,"username":"YSU0000"},"modified_by":{"user_id":1,"username":"YSU0000"},"last_update_date":"2023-07-20T11:34:53.896774+00:00","from_date":"2023-07-20T11:34:53.896774+00:00","to_date":"infinity"}edit-hive-metastore-confyeeduresourceedit-hive-metastore-conf-husage:edit-hive-metastore-conf[-h]--hive_metastore_conf_idHIVE_METASTORE_CONF_ID[--hive_site_xml_file_pathHIVE_SITE_XML_FILE_PATH][--core_site_xml_file_pathCORE_SITE_XML_FILE_PATH][--hdfs_site_xml_file_pathHDFS_SITE_XML_FILE_PATH][--krb5_conf_file_pathKRB5_CONF_FILE_PATH][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--hive_metastore_conf_idHIVE_METASTORE_CONF_IDProvideaspecifichive_metastore_conf_idtoedit-hive-metastore-conf.--hive_site_xml_file_pathHIVE_SITE_XML_FILE_PATHProvidehive_site_xml_file_pathtoedit-hive-metastore-conf.--core_site_xml_file_pathCORE_SITE_XML_FILE_PATHProvidecore_site_xml_file_pathtoedit-hive-metastore-conf.--hdfs_site_xml_file_pathHDFS_SITE_XML_FILE_PATHProvidehdfs_site_xml_file_pathtoedit-hive-metastore-conf.--krb5_conf_file_pathKRB5_CONF_FILE_PATHProvidekrb5_conf_file_pathtoedit-hive-metastore-conf.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)edit-hive-metastore-conf example with the required
‘–hive_metastore_conf_id’ argument and other optional argument is
passed which is to be updated.yeeduresourceedit-hive-metastore-conf--hive_metastore_conf_id=1--krb5_conf_file_path="/home/user/Documents/krb5.conf"Console output{"hive_metastore_conf_id":"1","tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538","created_by_id":"1","modified_by_id":"1","last_update_date":"2023-07-20T11:37:08.322Z","from_date":"2023-07-20T11:34:53.896Z","to_date":null}delete-hive-metastore-confyeeduresourcedelete-hive-metastore-conf-husage:delete-hive-metastore-conf[-h]--hive_metastore_conf_idHIVE_METASTORE_CONF_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--hive_metastore_conf_idHIVE_METASTORE_CONF_IDProvidehive_metastore_conf_idtodeleteaspecificHiveMetastoreConfiguration.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)delete-hive-metastore-conf example with the required
‘–hive_metastore_conf_id’ argument passed.yeeduresourcedelete-hive-metastore-conf--hive_metastore_conf_id=1Console output{"message":"Deleted Hive Metastore Configuration: 1"}ClusterCluster ConfigurationCommand NameUtilitycreate-confTo create the Cluster
Configuration.list-confsTo list all the available Cluster
Configurations.get-confTo get the information about a
specific Cluster Configuration.edit-confTo edit a specific Cluster
Configuration.create-confyeeduclustercreate-conf-husage:create-conf[-h]--nameNAME--descriptionDESCRIPTION--cloud_project_idCLOUD_PROJECT_ID--object_storage_manager_idOBJECT_STORAGE_MANAGER_ID--credentials_conf_idCREDENTIALS_CONF_ID--machine_conf_idMACHINE_CONF_ID[--spark_config_id[SPARK_CONFIG_ID]][--hive_metastore_conf_id[HIVE_METASTORE_CONF_ID]]--cloud_provider_idCLOUD_PROVIDER_ID--spark_infra_version_idSPARK_INFRA_VERSION_ID[--max_parallel_spark_job_execution_per_instance[MAX_PARALLEL_SPARK_JOB_EXECUTION_PER_INSTANCE]][--standalone_workers_number[STANDALONE_WORKERS_NUMBER]]--cluster_typeYEEDU,STANDALONE,CLUSTER--min_instancesMIN_INSTANCES--max_instancesMAX_INSTANCES--is_cudatrue,false[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--nameNAMEProvidenametocreate-conf.--descriptionDESCRIPTIONProvidedescriptiontocreate-conf.--cloud_project_idCLOUD_PROJECT_IDProvidecloud_project_idtocreate-conf.--object_storage_manager_idOBJECT_STORAGE_MANAGER_IDProvideobject_storage_manager_idtocreate-conf.--credentials_conf_idCREDENTIALS_CONF_IDProvidecredentials_conf_idtocreate-conf.--machine_conf_idMACHINE_CONF_IDProvidemachine_conf_idtocreate-conf.--spark_config_id[SPARK_CONFIG_ID]Providespark_config_idtocreate-conf.--hive_metastore_conf_id[HIVE_METASTORE_CONF_ID]Providehive_metastore_conf_idtocreate-conf.--cloud_provider_idCLOUD_PROVIDER_IDProvidecloud_provider_idtocreate-conf.--spark_infra_version_idSPARK_INFRA_VERSION_IDProvidespark_infra_version_idtocreate-conf.--max_parallel_spark_job_execution_per_instance[MAX_PARALLEL_SPARK_JOB_EXECUTION_PER_INSTANCE]Providemax_parallel_spark_job_execution_per_instancetocreate-conf.(default:5)--standalone_workers_number[STANDALONE_WORKERS_NUMBER]Providestandalone_workers_numbertocreate-conf.--cluster_typeYEEDU,STANDALONE,CLUSTERProvidecluster_typetocreate-conf.--min_instancesMIN_INSTANCESProvidemin_instancestocreate-conf.--max_instancesMAX_INSTANCESProvidemax_instancestocreate-conf.--is_cudatrue,falseProvideis_cudatocreate-conf.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)create-conf example with all the required arguments passed.yeeduclustercreate-conf--name="yeedu_cluster"--description="Cluster Configurations test"--cloud_project_id="yeedu"--object_storage_manager_id=1--credentials_conf_id=1--machine_conf_id=1--cloud_provider_id=0--spark_infra_version_id=0--max_parallel_spark_job_execution_per_instance=5--cluster_type="YEEDU"--min_instances=1--max_instances=2--is_cuda=falseConsole output{"cluster_conf_id":"1","name":"yeedu_cluster","description":"Cluster Configurations test","cloud_project_id":"yeedu","object_storage_manager_id":"1","credentials_conf_id":"1","machine_conf_id":"1","spark_config_id":null,"hive_metastore_conf_id":null,"cloud_provider_id":"0","spark_infra_version_id":"0","engine_cluster_spark_config":{"max_parallel_spark_job_execution_per_instance":5},"cluster_type":"YEEDU","min_instances":1,"max_instances":2,"is_cuda":false,"tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538","created_by_id":"1","modified_by_id":"1","last_update_date":"2023-07-20T11:38:27.321Z","from_date":"2023-07-20T11:38:27.321Z","to_date":null}list-confsyeeduclusterlist-confs-husage:list-confs[-h][--cloud_provider[{GCP,AWS,AZURE}]][--page_numberPAGE_NUMBER][--limitLIMIT][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--cloud_provider[{GCP,AWS,AZURE}]CloudProviderthatwillbeusedforfilteringlist.--page_numberPAGE_NUMBERTolistEngineCluserConfigurationforaspecificpage_number.(default:1)--limitLIMITProvidelimittolistnumberofEngineCluserConfiguration.(default:100)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list-confs example without optional arguments passed for output
format.yeeduclusterlist-confs--cloud_provider="GCP"--limit=2Console output{"data":[{"cluster_conf_id":"1","name":"yeedu_cluster","description":"Cluster Configurations test","cloud_project_id":"yeedu","object_storage_manager":{"object_storage_manager_id":"1","credentials_conf_id":"1","object_storage_bucket_name":"yeedu"},"credentials_conf_id":"1","machine_config":{"machine_conf_id":"1","network_tags":["yeedu","iap-allow"],"labels":{"env":"test","test":"dev","resource":"yeedu","tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538"},"is_spot_instance":false,"enable_public_ip":true,"block_project_ssh_keys":true,"bootstrap_shell_script":null,"boot_disk_image_config":{"boot_disk_image_id":"1","boot_disk_image":"ubuntu-os-cloud/ubuntu-2004-lts","cloud_provider":{"name":"gcp"}},"machine_type":{"machine_type_id":"15","name":"c2d-highcpu-16","vcpus":16,"memory":"32 GiB","has_cuda":false,"gpu_model":null,"gpus":null,"gpu_memory":null},"machine_network":{"network_conf_id":"1","network_project_id":"yeedu","network_name":"yeedu-spark-vpc","subnet":"custom-subnet-yeedu","availability_zone":{"name":"us-central1-a","region":"us-central1","description":"Council Bluffs, Iowa, North America"}},"machine_volume_config":{"volume_conf_id":"1","name":"yeedu volume","encrypted":false,"size":"375","machine_volume_num":1,"machine_volume_strip_num":1,"availability_zone":{"name":"us-central1-a","region":"us-central1"},"disk_type":{"name":"local-ssd","has_fixed_size":true,"min_size":375,"max_size":375}}},"spark_config":null,"hive_metastore":null,"cloud_provider":{"name":"gcp","description":"Provider for creating infrastructure on Google Cloud Platform"},"spark_infra_version":{"spark_version":"2.4.8","hive_version":"3.2.3","hadoop_version":"2.10.1","scala_version":"2.11.10"},"engine_cluster_spark_config":{"max_parallel_spark_job_per_instance":5,"standalone_workers_number":null},"cluster_type":"YEEDU","min_instances":1,"max_instances":2,"is_cuda":false,"tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538","created_by":{"user_id":"1","username":"YSU0000"},"modified_by":{"user_id":"1","username":"YSU0000"},"last_update_date":"2023-07-20T11:38:27.321Z","from_date":"2023-07-20T11:38:27.321Z","to_date":null}],"result_set":{"current_page":1,"total_objects":1,"total_pages":1,"limit":2}}get-confyeeduclusterget-conf-husage:get-conf[-h][--cluster_conf_idCLUSTER_CONF_ID][--cluster_conf_nameCLUSTER_CONF_NAME][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--cluster_conf_idCLUSTER_CONF_IDProvideClusterConfIdtogetinformationaboutaspecificClusterConfiguration.--cluster_conf_nameCLUSTER_CONF_NAMEProvideEngineClusterConfigNametogetinformationaboutaspecificClusterConfiguration.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)get-conf example with one of the optional ‘–cluster_conf_id’
argument passed.yeeduclusterget-conf--cluster_conf_id=1Console output{"cluster_conf_id":"1","name":"yeedu_cluster","description":"Cluster Configurations test","cloud_project_id":"yeedu","object_storage_manager":{"object_storage_manager_id":"1","credentials_conf_id":"1","object_storage_bucket_name":"yeedu"},"credentials_conf_id":"1","machine_config":{"machine_conf_id":"1","network_tags":["yeedu","iap-allow"],"labels":{"env":"test","test":"dev","resource":"yeedu","tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538"},"is_spot_instance":false,"enable_public_ip":true,"block_project_ssh_keys":true,"bootstrap_shell_script":null,"boot_disk_image_config":{"boot_disk_image_id":"1","boot_disk_image":"ubuntu-os-cloud/ubuntu-2004-lts","cloud_provider":{"name":"gcp"}},"machine_type":{"machine_type_id":"15","name":"c2d-highcpu-16","vcpus":16,"memory":"32 GiB","has_cuda":false,"gpu_model":null,"gpus":null,"gpu_memory":null},"machine_network":{"network_conf_id":"1","network_project_id":"yeedu","network_name":"yeedu-spark-vpc","subnet":"custom-subnet-yeedu","availability_zone":{"name":"us-central1-a","region":"us-central1","description":"Council Bluffs, Iowa, North America"}},"machine_volume_config":{"volume_conf_id":"1","name":"yeedu volume","encrypted":false,"size":"375","machine_volume_num":1,"machine_volume_strip_num":1,"availability_zone":{"name":"us-central1-a","region":"us-central1"},"disk_type":{"name":"local-ssd","has_fixed_size":true,"min_size":375,"max_size":375}}},"spark_config":null,"hive_metastore":null,"cloud_provider":{"name":"gcp","description":"Provider for creating infrastructure on Google Cloud Platform"},"spark_infra_version":{"spark_version":"2.4.8","hive_version":"3.2.3","hadoop_version":"2.10.1","scala_version":"2.11.10"},"engine_cluster_spark_config":{"max_parallel_spark_job_per_instance":5,"standalone_workers_number":null},"cluster_type":"YEEDU","min_instances":1,"max_instances":2,"is_cuda":false,"tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538","created_by":{"user_id":"1","username":"YSU0000"},"modified_by":{"user_id":"1","username":"YSU0000"},"last_update_date":"2023-07-20T11:38:27.321Z","from_date":"2023-07-20T11:38:27.321Z","to_date":null}edit-confyeeduclusteredit-conf-husage:edit-conf[-h][--cluster_conf_idCLUSTER_CONF_ID][--cluster_conf_nameCLUSTER_CONF_NAME][--name[NAME]][--description[DESCRIPTION]][--cloud_project_id[CLOUD_PROJECT_ID]][--max_parallel_spark_job_execution_per_instance[MAX_PARALLEL_SPARK_JOB_EXECUTION_PER_INSTANCE]][--standalone_workers_number[STANDALONE_WORKERS_NUMBER]][--cluster_typeYEEDU,STANDALONE,CLUSTER][--min_instances[MIN_INSTANCES]][--max_instances[MAX_INSTANCES]][--is_cuda[true,false]][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--cluster_conf_idCLUSTER_CONF_IDProvideaspecificClusterConfIdtoedit-conf.--cluster_conf_nameCLUSTER_CONF_NAMEProvideaspecificEngineClusterConfigNametoedit-conf.--name[NAME]Providenametoedit-conf.--description[DESCRIPTION]Providedescriptiontoedit-conf.--cloud_project_id[CLOUD_PROJECT_ID]Providecloud_project_idtoedit-conf.--max_parallel_spark_job_execution_per_instance[MAX_PARALLEL_SPARK_JOB_EXECUTION_PER_INSTANCE]Providemax_parallel_spark_job_execution_per_instancetoedit-conf.--standalone_workers_number[STANDALONE_WORKERS_NUMBER]Providestandalone_workers_numbertoedit-conf.--cluster_typeYEEDU,STANDALONE,CLUSTERProvidecluster_typetoedit-conf.--min_instances[MIN_INSTANCES]Providemin_instancestoedit-conf.--max_instances[MAX_INSTANCES]Providemax_instancestoedit-conf.--is_cuda[true,false]Provideis_cudatoedit-conf.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)edit-conf example with the required ‘–cluster_conf_id’ argument and
other optional argument is passed which is to be updated.yeeduclusteredit-conf--cluster_conf_id=1--name='yeedu_cluster_1'Console output{"cluster_conf_id":"1","name":"yeedu_cluster_1","description":"Cluster Configurations test","cloud_project_id":"yeedu","object_storage_manager_id":"1","credentials_conf_id":"1","machine_conf_id":"1","spark_config_id":null,"hive_metastore_conf_id":null,"cloud_provider_id":"0","spark_infra_version_id":"0","engine_cluster_spark_config":{"max_parallel_spark_job_execution_per_instance":5,"standalone_workers_number":null},"cluster_type":"YEEDU","min_instances":1,"max_instances":2,"is_cuda":false,"tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538","created_by_id":"1","modified_by_id":"1","last_update_date":"2023-07-20T11:42:41.921Z","from_date":"2023-07-20T11:38:27.321Z","to_date":null}Cluster InstanceCommand NameUtilitycreateTo create the Cluster Instance.listTo list all the available Cluster
Instances.getTo get the information about a
specific Cluster Instance.editTo edit a specific Cluster Instance.startTo start a specific Cluster Instance.stopTo stop a specific Cluster Instance.destroyTo destroy a specific Cluster
Instance.get-statsTo get the Spark Job Statistics of an
Cluster Instance.logsTo download Cluster Instance logs for
specific Cluster Instance Id.createyeeduclustercreate-husage:create[-h][--instance_name[INSTANCE_NAME]]--idle_timeout_ms[IDLE_TIMEOUT_MS][--auto_shutdown[true,false]]--cluster_conf_idCLUSTER_CONF_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--instance_name[INSTANCE_NAME]Provideinstance_nametocreate.--idle_timeout_ms[IDLE_TIMEOUT_MS]Provideidle_timeout_mstocreate.--auto_shutdown[true,false]Provideauto_shutdowntocreate.(default:true)--cluster_conf_idCLUSTER_CONF_IDProvidecluster_conf_idtocreate.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)create example with all the required and optional arguments passed.yeeduclustercreate--instance_name="yeedu_instance"--idle_timeout_ms=300000--auto_shutdown=true--cluster_conf_id=1Console output{"cluster_id":"34","instance_name":"yeedu_instance","idle_timeout_ms":"300000","auto_shutdown":true,"cluster_conf_id":"1","tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538","created_by_id":"1","modified_by_id":"1","last_update_date":"2023-07-20T11:44:07.355Z","from_date":"2023-07-20T11:44:07.355Z","to_date":null}listyeeduclusterlist-husage:list[-h][--cluster_status[CLUSTER_STATUS]][--cluster_conf_idCLUSTER_CONF_ID][--cluster_conf_nameCLUSTER_CONF_NAME][--page_numberPAGE_NUMBER][--limitLIMIT][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--cluster_status[CLUSTER_STATUS]ProvideClusterInstanceStatusfrom["INITIATING","RUNNING","STOPPING","STOPPED","DESTROYING","DESTROYED","ERROR","RESIZING_UP","RESIZING_DOWN"]tolist,Forexample--cluster_status="RUNNING,DESTROYED".--cluster_conf_idCLUSTER_CONF_IDProvideClusterConfIdtolistalltheClusterInstances.--cluster_conf_nameCLUSTER_CONF_NAMEProvideEngineClusterConfigNametolistalltheClusterInstances.--page_numberPAGE_NUMBERTolistClusterInstanceforaspecificpage_number.(default:1)--limitLIMITProvidelimittolistnumberofClusterInstance.(default:100)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list example passing the optional output arguments.yeeduclusterlist--cluster_status="RUNNING"--cluster_conf_name="yeedu_cluster"--limit=5Console output{"data":[{"cluster_id":34,"instance_name":"yeedu_instance","idle_timeout_ms":300000,"auto_shutdown":true,"cluster_conf_id":1,"cluster_status":"RUNNING","compute_engine_id":34,"instance_size":1,"workflow_job_instance_details":{"workflow_job_instance_status":{"workflow_job_instance_id":61982,"workflow_job_id":61982,"status":"DONE","from_date":"2023-07-20T11:44:07.355757+00:00","to_date":"2023-07-20T11:44:47.959702+00:00"}},"tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538","created_by":{"user_id":1,"username":"YSU0000"},"modified_by":{"user_id":1,"username":"YSU0000"},"last_update_date":"2023-07-20T11:44:07.355757+00:00","from_date":"2023-07-20T11:44:07.355757+00:00","to_date":"infinity"}],"result_set":{"current_page":1,"total_objects":1,"total_pages":1,"limit":5}}getyeeduclusterget-husage:get[-h][--cluster_idCLUSTER_ID][--cluster_nameCLUSTER_NAME][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--cluster_idCLUSTER_IDProvideClusterInstanceIdtogetinformationaboutaspecificClusterInstance.--cluster_nameCLUSTER_NAMEProvideClusterInstanceNametogetinformationaboutaspecificClusterInstance.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)get example with one of the optional arguments
‘–cluster_instance_name’ passed.yeeduclusterget--cluster_name="yeedu_instance"Console output{"cluster_id":34,"instance_name":"yeedu_instance","idle_timeout_ms":300000,"auto_shutdown":true,"cluster_conf_id":1,"cluster_status":"RUNNING","compute_engine_id":34,"instance_size":1,"workflow_job_instance_details":{"workflow_job_instance_status":{"workflow_job_instance_id":61982,"workflow_job_id":61982,"status":"DONE","from_date":"2023-07-20T11:44:07.355757+00:00","to_date":"2023-07-20T11:44:47.959702+00:00"}},"tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538","created_by":{"user_id":1,"username":"YSU0000"},"modified_by":{"user_id":1,"username":"YSU0000"},"last_update_date":"2023-07-20T11:44:07.355757+00:00","from_date":"2023-07-20T11:44:07.355757+00:00","to_date":"infinity"}edityeeduclusteredit-husage:edit[-h][--cluster_idCLUSTER_ID][--cluster_nameCLUSTER_NAME][--idle_timeout_ms[IDLE_TIMEOUT_MS]][--auto_shutdown[true,false]][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--cluster_idCLUSTER_IDProvideaspecificClusterInstanceIdtoedit.--cluster_nameCLUSTER_NAMEProvideaspecificClusterInstanceNametoedit.--idle_timeout_ms[IDLE_TIMEOUT_MS]Provideidle_timeout_mstoedit.--auto_shutdown[true,false]Provideauto_shutdowntoedit.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)edit example with one of the required ‘–cluster_id’ argument and
other optional argument is passed which is to be updated.yeeduclusteredit--cluster_id=34--idle_timeout_ms=600000Console output{"cluster_id":"34","instance_name":"yeedu_instance","idle_timeout_ms":"600000","auto_shutdown":true,"cluster_conf_id":"1","tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538","created_by_id":"1","modified_by_id":"1","last_update_date":"2023-07-20T11:46:35.401Z","from_date":"2023-07-20T11:44:07.355Z","to_date":null}startyeeduclusterstart-husage:start[-h][--cluster_idCLUSTER_ID][--cluster_nameCLUSTER_NAME][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--cluster_idCLUSTER_IDProvideClusterInstanceIdtostartanClusterInstance.--cluster_nameCLUSTER_NAMEProvideClusterInstanceNametostartanClusterInstance.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)start example with one of the required argument ‘–cluster_id’
passed.yeeduclusterstart--cluster_id=1Console output{"CosiStart":{"workflow_job_id":"61988","workflow_job_instance_id":"61988","engine_cluster_instance_id":"34"}}stopyeeduclusterstop-husage:stop[-h][--cluster_idCLUSTER_ID][--cluster_nameCLUSTER_NAME][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--cluster_idCLUSTER_IDProvideClusterInstanceIdtostopanClusterInstance.--cluster_nameCLUSTER_NAMEProvideClusterInstanceNametostopanClusterInstance.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)stop example with one of the required argument ‘–cluster_id’ passed.yeeduclusterstop--cluster_id=34Console output{"CosiStop":{"workflow_job_id":"61984","workflow_job_instance_id":"61984","engine_cluster_instance_id":34}}destroyyeeduclusterdestroy-husage:destroy[-h][--cluster_idCLUSTER_ID][--cluster_nameCLUSTER_NAME][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--cluster_idCLUSTER_IDProvideClusterInstanceIdtodestroyanClusterInstance.--cluster_nameCLUSTER_NAMEProvideClusterInstanceNametodestroyanClusterInstance.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)destroy example with one of the required argument ‘–cluster_id’
passed.yeeduclusterdestroy--cluster_id=1Console output{"CosiDestroy":{"workflow_job_id":"62047","workflow_job_instance_id":"62047","engine_cluster_instance_id":34}}get-statsyeeduclusterget-stats-husage:get-stats[-h][--cluster_idCLUSTER_ID][--cluster_nameCLUSTER_NAME][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--cluster_idCLUSTER_IDProvideClusterInstanceIdtogettheSparkJobStatisticsofanClusterInstance.--cluster_nameCLUSTER_NAMEProvideClusterInstanceNametogettheSparkJobStatisticsofanClusterInstance.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)get-stats example with one of the optional arguments
‘–cluster_instance_name’ passed.yeeduclusterget-stats--cluster_name="yeedu_instance"Console output{"SUBMITTED":1,"RUNNING":3,"DONE":4,"ERROR":0,"TERMINATED":0,"KILLING":0,"KILLED":1,"TOTAL_JOB_COUNT":9}logsyeeduclusterlogs-husage:logs[-h][--cluster_idCLUSTER_ID][--cluster_nameCLUSTER_NAME][--log_type{stdout,stderr}][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--cluster_idCLUSTER_IDProvideClusterInstanceIdtodownloadlogrecords.--cluster_nameCLUSTER_NAMEProvideClusterInstanceNametodownloadlogrecords.--log_type{stdout,stderr}Providelog_typetodownloadClusterInstancelogrecords.(default:stdout)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)logs example with one of the required ‘–cluster_id’ argument passed.yeeduclusterlogs--cluster_id=34Console outputInitializingmodules...-local-nodeinmodule-master-standalone-clusterinmodule-standalone-nodeinmodule-worker-standalone-clusterinmoduleInitializingthebackend...Successfullyconfiguredthebackend"pg"!Terraformwillautomaticallyusethisbackendunlessthebackendconfigurationchanges.Initializingproviderplugins...-Reusingpreviousversionofhashicorp/randomfromthedependencylockfile-Reusingpreviousversionofhashicorp/templatefromthedependencylockfile-Reusingpreviousversionofhashicorp/awsfromthedependencylockfile-Usinghashicorp/awsv5.3.0fromthesharedcachedirectory-Usinghashicorp/randomv3.5.1fromthesharedcachedirectory-Usinghashicorp/templatev2.2.0fromthesharedcachedirectoryTerraformhasbeensuccessfullyinitialized!YoumaynowbeginworkingwithTerraform.Tryrunning"terraform plan"toseeanychangesthatarerequiredforyourinfrastructure.AllTerraformcommandsshouldnowwork.IfyoueversetorchangemodulesorbackendconfigurationforTerraform,rerunthiscommandtoreinitializeyourworkingdirectory.Ifyouforget,othercommandswilldetectitandremindyoutodosoifnecessary.Success!Theconfigurationisvalid.Switchedtoworkspace"34".module.local-node[0].random_uuid.instance_uuid:Refreshingstate...[id=b91924dd-615f-e137-8059-710cd9fd57ad]module.local-node[0].aws_key_pair.deployer:Refreshingstate...[id=yeedu34-b91924dd-615f-e137-8059-710cd9fd57ad-ssh-key]module.local-node[0].aws_instance.vm[0]:Refreshingstate...[id=i-081774035e3470cd6]Note:ObjectshavechangedoutsideofTerraformTerraformdetectedthefollowingchangesmadeoutsideofTerraformsincethelast"terraform apply":# module.local-node[0].aws_key_pair.deployer has been changed~resource"aws_key_pair""deployer"{id="yeedu34-b91924dd-615f-e137-8059-710cd9fd57ad-ssh-key"+tags={}# (7 unchanged attributes hidden)}Unlessyouhavemadeequivalentchangestoyourconfiguration,orignoredtherelevantattributesusingignore_changes,thefollowingplanmayincludeactionstoundoorrespondtothesechanges.JobSpark Job ConfigurationCommand NameUtilitycreate-confTo create a Spark Job
Configuration.list-confsTo list all the available Spark
Job Configurations.get-confTo get information about a
specific Spark Job
Configuration.edit-confTo edit a Spark Job
Configuration.delete-confTo delete a specific Spark Job
Configuration.create-confyeedujobcreate-conf-husage:create-conf[-h]--cluster_idCLUSTER_ID--nameNAME[--files[FILES]][--properties-file[PROPERTIES_FILE]][--confCONF[CONF...]][--packages[PACKAGES]][--repositories[REPOSITORIES]][--jars[JARS]][--archives[ARCHIVES]]--deploy-modeclient,cluster[--driver-memory[DRIVER_MEMORY]][--driver-java-options[DRIVER_JAVA_OPTIONS]][--driver-library-path[DRIVER_LIBRARY_PATH]][--driver-class-path[DRIVER_CLASS_PATH]][--executor-memory[EXECUTOR_MEMORY]][--driver-cores[DRIVER_CORES]][--total-executor-cores[TOTAL_EXECUTOR_CORES]][--executor-cores[EXECUTOR_CORES]][--num-executors[NUM_EXECUTORS]][--principal[PRINCIPAL]][--keytab[KEYTAB]][--queue[QUEUE]][--class-name[CLASS_NAME]][--command[COMMAND]][--arguments[ARGUMENTS]][--raw-scala-codeRAW_SCALA_CODE][--max_concurrencyMAX_CONCURRENCY][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--cluster_idCLUSTER_IDProvidecluster_idtocreateaSparkJobConfiguration.--nameNAMEProvidenametocreateaSparkJobConfiguration.--files[FILES]ProvidefilestocreateaSparkJobConfiguration.--properties-file[PROPERTIES_FILE]Provideproperties-filetocreateaSparkJobConfiguration.--confCONF[CONF...]ProvideconftocreateaSparkJobConfiguration.--packages[PACKAGES]ProvidepackagestocreateaSparkJobConfiguration.--repositories[REPOSITORIES]ProviderepositoriestocreateaSparkJobConfiguration.--jars[JARS]ProvidejarstocreateaSparkJobConfiguration.--archives[ARCHIVES]ProvidearchivestocreateaSparkJobConfiguration.--deploy-modeclient,clusterProvidedeploy-modetocreateaSparkJobConfiguration.--driver-memory[DRIVER_MEMORY]Providedriver-memorytocreateaSparkJobConfiguration.--driver-java-options[DRIVER_JAVA_OPTIONS]Providedriver-java-optionstocreateaSparkJobConfiguration.--driver-library-path[DRIVER_LIBRARY_PATH]Providedriver-library-pathtocreateaSparkJobConfiguration.--driver-class-path[DRIVER_CLASS_PATH]Providedriver-class-pathtocreateaSparkJobConfiguration.--executor-memory[EXECUTOR_MEMORY]Provideexecutor-memorytocreateaSparkJobConfiguration.--driver-cores[DRIVER_CORES]Providedriver-corestocreateaSparkJobConfiguration.--total-executor-cores[TOTAL_EXECUTOR_CORES]Providetotal-executor-corestocreateaSparkJobConfiguration.--executor-cores[EXECUTOR_CORES]Provideexecutor-corestocreateaSparkJobConfiguration.--num-executors[NUM_EXECUTORS]Providenum-executorstocreateaSparkJobConfiguration.--principal[PRINCIPAL]ProvideprincipaltocreateaSparkJobConfiguration.--keytab[KEYTAB]ProvidekeytabtocreateaSparkJobConfiguration.--queue[QUEUE]ProvidequeuetocreateaSparkJobConfiguration.--class-name[CLASS_NAME]Provideclass-nametocreateaSparkJobConfiguration.--command[COMMAND]ProvidecommandtocreateaSparkJobConfiguration.--arguments[ARGUMENTS]ProvideargumentstocreateaSparkJobConfiguration.--raw-scala-codeRAW_SCALA_CODEProvideraw-scala-codefilepathtocreateaSparkJobConfiguration.--max_concurrencyMAX_CONCURRENCYProvidemax_concurrencynumbertolimitthenumberofjobssubmitted.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)create-conf example with all the required and optional arguments
passed.yeedujobcreate-conf--cluster_id=34--name="spark_examples"--deploy-mode="client"--class-name="org.apache.spark.examples.SparkPi"--command="file:///yeedu/object-storage-manager/spark-examples_2.11-2.4.8.jar"--arguments=500Console output{"job_conf_id":"63498","name":"spark_examples","cluster_id":"34","max_concurrency":"0","deploy_mode":"client","class_name":"org.apache.spark.examples.SparkPi","command":"file:///yeedu/object-storage-manager/spark-examples_2.11-2.4.8.jar","arguments":"500","rawScalaCode":null,"files":null,"properties_file":null,"conf":null,"packages":null,"repositories":null,"jars":null,"archives":null,"driver_memory":null,"driver_java_options":null,"driver_library_path":null,"driver_class_path":null,"executor_memory":null,"driver_cores":null,"total_executor_cores":null,"executor_cores":null,"num_executors":null,"principal":null,"keytab":null,"queue":null,"tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538","created_by_id":"1","modified_by_id":"1","last_update_date":"2023-07-20T11:52:46.836Z","from_date":"2023-07-20T11:52:46.836Z","to_date":null}list-confsyeedujoblist-confs-husage:list-confs[-h][--page_numberPAGE_NUMBER][--limitLIMIT][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--page_numberPAGE_NUMBERTolistSparkJobConfigurationsforaspecificpage_number.(default:1)--limitLIMITProvidelimittolistnumberofSparkJobConfigurations.(default:100)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list-confs example with optional arguments passed.yeedujoblist-confs--limit=2Console output{"data":[{"job_conf_id":"63498","name":"spark_examples","cluster_id":"34","deploy_mode":"client","max_concurrency":"0","class_name":"org.apache.spark.examples.SparkPi","command":"file:///yeedu/object-storage-manager/spark-examples_2.11-2.4.8.jar","arguments":"500","rawScalaCode":null,"files":null,"properties_file":null,"conf":null,"packages":null,"repositories":null,"jars":null,"archives":null,"driver_memory":null,"driver_java_options":null,"driver_library_path":null,"driver_class_path":null,"executor_memory":null,"driver_cores":null,"total_executor_cores":null,"executor_cores":null,"num_executors":null,"principal":null,"keytab":null,"queue":null,"tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538","created_by":{"user_id":"1","username":"YSU0000"},"modified_by":{"user_id":"1","username":"YSU0000"},"last_update_date":"2023-07-20T11:52:46.836Z","from_date":"2023-07-20T11:52:46.836Z","to_date":null}],"result_set":{"current_page":1,"total_objects":1,"total_pages":1,"limit":2}}get-confyeedujobget-conf-husage:get-conf[-h][--job_conf_idJOB_CONF_ID][--job_conf_nameJOB_CONF_NAME][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--job_conf_idJOB_CONF_IDProvideanidtogetinformationaboutaspecificSparkJobConfiguration.--job_conf_nameJOB_CONF_NAMEProvidenametogetinformationaboutaspecificSparkJobConfiguration.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)get-conf example with one of the required ‘–job_conf_id’ arguments
passed.yeedujobget-conf--job_conf_id=63498Console output{"job_conf_id":"63498","name":"spark_examples","cluster_id":"34","deploy_mode":"client","max_concurrency":"0","class_name":"org.apache.spark.examples.SparkPi","command":"file:///yeedu/object-storage-manager/spark-examples_2.11-2.4.8.jar","arguments":"500","rawScalaCode":null,"files":null,"properties_file":null,"conf":null,"packages":null,"repositories":null,"jars":null,"archives":null,"driver_memory":null,"driver_java_options":null,"driver_library_path":null,"driver_class_path":null,"executor_memory":null,"driver_cores":null,"total_executor_cores":null,"executor_cores":null,"num_executors":null,"principal":null,"keytab":null,"queue":null,"tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538","created_by":{"user_id":"1","username":"YSU0000"},"modified_by":{"user_id":"1","username":"YSU0000"},"last_update_date":"2023-07-20T11:52:46.836Z","from_date":"2023-07-20T11:52:46.836Z","to_date":null}edit-confyeedujobedit-conf-husage:edit-conf[-h][--job_conf_idJOB_CONF_ID][--job_conf_nameJOB_CONF_NAME][--cluster_idCLUSTER_ID][--cluster_nameCLUSTER_NAME][--files[FILES]][--properties-file[PROPERTIES_FILE]][--confCONF[CONF...]][--packages[PACKAGES]][--repositories[REPOSITORIES]][--jars[JARS]][--archives[ARCHIVES]][--deploy-modeclient,cluster][--driver-memory[DRIVER_MEMORY]][--driver-java-options[DRIVER_JAVA_OPTIONS]][--driver-library-path[DRIVER_LIBRARY_PATH]][--driver-class-path[DRIVER_CLASS_PATH]][--executor-memory[EXECUTOR_MEMORY]][--driver-cores[DRIVER_CORES]][--total-executor-cores[TOTAL_EXECUTOR_CORES]][--executor-cores[EXECUTOR_CORES]][--num-executors[NUM_EXECUTORS]][--principal[PRINCIPAL]][--keytab[KEYTAB]][--queue[QUEUE]][--class-name[CLASS_NAME]][--name[NAME]][--command[COMMAND]][--arguments[ARGUMENTS]][--raw-scala-codeRAW_SCALA_CODE][--max_concurrencyMAX_CONCURRENCY][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--job_conf_idJOB_CONF_IDProvideSparkJobConfigIdtoeditaSparkJobConfiguration.--job_conf_nameJOB_CONF_NAMEProvideSparkJobConfigNametoeditaSparkJobConfiguration.--cluster_idCLUSTER_IDProvideClusterIdtoeditinaSparkJobConfiguration.--cluster_nameCLUSTER_NAMEProvideClusterNametoeditinaSparkJobConfiguration.--files[FILES]ProvidefilestoeditinaSparkJobConfiguration.--properties-file[PROPERTIES_FILE]Provideproperties-filetoeditinaSparkJobConfiguration.--confCONF[CONF...]ProvideconftoeditinaSparkJobConfiguration.--packages[PACKAGES]ProvidepackagestoeditinaSparkJobConfiguration.--repositories[REPOSITORIES]ProviderepositoriestoeditinaSparkJobConfiguration.--jars[JARS]ProvidejarstoeditinaSparkJobConfiguration.--archives[ARCHIVES]ProvidearchivestoeditinaSparkJobConfiguration.--deploy-modeclient,clusterProvidedeploy-modetoeditinaSparkJobConfiguration.--driver-memory[DRIVER_MEMORY]Providedriver-memorytoeditinaSparkJobConfiguration.--driver-java-options[DRIVER_JAVA_OPTIONS]Providedriver-java-optionstoeditinaSparkJobConfiguration.--driver-library-path[DRIVER_LIBRARY_PATH]Providedriver-library-pathtoeditinaSparkJobConfiguration.--driver-class-path[DRIVER_CLASS_PATH]Providedriver-class-pathtoeditinaSparkJobConfiguration.--executor-memory[EXECUTOR_MEMORY]Provideexecutor-memorytoeditinaSparkJobConfiguration.--driver-cores[DRIVER_CORES]Providedriver-corestoeditinaSparkJobConfiguration.--total-executor-cores[TOTAL_EXECUTOR_CORES]Providetotal-executor-corestoeditinaSparkJobConfiguration.--executor-cores[EXECUTOR_CORES]Provideexecutor-corestoeditinaSparkJobConfiguration.--num-executors[NUM_EXECUTORS]Providenum-executorstoeditinaSparkJobConfiguration.--principal[PRINCIPAL]ProvideprincipaltoeditinaSparkJobConfiguration.--keytab[KEYTAB]ProvidekeytabtoeditinaSparkJobConfiguration.--queue[QUEUE]ProvidequeuetoeditinaSparkJobConfiguration.--class-name[CLASS_NAME]Provideclass-nametoeditinaSparkJobConfiguration.--name[NAME]ProvidenametoeditinaSparkJobConfiguration.--command[COMMAND]ProvidecommandtoeditinaSparkJobConfiguration.--arguments[ARGUMENTS]ProvideargumentstoeditinaSparkJobConfiguration.--raw-scala-codeRAW_SCALA_CODEProvideraw-scala-codefilepathtoeditinaSparkJobConfiguration.--max_concurrencyMAX_CONCURRENCYProvidemax_concurrencynumbertolimitthenumberofjobssubmitted.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)edit-conf example with one of the required ‘–job_conf_name’ argument
and other optional argument is passed which is to be updated.yeedujobedit-conf--job_conf_name="spark_examples"--arguments=1000Console output{"job_conf_id":"63498","name":"spark_examples","cluster_id":"34","max_concurrency":"0","deploy_mode":"client","class_name":"org.apache.spark.examples.SparkPi","command":"file:///yeedu/object-storage-manager/spark-examples_2.11-2.4.8.jar","arguments":"1000","rawScalaCode":null,"files":null,"properties_file":null,"conf":null,"packages":null,"repositories":null,"jars":null,"archives":null,"driver_memory":null,"driver_java_options":null,"driver_library_path":null,"driver_class_path":null,"executor_memory":null,"driver_cores":null,"total_executor_cores":null,"executor_cores":null,"num_executors":null,"principal":null,"keytab":null,"queue":null,"tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538","created_by_id":"1","modified_by_id":"1","last_update_date":"2023-07-20T11:55:09.338Z","from_date":"2023-07-20T11:52:46.836Z","to_date":null}delete-confyeedujobdelete-conf-husage:delete-conf[-h][--job_conf_idJOB_CONF_ID][--job_conf_nameJOB_CONF_NAME][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--job_conf_idJOB_CONF_IDProvideJobConfIdtodeleteaSparkJobConfiguration.--job_conf_nameJOB_CONF_NAMEProvideJobConfNametodeleteaSparkJobConfiguration.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)delete-conf example with one of the required ‘–job_conf_id’ argument
passed.yeedujobdelete-conf--job_conf_id=2Console output{"message":"Deleted Spark Job Config: 2"}Spark Job InstanceCommand NameUtilitystartTo run an Apache Spark Job.listTo list all the available Apache Spark Job
Instances.getTo get information about a specific Apache
Spark Job Instance.killTo kill a specific Apache Spark Job
Instance.logsTo download Spark Job Instance logs for
specific Spark Job Instance Id.startyeedujobstart-husage:start[-h][--job_conf_idJOB_CONF_ID][--job_conf_nameJOB_CONF_NAME][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--job_conf_idJOB_CONF_IDTorunanApacheSparkJob,enterjob_conf_id.--job_conf_nameJOB_CONF_NAMETorunanApacheSparkJob,enterjob_conf_name.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)start example with one of the required argument passed.yeedujobstart--job_conf_id=63498Console output{"job_id":"63575","job_conf_id":"63498","history_engine_cluster_instance_id":"34","tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538","created_by_id":"1","modified_by_id":"1","last_update_date":"2023-07-20T11:56:26.303Z","from_date":"2023-07-20T11:56:26.303Z","to_date":null}listyeedujoblist-husage:list[-h]--cluster_idCLUSTER_ID[--job_conf_idJOB_CONF_ID][--job_conf_nameJOB_CONF_NAME][--job_status{submitted,running,done,error,terminated,killing,killed}][--page_numberPAGE_NUMBER][--limitLIMIT][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--cluster_idCLUSTER_IDTolistApacheSparkJobofaspecificcluster_id.--job_conf_idJOB_CONF_IDTolistApacheSparkJobofaspecificjob_conf_id.--job_conf_nameJOB_CONF_NAMETolistApacheSparkJobofaspecificjob_conf_name.--job_status{submitted,running,done,error,terminated,killing,killed}TolistApacheSparkJobforaspecificSparkjobStatus.--page_numberPAGE_NUMBERTolistApacheSparkJobforaspecificpage_number.(default:1)--limitLIMITProvidelimittolistnumberofApacheSparkJobInstance.(default:100)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list example to list spark jobs of a paricular engine cluster
instance.yeedujoblist--cluster_id=1--limit=5Console output{"data":[{"job_id":63575,"job_application_id":null,"job_status":"SUBMITTED","cluster_id":"34","job_conf":{"job_conf_id":63498,"name":"spark_examples","max_concurrency":0,"deploy_mode":"client","class_name":"org.apache.spark.examples.SparkPi","command":"file:///yeedu/object-storage-manager/spark-examples_2.11-2.4.8.jar","arguments":"1000","rawScalaCode":null,"files":null,"properties_file":null,"conf":null,"packages":null,"repositories":null,"jars":null,"archives":null,"driver_memory":null,"driver_java_options":null,"driver_library_path":null,"driver_class_path":null,"executor_memory":null,"driver_cores":null,"total_executor_cores":null,"executor_cores":null,"num_executors":null,"principal":null,"keytab":null,"queue":null},"workflow_job_instance_details":{"workflow_job_instance_status":{"workflow_job_instance_id":62043,"workflow_job_id":62043,"status":"SENT","from_date":"2023-07-20T11:56:26.303763+00:00","to_date":"infinity"}},"tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538","created_by":{"user_id":1,"username":"YSU0000"},"modified_by":{"user_id":1,"username":"YSU0000"},"last_update_date":"2023-07-20T11:56:26.303763+00:00","from_date":"2023-07-20T11:56:26.303763+00:00","to_date":"infinity"}],"result_set":{"current_page":1,"total_objects":1,"total_pages":1,"limit":5}}list example to list spark jobs of a paricular engine cluster
instance having specific spark job status.yeedujoblist--cluster_id=1--job_status=running--limit=1Console output{"data":[{"job_id":3,"job_application_id":"local-1676966563563","job_status":"RUNNING","cluster_id":"1","job_conf":{"job_conf_id":1,"name":"resize_job","deploy_mode":"client","class_name":"SampleResizeJar","command":"file:///yeedu/object-storage-manager/SampleResizeJar-assembly-0.1.0-SNAPSHOT.jar","arguments":null,"rawScalaCode":null,"files":null,"properties_file":null,"conf":null,"packages":null,"repositories":null,"jars":null,"archives":null,"driver_memory":"10G","driver_java_options":"-Dderby.system.home=/yeedu/spark_metastores/1676966162","driver_library_path":null,"driver_class_path":null,"executor_memory":null,"driver_cores":null,"total_executor_cores":null,"executor_cores":null,"num_executors":null,"principal":null,"keytab":null,"queue":null},"workflow_job_instance_details":{"workflow_job_instance_status":{"workflow_job_instance_id":4,"workflow_job_id":4,"status":"EXECUTING","from_date":"2023-04-06T09:13:48.376291+00:00","to_date":"infinity"},"workflow_execution_process":{"machine_pid_number":"66","machine_hostname":"yeedu1-ceaa31b4-37a0-3c6a-9797-61b11d0614da","machine_id":"ceaa31b4-37a0-3c6a-9797-61b11d0614da","machine_pid_user":"root","machine_node_number":"2"}},"tenant_id":"be2a7d36-f555-4f78-b1bd-eafeefc285db","created_by":{"user_id":1,"username":"YSU0000"},"modified_by":{"user_id":1,"username":"YSU0000"},"last_update_date":"2023-04-06T09:13:48.376291+00:00","from_date":"2023-04-06T09:13:48.376291+00:00","to_date":"infinity"}],"result_set":{"current_page":1,"total_objects":3,"total_pages":3,"limit":1,"next_page":2}}getyeedujobget-husage:get[-h]--job_idJOB_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--job_idJOB_IDProvideanjob_idtogetinformationaboutaspecificApacheSparkJobInstance.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)get example with the required ‘–spark_job_instance_id’ arguments
passed.yeedujobget--job_id=63575Console output{"job_id":63575,"job_application_id":"local-1676966563563","job_status":"RUNNING","cluster_id":"34","job_conf":{"job_conf_id":63498,"name":"spark_examples","max_concurrency":0,"deploy_mode":"client","class_name":"org.apache.spark.examples.SparkPi","command":"file:///yeedu/object-storage-manager/spark-examples_2.11-2.4.8.jar","arguments":"1000","rawScalaCode":null,"files":null,"properties_file":null,"conf":null,"packages":null,"repositories":null,"jars":null,"archives":null,"driver_memory":null,"driver_java_options":null,"driver_library_path":null,"driver_class_path":null,"executor_memory":null,"driver_cores":null,"total_executor_cores":null,"executor_cores":null,"num_executors":null,"principal":null,"keytab":null,"queue":null}"workflow_job_instance_details":{"workflow_job_instance_status":{"workflow_job_instance_id":62043,"workflow_job_id":62043,"status":"EXECUTING","from_date":"2023-07-20T11:56:26.303763+00:00","to_date":"infinity"},"workflow_execution_process":{"machine_pid_number":"93","machine_hostname":"i-0fd5796fc70d11bf9","machine_id":"37a886f2-a5be-081e-3d46-ccef1454ef5e","machine_pid_user":"root","machine_node_number":"0"}},"tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538","created_by":{"user_id":1,"username":"YSU0000"},"modified_by":{"user_id":1,"username":"YSU0000"},"last_update_date":"2023-07-20T11:56:26.303763+00:00","from_date":"2023-07-20T11:56:26.303763+00:00","to_date":"2023-07-20T11:58:09.702464+00:00"}killyeedujobkill-husage:kill[-h]--job_idJOB_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--job_idJOB_IDProvideanjob_idtokillaspecificApacheSparkJobInstance.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)kill example with the required ‘–spark_job_instance_id’ argument
passed.yeedujobkill--job_id=63575Console output{"SparkKill":{"workflow_job_id":62043,"workflow_job_instance_id":62043,"spark_job_instance_id":63575,"spark_job_id":63498,"compute_engine_id":34}}logsyeedujoblogs-husage:logs[-h]--job_idJOB_ID[--log_type{stdout,stderr}][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--job_idJOB_IDProvidejob_idtodownloadlogrecords.--log_type{stdout,stderr}Providelog_typetodownloadSparkJobInstancelogrecords.(default:stdout)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)logs example with the required ‘–spark_job_instance_id’ arguments
passed.yeedujoblogs--job_id=63576Console outputPiisroughly3.141698702833974Workflow Details By Spark Job Application IDCommand NameUtilityget-workflow-job-instanceTo get information about a
specific Workflow Job Instance.get-workflow-job-instanceyeedujobget-workflow-job-instance-husage:get-workflow-job-instance[-h]--job_application_idJOB_APPLICATION_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--job_application_idJOB_APPLICATION_IDProvideajob_application_idtogetinformationaboutaspecificWorkflowJobInstance.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)get-workflow-job-instance example with the required
‘–job_application_id’ argument passed.yeedujobget-workflow-job-instance--job_application_id="local-1689855445076"Console output{"job_id":63688,"job_application_id":"local-1689855445076","job_status":"DONE","compute_engine":34,"cluster_id":"34","workflow_job_instance_details":{"workflow_job_instance_status":{"workflow_job_instance_id":62164,"workflow_job_id":62164,"status":"DONE","previous_status":["NONE","INIT","SENT","RECEIVED","EXECUTING"],"from_date":"2023-07-20T12:18:44.792999+00:00","to_date":"infinity"},"workflow_execution_process":{"machine_pid_number":"765","machine_hostname":"i-0cc7bff64c467f852","machine_id":"76a3d634-5e8f-31a8-b1d4-99e8cc9ae208","machine_pid_user":"root","machine_node_number":"0"}},"tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538","created_by":{"user_id":1,"username":"YSU0000"},"modified_by":{"user_id":1,"username":"YSU0000"},"last_update_date":"2023-07-20T12:17:17.444066+00:00","from_date":"2023-07-20T12:17:17.444066+00:00","to_date":"2023-07-20T12:18:44.792999+00:00"}IAM (Identity and Access Management)UserCommand NameUtilityget-user-infoTo get information about current
session user.get-user-rolesTo get all the roles of current
session user.get-user-infoyeeduiamget-user-info-husage:get-user-info[-h][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)get-user-info example without optional arguments passed for output
format.yeeduiamget-user-infoConsole output{"user_id":"1","tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538","username":"USER","email":"user@yeedu.com","group_info":[{"group_id":1,"groupname":"yeedu-user"}],"from_date":"2023-03-14T10:00:47.406Z","to_date":null}get-user-rolesyeeduiamget-user-roles-husage:get-user-roles[-h][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)get-user-roles example without optional arguments passed for output
format.yeeduiamget-user-rolesConsole output{"user_id":2,"username":"RU0000","user_roles":["Resource User"],"group_roles":[null]}Shared Platform and AdminCommand NameUtilitysync-userTo get the information about a
specific User.sync-groupTo get the information about a
specific Group.list-user-groupsTo list all the Groups for a
specific User.list-usersTo list all the available Users.list-group-usersTo list all the Users for a
specific Group.list-groupsTo list all the available
Groups.sync-useryeeduiamsync-user-husage:sync-user[-h]--usernameUSERNAME[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--usernameUSERNAMEProvideusernametogetinformationaboutaspecificUser.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)sync-user example with required argument ‘–username’ passed.yeeduiamsync-user--username="USER"Console output{"user_id":"2","username":"USER","email":"user@yeedu.com","from_date":"2023-03-14T10:03:06.200Z","to_date":null}sync-groupyeeduiamsync-group-husage:sync-group[-h]--groupnameGROUPNAME[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--groupnameGROUPNAMEProvidegroupnametogetinformationaboutaspecificGroup.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)sync-group example with required argument ‘–groupname’ passed.yeeduiamsync-group--groupname="yeedu-user"Console output{"group_id":"3","group_name":"yeedu-user","from_date":"2023-03-15T14:30:20.723Z","to_date":null}list-user-groupsyeeduiamlist-user-groups-husage:list-user-groups[-h]--user_idUSER_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--user_idUSER_IDProvideuser_idtolistalltheGroupsforaspecificUser.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list-user-groups example with required argument ‘–user_id’ passed.yeeduiamlist-user-groups--user_id=2Console output{"user_id":2,"username":"RU0000","groups":["yeedu-user"]}list-usersyeeduiamlist-users-husage:list-users[-h][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list-users example without optional arguments passed for output
format.yeeduiamlist-usersConsole output[{"user_id":"1","username":"YA0000","email":"ya0000@yeedu.com","from_date":"2023-03-14T10:03:06.200Z","to_date":null},{"user_id":"2","username":"RM0000","email":"rm0000@yeedu.com","from_date":"2023-03-14T10:03:11.934Z","to_date":null}]list-group-usersyeeduiamlist-group-users-husage:list-group-users[-h]--group_idGROUP_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--group_idGROUP_IDProvidegroup_idtolistalltheUsersforaspecificGroup.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list-group-users example with required argument ‘–group_id’ passed.yeeduiamlist-group-users--group_id=2Console output{"group_id":2,"group_name":"yeedu-provider","users":["YSU0000","RP0000"]}list-groupsyeeduiamlist-groups-husage:list-groups[-h][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list-groups example without optional arguments passed for output
format.yeeduiamlist-groupsConsole output[{"group_id":"1","group_name":"yeedu-manager","from_date":"2023-03-15T14:30:20.723Z","to_date":null},{"group_id":"2","group_name":"yeedu-provider","from_date":"2023-03-15T14:30:20.723Z","to_date":null},{"group_id":"3","group_name":"yeedu-user","from_date":"2023-03-15T14:30:20.723Z","to_date":null}]LookupCommand NameUtilitylist-resourcesTo get all the resources.get-resourceTo get resource details for a
specific Resource.list-permissionsTo get all the Permission Types.get-permissionTo get resource details for a
specific Permission Type.list-rolesTo get all the Roles.get-roleTo get resource details for a
specific Role.list-rulesTo get all the Rules.get-ruleTo get resource details for a
specific Rule.list-resourcesyeeduiamlist-resources-husage:list-resources[-h][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list-resources example without optional argument passed for output
format.yeeduiamlist-resourcesConsole output[{"resource_id":0,"resource_path":"/api/v1/lookup_cloud_providers","from_date":"2023-07-14T13:44:14.783Z","to_date":null},{"resource_id":1,"resource_path":"/api/v1/lookup_cloud_providers/:cloud_provider_id","from_date":"2023-07-14T13:44:14.783Z","to_date":null},...{"resource_id":102,"resource_path":"/api/v1/permission/:auth_permissions_type_id/resource/:auth_resources_id/rule/:id","from_date":"2023-07-14T13:44:14.783Z","to_date":null}]get-resourceyeeduiamget-resource-husage:get-resource[-h]--resource_idRESOURCE_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--resource_idRESOURCE_IDProvidetheresource_idtogetinformationaboutaspecificResource.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)get-resource example with required argument ‘–resource_id’ passed.yeeduiamget-resource--resource_id=18Console output{"resource_id":18,"resource_path":"/api/v1/machine/network","from_date":"2023-07-14T13:44:14.783Z","to_date":null}list-permissionsyeeduiamlist-permissions-husage:list-permissions[-h][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list-permissions example without optional argument passed for output
format.yeeduiamlist-permissionsConsole output[{"permission_id":0,"permission":"GET","description":"To list a resource","from_date":"2023-07-14T13:44:14.282Z","to_date":null},...{"permission_id":3,"permission":"DELETE","description":"To delete a resource","from_date":"2023-07-14T13:44:14.282Z","to_date":null}]get-permissionyeeduiamget-permission-husage:get-permission[-h]--permission_idPERMISSION_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--permission_idPERMISSION_IDProvidethepermission_idtogetinformationaboutaspecificPermissionType.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)get-permission example with required argument ‘–permission_id’
passed.yeeduiamget-permission--permission_id=1Console output{"permission_id":1,"permission":"POST","description":"To create a resource","from_date":"2023-07-14T13:44:14.282Z","to_date":null}list-rolesyeeduiamlist-roles-husage:list-roles[-h][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list-roles example without optional arguments passed for output
format.yeeduiamlist-rolesConsole output[{"role_id":0,"role":"Resource Manager","description":"GET (Lookup, Volume Config, Network Config, Boot Disk Image Config, Machine Config, Credentials Config, Object Storage Manager, Object Storage Manager Files, Hive Metastore Config, Cluster Configuration, Cluster Instance, Spark Job Config, Spark Job Instance, User) PUT (Volume Config, Network Config, Machine Config, Credentials Config, Object Storage Manager, Hive Metastore Config, Cluster Configuration) POST (Volume Config, Network Config, Boot Disk Image Config, Machine Config, Credentials Config, Object Storage Manager, Hive Metastore Config, Cluster Configuration) DELETE (Credentials Config, Object Storage Manager)","from_date":"2023-07-14T13:44:15.285Z","to_date":null},...{"role_id":4,"role":"Platform Admin","description":"GET/PUT/POST/DELETE (Lookup, Volume Config, Network Config, Boot Disk Image Config, Machine Config, Credentials Config, Object Storage Manager, Object Storage Manager Files, Hive Metastore Config, Cluster Configuration, Cluster Instance, Spark Job Config, Spark Job Instance, User, Admin, Shared Platform and Admin Resources, Platform Admin, IAM Lookup). Responsible to manage tenants and can access any endpoint.","from_date":"2023-07-14T13:44:15.285Z","to_date":null}]get-roleyeeduiamget-role-husage:get-role[-h]--role_idROLE_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--role_idROLE_IDProvidetherole_idtogetinformationaboutaspecificRole.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)get-role example with required argument ‘–role_id’ passed.yeeduiamget-role--role_id=1Console output{"role_id":1,"role":"Resource Provider","description":"GET (Lookup, Volume Config, Network Config, Boot Disk Image Config, Machine Config, Credentials Config, Object Storage Manager, Object Storage Manager Files, Hive Metastore Config, Cluster Configuration, Cluster Instance, Spark Job Config, Spark Job Instance, User) POST/PUT (Cluster Instance)","from_date":"2023-07-14T13:44:15.285Z","to_date":null}list-rulesyeeduiamlist-rules-husage:list-rules[-h][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list-rules example without optional arguments passed for output
format.yeeduiamlist-rulesConsole output[{"rule_id":"0","permission_type":{"permission_id":0,"permission":"GET","description":"To list a resource"},"resource":{"resource_id":0,"resource_path":"/api/v1/lookup_cloud_providers"},"role":{"role_id":0,"role":"Resource Manager","description":"GET (Lookup, Volume Config, Network Config, Boot Disk Image Config, Machine Config, Credentials Config, Object Storage Manager, Object Storage Manager Files, Hive Metastore Config, Cluster Configuration, Cluster Instance, Spark Job Config, Spark Job Instance, User) PUT (Volume Config, Network Config, Machine Config, Credentials Config, Object Storage Manager, Hive Metastore Config, Cluster Configuration) POST (Volume Config, Network Config, Boot Disk Image Config, Machine Config, Credentials Config, Object Storage Manager, Hive Metastore Config, Cluster Configuration) DELETE (Credentials Config, Object Storage Manager)"},"from_date":"2023-07-14T13:44:15.788Z","to_date":null},...{"rule_id":"382","permission_type":{"permission_id":1,"permission":"POST","description":"To create a resource"},"resource":{"resource_id":102,"resource_path":"/api/v1/cluster/uptime"},"role":{"role_id":4,"role":"Platform Admin","description":"GET/PUT/POST/DELETE (Lookup, Volume Config, Network Config, Boot Disk Image Config, Machine Config, Credentials Config, Object Storage Manager, Object Storage Manager Files, Hive Metastore Config, Cluster Configuration, Cluster Instance, Spark Job Config, Spark Job Instance, User, Admin, Shared Platform and Admin Resources, Platform Admin, IAM Lookup). Responsible to manage tenants and can access any endpoint."},"from_date":"2023-07-14T13:44:15.788Z","to_date":null}]get-ruleyeeduiamget-rule-husage:get-rule[-h]--rule_idRULE_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--rule_idRULE_IDProvidetherule_idtogetinformationaboutaspecificRule.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)get-rule example with required argument ‘–rule_id’ passed.yeeduiamget-rule--rule_id=108Console output{"rule_id":"108","permission_type":{"permission_id":0,"permission":"GET","description":"To list a resource"},"resource":{"resource_id":45,"resource_path":"/api/v1/spark/job/:job_id"},"role":{"role_id":1,"role":"Resource Provider","description":"GET (Lookup, Volume Config, Network Config, Boot Disk Image Config, Machine Config, Credentials Config, Object Storage Manager, Object Storage Manager Files, Hive Metastore Config, Cluster Configuration, Cluster Instance, Spark Job Config, Spark Job Instance, User) POST/PUT (Cluster Instance)"},"from_date":"2023-07-14T13:44:15.788Z","to_date":null}Platform-AdminTenantCommand NameUtilitycreate-tenantTo create a Tenant.list-tenantsTo list all the available Tenants.get-tenantTo get information about a specific
Tenant.edit-tenantTo edit a specific Tenant.delete-tenantTo delete a specific Tenant.create-tenantyeeduplatform-admincreate-tenant-husage:create-tenant[-h]--nameNAME[--descriptionDESCRIPTION][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--nameNAMEProvidenametocreate-tenant.--descriptionDESCRIPTIONProvidedescriptiontocreate-tenant.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)create-tenant example with all the required and optional arguments
passed.yeeduplatform-admincreate-tenant--name="tenant1"--description="Yeedu Tenant-1"Console output{"tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538","name":"tenant1","description":"Yeedu Tenant-1","created_by_id":"1","modified_by_id":"1","last_update_date":"2023-03-13T12:29:25.982Z","from_date":"2023-03-13T12:29:25.982Z","to_date":null}list-tenantsyeeduplatform-adminlist-tenants-husage:list-tenants[-h][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list-tenants example without optional arguments passed for output
format.yeeduplatform-adminlist-tenantsConsole output[{"tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538","name":"tenant1","description":"Yeedu Tenant-1","created_by":{"user_id":"1","username":"YSU0000"},"modified_by":{"user_id":"1","username":"YSU0000"},"last_update_date":"2023-07-20T10:56:33.714Z","from_date":"2023-07-20T10:56:33.714Z","to_date":null}]get-tenantyeeduplatform-adminget-tenant-husage:get-tenant[-h]--tenant_idTENANT_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--tenant_idTENANT_IDProvidethetenant_idtogetinformationaboutaspecificTenant.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)get-tenant example with the required ‘–tenant_id’ arguments passed.yeeduplatform-adminget-tenant--tenant_id="0b5017a9-6099-497f-81ba-d4e537e23538"Console output{"tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538","name":"tenant1","description":"Yeedu Tenant-1","created_by":{"user_id":"1","username":"YSU0000"},"modified_by":{"user_id":"1","username":"YSU0000"},"last_update_date":"2023-07-20T10:56:33.714Z","from_date":"2023-07-20T10:56:33.714Z","to_date":null}edit-tenantyeeduplatform-adminedit-tenant-husage:edit-tenant[-h]--tenant_idTENANT_ID[--name[NAME]][--description[DESCRIPTION]][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--tenant_idTENANT_IDProvideaspecifictenantIdtoedit-tenant.--name[NAME]Providenametoedit-tenant.--description[DESCRIPTION]Providedescriptiontoedit-tenant.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)edit-tenant example with the required ‘–tenant_id’ argument and
other optional argument is passed which is to be updated.yeeduplatform-adminedit-tenant--tenant_id="0b5017a9-6099-497f-81ba-d4e537e23538"--description="Yeedu Tenant 1"Console output{"tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538","name":"tenant1","description":"Yeedu Tenant 1","created_by_id":"1","modified_by_id":"1","last_update_date":"2023-07-20T12:42:11.131Z","from_date":"2023-07-20T10:56:33.714Z","to_date":null}delete-tenantyeeduplatform-admindelete-tenant-husage:delete-tenant[-h]--tenant_idTENANT_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--tenant_idTENANT_IDProvidethetenant_idtodeleteaspecificTenant.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)delete-tenant example with the required ‘–tenant_id’ argument
passed.yeeduplatform-admindelete-tenant--tenant_id="0b5017a9-6099-497f-81ba-d4e537e23538"Console output{"message":"Deleted Tenant: 0b5017a9-6099-497f-81ba-d4e537e23538"}UserCommand NameUtilitylist-user-tenantsTo list all the tenants
associated to an user.list-tenant-usersTo list all the users present in
a tenant.get-tenant-userTo get information about a User
present in a specific tenant.get-user-rolesTo get all the roles of an User
present in a specific tenant.list-users-rolesTo list all the Users Roles in a
specific tenant.get-role-usersTo get all the users of a Role
present in a specific tenant.create-user-roleTo create an User Role for a
specific tenant.delete-user-roleTo delete an User Role of a
specific tenant.list-user-tenantsyeeduplatform-adminlist-user-tenants-husage:list-user-tenants[-h]--user_idUSER_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--user_idUSER_IDProvideUserIdtolistallthetenants.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list-user-tenants example without optional arguments passed for
output format.yeeduplatform-adminlist-user-tenants--user_id=1Console output[{"tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538","name":"tenant1","description":"Yeedu Tenant 1"},{"tenant_id":"066a702d-6b9d-4176-afc5-51c24a651739","name":"tenant2","description":"Yeedu Tenant 2"},{"tenant_id":"328aba9a-92ac-458d-8c27-fe9ea6e5e9ab","name":"tenant3","description":"Yeedu Tenant 3"},{"tenant_id":"6b682ef1-ede4-4d96-bab6-cd008aadd534","name":"tenant4","description":"Yeedu Tenant 4"}]list-tenant-usersyeeduplatform-adminlist-tenant-users-husage:list-tenant-users[-h]--tenant_idTENANT_ID[--page_numberPAGE_NUMBER][--limitLIMIT][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--tenant_idTENANT_IDProvideTenantIdtolistalltheuserspresentinit.--page_numberPAGE_NUMBERTolisttenantusersforaspecificpage_number.(default:1)--limitLIMITProvidelimittolistnumberoftenantusers.(default:100)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list-tenant-users example without optional arguments passed for
output format.yeeduplatform-adminlist-tenant-users--tenant_id="0b5017a9-6099-497f-81ba-d4e537e23538"--limit=2Console output{"data":{"tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538","users":["YA0000","YSU0000"]},"result_set":{"current_page":1,"total_objects":2,"total_pages":1,"limit":2}}get-tenant-useryeeduplatform-adminget-tenant-user-husage:get-tenant-user[-h]--tenant_idTENANT_ID--user_idUSER_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--tenant_idTENANT_IDProvideTenantIdtogetinformationaboutaspecificUser.--user_idUSER_IDProvideUserIdtogetinformationaboutaspecificUser.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)get-tenant-user example with the required ‘–tenant_id’ arguments
passed.yeeduplatform-adminget-tenant-user--tenant_id="0b5017a9-6099-497f-81ba-d4e537e23538"--user_id=1Console output{"user_id":1,"username":"USER","email":"user@yeedu.com","from_date":"2023-03-14T10:00:47.406628+00:00","to_date":"infinity"}get-user-rolesyeeduplatform-adminget-user-roles-husage:get-user-roles[-h]--tenant_idTENANT_ID--user_idUSER_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--tenant_idTENANT_IDProvideTenantIdtogetrolesofaspecificUser.--user_idUSER_IDProvideUserIdtogetrolesofaspecificUser.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)get-user-roles example with the required arguments ‘–tenant_id’ and
‘–user_id’ passed.yeeduplatform-adminget-user-roles--tenant_id="0b5017a9-6099-497f-81ba-d4e537e23538"--user_id=1Console output{"user_id":1,"username":"RM0000","user_roles":["Resource Manager"],"group_roles":[null]}list-users-rolesyeeduplatform-adminlist-users-roles-husage:list-users-roles[-h]--tenant_idTENANT_ID[--page_numberPAGE_NUMBER][--limitLIMIT][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--tenant_idTENANT_IDProvideTenantIdtolistUserroles.--page_numberPAGE_NUMBERTolistusersrolesforaspecificpage_number.(default:1)--limitLIMITProvidelimittolistnumberofusersroles.(default:100)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list-users-roles example with the required arguments ‘–tenant_id’
passed.yeeduplatform-adminlist-users-roles--tenant_id="0b5017a9-6099-497f-81ba-d4e537e23538"--limit=2Console output{"data":[{"user_id":1,"username":"RM0000","user_roles":["Resource Manager"],"group_roles":[null]},{"user_id":2,"username":"YSU0000","user_roles":["Platform Admin"],"group_roles":[null]}],"result_set":{"current_page":1,"total_objects":2,"total_pages":1,"limit":2}}get-role-usersyeeduplatform-adminget-role-users-husage:get-role-users[-h]--tenant_idTENANT_ID--role_idROLE_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--tenant_idTENANT_IDProvideTenantIdtogetusersinaspecificRole.--role_idROLE_IDProvideRoleIdtogetusersinaspecificRole.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)get-role-users example with the required ‘–tenant_id’ arguments
passed.yeeduplatform-adminget-role-users--tenant_id="0b5017a9-6099-497f-81ba-d4e537e23538"--role_id=1Console output{"role_id":1,"users":["RP0000"]}create-user-roleyeeduplatform-admincreate-user-role-husage:create-user-role[-h][--tenant_idTENANT_ID]--user_idUSER_ID--role_idROLE_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--tenant_idTENANT_IDProvideTenantIdtocreate-user-role.--user_idUSER_IDProvideUserIdtocreate-user-role.--role_idROLE_IDProvideRoleIdtocreate-user-role.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)create-user-role example with all the required and optional arguments
passed.yeeduplatform-admincreate-user-role--tenant_id="0b5017a9-6099-497f-81ba-d4e537e23538"--user_id=2--role_id=1Console output{"user_roles_id":"2","tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538","user_id":"2","role_id":1,"created_by_id":"1","modified_by_id":"1","last_update_date":"2023-03-15T12:50:27.826Z","from_date":"2023-03-15T12:50:27.826Z","to_date":null}delete-user-roleyeeduplatform-admindelete-user-role-husage:delete-user-role[-h][--tenant_idTENANT_ID]--user_idUSER_ID--role_idROLE_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--tenant_idTENANT_IDProvideTenantIdtodelete-user-role.--user_idUSER_IDProvideUserIdtodelete-user-role.--role_idROLE_IDProvideRoleIdtodelete-user-role.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)delete-user-role example with the required ‘–tenant_id’ argument
passed.yeeduplatform-admindelete-user-role--tenant_id="0b5017a9-6099-497f-81ba-d4e537e23538"--user_id=2--role_id=1Console output{"message":"Deleted User Roles for the provided tenant_id: '0b5017a9-6099-497f-81ba-d4e537e23538', user_id: 2 and role_id: 1."}GroupCommand NameUtilitylist-tenant-groupsTo list all the groups present
in a tenant.get-tenant-groupTo get information about a Group
present in a specific tenant.get-group-rolesTo get all the roles of a Group
present in a specific tenant.list-groups-rolesTo list all the Groups Roles in
a specific tenant.get-role-groupsTo get all the groups having a
specific Role present in a
specific tenant.create-group-roleTo create a Group Role for a
specific tenant.delete-group-roleTo delete a Group Role of a
specific tenant.list-tenant-groupsyeeduplatform-adminlist-tenant-groups-husage:list-tenant-groups[-h]--tenant_idTENANT_ID[--page_numberPAGE_NUMBER][--limitLIMIT][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--tenant_idTENANT_IDProvideTenantIdtolistallthegroupspresentinit.--page_numberPAGE_NUMBERTolisttenantgroupsforaspecificpage_number.(default:1)--limitLIMITProvidelimittolistnumberoftenantgroups.(default:100)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list-tenant-groups example without optional arguments passed for
output format.yeeduplatform-adminlist-tenant-groups--tenant_id="0b5017a9-6099-497f-81ba-d4e537e23538"--limit=2Console output{"data":{"tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538","groups":["yeedu-manager","yeedu-user"]},"result_set":{"current_page":1,"total_objects":2,"total_pages":1,"limit":2}}get-tenant-groupyeeduplatform-adminget-tenant-group-husage:get-tenant-group[-h]--tenant_idTENANT_ID--group_idGROUP_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--tenant_idTENANT_IDProvideTenantIdtogetinformationaboutaspecificGroup.--group_idGROUP_IDProvideGroupIdtogetinformationaboutaspecificGroup.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)get-tenant-group example without optional arguments passed for output
format.yeeduplatform-adminget-tenant-group--tenant_id="0b5017a9-6099-497f-81ba-d4e537e23538"--group_id=1Console output{"group_id":1,"group_name":"yeedu-manager","from_date":"2023-03-15T11:32:17.570658+00:00","to_date":"infinity"}get-group-rolesyeeduplatform-adminget-group-roles-husage:get-group-roles[-h]--tenant_idTENANT_ID--group_idGROUP_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--tenant_idTENANT_IDProvideTenantIdtogetrolesofaspecificGroup.--group_idGROUP_IDProvideGroupIdtogetrolesofaspecificGroup.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)get-group-roles example with the required ‘–tenant_id’ and
‘–group_id’ arguments passed.yeeduplatform-adminget-group-roles--tenant_id="0b5017a9-6099-497f-81ba-d4e537e23538"--group_id=1Console output{"group_id":1,"roles":["Resource Manager"]}list-groups-rolesyeeduplatform-adminlist-groups-roles-husage:list-groups-roles[-h]--tenant_idTENANT_ID[--page_numberPAGE_NUMBER][--limitLIMIT][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--tenant_idTENANT_IDProvideTenantIdtolistGrouproles.--page_numberPAGE_NUMBERTolistgroupsrolesforaspecificpage_number.(default:1)--limitLIMITProvidelimittolistnumberofgroupsroles.(default:100)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list-groups-roles example with the required arguments ‘–tenant_id’
passed.yeeduplatform-adminlist-groups-roles--tenant_id="0b5017a9-6099-497f-81ba-d4e537e23538"--limit=2Console output{"data":[{"group_id":1,"group_name":"yeedu-manager","roles":["Resource Manager"]},{"group_id":3,"group_name":"yeedu-user","roles":["Resource User"]}],"result_set":{"current_page":1,"total_objects":2,"total_pages":1,"limit":2}}get-role-groupsyeeduplatform-adminget-role-groups-husage:get-role-groups[-h]--tenant_idTENANT_ID--role_idROLE_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--tenant_idTENANT_IDProvideTenantIdtogetgroupsinaspecificRole.--role_idROLE_IDProvideRoleIdtogetgroupsinaspecificRole.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)get-role-groups example with the required arguments ‘–tenant_id’ and
‘–role_id’ passed.yeeduplatform-adminget-role-groups--tenant_id="0b5017a9-6099-497f-81ba-d4e537e23538"--role_id=0Console output{"role_id":0,"groups":["yeedu-manager"]}create-group-roleyeeduplatform-admincreate-group-role-husage:create-group-role[-h][--tenant_idTENANT_ID]--group_idGROUP_ID--role_idROLE_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--tenant_idTENANT_IDProvideTenantIdtocreate-group-role.--group_idGROUP_IDProvideGroupIdtocreate-group-role.--role_idROLE_IDProvideRoleIdtocreate-group-role.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)create-group-role example with all the required and optional
arguments passed.yeeduplatform-admincreate-group-role--tenant_id="0b5017a9-6099-497f-81ba-d4e537e23538"--group_id=1--role_id=0Console output{"group_roles_id":"1","tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538","group_id":"1","role_id":0,"created_by_id":"1","modified_by_id":"1","last_update_date":"2023-03-15T13:10:15.840Z","from_date":"2023-03-15T13:10:15.840Z","to_date":null}delete-group-roleyeeduplatform-admindelete-group-role-husage:delete-group-role[-h][--tenant_idTENANT_ID]--group_idGROUP_ID--role_idROLE_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--tenant_idTENANT_IDProvideTenantIdtodelete-group-role.--group_idGROUP_IDProvideGroupIdtodelete-group-role.--role_idROLE_IDProvideRoleIdtodelete-group-role.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)delete-group-role example with all the required argument passed.yeeduplatform-admindelete-group-role--tenant_id="0b5017a9-6099-497f-81ba-d4e537e23538"--group_id=1--role_id=0Console output{"message":"Deleted Group Role for the provided Tenant Id: '0b5017a9-6099-497f-81ba-d4e537e23538', Group Id: 1, and Role Id: 0"}AdminUserCommand NameUtilitylist-usersTo list all the users present in
tenant.get-userTo get information about a
specific User.get-user-rolesTo get all the roles of a
specific User.list-users-rolesTo list all the Users Roles.get-role-usersTo get all the users in a
specific Role.create-user-roleTo create an User Role.delete-user-roleTo delete an User Role.list-usersyeeduadminlist-users-husage:list-users[-h][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list-users example without optional arguments passed for output
format.yeeduadminlist-usersConsole output{"tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538","users":["RM0000","RP0000","YA0000","YSU0000"]}get-useryeeduadminget-user-husage:get-user[-h]--user_idUSER_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--user_idUSER_IDProvideUserIdtogetinformationaboutaspecificUser.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)get-user example without optional arguments passed for output format.yeeduadminget-user--user_id=1Console output{"user_id":1,"username":"USER","email":"user@yeedu.com","from_date":"2023-03-14T10:00:47.406628+00:00","to_date":"infinity"}get-user-rolesyeeduadminget-user-roles-husage:get-user-roles[-h]--user_idUSER_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--user_idUSER_IDProvideUserIdtogetrolesofaspecificUser.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)get-user-roles example with the required arguments ‘–user_id’
passed.yeeduadminget-user-roles--user_id=1Console output{"user_id":1,"username":"RM0000","user_roles":["Resource Manager"],"group_roles":[null]}list-users-rolesyeeduadminlist-users-roles-husage:list-users-roles[-h][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list-users-roles example without optional arguments passed for output
format.yeeduadminlist-users-rolesConsole output[{"user_id":1,"username":"RM0000","user_roles":["Resource Manager"],"group_roles":[null]},{"user_id":2,"username":"RP0000","user_roles":["Resource Provider"],"group_roles":[null]}]get-role-usersyeeduadminget-role-users-husage:get-role-users[-h]--role_idROLE_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--role_idROLE_IDProvideRoleIdtogetusersinaspecificRole.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)get-role-users example with the required ‘–role_id’ arguments
passed.yeeduadminget-role-users--role_id=1Console output{"role_id":1,"users":["RP0000"]}create-user-roleyeeduadmincreate-user-role-husage:create-user-role[-h]--user_idUSER_ID--role_idROLE_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--user_idUSER_IDProvideUserIdtocreate-user-role.--role_idROLE_IDProvideRoleIdtocreate-user-role.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)create-user-role example with all the required and optional arguments
passed.yeeduadmincreate-user-role--user_id=2--role_id=1Console output{"user_roles_id":"2","tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538","user_id":"2","role_id":1,"created_by_id":"1","modified_by_id":"1","last_update_date":"2023-03-15T12:50:27.826Z","from_date":"2023-03-15T12:50:27.826Z","to_date":null}delete-user-roleyeeduadmindelete-user-role-husage:delete-user-role[-h]--user_idUSER_ID--role_idROLE_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--user_idUSER_IDProvideUserIdtodelete-user-role.--role_idROLE_IDProvideRoleIdtodelete-user-role.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)delete-user-role example with all the required argument passed.yeeduadmindelete-user-role--user_id=2--role_id=1Console output{"message":"Deleted User Roles for the provided User Id: 2 and Role Id: 1."}GroupCommand NameUtilitylist-groupsTo list all the groups present
in tenant.get-groupTo get information about a
specific Group.get-group-rolesTo get all the roles of a
specific Group.list-groups-rolesTo list all the Groups Roles.get-role-groupsTo get all the groups in a
specific Role.create-group-roleTo create a Group Role.delete-group-roleTo delete a group Role.list-groupsyeeduadminlist-groups-husage:list-groups[-h][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list-groups example without optional arguments passed for output format.yeeduadminlist-groupsConsole output{"tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538","groups":["yeedu-manager"]}get-groupyeeduadminget-group-husage:get-group[-h]--group_idGROUP_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--group_idGROUP_IDProvideGroupIdtogetinformationaboutaspecificGroup.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)get-group example with the required argument ‘–group_id’ passed.yeeduadminget-group--group_id=1Console output{"group_id":1,"group_name":"yeedu-manager","from_date":"2023-03-15T11:32:17.570658+00:00","to_date":"infinity"}get-group-rolesyeeduadminget-group-roles-husage:get-group-roles[-h]--group_idGROUP_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--group_idGROUP_IDProvideGroupIdtogetrolesofaspecificGroup.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)get-group-roles example with the required argument ‘–group_id’ passed.yeeduadminget-group-roles--group_id=1Console output{"group_id":1,"roles":["Resource Manager"]}list-groups-rolesyeeduadminlist-groups-roles-husage:list-groups-roles[-h][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list-groups-roles example without optional arguments passed for output format.yeeduadminlist-groups-rolesConsole output[{"group_id":1,"group_name":"yeedu-manager","roles":["Resource Manager"]}]get-role-groupsyeeduadminget-role-groups-husage:get-role-groups[-h]--role_idROLE_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--role_idROLE_IDProvideRoleIdtogetgroupsinaspecificRole.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)get-role-groups example with the required argument ‘–role_id’ passed.yeeduadminget-role-groups--role_id=0Console output{"role_id":0,"groups":["yeedu-manager"]}create-group-roleyeeduadmincreate-group-role-husage:create-group-role[-h]--group_idGROUP_ID--role_idROLE_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--group_idGROUP_IDProvideGroupIdtocreate-group-role.--role_idROLE_IDProvideRoleIdtocreate-group-role.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)create-group-role example with all the required arguments passed.yeeduadmincreate-group-role--group_id=1--role_id=0Console output{"group_roles_id":"1","tenant_id":"0b5017a9-6099-497f-81ba-d4e537e23538","group_id":"1","role_id":0,"created_by_id":"1","modified_by_id":"1","last_update_date":"2023-03-15T13:10:15.840Z","from_date":"2023-03-15T13:10:15.840Z","to_date":null}delete-group-roleyeeduadmindelete-group-role-husage:delete-group-role[-h]--group_idGROUP_ID--role_idROLE_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--group_idGROUP_IDProvideGroupIdtodelete-group-role.--role_idROLE_IDProvideRoleIdtodelete-group-role.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)delete-group-role example with all the required arguments passed.yeeduadmindelete-group-role--group_id=1--role_id=0Console output{"message":"Deleted Group Role for the provided Group Id: 1 and Role Id: 0"}