Package: yeedu
Command-Line-InterfaceCLI(Command Line Interface) is a standard CLI to run interactively with Yeedu'sRESTful-API.CLI FeaturesCLI SetupWindowsGenerate Executable file for yeedu CLILinuxEnvironment Variable SetupAuthentication SetupStoring the credentials as Environment VariablesStoring the credentials inside ayeedu_credentials.configfileStoring the Yeedu Session Token inside a fileConfigurelist-tenantsassociate-tenantResourceLookuplist-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-confssearch-volume-confsget-volume-confedit-volume-confdelete-volume-confNetwork Configurationcreate-network-conflist-network-confssearch-network-confsget-network-confedit-network-confdelete-network-confBoot Disk Image Configcreate-boot-disk-image-confget-boot-disk-image-conflist-boot-disk-image-confssearch-boot-disk-image-confsedit-boot-disk-image-confdelete-boot-disk-image-confCredentials Configurationcreate-credential-conflist-credential-confssearch-credential-confsget-credential-confedit-credential-confdelete-credential-confCloud Envcreate-cloud-envlist-cloud-envssearch-cloud-envsget-cloud-envedit-cloud-envdelete-cloud-envObject Storage Managercreate-object-storage-managerlist-object-storage-managerssearch-object-storage-managersget-object-storage-manageredit-object-storage-managerdelete-object-storage-managerObject Storage Manager Filescreate-object-storage-manager-filelist-object-storage-manager-filessearch-object-storage-manager-filesget-object-storage-manager-filedelete-object-storage-manager-fileHive Metastore Configurationcreate-hive-metastore-conflist-hive-metastore-confssearch-hive-metastore-confsget-hive-metastore-confedit-hive-metastore-confdelete-hive-metastore-confClusterCluster Configurationcreate-conflist-confssearch-confsget-confedit-confdelete-confCluster Instancecreatelistsearchgeteditstartstopdestroyget-statslist-statuslogsCluster Access Controlassociate-workspacedissociate-workspacelist-workspaceslist-workspace-clusterssearch-workspace-clustersWorkspaceWorksapcecreatelistsearchgeteditenabledisableWorkspace Access Controlcreate-user-accesscreate-group-accessdelete-user-accessdelete-group-accesslist-userssearch-usersmatch-userlist-groupssearch-groupsmatch-groupget-user-accessget-group-accesslist-users-accesslist-groups-accessJobSpark Job Configurationcreate-conflist-confssearch-confsget-confedit-confenable-confdisable-confSpark Job Instancestartlistsearchgetstopget-statuslogsWorkflow Details By Spark Job Application Idget-workflow-job-instanceNotebookNotebook Configurationcreate-conflist-confssearch-confsget-confedit-confenable-confdisable-confNotebook Instancestartkernel-startkernel-interruptkernel-restartlistsearchgetstoplogsIAMUserget-user-infoget-user-rolesShared Platform and Adminsync-usersync-grouplist-user-groupslist-userssearch-usersmatch-userlist-group-userslist-groupssearch-groupsmatch-groupLookuplist-resourcesget-resourcelist-permissionsget-permissionlist-rolesget-rolelist-rulesget-rulelist-workspace-permissionsget-workspace-permissionPlatform-AdminTenantcreate-tenantlist-tenantssearch-tenantsget-tenantedit-tenantdelete-tenantUserlist-user-tenantslist-tenant-userssearch-tenant-usersget-tenant-userget-user-roleslist-users-rolesget-role-userscreate-user-roledelete-user-roleGrouplist-tenant-groupssearch-tenant-groupsget-tenant-groupget-group-roleslist-groups-rolesget-role-groupscreate-group-roledelete-group-roleAdminUserlist-userssearch-usersget-userget-user-roleslist-users-rolesget-role-userscreate-user-roledelete-user-roleGrouplist-groupssearch-groupsget-groupget-group-roleslist-groups-rolesget-role-groupscreate-group-roledelete-group-roleCLI SetupTo set up the Yeedu CLI on the environment, execute the following command from the project directory.Windowspip install --editable .Generate Executable file for Yeedu CLINeed to installpyinstallerusing below-mentioned commandpip install pyinstallerFrom the project directory execute the mention commandpyinstaller --onefile yeedu.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 the executable fileyeedu.exe resource list-providersLinuxWSLsudoaptinstallpython3-pippip3install--editable.Bashsudopython3setup.pydevelopTab-AutocompleteNavigate to the/scriptsdirectory from the project directory and obtain theyeedu_autocompletion.shfile.# Add the following to ~/.bashrcsource/path/to/yeedu_autocompletion.shAfter adding the above information to~/.bashrc, restart the shell or open a new shell session.Environment 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_USERNAME=USERYEEDU_PASSWORD=PASSYEEDU_RESTAPI_TOKEN=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6ImFiY2RlZiIsImlkIjoiMSIsImlhdCI6MTY2NzgwOTYwMX0.HwhdTHBttnR0NFtmUDjcxTLMSLfyNuBs7t7GO9zOf08YEEDU_RESTAPI_TOKEN_FILE_PATH=/home/user/yeedu_cli.configAlternative of.envfileWindows CMDSET YEEDU_RESTAPI_URL="http://localhost:8080"
SET YEEDU_CLI_LOG_DIR=/.yeedu/cli/logs/
SET YEEDU_USERNAME=USER
SET YEEDU_PASSWORD=PASS
SET YEEDU_RESTAPI_TOKEN=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6ImFiY2RlZiIsImlkIjoiMSIsImlhdCI6MTY2NzgwOTYwMX0.HwhdTHBttnR0NFtmUDjcxTLMSLfyNuBs7t7GO9zOf08
SET YEEDU_RESTAPI_TOKEN_FILE_PATH=/home/user/yeedu_cli.configLinuxexportYEEDU_RESTAPI_URL="http://localhost:8080"exportYEEDU_CLI_LOG_DIR=/.yeedu/cli/logs/exportYEEDU_USERNAME=USERexportYEEDU_PASSWORD=PASSexportYEEDU_RESTAPI_TOKEN=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6ImFiY2RlZiIsImlkIjoiMSIsImlhdCI6MTY2NzgwOTYwMX0.HwhdTHBttnR0NFtmUDjcxTLMSLfyNuBs7t7GO9zOf08exportYEEDU_RESTAPI_TOKEN_FILE_PATH=/home/user/yeedu_cli.configAuthentication SetupThe following describes the ways of storing credentials, which will be used to generate the token [Environment Variables being given priority].Storing the credentials as Environment VariablesYEEDU_USERNAME=USER
YEEDU_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. The user can save the token at any location and provide the file path in environment variableYEEDU_RESTAPI_TOKEN_FILE_PATHFor exampleYEEDU_RESTAPI_TOKEN_FILE_PATH="/home/user/Documents/YeeduToken/{FileName}"The 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 the tenant with the current user's session Token.Configureyeeduconfigure-hYeeduCLI

positionalarguments:{configure}options:-h,--helpShowthishelpmessageandexit.--timeout[TIMEOUT]ProvidetokenexpirationtimeoutinhourExample:--timeout=24,--timeout=infinity(infinityfornoexpirationtime)togenerateYeeduToken.(default:48)--no-browser[{true,false}]If'no-browser=true'isprovided,thebrowserwillnotopenautomaticallyfortheSSOloginURL.(default:false)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)User can provide the file path to store 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 the 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 iam list-tenantscommand.list-tenantsyeeduiamlist-tenants-husage:list-tenants[-h][--page_numberPAGE_NUMBER][--limitLIMIT][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--page_numberPAGE_NUMBERTolisttheavailabletenantsforaspecificpage_number.(default:1)--limitLIMITProvidelimittolistnumberofavailabletenants.(default:100)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list-tenants example without optional arguments passed.yeeduiamlist-tenantsConsole output{"data":[{"tenant_id":"6423f466-ff56-4ba4-8c2d-8229beb67e38","name":"tenant1","description":"Yeedu Tenant 1"},{"tenant_id":"066a702d-6b9d-4176-afc5-51c24a651739","name":"tenant2","description":"Yeedu Tenant 2"},{"tenant_id":"cf1f945f-01ce-4ac6-a070-8c733f2fa791","name":"tenant3","description":"Yeedu Tenant 3"},{"tenant_id":"6b682ef1-ede4-4d96-bab6-cd008aadd534","name":"tenant4","description":"Yeedu Tenant 4"}],"result_set":{"current_page":1,"total_objects":4,"total_pages":1,"limit":100}}Executeyeedu iam associate-tenant --tenant_id={tenant_id}to associate a tenant id from theyeedu iam list-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="6423f466-ff56-4ba4-8c2d-8229beb67e38"Console output{"message":"Successfully associated Tenant"}ResourceLookupCommand 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 all 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-09-27T06:11:53.179Z","to_date":null},{"cloud_provider_id":"1","name":"aws","description":"Provider for creating infrastructure on Amazon Web Services","from_date":"2023-09-27T06:11:53.179Z","to_date":null},{"cloud_provider_id":"2","name":"azure","description":"Provider for creating infrastructure on Azure Cloud Platform","from_date":"2023-09-27T06:11:53.179Z","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-09-27T06:11:53.179Z","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-09-27T06:11:53.246Z","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-09-27T06:11:53.246Z","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-09-27T06:11:53.246Z","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-09-27T06:11:53.193Z","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-09-27T06:11:53.193Z","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-09-27T06:11:53.193Z","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 arguments passed for the 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-09-27T06:11:53.242Z","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-09-27T06:11:53.242Z","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 arguments passed for the 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-09-27T06:11:53.188Z","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-09-27T06:11:53.188Z","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-09-27T06:11:53.188Z","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 arguments passed for the 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-09-27T06:11:53.186Z","to_date":null},...{"engine_cluster_instance_status_id":"8","name":"RESIZING_DOWN","description":"The cluster instance will scale down","from_date":"2023-09-27T06:11:53.186Z","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 arguments passed for the output format.yeeduresourcelist-spark-compute-typesConsole output[{"spark_compute_type_id":"0","name":"YEEDU","description":null,"from_date":"2023-09-27T06:11:53.265Z","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 arguments passed for the 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","python_version":"3.9.5","notebook_support":false,"from_date":"2023-10-18T12:28:01.395Z","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","python_version":"3.9.5","notebook_support":true,"from_date":"2023-10-18T12:28:01.395Z","to_date":null},{"spark_infra_version_id":"2","spark_version":"v3.2.2-rc5","hive_version":"3.2.3","hadoop_version":"3.2.4","scala_version":"2.12.15","python_version":"3.9.5","notebook_support":true,"from_date":"2023-10-18T12:28:01.395Z","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 arguments passed for the 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-09-27T06:11:53.266Z","to_date":null},...{"spark_job_status_id":"8","name":"STOPPED","description":"The process was successfully stopped","from_date":"2023-09-27T06:11:53.266Z","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 arguments passed for the output format.yeeduresourcelist-workflow-execution-statesConsole output[{"workflow_execution_state_id":-1,"name":"NONE","description":"NONE","from_date":"2023-09-27T06:11:53.255Z","to_date":null},...{"workflow_execution_state_id":99,"name":"DONE","description":"NONE","from_date":"2023-09-27T06:11:53.255Z","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 arguments passed for the output format.yeeduresourcelist-workflow-typesConsole output[{"workflow_type_id":"0","name":"spark_start","queue_name":"yeedu.workflows.usi.start","description":null,"from_date":"2023-09-27T06:11:53.257Z","to_date":null},...{"workflow_type_id":"8","name":"cosi_resize_down","queue_name":"yeedu.workflows.cosi","description":null,"from_date":"2023-09-27T06:11:53.257Z","to_date":null}]Volume ConfigurationCommand NameUtilitycreate-volume-confTo create the Volume Configuration.list-volume-confsTo list all the available Volume Configurations.search-volume-confsTo search 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][--description[DESCRIPTION]]--encrypted{true,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.--description[DESCRIPTION]Providedescriptiontocreate-volume-conf.--encrypted{true,false}Provideencryptedtocreate-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"--encrypted=false--disk_type_id=1--machine_volume_num=1--machine_volume_strip_num=1Console output{"volume_conf_id":"1","name":"yeedu_volume","description":null,"encrypted":false,"size":"375","disk_type_id":"4","disk_type_name":"local-ssd","machine_volume_num":1,"machine_volume_strip_num":1,"created_by_id":"1","modified_by_id":"1","last_update_date":"2023-09-28T14:52:41.175Z","from_date":"2023-09-28T14:52:41.175Z","to_date":null}list-volume-confsyeeduresourcelist-volume-confs-husage:list-volume-confs[-h][--page_numberPAGE_NUMBER][--limitLIMIT][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--page_numberPAGE_NUMBERTolistVolumeConfigurationsforaspecificpage_number.(default:1)--limitLIMITProvidelimittolistnumberofVolumeConfigurations.(default:100)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list-volume-confs example with optional arguments passed for the output format.yeeduresourcelist-volume-confs--cloud_provider="GCP"Console output{"data":[{"volume_conf_id":1,"name":"yeedu_volume","description":null,"encrypted":false,"size":375,"disk_type":{"disk_type_id":4,"name":"local-ssd","has_fixed_size":true,"min_size":375,"max_size":375,"cloud_provider":{"cloud_provider_id":0,"name":"gcp"}},"machine_volume_num":1,"machine_volume_strip_num":1,"created_by":{"user_id":1,"username":"YSU0000"},"modified_by":{"user_id":1,"username":"YSU0000"},"last_update_date":"2024-01-05T09:27:59.407362+00:00","from_date":"2024-01-05T09:27:59.407362+00:00","to_date":"infinity"}],"result_set":{"current_page":1,"total_objects":1,"total_pages":1,"limit":100}}search-volume-confsyeeduresourcesearch-volume-confs-husage:search-volume-confs[-h]--volume_conf_nameVOLUME_CONF_NAME[--page_numberPAGE_NUMBER][--limitLIMIT][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--volume_conf_nameVOLUME_CONF_NAMEProvidevolume_conf_nametosearchalltheavailableVolumeConfigurations.--page_numberPAGE_NUMBERTosearchVolumeConfigurationsforaspecificpage_number.(default:1)--limitLIMITProvidelimittosearchnumberofVolumeConfigurations.(default:100)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)search-volume-confs example with required argument '--volume_conf_name' passed.yeeduresourcesearch-volume-confs--volume_conf_name="yeedu_"Console output{"data":[{"volume_conf_id":1,"name":"yeedu_volume","description":null,"encrypted":false,"size":375,"disk_type":{"disk_type_id":4,"name":"local-ssd","has_fixed_size":true,"min_size":375,"max_size":375,"cloud_provider":{"cloud_provider_id":0,"name":"gcp"}},"machine_volume_num":1,"machine_volume_strip_num":1,"created_by":{"user_id":1,"username":"YSU0000"},"modified_by":{"user_id":1,"username":"YSU0000"},"last_update_date":"2024-01-05T09:27:59.407362+00:00","from_date":"2024-01-05T09:27:59.407362+00:00","to_date":"infinity"}],"result_set":{"current_page":1,"total_objects":1,"total_pages":1,"limit":100}}get-volume-confyeeduresourceget-volume-conf-husage:get-volume-conf[-h][--volume_conf_idVOLUME_CONF_ID][--volume_conf_nameVOLUME_CONF_NAME][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--volume_conf_idVOLUME_CONF_IDProvidevolume_conf_idtogetinformationaboutaspecificVolumeConfiguration.--volume_conf_nameVOLUME_CONF_NAMEProvidevolume_conf_nametogetinformationaboutaspecificVolumeConfiguration.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)```-get-volume-confexamplewithanyoneoftherequiredargument'--volume_conf_id'passed.```bash
yeeduresourceget-volume-conf--volume_conf_id=1Console output{"volume_conf_id":1,"name":"yeedu_volume","description":null,"encrypted":false,"size":375,"disk_type":{"disk_type_id":4,"name":"local-ssd","has_fixed_size":true,"min_size":375,"max_size":375,"cloud_provider":{"cloud_provider_id":0,"name":"gcp"}},"machine_volume_num":1,"machine_volume_strip_num":1,"created_by":{"user_id":1,"username":"YSU0000"},"modified_by":{"user_id":1,"username":"YSU0000"},"last_update_date":"2024-01-05T09:27:59.407362+00:00","from_date":"2024-01-05T09:27:59.407362+00:00","to_date":"infinity"}edit-volume-confyeeduresourceedit-volume-conf-husage:edit-volume-conf[-h][--volume_conf_idVOLUME_CONF_ID][--volume_conf_nameVOLUME_CONF_NAME][--name[NAME]][--description[DESCRIPTION]][--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.--volume_conf_nameVOLUME_CONF_NAMEProvidespecificvolume_conf_nametoedit-volume-conf.--name[NAME]Providenametoedit-volume-conf.--description[DESCRIPTION]Providedescriptiontoedit-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 any one of the required argument '--volume_conf_name' and other optional arguments are passed which is to be updated.yeeduresourceedit-volume-conf--volume_conf_name="yeedu_volume"--encrypted=trueConsole output{"volume_conf_id":"1","name":"yeedu_volume","description":null,"encrypted":true,"size":"375","disk_type_id":"4","disk_type_name":"local-ssd","machine_volume_num":1,"machine_volume_strip_num":1,"created_by_id":"1","modified_by_id":"1","last_update_date":"2024-01-05T09:36:06.435Z","from_date":"2024-01-05T09:27:59.407Z","to_date":null}delete-volume-confyeeduresourcedelete-volume-conf-husage:delete-volume-conf[-h][--volume_conf_idVOLUME_CONF_ID][--volume_conf_nameVOLUME_CONF_NAME][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--volume_conf_idVOLUME_CONF_IDProvidevolume_conf_idtodeleteaspecificVolumeConfiguration.--volume_conf_nameVOLUME_CONF_NAMEProvidevolume_conf_nametodeleteaspecificVolumeConfiguration.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)delete-volume-conf example with any one of the required argument '--volume_conf_name' which is to be deleted.yeeduresourcedelete-volume-conf--volume_conf_name="yeedu_volume"Console output{"message":"Deleted volume config name: 'yeedu_volume'."}Network ConfigurationNetwork ConfigurationCommand NameUtilitycreate-network-confTo create the Network Configuration.list-network-confsTo get information about Network Configurations for a specific specific network.search-network-confsTo get information about Network Configurations for a specific specific network.get-network-confTo get information about a specific Network Configuration for a specific networkedit-network-confTo edit a specific Network Configuration for a specific network.delete-network-confTo delete a specific Network Configuration for a specific network.create-network-confyeeduresourcecreate-network-conf-husage:create-network-conf[-h]--nameNAME[--descriptionDESCRIPTION]--network_project_idNETWORK_PROJECT_ID--network_nameNETWORK_NAME--subnetSUBNET--availability_zone_idAVAILABILITY_ZONE_ID[--network_tags['value1,value2']][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--nameNAMEProvidenametocreate-network-conf.--descriptionDESCRIPTIONProvidedescriptiontocreate-network-conf.--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.--network_tags['value1,value2']Providenetwork_tagstocreate-network-conf.(default:[])--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--name="yeedu_network"--network_project_id="modak-yeedu"--network_name='modak-yeedu-spark-vpc'--subnet='custom-subnet-modak-yeedu'--availability_zone_id=75--network_tags="yeedu,iap-allow"Console output{"network_conf_id":"1","name":"yeedu_network","description":null,"network_project_id":"modak-yeedu","network_name":"modak-yeedu-spark-vpc","network_tags":["yeedu","iap-allow"],"subnet":"custom-subnet-modak-yeedu","availability_zone_id":"75","tenant_id":"1ea17e91-257b-4a6c-82aa-265568d31615","created_by_id":"1","modified_by_id":"1","last_update_date":"2024-01-05T09:43:06.687Z","from_date":"2024-01-05T09:43:06.687Z","to_date":null}list-network-confsyeeduresourcelist-network-confs-husage:list-network-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}]Providespecificcloud_provider_idtogetinformationaboutrelatedNetworkConfigurations.--page_numberPAGE_NUMBERTolistNetworkConfigurationsforaspecificpage_number.(default:1)--limitLIMITProvidelimittolistnumberofNetworkConfigurations.(default:100)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list-network-confs example with optional argument--cloud_providerpassed.yeeduresourcelist-network-confs--cloud_provider="GCP"Console output{"data":[{"network_conf_id":1,"network_conf_name":"yeedu_network","description":null,"network_project_id":"modak-yeedu","network_name":"modak-yeedu-spark-vpc","network_tags":["yeedu","iap-allow"],"subnet":"custom-subnet-modak-yeedu","availability_zone":{"availability_zone_id":75,"cloud_provider":{"cloud_provider_id":0,"name":"gcp","description":"Provider for creating infrastructure on Google Cloud Platform"},"name":"us-central1-a","region":"us-central1","description":"Council Bluffs, Iowa, North America"},"tenant_id":"1ea17e91-257b-4a6c-82aa-265568d31615","created_by":{"user_id":1,"username":"YSU0000"},"modified_by":{"user_id":1,"username":"YSU0000"},"last_update_date":"2024-01-05T09:43:06.687724+00:00","from_date":"2024-01-05T09:43:06.687724+00:00","to_date":"infinity"}],"result_set":{"current_page":1,"total_objects":1,"total_pages":1,"limit":100}}search-network-confsyeeduresourcesearch-network-confs-husage:search-network-confs[-h]--network_conf_nameNETWORK_CONF_NAME[--cloud_provider[{GCP,AWS,AZURE}]][--page_numberPAGE_NUMBER][--limitLIMIT][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--network_conf_nameNETWORK_CONF_NAMEProvidenetwork_conf_nametogetinformationaboutaspecificNetworkConfiguration.--cloud_provider[{GCP,AWS,AZURE}]Providespecificcloud_provider_idtogetinformationaboutrelatedNetworkConfigurations.--page_numberPAGE_NUMBERTosearchNetworkConfigurationsforaspecificpage_number.(default:1)--limitLIMITProvidelimittosearchnumberofNetworkConfigurations.(default:100)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)search-network-confs example with required argument--network_conf_namepassed.yeeduresourcesearch-network-confs--network_conf_name="yeedu_"Console output{"data":[{"network_conf_id":1,"network_conf_name":"yeedu_network","description":null,"network_project_id":"modak-yeedu","network_name":"modak-yeedu-spark-vpc","network_tags":["yeedu","iap-allow"],"subnet":"custom-subnet-modak-yeedu","availability_zone":{"availability_zone_id":75,"cloud_provider":{"cloud_provider_id":0,"name":"gcp","description":"Provider for creating infrastructure on Google Cloud Platform"},"name":"us-central1-a","region":"us-central1","description":"Council Bluffs, Iowa, North America"},"tenant_id":"1ea17e91-257b-4a6c-82aa-265568d31615","created_by":{"user_id":1,"username":"YSU0000"},"modified_by":{"user_id":1,"username":"YSU0000"},"last_update_date":"2024-01-05T09:43:06.687724+00:00","from_date":"2024-01-05T09:43:06.687724+00:00","to_date":"infinity"}],"result_set":{"current_page":1,"total_objects":1,"total_pages":1,"limit":100}}get-network-confyeeduresourceget-network-conf-husage:get-network-conf[-h][--network_conf_idNETWORK_CONF_ID][--network_conf_nameNETWORK_CONF_NAME][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--network_conf_idNETWORK_CONF_IDProvidenetwork_conf_idtogetinformationaboutaspecificnetworkConfiguration.--network_conf_nameNETWORK_CONF_NAMEProvidenetwork_conf_nametogetinformationaboutaspecificnetworkConfiguration.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)get-network-conf example with any one of the required argument '--network_conf_name' passed.yeeduresourceget-network-conf--network_conf_name="yeedu_network"Console output{"network_conf_id":1,"network_conf_name":"yeedu_network","description":null,"network_project_id":"modak-yeedu","network_name":"modak-yeedu-spark-vpc","network_tags":["yeedu","iap-allow"],"subnet":"custom-subnet-modak-yeedu","availability_zone":{"availability_zone_id":75,"cloud_provider":{"cloud_provider_id":0,"name":"gcp","description":"Provider for creating infrastructure on Google Cloud Platform"},"name":"us-central1-a","region":"us-central1","description":"Council Bluffs, Iowa, North America"},"tenant_id":"1ea17e91-257b-4a6c-82aa-265568d31615","created_by":{"user_id":1,"username":"YSU0000"},"modified_by":{"user_id":1,"username":"YSU0000"},"last_update_date":"2024-01-05T09:43:06.687724+00:00","from_date":"2024-01-05T09:43:06.687724+00:00","to_date":"infinity"}edit-network-confyeeduresourceedit-network-conf-husage:edit-network-conf[-h][--network_conf_idNETWORK_CONF_ID][--network_conf_nameNETWORK_CONF_NAME][--nameNAME][--descriptionDESCRIPTION][--network_name[NETWORK_NAME]][--network_project_id[NETWORK_PROJECT_ID]][--availability_zone_idAVAILABILITY_ZONE_ID][--subnet[SUBNET]][--network_tags['value1,value2']][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--network_conf_idNETWORK_CONF_IDProvideaspecificNetworkConfigurationnetwork_conf_idtoedit-network-conf.--network_conf_nameNETWORK_CONF_NAMEProvideaspecificNetworkConfigurationnetwork_conf_nametoedit-network-conf.--nameNAMEProvidenametoedit-network-conf.--descriptionDESCRIPTIONProvidedescriptiontoedit-network-conf.--network_name[NETWORK_NAME]Providenetwork_nametoedit-network-conf.--network_project_id[NETWORK_PROJECT_ID]Providenetwork_project_idtoedit-network-conf.--availability_zone_idAVAILABILITY_ZONE_IDProvideavailability_zone_idtoedit-network-conf.--subnet[SUBNET]Providesubnettoedit-network-conf.--network_tags['value1,value2']Providenetwork_tagstoedit-network-conf.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)edit-network-conf example with any one of the required argument '--network_conf_id' and other optional argument is passed which is to be updated.yeeduresourceedit-network-conf--network_conf_id=1--network_name="modak-yeedu-spark-vpc"Console output{"network_conf_id":"1","network_conf_name":"yeedu_network","description":null,"network_project_id":"modak-yeedu","network_name":"modak-yeedu-spark-vpc","network_tags":["yeedu","iap-allow"],"subnet":"custom-subnet-modak-yeedu","availability_zone_id":"75","tenant_id":"1ea17e91-257b-4a6c-82aa-265568d31615","created_by_id":"1","modified_by_id":"1","last_update_date":"2024-01-05T09:58:13.769Z","from_date":"2024-01-05T09:43:06.687Z","to_date":null}delete-network-confyeeduresourcedelete-network-conf-husage:delete-network-conf[-h][--network_conf_idNETWORK_CONF_ID][--network_conf_nameNETWORK_CONF_NAME][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--network_conf_idNETWORK_CONF_IDProvidenetwork_conf_idtodeleteaspecificnetworkConfiguration.--network_conf_nameNETWORK_CONF_NAMEProvidenetwork_conf_nametodeleteaspecificnetworkConfiguration.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)delete-network-conf example with any one of the required argument '--network_conf_id' which is to be deleted.yeeduresourcedelete-network-conf--network_conf_id=1Console output{"message":"Deleted Machine Network Configuration Id: 1."}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.search-boot-disk-image-confsTo search all the available Boot Disk Image Configurations.edit-boot-disk-image-confTo edit the information about a specific Boot Disk Image Configuration.delete-boot-disk-image-confTo delete the information about a specific Boot Disk Image Configuration.create-boot-disk-image-confyeeduresourcecreate-boot-disk-image-conf-husage:create-boot-disk-image-conf[-h]--nameNAME[--descriptionDESCRIPTION]--cloud_provider_idCLOUD_PROVIDER_ID--linux_distro_idLINUX_DISTRO_ID--boot_disk_imageBOOT_DISK_IMAGE[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--nameNAMEProvidenametocreate-boot-disk-image-conf.--descriptionDESCRIPTIONProvidedescriptiontocreate-boot-disk-image-conf.--cloud_provider_idCLOUD_PROVIDER_IDProvidecloud_provider_idtocreate-boot-disk-image-conf.--linux_distro_idLINUX_DISTRO_IDProvidelinux_distro_idtocreate-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--name="yeedu_boot_disk_image"--cloud_provider_id=0--boot_disk_image="ubuntu-os-cloud/ubuntu-2004-lts"--linux_distro_id=1Console output{"boot_disk_image_id":"2","boot_disk_image_name":"yeedu_boot_disk_image","description":null,"cloud_provider_id":0,"linux_distro_id":1,"boot_disk_image":"ubuntu-os-cloud/ubuntu-2004-lts","created_by_id":"1","modified_by_id":"1","last_update_date":"2024-01-05T10:09:27.590Z","from_date":"2024-01-05T10:09:27.590Z","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][--boot_disk_image_nameBOOT_DISK_IMAGE_NAME][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--boot_disk_image_idBOOT_DISK_IMAGE_IDProvideBootDiskImageIdtogetinformationaboutaspecificbootdiskimageconfiguration.--boot_disk_image_nameBOOT_DISK_IMAGE_NAMEProvideBootDiskImageNametogetinformationaboutaspecificbootdiskimageconfiguration.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)get-boot-disk-image-conf example with any one of the required arguments passed.yeeduresourceget-boot-disk-image-conf--boot_disk_image_id=1Console output{"boot_disk_image_id":1,"boot_disk_image_name":"yeedu_boot_disk_image","description":null,"cloud_provider":{"cloud_provider_id":0,"name":"gcp","description":"Provider for creating infrastructure on Google Cloud Platform"},"linux_distro":{"linux_distro_id":1,"distro_name":"UBUNTU","distro_version":"20.04 LTS"},"boot_disk_image":"ubuntu-os-cloud/ubuntu-2004-lts","created_by":{"user_id":1,"username":"YSU0000"},"modified_by":{"user_id":1,"username":"YSU0000"},"last_update_date":"2024-01-05T10:09:27.590432+00:00","from_date":"2024-01-05T10:09:27.590432+00:00","to_date":"infinity"}list-boot-disk-image-confsyeeduresourcelist-boot-disk-image-confs-husage:list-boot-disk-image-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}]Providecloud_providertolistalltherelatedbootdiskimageconfigsforaspecificCloudProvider.--page_numberPAGE_NUMBERTolistbootdiskimageconfigurationsforaspecificpage_number.(default:1)--limitLIMITProvidelimittolistnumberofbootdiskimageconfigurations.(default:100)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list-boot-disk-image-confs example with an optional argument passed.yeeduresourcelist-boot-disk-image-confs--cloud_provider="GCP"Console output{"data":[{"boot_disk_image_id":1,"boot_disk_image_name":"yeedu_boot_disk_image","description":null,"cloud_provider":{"cloud_provider_id":0,"name":"gcp","description":"Provider for creating infrastructure on Google Cloud Platform"},"linux_distro":{"linux_distro_id":0,"distro_name":"UBUNTU","distro_version":"20.04 LTS"},"boot_disk_image":"ubuntu-os-cloud/ubuntu-2004-lts","created_by":{"user_id":1,"username":"YSU0000"},"modified_by":{"user_id":1,"username":"YSU0000"},"last_update_date":"2024-01-05T10:09:27.590432+00:00","from_date":"2024-01-05T10:09:27.590432+00:00","to_date":"infinity"}],"result_set":{"current_page":1,"total_objects":1,"total_pages":1,"limit":100}}search-boot-disk-image-confsyeeduresourcesearch-boot-disk-image-confs-husage:search-boot-disk-image-confs[-h]--boot_disk_image_nameBOOT_DISK_IMAGE_NAME[--cloud_provider[{GCP,AWS,AZURE}]][--page_numberPAGE_NUMBER][--limitLIMIT][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--boot_disk_image_nameBOOT_DISK_IMAGE_NAMEProvideBootDiskImageNametosearchinformationaboutalltherelatedbootdiskimageconfigs.--cloud_provider[{GCP,AWS,AZURE}]Providecloud_providertosearchalltherelatedbootdiskimageconfigsforaspecificCloudProvider.--page_numberPAGE_NUMBERTolistbootdiskimageconfigurationsforaspecificpage_number.(default:1)--limitLIMITProvidelimittolistnumberofbootdiskimageconfigurations.(default:100)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)search-boot-disk-image-confs example with the required argument '--boot_disk_image_name' passed.yeeduresourcesearch-boot-disk-image-confs--boot_disk_image_name="yeedu_"Console output{"data":[{"boot_disk_image_id":1,"boot_disk_image_name":"yeedu_boot_disk_image","description":null,"cloud_provider":{"cloud_provider_id":0,"name":"gcp","description":"Provider for creating infrastructure on Google Cloud Platform"},"linux_distro":{"linux_distro_id":0,"distro_name":"UBUNTU","distro_version":"20.04 LTS"},"boot_disk_image":"ubuntu-os-cloud/ubuntu-2004-lts","created_by":{"user_id":1,"username":"YSU0000"},"modified_by":{"user_id":1,"username":"YSU0000"},"last_update_date":"2024-01-05T10:09:27.590432+00:00","from_date":"2024-01-05T10:09:27.590432+00:00","to_date":"infinity"}],"result_set":{"current_page":1,"total_objects":1,"total_pages":1,"limit":100}}edit-boot-disk-image-confyeeduresourceedit-boot-disk-image-conf-husage:edit-boot-disk-image-conf[-h][--boot_disk_image_idBOOT_DISK_IMAGE_ID][--boot_disk_image_nameBOOT_DISK_IMAGE_NAME][--nameNAME][--descriptionDESCRIPTION][--linux_distro_idLINUX_DISTRO_ID][--boot_disk_imageBOOT_DISK_IMAGE][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--boot_disk_image_idBOOT_DISK_IMAGE_IDProvideboot_disk_image_idtoeditaspecificbootdiskimageconfiguration.--boot_disk_image_nameBOOT_DISK_IMAGE_NAMEProvideboot_disk_image_nametoeditaspecificbootdiskimageconfiguration.--nameNAMEProvidenametoeditaspecificbootdiskimageconfiguration.--descriptionDESCRIPTIONProvidedescriptiontoeditaspecificbootdiskimageconfiguration.--linux_distro_idLINUX_DISTRO_IDProvidelinux_distro_idtoeditaspecificbootdiskimageconfiguration.--boot_disk_imageBOOT_DISK_IMAGEProvideboot_disk_imagetoeditaspecificbootdiskimageconfiguration.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetoeditoutputinYAMLformat.(default:false)edit-boot-disk-image-conf example with any one of the required argument '--boot_disk_image_id' and other optional argument is passed which is to be updated.yeeduresourceedit-boot-disk-image-conf--boot_disk_image_id=1--description="dev boot disk"Console output{"boot_disk_image_id":"1","boot_disk_image_name":"yeedu_boot_disk_image","description":"dev boot disk","cloud_provider_id":0,"linux_distro_id":0,"boot_disk_image":"ubuntu-os-cloud/ubuntu-2004-lts","created_by_id":"1","modified_by_id":"1","last_update_date":"2024-01-05T10:22:54.395Z","from_date":"2024-01-05T10:09:27.590Z","to_date":null}delete-boot-disk-image-confyeeduresourcedelete-boot-disk-image-conf-husage:delete-boot-disk-image-conf[-h][--boot_disk_image_idBOOT_DISK_IMAGE_ID][--boot_disk_image_nameBOOT_DISK_IMAGE_NAME][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--boot_disk_image_idBOOT_DISK_IMAGE_IDProvideboot_disk_image_idtodeleteaspecificbootdiskimageconfiguration.--boot_disk_image_nameBOOT_DISK_IMAGE_NAMEProvideboot_disk_image_nametodeleteaspecificbootdiskimageconfiguration.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetodeleteoutputinYAMLformat.(default:false)delete-boot-disk-image-conf example with any one of the required argument '--boot_disk_image_id' is passed which is to be deleted.yeeduresourcedelete-boot-disk-image-conf--boot_disk_image_id=1Console output{"message":"Deleted boot disk image configuration id: 1."}Credentials ConfigurationCommand NameUtilitycreate-credential-confTo create a Credential Configuration.list-credential-confsTo list all the available Credential Configurations.search-credential-confsTo search all the Credential Configurations based on name.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]--nameNAME--credential_type_idCREDENTIAL_TYPE_ID--base64_encoded_credentialsBASE64_ENCODED_CREDENTIALS[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--nameNAMEProvidenametocreate-credential-conf.--descriptionDESCRIPTIONProvidedescriptiontocreate-credential-conf.--credential_type_idCREDENTIAL_TYPE_IDProvidecredential_type_idtocreate-credential-conf.--base64_encoded_credentialsBASE64_ENCODED_CREDENTIALSProvidebase64_encoded_credentialstocreate-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--name='modakyeedu-svc'--credential_type_id=0--base64_encoded_credentials='ew0KICAieWVlZHVfY3JlZGVudGlhbHMiOiAiRHVtbXkgQ3JlZGVudGlhbHMgQ29uZmlndXJhdGlvbiINCn0'Console output{"credentials_conf_id":"1","name":"modakyeedu-svc","description":null,"credential_type_id":"0","tenant_id":"e67f00ad-68aa-46d0-b32e-f3f8dac5427d","created_by_id":"1","modified_by_id":"1","last_update_date":"2023-09-28T17:28:11.325Z","from_date":"2023-09-28T17:28:11.325Z","to_date":null}list-credential-confsyeeduresourcelist-credential-confs-husage:list-credential-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}]CloudProviderthatwillbeusedforfilteringCredentialConfigurations.--page_numberPAGE_NUMBERTolistCredentialConfigurationsforaspecificpage_number.(default:1)--limitLIMITProvidelimittolistnumberofCredentialConfigurations.(default:100)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list-credential-confs example with optional arguments passed.yeeduresourcelist-credential-confs--cloud_provider="GCP"Console output{"data":[{"credentials_conf_id":1,"credentials_conf_name":"modakyeedu-svc","description":null,"credential_type":{"name":"gcp","cloud_provider":{"name":"gcp","description":"Provider for creating infrastructure on Google Cloud Platform"}},"tenant_id":"e67f00ad-68aa-46d0-b32e-f3f8dac5427d","created_by":{"user_id":1,"username":"YSU0000"},"modified_by":{"user_id":1,"username":"YSU0000"},"last_update_date":"2023-09-28T17:28:11.325838+00:00","from_date":"2023-09-28T17:28:11.325838+00:00","to_date":"infinity"}],"result_set":{"current_page":1,"total_objects":1,"total_pages":1,"limit":100}}search-credential-confsyeeduresourcesearch-credential-confs-husage:search-credential-confs[-h]--credentials_conf_nameCREDENTIALS_CONF_NAME[--cloud_provider[{GCP,AWS,AZURE}]][--page_numberPAGE_NUMBER][--limitLIMIT][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--credentials_conf_nameCREDENTIALS_CONF_NAMEProvidecredentials_conf_nametosearchcredentialconfiguration.--cloud_provider[{GCP,AWS,AZURE}]CloudProviderthatwillbeusedforfilteringCredentialConfigurations.--page_numberPAGE_NUMBERTosearchCredentialConfigurationsforaspecificpage_number.(default:1)--limitLIMITProvidelimittosearchnumberofCredentialConfigurations.(default:100)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)search-credential-confs example with required argument '--credentials_conf_name' passed.yeeduresourcesearch-credential-confs--credentials_conf_name="modak"Console output{"data":[{"credentials_conf_id":1,"credentials_conf_name":"modakyeedu-svc","description":null,"credential_type":{"name":"gcp","cloud_provider":{"name":"gcp","description":"Provider for creating infrastructure on Google Cloud Platform"}},"tenant_id":"e67f00ad-68aa-46d0-b32e-f3f8dac5427d","created_by":{"user_id":1,"username":"YSU0000"},"modified_by":{"user_id":1,"username":"YSU0000"},"last_update_date":"2023-09-28T17:28:11.325838+00:00","from_date":"2023-09-28T17:28:11.325838+00:00","to_date":"infinity"}],"result_set":{"current_page":1,"total_objects":1,"total_pages":1,"limit":100}}get-credential-confyeeduresourceget-credential-conf-husage:get-credential-conf[-h][--credentials_conf_idCREDENTIALS_CONF_ID][--credentials_conf_nameCREDENTIALS_CONF_NAME][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--credentials_conf_idCREDENTIALS_CONF_IDProvidecredentials_conf_idtogetinformationaboutaspecificcredentialconfiguration.--credentials_conf_nameCREDENTIALS_CONF_NAMEProvidecredentials_conf_nametogetinformationaboutaspecificcredentialconfiguration.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)get-credential-conf example with any one of the required '--credentials_conf_name' arguments passed.yeeduresourceget-credential-conf--credentials_conf_name=""Console output{"credentials_conf_id":1,"credentials_conf_name":"modakyeedu-svc","description":null,"credential_type":{"name":"gcp","cloud_provider":{"name":"gcp","description":"Provider for creating infrastructure on Google Cloud Platform"}},"tenant_id":"e67f00ad-68aa-46d0-b32e-f3f8dac5427d","created_by":{"user_id":1,"username":"YSU0000"},"modified_by":{"user_id":1,"username":"YSU0000"},"last_update_date":"2023-09-28T17:28:11.325838+00:00","from_date":"2023-09-28T17:28:11.325838+00:00","to_date":"infinity"}edit-credential-confyeeduresourceedit-credential-conf-husage:edit-credential-conf[-h][--credentials_conf_idCREDENTIALS_CONF_ID][--credentials_conf_nameCREDENTIALS_CONF_NAME][--nameNAME][--base64_encoded_credentialsBASE64_ENCODED_CREDENTIALS][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--credentials_conf_idCREDENTIALS_CONF_IDProvidecredentials_conf_idtoeditaspecificCredentialConfiguration.--credentials_conf_nameCREDENTIALS_CONF_NAMEProvidecredentials_conf_nametoeditaspecificCredentialConfiguration.--nameNAMEProvidenametoedit-credential-conf.--descriptionDESCRIPTIONProvidedescriptiontoedit-credential-conf.--base64_encoded_credentialsBASE64_ENCODED_CREDENTIALSProvidebase64_encoded_credentialstoedit-credential-conf.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)edit-credential-conf example with any one of 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='modak-yeedu-svc'Console output{"credentials_conf_id":"1","name":"modak-yeedu-svc","credential_type_id":"0","tenant_id":"e67f00ad-68aa-46d0-b32e-f3f8dac5427d","created_by_id":"1","modified_by_id":"1","last_update_date":"2023-09-28T17:33:36.788Z","from_date":"2023-09-28T17:28:11.325Z","to_date":null}delete-credential-confyeeduresourcedelete-credential-conf-husage:delete-credential-conf[-h][--credentials_conf_idCREDENTIALS_CONF_ID][--credentials_conf_nameCREDENTIALS_CONF_NAME][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--credentials_conf_idCREDENTIALS_CONF_IDProvidecredentials_conf_idtodeleteaspecificCredentialConfiguration.--credentials_conf_nameCREDENTIALS_CONF_NAMEProvidecredentials_conf_nametodeleteaspecificCredentialConfiguration.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)delete-credential-conf example with any one of the required '--credentials_conf_name' argument passed.yeeduresourcedelete-credential-conf--credentials_conf_name="modak-yeedu-svc"Console output{"message":"Deleted Credentials Configuration Name: 'modak-yeedu-svc'."}Cloud EnvCommand NameUtilitycreate-cloud-envTo create a Object Storage Manager.list-cloud-envsTo list all the available Object Storage Manager Configurations.search-cloud-envsTo search Object Storage Manager Configurations.get-cloud-envTo get information about a specific Object Storage Manager.edit-cloud-envTo edit a specific Object Storage Manager Configuration.delete-cloud-envTo delete a specific Object Storage Manager.create-cloud-envyeeduresourcecreate-cloud-env-husage:create-cloud-env[-h]--nameNAME[--descriptionDESCRIPTION]--cloud_provider_idCLOUD_PROVIDER_ID--availability_zone_idAVAILABILITY_ZONE_ID--network_conf_idNETWORK_CONF_ID--cloud_projectCLOUD_PROJECT--credential_config_idCREDENTIAL_CONFIG_ID--boot_disk_image_idBOOT_DISK_IMAGE_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--nameNAMEProvidenametocreateacloudenvironment.--descriptionDESCRIPTIONProvidedescriptiontocreateacloudenvironment.--cloud_provider_idCLOUD_PROVIDER_IDProvidecloud_provider_idtocreateacloudenvironment.--availability_zone_idAVAILABILITY_ZONE_IDProvideavailability_zone_idtocreateacloudenvironment.--network_conf_idNETWORK_CONF_IDProvidenetwork_conf_idtocreateacloudenvironment.--cloud_projectCLOUD_PROJECTProvidecloud_projecttocreateacloudenvironment.--credential_config_idCREDENTIAL_CONFIG_IDProvidecredential_config_idtocreateacloudenvironment.--boot_disk_image_idBOOT_DISK_IMAGE_IDProvideboot_disk_image_idtocreateacloudenvironment.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)create-cloud-env example with all the required arguments passed.yeeduresourcecreate-cloud-env--name="gcp_cloud_env"--cloud_provider_id=0--availability_zone_id=75--network_conf_id=1--cloud_project="modak-nabu"--credential_config_id=1--boot_disk_image_id=1Console output{"cloud_env_id":"1","name":"gcp_cloud_env","description":null,"cloud_provider_id":"0","availability_zone_id":"75","network_conf_id":"1","cloud_project":"modak-yeedu","credential_config_id":"1","boot_disk_image_id":"1","created_by_id":"1","modified_by_id":"1","last_update_date":"2024-01-08T09:07:25.748Z","from_date":"2024-01-08T09:07:25.748Z","to_date":null}list-cloud-envsyeeduresourcelist-cloud-envs-husage:list-cloud-envs[-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}]Providecloud_providertolistalltherelatedcloudenvironmentsofaspecificcloudprovider.--page_numberPAGE_NUMBERTolistcloudenvironmentsforaspecificpage_number.(default:1)--limitLIMITProvidelimittolistnumberofcloudenvironments.(default:100)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list-cloud-envs example with an optional argument passed.yeeduresourcelist-cloud-envs--cloud_provider="GCP"Console output{"data":[{"cloud_env_id":1,"cloud_env_name":"gcp_cloud_env","description":"yeedu cloud environment","cloud_provider":{"cloud_provider_id":0,"name":"gcp","description":"Provider for creating infrastructure on Google Cloud Platform"},"availability_zone":{"availability_zone_id":75,"name":"us-central1-a","region":"us-central1","description":"Council Bluffs, Iowa, North America"},"network_config":{"network_conf_id":1,"name":"yeedu_gcp_network","description":null,"network_project_id":"modak-yeedu","network_name":"modak-yeedu-vpc","network_tags":["yeedu","iap-allow"],"subnet":"custom-subnet-modak-yeedu","availability_zone":{"availability_zone_id":75,"name":"us-central1-a","region":"us-central1","description":"Council Bluffs, Iowa, North America"}},"cloud_project":"modak-yeedu","credential_config":{"credential_conf_id":1,"name":"modakyeedu-svc","description":null,"credential_type":{"credential_type_id":0,"name":"gcp"}},"boot_disk_image":{"boot_disk_image_id":1,"name":"gcp_boot_disk","description":"dev boot disk","linux_distro":{"linux_distro_id":0,"distro_name":"UBUNTU","distro_version":"20.04 LTS"},"boot_disk_image":"ubuntu-os-cloud/ubuntu-2004-lts"},"tenant_id":"1ea17e91-257b-4a6c-82aa-265568d31615","created_by":{"user_id":1,"username":"YSU0000"},"modified_by":{"user_id":1,"username":"YSU0000"},"last_update_date":"2023-12-28T14:06:38.078294+00:00","from_date":"2023-12-28T14:06:38.078294+00:00","to_date":"infinity"}],"result_set":{"current_page":1,"total_objects":1,"total_pages":1,"limit":100}}search-cloud-envsyeeduresourcesearch-cloud-envs-husage:search-cloud-envs[-h]--cloud_env_nameCLOUD_ENV_NAME[--cloud_provider[{GCP,AWS,AZURE}]][--page_numberPAGE_NUMBER][--limitLIMIT][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--cloud_env_nameCLOUD_ENV_NAMEProvidecloud_env_nametosearchmatchingcloudenvironments.--cloud_provider[{GCP,AWS,AZURE}]Providecloud_providertosearchalltherelatedcloudenvironmentsofaspecificcloudprovider.--page_numberPAGE_NUMBERTolistcloudenvironmentsforaspecificpage_number.(default:1)--limitLIMITProvidelimittolistnumberofcloudenvironments.(default:100)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)search-cloud-envs example with required argument '--cloud_env_name' passed.yeeduresourcesearch-cloud-envs--cloud_env_name="gcp_"Console output{"data":[{"cloud_env_id":1,"cloud_env_name":"gcp_cloud_env","description":"yeedu cloud environment","cloud_provider":{"cloud_provider_id":0,"name":"gcp","description":"Provider for creating infrastructure on Google Cloud Platform"},"availability_zone":{"availability_zone_id":75,"name":"us-central1-a","region":"us-central1","description":"Council Bluffs, Iowa, North America"},"network_config":{"network_conf_id":1,"name":"yeedu_gcp_network","description":null,"network_project_id":"modak-yeedu","network_name":"modak-yeedu-vpc","network_tags":["yeedu","iap-allow"],"subnet":"custom-subnet-modak-yeedu","availability_zone":{"availability_zone_id":75,"name":"us-central1-a","region":"us-central1","description":"Council Bluffs, Iowa, North America"}},"cloud_project":"modak-yeedu","credential_config":{"credential_conf_id":1,"name":"modakyeedu-svc","description":null,"credential_type":{"credential_type_id":0,"name":"gcp"}},"boot_disk_image":{"boot_disk_image_id":1,"name":"gcp_boot_disk","description":"dev boot disk","linux_distro":{"linux_distro_id":0,"distro_name":"UBUNTU","distro_version":"20.04 LTS"},"boot_disk_image":"ubuntu-os-cloud/ubuntu-2004-lts"},"tenant_id":"1ea17e91-257b-4a6c-82aa-265568d31615","created_by":{"user_id":1,"username":"YSU0000"},"modified_by":{"user_id":1,"username":"YSU0000"},"last_update_date":"2023-12-28T14:06:38.078294+00:00","from_date":"2023-12-28T14:06:38.078294+00:00","to_date":"infinity"}],"result_set":{"current_page":1,"total_objects":1,"total_pages":1,"limit":100}}get-cloud-envyeeduresourceget-cloud-env-husage:get-cloud-env[-h][--cloud_env_idCLOUD_ENV_ID][--cloud_env_nameCLOUD_ENV_NAME][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--cloud_env_idCLOUD_ENV_IDProvidecloud_env_idtogetdetialsaboutaspecificcloudenvironment.--cloud_env_nameCLOUD_ENV_NAMEProvidecloud_env_nametogetdetialsaboutaspecificcloudenvironment.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)get-cloud-env example with any one of the required argument passed.yeeduresourceget-cloud-env--cloud_env_id=1Console output{"cloud_env_id":1,"cloud_env_name":"gcp_cloud_env","description":"yeedu cloud environment","cloud_provider":{"cloud_provider_id":0,"name":"gcp","description":"Provider for creating infrastructure on Google Cloud Platform"},"availability_zone":{"availability_zone_id":75,"name":"us-central1-a","region":"us-central1","description":"Council Bluffs, Iowa, North America"},"network_config":{"network_conf_id":1,"name":"yeedu_gcp_network","description":null,"network_project_id":"modak-yeedu","network_name":"modak-yeedu-vpc","network_tags":["yeedu","iap-allow"],"subnet":"custom-subnet-modak-yeedu","availability_zone":{"availability_zone_id":75,"name":"us-central1-a","region":"us-central1","description":"Council Bluffs, Iowa, North America"}},"cloud_project":"modak-yeedu","credential_config":{"credential_conf_id":1,"name":"modakyeedu-svc","description":null,"credential_type":{"credential_type_id":0,"name":"gcp"}},"boot_disk_image":{"boot_disk_image_id":1,"name":"gcp_boot_disk","description":"dev boot disk","linux_distro":{"linux_distro_id":0,"distro_name":"UBUNTU","distro_version":"20.04 LTS"},"boot_disk_image":"ubuntu-os-cloud/ubuntu-2004-lts"},"tenant_id":"1ea17e91-257b-4a6c-82aa-265568d31615","created_by":{"user_id":1,"username":"YSU0000"},"modified_by":{"user_id":1,"username":"YSU0000"},"last_update_date":"2023-12-28T14:06:38.078294+00:00","from_date":"2023-12-28T14:06:38.078294+00:00","to_date":"infinity"}edit-cloud-envyeeduresourceedit-cloud-env-husage:edit-cloud-env[-h][--cloud_env_idCLOUD_ENV_ID][--cloud_env_nameCLOUD_ENV_NAME][--nameNAME][--descriptionDESCRIPTION][--availability_zone_idAVAILABILITY_ZONE_ID][--network_conf_idNETWORK_CONF_ID][--cloud_projectCLOUD_PROJECT][--credential_config_idCREDENTIAL_CONFIG_ID][--boot_disk_image_idBOOT_DISK_IMAGE_ID][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--cloud_env_idCLOUD_ENV_IDProvidecloud_env_idtoeditaspecificcloudenvironment.--cloud_env_nameCLOUD_ENV_NAMEProvidecloud_env_nametoeditaspecificcloudenvironment.--nameNAMEProvidenametoeditaspecificcloudenvironment.--descriptionDESCRIPTIONProvidedescriptiontoeditaspecificcloudenvironment.--availability_zone_idAVAILABILITY_ZONE_IDProvideavailability_zone_idtoeditaspecificcloudenvironment.--network_conf_idNETWORK_CONF_IDProvidenetwork_conf_idtoeditaspecificcloudenvironment.--cloud_projectCLOUD_PROJECTProvidecloud_projecttoeditaspecificcloudenvironment.--credential_config_idCREDENTIAL_CONFIG_IDProvidecredential_config_idtoeditaspecificcloudenvironment.--boot_disk_image_idBOOT_DISK_IMAGE_IDProvideboot_disk_image_idtoeditaspecificcloudenvironment.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetoeditoutputinYAMLformat.(default:false)edit-cloud-env example with all the required arguments passed which needs to be updated.yeeduresourceedit-cloud-env--cloud_env_id=1--name="gcp_cloud_env_dev"Console output{"cloud_env_id":"1","name":"gcp_cloud_env_dev","description":null,"cloud_provider_id":"0","availability_zone_id":"75","network_conf_id":"1","cloud_project":"modak-yeedu","credential_config_id":"1","boot_disk_image_id":"1","created_by_id":"1","modified_by_id":"1","last_update_date":"2024-01-08T09:07:25.748Z","from_date":"2024-01-08T09:07:25.748Z","to_date":null}delete-cloud-envyeeduresourcedelete-cloud-env-husage:delete-cloud-env[-h][--cloud_env_idCLOUD_ENV_ID][--cloud_env_nameCLOUD_ENV_NAME][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--cloud_env_idCLOUD_ENV_IDProvidecloud_env_idtodeleteaspecificcloudenvironment.--cloud_env_nameCLOUD_ENV_NAMEProvidecloud_env_nametodeleteaspecificcloudenvironment.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetodeleteoutputinYAMLformat.(default:false)delete-cloud-env example with any one of the required argument passed.yeeduresourcedelete-cloud-env--cloud_env_id=1Console output{"message":"Deleted cloud environment id: 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.search-object-storage-managersTo search 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[--descriptionDESCRIPTION]--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.--descriptionDESCRIPTIONProvidedescriptiontocreate-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_osm"--credentials_conf_id=1--object_storage_bucket_name="modak-yeedu-nabu"Console output{"object_storage_manager_id":"1","name":"yeedu_object_storage_manager","description":null,"credentials_conf_id":"1","object_storage_bucket_name":"modak-yeedu-nabu","tenant_id":"1ea17e91-257b-4a6c-82aa-265568d31615","created_by_id":"1","modified_by_id":"1","last_update_date":"2024-01-08T09:32:24.643Z","from_date":"2024-01-08T09:32:24.643Z","to_date":null}list-object-storage-managersyeeduresourcelist-object-storage-managers-husage:list-object-storage-managers[-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_NUMBERTolistObjectStorageManagersforaspecificpage_number.(default:1)--limitLIMITProvidelimittolistnumberofObjectStorageManagers.(default:100)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list-object-storage-managers example with an optional argument passed.yeeduresourcelist-object-storage-managers--cloud_provider="GCP"Console output{"data":[{"object_storage_manager_id":1,"object_storage_manager_name":"yeedu_object_storage_manager","description":null,"object_storage_bucket_name":"modak-yeedu-nabu","credentials_config":{"credentials_conf_id":1,"description":null,"name":"modakyeedu-svc","credential_type":{"credential_type_id":0,"name":"gcp","cloud_provider":{"name":"gcp","description":"Provider for creating infrastructure on Google Cloud Platform"}}},"tenant_id":"1ea17e91-257b-4a6c-82aa-265568d31615","created_by":{"user_id":1,"username":"YSU0000"},"modified_by":{"user_id":1,"username":"YSU0000"},"last_update_date":"2024-01-04T09:11:38.51+00:00","from_date":"2023-12-28T14:05:05.328617+00:00","to_date":"infinity"}],"result_set":{"current_page":1,"total_objects":1,"total_pages":1,"limit":100}}search-object-storage-managersyeeduresourcesearch-object-storage-managers-husage:search-object-storage-managers[-h]--object_storage_manager_nameOBJECT_STORAGE_MANAGER_NAME[--cloud_provider[{GCP,AWS,AZURE}]][--page_numberPAGE_NUMBER][--limitLIMIT][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--object_storage_manager_nameOBJECT_STORAGE_MANAGER_NAMEProvideObjectStorageManagerNametosearchinformationaboutaspecificObjectStorageManager.--cloud_provider[{GCP,AWS,AZURE}]CloudProviderthatwillbeusedforfilteringlist.--page_numberPAGE_NUMBERTosearchObjectStorageManagersforaspecificpage_number.(default:1)--limitLIMITProvidelimittosearchnumberofObjectStorageManagers.(default:100)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)search-object-storage-managers example with required argument '--object_storage_manager_name' passed.yeeduresourcesearch-object-storage-managers--object_storage_manager_name="gcp_"Console output{"data":[{"object_storage_manager_id":1,"object_storage_manager_name":"yeedu_object_storage_manager","description":null,"object_storage_bucket_name":"modak-yeedu-nabu","credentials_config":{"credentials_conf_id":1,"description":null,"name":"modakyeedu-svc","credential_type":{"credential_type_id":0,"name":"gcp","cloud_provider":{"name":"gcp","description":"Provider for creating infrastructure on Google Cloud Platform"}}},"tenant_id":"1ea17e91-257b-4a6c-82aa-265568d31615","created_by":{"user_id":1,"username":"YSU0000"},"modified_by":{"user_id":1,"username":"YSU0000"},"last_update_date":"2024-01-04T09:11:38.51+00:00","from_date":"2023-12-28T14:05:05.328617+00:00","to_date":"infinity"}],"result_set":{"current_page":1,"total_objects":1,"total_pages":1,"limit":100}}get-object-storage-manageryeeduresourceget-object-storage-manager-husage:get-object-storage-manager[-h][--object_storage_manager_idOBJECT_STORAGE_MANAGER_ID][--object_storage_manager_nameOBJECT_STORAGE_MANAGER_NAME][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--object_storage_manager_idOBJECT_STORAGE_MANAGER_IDProvideObjectStorageManagerIdtogetinformationaboutaspecificObjectStorageManager.--object_storage_manager_nameOBJECT_STORAGE_MANAGER_NAMEProvideObjectStorageManagerNametogetinformationaboutaspecificObjectStorageManager.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)get-object-storage-manager example with any one of the required argument passed.yeeduresourceget-object-storage-manager--object_storage_manager_id=1Console output{"object_storage_manager_id":1,"object_storage_manager_name":"yeedu_object_storage_manager","description":null,"object_storage_bucket_name":"modak-yeedu-nabu","credentials_config":{"credentials_conf_id":1,"description":null,"name":"modakyeedu-svc","credential_type":{"credential_type_id":0,"name":"gcp","cloud_provider":{"name":"gcp","description":"Provider for creating infrastructure on Google Cloud Platform"}}},"tenant_id":"1ea17e91-257b-4a6c-82aa-265568d31615","created_by":{"user_id":1,"username":"YSU0000"},"modified_by":{"user_id":1,"username":"YSU0000"},"last_update_date":"2024-01-04T09:11:38.51+00:00","from_date":"2023-12-28T14:05:05.328617+00:00","to_date":"infinity"}edit-object-storage-manageryeeduresourceedit-object-storage-manager-husage:edit-object-storage-manager[-h][--object_storage_manager_idOBJECT_STORAGE_MANAGER_ID][--object_storage_manager_nameOBJECT_STORAGE_MANAGER_NAME][--nameNAME][--descriptionDESCRIPTION][--credentials_conf_idCREDENTIALS_CONF_ID][--object_storage_bucket_nameOBJECT_STORAGE_BUCKET_NAME][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--object_storage_manager_idOBJECT_STORAGE_MANAGER_IDProvideobject_storage_manager_idtoeditinformationaboutaspecificObjectStorageManager.--object_storage_manager_nameOBJECT_STORAGE_MANAGER_NAMEProvideobject_storage_manager_nametoeditinformationaboutaspecificObjectStorageManager.--nameNAMEProvidenametoedit-object-storage-manager.--descriptionDESCRIPTIONProvidedescriptiontoedit-object-storage-manager.--credentials_conf_idCREDENTIALS_CONF_IDProvidecredentials_conf_idtoedit-object-storage-manager.--object_storage_bucket_nameOBJECT_STORAGE_BUCKET_NAMEProvideobject_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--name="yeedu_object_storage_manager"Console output{"object_storage_manager_id":"1","name":"yeedu_object_storage_manager","description":null,"credentials_conf_id":"1","object_storage_bucket_name":"modak-yeedu-nabu","tenant_id":"1ea17e91-257b-4a6c-82aa-265568d31615","created_by_id":"1","modified_by_id":"1","last_update_date":"2024-01-08T09:32:24.643Z","from_date":"2024-01-08T09:32:24.643Z","to_date":null}delete-object-storage-manageryeeduresourcedelete-object-storage-manager-husage:delete-object-storage-manager[-h][--object_storage_manager_idOBJECT_STORAGE_MANAGER_ID][--object_storage_manager_nameOBJECT_STORAGE_MANAGER_NAME][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--object_storage_manager_idOBJECT_STORAGE_MANAGER_IDProvideobject_storage_manager_idtodeleteaspecificObjectStorageManager.--object_storage_manager_nameOBJECT_STORAGE_MANAGER_NAMEProvideobject_storage_manager_nametodeleteaspecificObjectStorageManager.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)delete-object-storage-manager example with any one of the required argument passed.yeeduresourcedelete-object-storage-manager--object_storage_manager_name="yeedu_object_storage_manager"Console output{"message":"Deleted Object Storage Manager Configuration Name: 'yeedu_object_storage_manager'."}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.search-object-storage-manager-filesTo search 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][--object_storage_manager_nameOBJECT_STORAGE_MANAGER_NAME]--local_file_pathLOCAL_FILE_PATH[--cluster_idCLUSTER_ID][--cluster_nameCLUSTER_NAME][--overwrite[{true,false}]][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--object_storage_manager_idOBJECT_STORAGE_MANAGER_IDProvideObjectStorageManagerIdtocreate-object-storage-manager-file.--object_storage_manager_nameOBJECT_STORAGE_MANAGER_NAMEProvideObjectStorageManagerNametotocreate-object-storage-manager-file.--local_file_pathLOCAL_FILE_PATHProvidelocal_file_pathtocreate-object-storage-manager-file.--cluster_idCLUSTER_IDProvideClusterInstanceId[OPTIONAL]tocheckpermissionsbeforecreate-object-storage-manager-file.--cluster_nameCLUSTER_NAMEProvideClusterInstanceName[OPTIONAL]tocheckpermissionsbeforecreate-object-storage-manager-file.--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/Downloads/spark-examples_2.12-3.2.2.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","tenant_id":"1ea17e91-257b-4a6c-82aa-265568d31615","created_by_id":"1","modified_by_id":"1","last_update_date":"2024-01-08T09:58:48.760Z","from_date":"2024-01-08T09:58:48.760Z","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][--object_storage_manager_nameOBJECT_STORAGE_MANAGER_NAME][--page_numberPAGE_NUMBER][--limitLIMIT][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--object_storage_manager_idOBJECT_STORAGE_MANAGER_IDProvideObjectStorageManagerIdtolistalltheavailableObjectStorageManagerFiles.--object_storage_manager_nameOBJECT_STORAGE_MANAGER_NAMEProvideObjectStorageManagerNametolistalltheavailableObjectStorageManagerFiles.--page_numberPAGE_NUMBERTolistObjectStorageManagerFilesforaspecificpage_number.(default:1)--limitLIMITProvidelimittolistnumberofObjectStorageManagerFiles.(default:100)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list-object-storage-manager-files example with any one of the required argument passed.yeeduresourcelist-object-storage-manager-files--object_storage_manager_name="yeedu_object_storage_manager"Console output{"data":[{"object_storage_manager_file_id":1,"object_storage_manager":{"object_storage_manager_id":1,"object_storage_manager_name":"yeedu_object_storage_manager","description":null,"credentials_config":{"credential_config_id":1,"name":"modak-yeedu-svc","description":null,"credential_type":{"name":"gcp","description":"Provider for creating infrastructure on Google Cloud Platform"}},"object_storage_bucket_name":"modak-yeedu-nabu"},"file_name":"spark-examples_2.12-3.2.2.jar","full_file_path":"file:///yeedu/object-storage-manager/spark-examples_2.12-3.2.2.jar","file_size_bytes":"1560870","file_type":"jar","tenant_id":"1ea17e91-257b-4a6c-82aa-265568d31615","created_by":{"user_id":1,"username":"YSU0000"},"modified_by":{"user_id":1,"username":"YSU0000"},"last_update_date":"2024-01-08T09:58:48.760362+00:00","from_date":"2024-01-08T09:58:48.760362+00:00","to_date":"infinity"}],"result_set":{"current_page":1,"total_objects":1,"total_pages":1,"limit":100}}search-object-storage-manager-filesyeeduresourcesearch-object-storage-manager-files-husage:search-object-storage-manager-files[-h]--file_nameFILE_NAME[--object_storage_manager_idOBJECT_STORAGE_MANAGER_ID][--object_storage_manager_nameOBJECT_STORAGE_MANAGER_NAME][--page_numberPAGE_NUMBER][--limitLIMIT][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--file_nameFILE_NAMEProvideFileNametosearchalltheavailableObjectStorageManagerFiles.--object_storage_manager_idOBJECT_STORAGE_MANAGER_IDProvideObjectStorageManagerIdtosearchalltheavailableObjectStorageManagerFiles.--object_storage_manager_nameOBJECT_STORAGE_MANAGER_NAMEProvideObjectStorageManagerNametosearchalltheavailableObjectStorageManagerFiles.--page_numberPAGE_NUMBERTosearchObjectStorageManagerFilesforaspecificpage_number.(default:1)--limitLIMITProvidelimittosearchnumberofObjectStorageManagerFiles.(default:100)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)search-object-storage-manager-files example with any one of the required argument passed.yeeduresourcesearch-object-storage-manager-files--object_storage_manager_name="yeedu_object_storage_manager"--file_name="spark-examples_"Console output{"data":[{"object_storage_manager_file_id":1,"object_storage_manager":{"object_storage_manager_id":1,"object_storage_manager_name":"yeedu_object_storage_manager","description":null,"credentials_config":{"credential_config_id":1,"name":"modak-yeedu-svc","description":null,"credential_type":{"name":"gcp","description":"Provider for creating infrastructure on Google Cloud Platform"}},"object_storage_bucket_name":"modak-yeedu-nabu"},"file_name":"spark-examples_2.12-3.2.2.jar","full_file_path":"file:///yeedu/object-storage-manager/spark-examples_2.12-3.2.2.jar","file_size_bytes":"1560870","file_type":"jar","tenant_id":"1ea17e91-257b-4a6c-82aa-265568d31615","created_by":{"user_id":1,"username":"YSU0000"},"modified_by":{"user_id":1,"username":"YSU0000"},"last_update_date":"2024-01-08T09:58:48.760362+00:00","from_date":"2024-01-08T09:58:48.760362+00:00","to_date":"infinity"}],"result_set":{"current_page":1,"total_objects":1,"total_pages":1,"limit":100}}get-object-storage-manager-fileyeeduresourceget-object-storage-manager-file-husage:get-object-storage-manager-file[-h][--object_storage_manager_idOBJECT_STORAGE_MANAGER_ID][--object_storage_manager_nameOBJECT_STORAGE_MANAGER_NAME][--file_idFILE_ID][--file_nameFILE_NAME][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--object_storage_manager_idOBJECT_STORAGE_MANAGER_IDProvideObjectStorageManagerIdtogetinformationaboutaspecificObjectStorageManagerFiles.--object_storage_manager_nameOBJECT_STORAGE_MANAGER_NAMEProvideObjectStorageManagerNametogetinformationaboutaspecificObjectStorageManagerFiles.--file_idFILE_IDProvideFileIdtogetinformationaboutaspecificObjectStorageManagerFiles.--file_nameFILE_NAMEProvideFileNametogetinformationaboutaspecificObjectStorageManagerFiles.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)get-object-storage-manager-file example with any one of 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_manager_name":"yeedu_object_storage_manager","description":null,"credentials_config":{"credential_config_id":1,"name":"modak-yeedu-svc","description":null,"credential_type":{"name":"gcp","description":"Provider for creating infrastructure on Google Cloud Platform"}},"object_storage_bucket_name":"modak-yeedu-nabu"},"file_name":"spark-examples_2.12-3.2.2.jar","full_file_path":"file:///yeedu/object-storage-manager/spark-examples_2.12-3.2.2.jar","file_size_bytes":"1560870","file_type":"jar","tenant_id":"1ea17e91-257b-4a6c-82aa-265568d31615","created_by":{"user_id":1,"username":"YSU0000"},"modified_by":{"user_id":1,"username":"YSU0000"},"last_update_date":"2024-01-08T09:58:48.760362+00:00","from_date":"2024-01-08T09:58:48.760362+00:00","to_date":"infinity"}delete-object-storage-manager-fileyeeduresourcedelete-object-storage-manager-file-husage:delete-object-storage-manager-file[-h][--object_storage_manager_idOBJECT_STORAGE_MANAGER_ID][--object_storage_manager_nameOBJECT_STORAGE_MANAGER_NAME][--file_idFILE_ID][--file_nameFILE_NAME][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--object_storage_manager_idOBJECT_STORAGE_MANAGER_IDProvideObjectStorageManagerIdtodeleteaspecificObjectStorageManagerFile.--object_storage_manager_nameOBJECT_STORAGE_MANAGER_NAMEProvideObjectStorageManagerNametodeleteaspecificObjectStorageManagerFile.--file_idFILE_IDProvideFileIdtodeleteaspecificObjectStorageManagerFiles.--file_nameFILE_NAMEProvideFileNametodeleteaspecificObjectStorageManagerFiles.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)delete-object-storage-manager-file example with any one of the required arguments passed.yeeduresourcedelete-object-storage-manager-file--object_storage_manager_id=1--file_id=1Console output{"message":"The File: 'spark-examples_2.12-3.2.2.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.search-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]--nameNAME[--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--nameNAMEProvidenametocreate-hive-metastore-conf.--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--name="yeedu_hive_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","name":"yeedu_hive_conf","tenant_id":"e67f00ad-68aa-46d0-b32e-f3f8dac5427d","created_by_id":"1","modified_by_id":"1","last_update_date":"2023-09-29T07:37:52.309Z","from_date":"2023-09-29T07:37:52.309Z","to_date":null}list-hive-metastore-confsyeeduresourcelist-hive-metastore-confs-husage:list-hive-metastore-confs[-h][--page_numberPAGE_NUMBER][--limitLIMIT][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--page_numberPAGE_NUMBERTolistHiveMetastoreConfigurationsforaspecificpage_number.(default:1)--limitLIMITProvidelimittolistnumberofHiveMetastoreConfigurations.(default:100)--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 the output format.yeeduresourcelist-hive-metastore-confsConsole output{"data":[{"hive_metastore_conf_id":1,"hive_metastore_conf_name":"yeedu_hive_conf","tenant_id":"e67f00ad-68aa-46d0-b32e-f3f8dac5427d","created_by":{"user_id":1,"username":"YSU0000"},"modified_by":{"user_id":1,"username":"YSU0000"},"last_update_date":"2023-09-29T07:37:52.309654+00:00","from_date":"2023-09-29T07:37:52.309654+00:00","to_date":"infinity"}],"result_set":{"current_page":1,"total_objects":1,"total_pages":1,"limit":100}}search-hive-metastore-confsyeeduresourcesearch-hive-metastore-confs-husage:search-hive-metastore-confs[-h]--hive_metastore_conf_nameHIVE_METASTORE_CONF_NAME[--page_numberPAGE_NUMBER][--limitLIMIT][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--hive_metastore_conf_nameHIVE_METASTORE_CONF_NAMEProvidehive_metastore_conf_nametosearchinformationaboutHiveMetastoreConfigurations.--page_numberPAGE_NUMBERTosearchHiveMetastoreConfigurationsforaspecificpage_number.(default:1)--limitLIMITProvidelimittosearchnumberofHiveMetastoreConfigurations.(default:100)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)search-hive-metastore-confs example with required argument '--hive_metastore_conf_name' passed.yeeduresourcesearch-hive-metastore-confs--hive_metastore_conf_name="yeedu_"Console output{"data":[{"hive_metastore_conf_id":1,"hive_metastore_conf_name":"yeedu_hive_conf","tenant_id":"e67f00ad-68aa-46d0-b32e-f3f8dac5427d","created_by":{"user_id":1,"username":"YSU0000"},"modified_by":{"user_id":1,"username":"YSU0000"},"last_update_date":"2023-09-29T07:37:52.309654+00:00","from_date":"2023-09-29T07:37:52.309654+00:00","to_date":"infinity"}],"result_set":{"current_page":1,"total_objects":1,"total_pages":1,"limit":100}}get-hive-metastore-confyeeduresourceget-hive-metastore-conf-husage:get-hive-metastore-conf[-h][--hive_metastore_conf_idHIVE_METASTORE_CONF_ID][--hive_metastore_conf_nameHIVE_METASTORE_CONF_NAME][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--hive_metastore_conf_idHIVE_METASTORE_CONF_IDProvidehive_metastore_conf_idtogetinformationaboutaspecificHiveMetastoreConfiguration.--hive_metastore_conf_nameHIVE_METASTORE_CONF_NAMEProvidehive_metastore_conf_nametogetinformationaboutaspecificHiveMetastoreConfiguration.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)get-hive-metastore-conf example with any one of the required '--hive_metastore_conf_id' argument passed.yeeduresourceget-hive-metastore-conf--hive_metastore_conf_id=1Console output{"hive_metastore_conf_id":1,"hive_metastore_conf_name":"yeedu_hive_conf","tenant_id":"e67f00ad-68aa-46d0-b32e-f3f8dac5427d","created_by":{"user_id":1,"username":"YSU0000"},"modified_by":{"user_id":1,"username":"YSU0000"},"last_update_date":"2023-09-29T07:37:52.309654+00:00","from_date":"2023-09-29T07:37:52.309654+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_metastore_conf_nameHIVE_METASTORE_CONF_NAME][--nameNAME][--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_metastore_conf_nameHIVE_METASTORE_CONF_NAMEProvideaspecifichive_metastore_conf_nametoedit-hive-metastore-conf.--nameNAMEProvidenametoedit-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 any one of 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","hive_metastore_conf_name":"yeedu_hive_conf","tenant_id":"e67f00ad-68aa-46d0-b32e-f3f8dac5427d","created_by_id":"1","modified_by_id":"1","last_update_date":"2023-09-29T07:46:42.929Z","from_date":"2023-09-29T07:37:52.309Z","to_date":null}delete-hive-metastore-confyeeduresourcedelete-hive-metastore-conf-husage:delete-hive-metastore-conf[-h][--hive_metastore_conf_idHIVE_METASTORE_CONF_ID][--hive_metastore_conf_nameHIVE_METASTORE_CONF_NAME][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--hive_metastore_conf_idHIVE_METASTORE_CONF_IDProvidehive_metastore_conf_idtodeleteaspecificHiveMetastoreConfiguration.--hive_metastore_conf_nameHIVE_METASTORE_CONF_NAMEProvidehive_metastore_conf_nametodeleteaspecificHiveMetastoreConfiguration.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)delete-hive-metastore-conf example with any one of the required argument '--hive_metastore_conf_id' passed.yeeduresourcedelete-hive-metastore-conf--hive_metastore_conf_id=1Console output{"message":"Deleted Hive Metastore Configuration Id: 1"}ClusterCluster ConfigurationCommand NameUtilitycreate-confTo create the Cluster Configuration.list-confsTo list all the available Cluster Configurations.search-confsTo search all the available Cluster Configurations.get-confTo get the information about a specific Cluster Configuration.edit-confTo edit a specific Cluster Configuration.delete-confTo delete a specific Cluster Configuration.create-confyeeduclustercreate-conf-husage:create-conf[-h]--nameNAME[--descriptionDESCRIPTION]--machine_type_category_idMACHINE_TYPE_CATEGORY_ID--machine_type_idMACHINE_TYPE_ID--volume_conf_idVOLUME_CONF_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--nameNAMEProvidenametocreate-conf.--descriptionDESCRIPTIONProvidedescriptiontocreate-conf.--machine_type_category_idMACHINE_TYPE_CATEGORY_IDProvidemachine_category_type_idtocreate_cluster_conf.--machine_type_idMACHINE_TYPE_IDProvidemachine_type_idtocreate_cluster_conf.--volume_conf_idVOLUME_CONF_IDProvidevolume_conf_idtocreate_cluster_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_config"--description="Cluster Configurations test"--machine_type_id=64--machine_type_category_id=2--volume_conf_id=1Console output{"cluster_conf_id":"1","name":"yeedu_cluster_config","description":"Cluster Configurations test","machine_type_category_id":"2","machine_type_id":"64","volume_conf_id":"1","created_by_id":"1","modified_by_id":"1","last_update_date":"2023-09-29T07:51:12.575Z","from_date":"2023-09-29T07:51:12.575Z","to_date":null}list-confsyeeduclusterlist-confs-husage:list-confs[-h][--cloud_provider[{GCP,AWS,AZURE}]][--compute_type[{compute_optimized,memory_optimized,general_purpose,gpu_accelerated}]][--page_numberPAGE_NUMBER][--limitLIMIT][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--cloud_provider[{GCP,AWS,AZURE}]Providespecificcloud_provider_idtogetinformationaboutrelatedClusterConfiguration.--compute_type[{compute_optimized,memory_optimized,general_purpose,gpu_accelerated}]Providespecificcompute_typetogetinformationaboutrelatedClusterConfiguration.--page_numberPAGE_NUMBERTolistClusterConfigurationforaspecificpage_number.(default:1)--limitLIMITProvidelimittolistnumberofClusterConfiguration.(default:100)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list-confs example with optional arguments passed.yeeduclusterlist-confs--cloud_provider="GCP"--limit=1Console output{"data":[{"cluster_conf_id":1,"cluster_conf_name":"yeedu_cluster_config","description":"Cluster Configurations test","machine_type_category":"general_purpose","machine_type":{"machine_type_id":64,"name":"n1-standard-4","vcpus":4,"memory":"15 GiB","has_cuda":false,"gpu_model":null,"gpus":null,"gpu_memory":null,"cloud_provider":{"cloud_provider_id":0,"name":"gcp"}},"machine_volume_conf":{"volume_conf_id":1,"name":"volume_gcp_1","encrypted":true,"size":375,"disk_type":{"disk_type_id":4,"name":"local-ssd","has_fixed_size":true,"min_size":375,"max_size":375,"cloud_provider":{"cloud_provider_id":0,"name":"gcp"}},"machine_volume_num":1,"machine_volume_strip_num":1},"disk_num":1,"disk_size":375,"machine_price_ycu":2.17,"created_by":{"user_id":1,"username":"YSU0000"},"modified_by":{"user_id":1,"username":"YSU0000"},"last_update_date":"2024-01-08T10:20:19.399039+00:00","from_date":"2024-01-08T10:20:19.399039+00:00","to_date":"infinity"}],"result_set":{"current_page":1,"total_objects":1,"total_pages":1,"limit":1}}search-confsyeeduclustersearch-confs-husage:search-confs[-h]--cluster_conf_nameCLUSTER_CONF_NAME[--compute_type{compute_optimized,memory_optimized,general_purpose,gpu_accelerated}][--cloud_provider[{GCP,AWS,AZURE}]][--page_numberPAGE_NUMBER][--limitLIMIT][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--cluster_conf_nameCLUSTER_CONF_NAMEProvideClusterConfigNametosearchClusterConfigurations.--compute_type{compute_optimized,memory_optimized,general_purpose,gpu_accelerated}ProvidespecificcomputetypetosearchinformationaboutrelatedClusterConfiguration.--cloud_provider[{GCP,AWS,AZURE}]Providespecificcloud_provider_idtosearchinformationaboutrelatedClusterConfiguration.--page_numberPAGE_NUMBERTosearchClusterConfigurationforaspecificpage_number.(default:1)--limitLIMITProvidelimittosearchnumberofClusterConfiguration.(default:100)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)search-confs example with required argument '--cluster_conf_name' passed.yeeduclustersearch-confs--cluster_conf_name="yeedu_"Console output{"data":[{"cluster_conf_id":1,"cluster_conf_name":"yeedu_cluster_config","description":"Cluster Configurations test","machine_type_category":"general_purpose","machine_type":{"machine_type_id":64,"name":"n1-standard-4","vcpus":4,"memory":"15 GiB","has_cuda":false,"gpu_model":null,"gpus":null,"gpu_memory":null,"cloud_provider":{"cloud_provider_id":0,"name":"gcp"}},"machine_volume_conf":{"volume_conf_id":1,"name":"volume_gcp_1","encrypted":true,"size":375,"disk_type":{"disk_type_id":4,"name":"local-ssd","has_fixed_size":true,"min_size":375,"max_size":375,"cloud_provider":{"cloud_provider_id":0,"name":"gcp"}},"machine_volume_num":1,"machine_volume_strip_num":1},"disk_num":1,"disk_size":375,"machine_price_ycu":2.17,"created_by":{"user_id":1,"username":"YSU0000"},"modified_by":{"user_id":1,"username":"YSU0000"},"last_update_date":"2024-01-08T10:20:19.399039+00:00","from_date":"2024-01-08T10:20:19.399039+00:00","to_date":"infinity"}],"result_set":{"current_page":1,"total_objects":1,"total_pages":1,"limit":1}}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_IDProvideClusterConfigIdtogetinformationaboutaspecificClusterConfiguration.--cluster_conf_nameCLUSTER_CONF_NAMEProvideClusterConfigNametogetinformationaboutaspecificClusterConfiguration.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)get-conf example with any one of the required argument '--cluster_conf_id' passed.yeeduclusterget-conf--cluster_conf_id=1Console output{"cluster_conf_id":1,"cluster_conf_name":"yeedu_cluster_config","description":"Cluster Configurations test","machine_type_category":"general_purpose","machine_type":{"machine_type_id":64,"name":"n1-standard-4","vcpus":4,"memory":"15 GiB","has_cuda":false,"gpu_model":null,"gpus":null,"gpu_memory":null,"cloud_provider":{"cloud_provider_id":0,"name":"gcp"}},"machine_volume_conf":{"volume_conf_id":1,"name":"volume_gcp_1","encrypted":true,"size":375,"disk_type":{"disk_type_id":4,"name":"local-ssd","has_fixed_size":true,"min_size":375,"max_size":375,"cloud_provider":{"cloud_provider_id":0,"name":"gcp"}},"machine_volume_num":1,"machine_volume_strip_num":1},"disk_num":1,"disk_size":375,"machine_price_ycu":2.17,"created_by":{"user_id":1,"username":"YSU0000"},"modified_by":{"user_id":1,"username":"YSU0000"},"last_update_date":"2024-01-08T10:20:19.399039+00:00","from_date":"2024-01-08T10:20:19.399039+00:00","to_date":"infinity"}edit-confyeeduclusteredit-conf-husage:edit-conf[-h][--cluster_conf_idCLUSTER_CONF_ID][--cluster_conf_nameCLUSTER_CONF_NAME][--name[NAME]][--description[DESCRIPTION]][--machine_type_category_idMACHINE_TYPE_CATEGORY_ID][--machine_type_idMACHINE_TYPE_ID][--volume_conf_idVOLUME_CONF_ID][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--cluster_conf_idCLUSTER_CONF_IDProvideaspecificClusterConfigIdtoedit-conf.--cluster_conf_nameCLUSTER_CONF_NAMEProvideaspecificClusterConfigNametoedit-conf.--name[NAME]Providenametoedit-conf.--description[DESCRIPTION]Providedescriptiontoedit-conf.--machine_type_category_idMACHINE_TYPE_CATEGORY_IDProvidemachine_type_category_idtoedit-conf.--machine_type_idMACHINE_TYPE_IDProvidemachine_type_idtoedit-conf.--volume_conf_idVOLUME_CONF_IDProvidevolume_conf_idtoedit-conf.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)edit-conf example with any one of the required argument '--cluster_conf_id' and other optional argument is passed which is to be updated.yeeduclusteredit-conf--cluster_conf_id=1--description="Yeedu General Purpose Configuration"Console output{"cluster_conf_id":"1","name":"yeedu_cluster_config","description":"Yeedu General Purpose Configuration","machine_type_category_id":"2","machine_type_id":"64","volume_conf_id":"1","created_by_id":"1","modified_by_id":"1","last_update_date":"2024-01-08T10:27:07.773Z","from_date":"2024-01-08T10:20:19.399Z","to_date":null}delete-confyeeduclusterdelete-conf-husage:delete-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_IDProvideClusterConfigIdtodeleteaspecificClusterConfiguration.--cluster_conf_nameCLUSTER_CONF_NAMEProvideClusterConfigNametodeleteaspecificClusterConfiguration.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)delete-conf example with any one of the required argument passed.yeeduclusterdelete-conf--cluster_conf_name="yeedu_cluster_config"Console output{"message":"Deleted Cluster Config Name: 'yeedu_cluster_config'"}Cluster InstanceCommand NameUtilitycreateTo create the Cluster Instance.listTo list all the available Cluster Instances.searchTo search cluster instances by cluster name.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 a Cluster Instance.list-statusTo list status events of Cluster Instances.logsTo download Cluster Instance logs for a specific Cluster Instancecreateyeeduclustercreate-husage:create[-h]--name[NAME][--descriptionDESCRIPTION]--idle_timeout_ms[IDLE_TIMEOUT_MS][--auto_shutdown[{true,false}]][--labelsLABELS[LABELS...]][--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]--cloud_env_idCLOUD_ENV_ID--object_storage_manager_idOBJECT_STORAGE_MANAGER_ID[--confCONF[CONF...]][--packages[PACKAGES]][--repositories[REPOSITORIES]][--jars[JARS]][--archives[ARCHIVES]][--env_varENV_VAR[ENV_VAR...]][--conf_secretCONF_SECRET[CONF_SECRET...]][--env_var_secretENV_VAR_SECRET[ENV_VAR_SECRET...]][--hive_metastore_conf_id[HIVE_METASTORE_CONF_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_type[YEEDU,STANDALONE,CLUSTER]--min_instancesMIN_INSTANCES--max_instancesMAX_INSTANCES--cluster_conf_idCLUSTER_CONF_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--name[NAME]Providenametocreateaclusterinstance.--descriptionDESCRIPTIONProvidedescriptiontocreateaclusterinstance.--idle_timeout_ms[IDLE_TIMEOUT_MS]Provideidle_timeout_mstocreateaclusterinstance.--auto_shutdown[{true,false}]Provideauto_shutdowntocreateaclusterinstance.(default:true)--labelsLABELS[LABELS...]Providelabelstocreateaclusterinstance.--is_spot_instance[{true,false}]Provideis_spot_instancetocreateaclusterinstance.(default:false)--enable_public_ip[{true,false}]Provideenable_public_iptocreateaclusterinstance.(default:false)--block_project_ssh_keys[{true,false}]Provideblock_project_ssh_keystocreateaclusterinstance.(default:true)--bootstrap_shell_script_file_pathBOOTSTRAP_SHELL_SCRIPT_FILE_PATHProvidebootstrap_shell_script_file_pathtocreateaclusterinstance.--cloud_env_idCLOUD_ENV_IDProvidecloud_env_idtocreateaclusterinstance.--object_storage_manager_idOBJECT_STORAGE_MANAGER_IDProvideobject_storage_manager_idtocreateaclusterinstance.--confCONF[CONF...]Provideconftocreateaclusterinstance.--packages[PACKAGES]Providepackagestocreateaclusterinstance.--repositories[REPOSITORIES]Providerepositoriestocreateaclusterinstance.--jars[JARS]Providejarstocreateaclusterinstance.--archives[ARCHIVES]Providearchivestocreateaclusterinstance.--env_varENV_VAR[ENV_VAR...]Provideenv_vartocreateaclusterinstance.--conf_secretCONF_SECRET[CONF_SECRET...]Provideconf_secrettocreateaclusterinstance.--env_var_secretENV_VAR_SECRET[ENV_VAR_SECRET...]Provideenv_var_secrettocreateaclusterinstance.--hive_metastore_conf_id[HIVE_METASTORE_CONF_ID]Providehive_metastore_conf_idtocreateaclusterinstance.--spark_infra_version_idSPARK_INFRA_VERSION_IDProvidespark_infra_version_idtocreateaclusterinstance.--max_parallel_spark_job_execution_per_instance[MAX_PARALLEL_SPARK_JOB_EXECUTION_PER_INSTANCE]Providemax_parallel_spark_job_execution_per_instancetocreateaclusterinstance.(default:5)--standalone_workers_number[STANDALONE_WORKERS_NUMBER]Providestandalone_workers_numbertocreateaclusterinstance.--cluster_type[YEEDU,STANDALONE,CLUSTER]Providecluster_typetocreateaclusterinstance.--min_instancesMIN_INSTANCESProvidemin_instancestocreateaclusterinstance.--max_instancesMAX_INSTANCESProvidemax_instancestocreateaclusterinstance.--cluster_conf_idCLUSTER_CONF_IDProvidecluster_conf_idtocreateaclusterinstance.--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--name="yeedu_cluster_instance"--description="Yeedu Instance"--idle_timeout_ms=600000--auto_shutdown=true--labels="env=test"--is_spot_instance=false--enable_public_ip=true--block_project_ssh_keys=true--object_storage_manager_id=1--cloud_env_id=1--spark_infra_version_id=2--max_parallel_spark_job_execution_per_instance=5--cluster_type="YEEDU"--min_instances=1--max_instances=1--cluster_conf_id=1Console output{"cluster_id":"1","name":"yeedu_cluster_instance","description":"Yeedu Instance","cloud_env_id":1,"idle_timeout_ms":"600000","auto_shutdown":true,"labels":{"env":"test","resource":"yeedu","vm":"yeedu_node","tenant_id":"1ea17e91-257b-4a6c-82aa-265568d31615"},"is_spot_instance":false,"enable_public_ip":true,"block_project_ssh_keys":true,"bootstrap_shell_script":null,"object_storage_manager_id":"1","cluster_conf_id":"1","spark_config_id":null,"hive_metastore_conf_id":null,"spark_infra_version_id":"2","engine_cluster_spark_config":{"max_parallel_spark_job_execution_per_instance":5},"cluster_type":"YEEDU","min_instances":1,"max_instances":1,"tenant_id":"1ea17e91-257b-4a6c-82aa-265568d31615","created_by_id":"1","modified_by_id":"1","last_update_date":"2024-01-08T10:44:07.650Z","from_date":"2024-01-08T10:44:07.650Z","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 with all the optional arguments passed.yeeduclusterlist--cluster_status="RUNNING"--limit=1Console output{"data":[{"cluster_id":1,"name":"yeedu_cluster_instance","description":"Yeedu Instance","labels":{"env":"test","resource":"yeedu","vm":"yeedu_node","tenant_id":"1ea17e91-257b-4a6c-82aa-265568d31615"},"idle_timeout_ms":600000,"auto_shutdown":true,"cluster_status":"RUNNING","cluster_type":"YEEDU","compute_engine_id":3,"instance_size":1,"is_spot_instance":false,"enable_public_ip":true,"block_project_ssh_keys":true,"min_instances":1,"max_instances":1,"total_ycu":null,"bootstrap_shell_script":null,"spark_config_id":null,"cluster_conf":{"cluster_conf_id":1,"cluster_conf_name":"n1-standard-4","description":null,"machine_type_category":"general_purpose","machine_type":{"machine_type_id":64,"name":"n1-standard-4","vcpus":4,"memory":"15 GiB","has_cuda":false,"gpu_model":null,"gpus":null,"gpu_memory":null},"machine_volume_conf":{"volume_conf_id":1,"name":"volume_gcp_1","description":null,"encrypted":true,"size":375,"disk_machine_type":{"disk_machine_type_id":4,"cloud_provider_id":0,"name":"local-ssd","has_fixed_size":true,"min_size":375,"max_size":375},"machine_volume_num":1,"machine_volume_strip_num":1}},"cloud_env":{"cloud_env_id":1,"name":"gcp_cloud_env","description":"yeedu cloud environment","cloud_provider":{"cloud_provider_id":0,"name":"gcp"},"availabilty_zone":{"availabilty_zone_id":75,"name":"us-central1-a","cloud_provider_id":0,"region":"us-central1","description":"Council Bluffs, Iowa, North America"},"machine_network":{"machine_network_conf_id":1,"name":"yeedu_gcp_network","description":null,"network_project_id":"modak-yeedu","network_name":"modak-yeedu-spark-vpc","network_tags":["yeedu","iap-allow"],"subnet":"custom-subnet-modak-nabu","machine_network_availability_zone":{"availability_zone_id":75,"name":"us-central1-a","cloud_provider_id":0,"region":"us-central1","description":"Council Bluffs, Iowa, North America"}},"cloud_project":"modak-yeedu","credentials_config":{"credential_config_id":1,"name":"modaknabu-svc","description":null,"credential_type":{"credential_type_id":0,"name":"gcp","cloud_provider_id":0}},"boot_disk_image":{"boot_disk_image_id":1,"name":"gcp_boot_disk","description":"dev boot disk","cloud_provider_id":0,"linux_distro":{"linux_distro_id":0,"distro_name":"UBUNTU","distro_version":"20.04 LTS"},"boot_disk_image":"ubuntu-os-cloud/ubuntu-2004-lts"}},"hive_metastore_conf":{"hive_metastore_conf_id":null,"hive_metastore_conf_name":null},"spark_infra_version":{"spark_infra_version_id":2,"spark_version":"3.2.2","hive_version":"3.2.3","hadoop_version":"3.2.4","scala_version":"2.12.15","python_version":"3.9.5","notebook_support":true},"engine_cluster_spark_config":{"max_parallel_spark_job_execution_per_instance":5,"standalone_workers_number":null},"object_storage_manager":{"object_storage_manager_id":1,"name":"yeedu_osm","description":"test","credentials_config":{"credential_config_id":1,"name":"modakyeedu-svc","description":null,"credential_type_name":"gcp"},"object_storage_bucket_name":"modak-yeedu-nabu"},"workflow_job_instance_details":{"workflow_job_instance_status":{"workflow_job_instance_id":5,"workflow_job_id":5,"status":"EXECUTING","from_date":"2024-01-08T10:44:07.650245+00:00","to_date":"infinity"}},"tenant_id":"1ea17e91-257b-4a6c-82aa-265568d31615","created_by":{"user_id":1,"username":"YSU0000"},"modified_by":{"user_id":1,"username":"YSU0000"},"last_update_date":"2024-01-08T10:44:07.650245+00:00","from_date":"2024-01-08T10:44:07.650245+00:00","to_date":"infinity"}],"result_set":{"current_page":1,"total_objects":1,"total_pages":1,"limit":100}}searchyeeduclustersearch-husage:search[-h]--cluster_nameCLUSTER_NAME[--page_numberPAGE_NUMBER][--limitLIMIT][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--cluster_nameCLUSTER_NAMEProvideclusternametosearchclusterinstances.--page_numberPAGE_NUMBERTosearchclusterinstancesforaspecificpage_number.(default:1)--limitLIMITProvidelimittosearchnumberofclusterinstances.(default:100)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)search example with all the optional arguments passed.yeeduclustersearch--cluster_name="yeedu_"--limit=1Console output{"data":[{"cluster_id":1,"name":"yeedu_cluster_instance","description":"Yeedu Instance","labels":{"env":"test","resource":"yeedu","vm":"yeedu_node","tenant_id":"1ea17e91-257b-4a6c-82aa-265568d31615"},"idle_timeout_ms":600000,"auto_shutdown":true,"cluster_status":"RUNNING","cluster_type":"YEEDU","compute_engine_id":3,"instance_size":1,"is_spot_instance":false,"enable_public_ip":true,"block_project_ssh_keys":true,"min_instances":1,"max_instances":1,"total_ycu":null,"bootstrap_shell_script":null,"spark_config_id":null,"cluster_conf":{"cluster_conf_id":1,"cluster_conf_name":"n1-standard-4","description":null,"machine_type_category":"general_purpose","machine_type":{"machine_type_id":64,"name":"n1-standard-4","vcpus":4,"memory":"15 GiB","has_cuda":false,"gpu_model":null,"gpus":null,"gpu_memory":null},"machine_volume_conf":{"volume_conf_id":1,"name":"volume_gcp_1","description":null,"encrypted":true,"size":375,"disk_machine_type":{"disk_machine_type_id":4,"cloud_provider_id":0,"name":"local-ssd","has_fixed_size":true,"min_size":375,"max_size":375},"machine_volume_num":1,"machine_volume_strip_num":1}},"cloud_env":{"cloud_env_id":1,"name":"gcp_cloud_env","description":"yeedu cloud environment","cloud_provider":{"cloud_provider_id":0,"name":"gcp"},"availabilty_zone":{"availabilty_zone_id":75,"name":"us-central1-a","cloud_provider_id":0,"region":"us-central1","description":"Council Bluffs, Iowa, North America"},"machine_network":{"machine_network_conf_id":1,"name":"yeedu_gcp_network","description":null,"network_project_id":"modak-yeedu","network_name":"modak-yeedu-spark-vpc","network_tags":["yeedu","iap-allow"],"subnet":"custom-subnet-modak-nabu","machine_network_availability_zone":{"availability_zone_id":75,"name":"us-central1-a","cloud_provider_id":0,"region":"us-central1","description":"Council Bluffs, Iowa, North America"}},"cloud_project":"modak-yeedu","credentials_config":{"credential_config_id":1,"name":"modaknabu-svc","description":null,"credential_type":{"credential_type_id":0,"name":"gcp","cloud_provider_id":0}},"boot_disk_image":{"boot_disk_image_id":1,"name":"gcp_boot_disk","description":"dev boot disk","cloud_provider_id":0,"linux_distro":{"linux_distro_id":0,"distro_name":"UBUNTU","distro_version":"20.04 LTS"},"boot_disk_image":"ubuntu-os-cloud/ubuntu-2004-lts"}},"hive_metastore_conf":{"hive_metastore_conf_id":null,"hive_metastore_conf_name":null},"spark_infra_version":{"spark_infra_version_id":2,"spark_version":"3.2.2","hive_version":"3.2.3","hadoop_version":"3.2.4","scala_version":"2.12.15","python_version":"3.9.5","notebook_support":true},"engine_cluster_spark_config":{"max_parallel_spark_job_execution_per_instance":5,"standalone_workers_number":null},"object_storage_manager":{"object_storage_manager_id":1,"name":"yeedu_osm","description":"test","credentials_config":{"credential_config_id":1,"name":"modakyeedu-svc","description":null,"credential_type_name":"gcp"},"object_storage_bucket_name":"modak-yeedu-nabu"},"workflow_job_instance_details":{"workflow_job_instance_status":{"workflow_job_instance_id":5,"workflow_job_id":5,"status":"EXECUTING","from_date":"2024-01-08T10:44:07.650245+00:00","to_date":"infinity"}},"tenant_id":"1ea17e91-257b-4a6c-82aa-265568d31615","created_by":{"user_id":1,"username":"YSU0000"},"modified_by":{"user_id":1,"username":"YSU0000"},"last_update_date":"2024-01-08T10:44:07.650245+00:00","from_date":"2024-01-08T10:44:07.650245+00:00","to_date":"infinity"}],"result_set":{"current_page":1,"total_objects":1,"total_pages":1,"limit":100}}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 any one of the required argument '--cluster_name' passed.yeeduclusterget--cluster_name="yeedu_cluster_instance"Console output{"cluster_id":1,"name":"yeedu_cluster_instance","description":"Yeedu Instance","labels":{"env":"test","resource":"yeedu","vm":"yeedu_node","tenant_id":"1ea17e91-257b-4a6c-82aa-265568d31615"},"idle_timeout_ms":600000,"auto_shutdown":true,"cluster_status":"RUNNING","cluster_type":"YEEDU","compute_engine_id":3,"instance_size":1,"is_spot_instance":false,"enable_public_ip":true,"block_project_ssh_keys":true,"min_instances":1,"max_instances":1,"total_ycu":null,"bootstrap_shell_script":null,"spark_config_id":null,"cluster_conf":{"cluster_conf_id":1,"cluster_conf_name":"n1-standard-4","description":null,"machine_type_category":"general_purpose","machine_type":{"machine_type_id":64,"name":"n1-standard-4","vcpus":4,"memory":"15 GiB","has_cuda":false,"gpu_model":null,"gpus":null,"gpu_memory":null},"machine_volume_conf":{"volume_conf_id":1,"name":"volume_gcp_1","description":null,"encrypted":true,"size":375,"disk_machine_type":{"disk_machine_type_id":4,"cloud_provider_id":0,"name":"local-ssd","has_fixed_size":true,"min_size":375,"max_size":375},"machine_volume_num":1,"machine_volume_strip_num":1}},"cloud_env":{"cloud_env_id":1,"name":"gcp_cloud_env","description":"yeedu cloud environment","cloud_provider":{"cloud_provider_id":0,"name":"gcp"},"availabilty_zone":{"availabilty_zone_id":75,"name":"us-central1-a","cloud_provider_id":0,"region":"us-central1","description":"Council Bluffs, Iowa, North America"},"machine_network":{"machine_network_conf_id":1,"name":"yeedu_gcp_network","description":null,"network_project_id":"modak-yeedu","network_name":"modak-yeedu-spark-vpc","network_tags":["yeedu","iap-allow"],"subnet":"custom-subnet-modak-nabu","machine_network_availability_zone":{"availability_zone_id":75,"name":"us-central1-a","cloud_provider_id":0,"region":"us-central1","description":"Council Bluffs, Iowa, North America"}},"cloud_project":"modak-yeedu","credentials_config":{"credential_config_id":1,"name":"modaknabu-svc","description":null,"credential_type":{"credential_type_id":0,"name":"gcp","cloud_provider_id":0}},"boot_disk_image":{"boot_disk_image_id":1,"name":"gcp_boot_disk","description":"dev boot disk","cloud_provider_id":0,"linux_distro":{"linux_distro_id":0,"distro_name":"UBUNTU","distro_version":"20.04 LTS"},"boot_disk_image":"ubuntu-os-cloud/ubuntu-2004-lts"}},"hive_metastore_conf":{"hive_metastore_conf_id":null,"hive_metastore_conf_name":null},"spark_infra_version":{"spark_infra_version_id":2,"spark_version":"3.2.2","hive_version":"3.2.3","hadoop_version":"3.2.4","scala_version":"2.12.15","python_version":"3.9.5","notebook_support":true},"engine_cluster_spark_config":{"max_parallel_spark_job_execution_per_instance":5,"standalone_workers_number":null},"object_storage_manager":{"object_storage_manager_id":1,"name":"yeedu_osm","description":"test","credentials_config":{"credential_config_id":1,"name":"modakyeedu-svc","description":null,"credential_type_name":"gcp"},"object_storage_bucket_name":"modak-yeedu-nabu"},"workflow_job_instance_details":{"workflow_job_instance_status":{"workflow_job_instance_id":5,"workflow_job_id":5,"status":"EXECUTING","from_date":"2024-01-08T10:44:07.650245+00:00","to_date":"infinity"}},"tenant_id":"1ea17e91-257b-4a6c-82aa-265568d31615","created_by":{"user_id":1,"username":"YSU0000"},"modified_by":{"user_id":1,"username":"YSU0000"},"last_update_date":"2024-01-08T10:44:07.650245+00:00","from_date":"2024-01-08T10:44:07.650245+00:00","to_date":"infinity"}edityeeduclusteredit-husage:edit[-h][--cluster_idCLUSTER_ID][--cluster_nameCLUSTER_NAME][--nameNAME][--descriptionDESCRIPTION][--idle_timeout_ms[IDLE_TIMEOUT_MS]][--auto_shutdown[{true,false}]][--labelsLABELS[LABELS...]][--enable_public_ip[{true,false}]][--block_project_ssh_keys[{true,false}]][--bootstrap_shell_script_file_path[BOOTSTRAP_SHELL_SCRIPT_FILE_PATH]][--cloud_env_id[CLOUD_ENV_ID]][--object_storage_manager_id[OBJECT_STORAGE_MANAGER_ID]][--hive_metastore_conf_id[HIVE_METASTORE_CONF_ID]][--spark_infra_version_idSPARK_INFRA_VERSION_ID][--cluster_conf_id[CLUSTER_CONF_ID]][--confCONF[CONF...]][--packages[PACKAGES]][--repositories[REPOSITORIES]][--jars[JARS]][--archives[ARCHIVES]][--env_varENV_VAR[ENV_VAR...]][--conf_secretCONF_SECRET[CONF_SECRET...]][--env_var_secretENV_VAR_SECRET[ENV_VAR_SECRET...]][--max_parallel_spark_job_execution_per_instance[MAX_PARALLEL_SPARK_JOB_EXECUTION_PER_INSTANCE]][--standalone_workers_number[STANDALONE_WORKERS_NUMBER]][--min_instances[MIN_INSTANCES]][--max_instances[MAX_INSTANCES]][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--cluster_idCLUSTER_IDProvideaspecificclusterinstanceidtoedit.--cluster_nameCLUSTER_NAMEProvideaspecificclusterinstancenametoedit.--nameNAMEProvidenametoeditaclusterinstance.--descriptionDESCRIPTIONProvidedescriptiontoeditaclusterinstance.--idle_timeout_ms[IDLE_TIMEOUT_MS]Provideidle_timeout_mstoeditaclusterinstance.--auto_shutdown[{true,false}]Provideauto_shutdowntoeditaclusterinstance.--labelsLABELS[LABELS...]Providelabelstoeditaclusterinstance.--enable_public_ip[{true,false}]Provideenable_public_iptoeditaclusterinstance.--block_project_ssh_keys[{true,false}]Provideblock_project_ssh_keystoeditaclusterinstance.--bootstrap_shell_script_file_path[BOOTSTRAP_SHELL_SCRIPT_FILE_PATH]Providebootstrap_shell_script_file_pathtoeditaclusterinstance.--cloud_env_id[CLOUD_ENV_ID]Providecloud_env_idtoeditaclusterinstance.--object_storage_manager_id[OBJECT_STORAGE_MANAGER_ID]Provideobject_storage_manager_idtoeditaclusterinstance.--hive_metastore_conf_id[HIVE_METASTORE_CONF_ID]Providehive_metastore_conf_idtoeditaclusterinstance.--spark_infra_version_idSPARK_INFRA_VERSION_IDProvidespark_infra_version_idtoeditaclusterinstance.--cluster_conf_id[CLUSTER_CONF_ID]Providecluster_conf_idtoeditaclusterinstance.--confCONF[CONF...]Provideconftoeditaclusterinstance.--packages[PACKAGES]Providepackagestoeditaclusterinstance.--repositories[REPOSITORIES]Providerepositoriestoeditaclusterinstance.--jars[JARS]Providejarstoeditaclusterinstance.--archives[ARCHIVES]Providearchivestoeditaclusterinstance.--env_varENV_VAR[ENV_VAR...]Provideenv_vartoeditaclusterinstance.--conf_secretCONF_SECRET[CONF_SECRET...]Provideconf_secrettoeditaclusterinstance.--env_var_secretENV_VAR_SECRET[ENV_VAR_SECRET...]Provideenv_var_secrettoeditaclusterinstance.--max_parallel_spark_job_execution_per_instance[MAX_PARALLEL_SPARK_JOB_EXECUTION_PER_INSTANCE]Providemax_parallel_spark_job_execution_per_instancetoeditaclusterinstance.--standalone_workers_number[STANDALONE_WORKERS_NUMBER]Providestandalone_workers_numbertoeditaclusterinstance.--min_instances[MIN_INSTANCES]Providemin_instancestoeditaclusterinstance.--max_instances[MAX_INSTANCES]Providemax_instancestoeditaclusterinstance.--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=1--idle_timeout_ms=600000Console output{"cluster_id":"1","name":"yeedu_cluster_instance","description":"Yeedu Instance","cloud_env_id":1,"idle_timeout_ms":"600000","auto_shutdown":true,"labels":{"env":"test","resource":"yeedu","vm":"yeedu_node","tenant_id":"1ea17e91-257b-4a6c-82aa-265568d31615"},"is_spot_instance":false,"enable_public_ip":true,"block_project_ssh_keys":true,"bootstrap_shell_script":null,"object_storage_manager_id":"1","cluster_conf_id":"1","spark_config_id":null,"hive_metastore_conf_id":null,"spark_infra_version_id":"2","engine_cluster_spark_config":{"max_parallel_spark_job_execution_per_instance":5},"cluster_type":"YEEDU","min_instances":1,"max_instances":1,"tenant_id":"1ea17e91-257b-4a6c-82aa-265568d31615","created_by_id":"1","modified_by_id":"1","last_update_date":"2024-01-08T10:44:07.650Z","from_date":"2024-01-08T10:44:07.650Z","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_IDProvideclusterinstanceidtostartaclusterinstance.--cluster_nameCLUSTER_NAMEProvideclusterinstancenametostartaclusterinstance.--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":1,"workflow_job_instance_id":1,"engine_cluster_instance_id":1}}stopyeeduclusterstop-husage:stop[-h][--cluster_idCLUSTER_ID][--cluster_nameCLUSTER_NAME][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--cluster_idCLUSTER_IDProvideclusterinstanceidtostopaclusterinstance.--cluster_nameCLUSTER_NAMEProvideclusterinstancenametostopaclusterinstance.--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=1Console output{"CosiStop":{"workflow_job_id":1,"workflow_job_instance_id":1,"engine_cluster_instance_id":1}}destroyyeeduclusterdestroy-husage:destroy[-h][--cluster_idCLUSTER_ID][--cluster_nameCLUSTER_NAME][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--cluster_idCLUSTER_IDProvideclusterinstanceidtodestroyaclusterinstance.--cluster_nameCLUSTER_NAMEProvideclusterinstancenametodestroyaclusterinstance.--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":1,"workflow_job_instance_id":1,"engine_cluster_instance_id":1}}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_IDProvideclusterinstanceidtogetthesparkjobstatisticsofaclusterinstance.--cluster_nameCLUSTER_NAMEProvideclusterinstancenametogetthesparkjobstatisticsofaclusterinstance.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)get-stats example with one of the optional arguments '--cluster_name' passed.yeeduclusterget-stats--cluster_name="yeedu_cluster_instance"Console output{"SUBMITTED":1,"RUNNING":2,"DONE":4,"ERROR":0,"TERMINATED":0,"STOPPING":1,"STOPPED":1,"TOTAL_JOB_COUNT":9}list-statusyeeduclusterlist-status-husage:list-status[-h][--cluster_idCLUSTER_ID][--cluster_nameCLUSTER_NAME][--page_numberPAGE_NUMBER][--limitLIMIT][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--cluster_idCLUSTER_IDProvideclusteridtolistalltheclusterinstancestatus.--cluster_nameCLUSTER_NAMEProvideclusternametolistalltheclusterinstancestatus.--page_numberPAGE_NUMBERTolisttheclusterinstancestatusforaspecificpage_number.(default:1)--limitLIMITProvidelimittolistnumberofclusterinstancestatus.(default:100)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list-status example with one of the required argument '--cluster_id' and other optional argument passed.yeeduclusterlist-status--cluster_id=1--limit=4Console output{"data":[{"cluster_status":"STOPPED","current_node_size":0,"created_by":null,"start_time":"2023-09-29T07:33:38.586618+00:00","end_time":"infinity"},{"cluster_status":"STOPPING","current_node_size":0,"created_by":null,"start_time":"2023-09-29T07:32:12.534424+00:00","end_time":"2023-09-29T07:33:38.586618+00:00"},{"cluster_status":"RUNNING","current_node_size":1,"created_by":null,"start_time":"2023-09-29T07:20:47.743064+00:00","end_time":"2023-09-29T07:32:12.534424+00:00"},{"cluster_status":"INITIATING","current_node_size":1,"created_by":null,"start_time":"2023-09-29T07:19:58.413655+00:00","end_time":"2023-09-29T07:20:47.743064+00:00"}],"result_set":{"current_page":1,"total_objects":32,"total_pages":8,"limit":4,"next_page":2}}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=1Console outputInitializingmodules...
-local-nodeinmodule
-master-standalone-clusterinmodule
-standalone-nodeinmodule
-worker-standalone-clusterinmodule
Initializingthebackend...

Successfullyconfiguredthebackend"pg"!Terraformwillautomatically
usethisbackendunlessthebackendconfigurationchanges.
Initializingproviderplugins...
-Findinglatestversionofhashicorp/random...
-Findinglatestversionofhashicorp/template...
-Findinglatestversionofhashicorp/google...
-Installinghashicorp/templatev2.2.0...
-Installedhashicorp/templatev2.2.0(signedbyHashiCorp)-Installinghashicorp/googlev4.50.0...
-Installedhashicorp/googlev4.50.0(signedbyHashiCorp)-Installinghashicorp/randomv3.4.3...
-Installedhashicorp/randomv3.4.3(signedbyHashiCorp)Terraformhascreatedalockfile.terraform.lock.hcltorecordtheprovider
selectionsitmadeabove.Includethisfileinyourversioncontrolrepository
sothatTerraformcanguaranteetomakethesameselectionsbydefaultwhen
yourun"terraform init"inthefuture.
Terraformhasbeensuccessfullyinitialized!

...

Applycomplete!Resources:3added,0changed,0destroyed.

Outputs:
local-node-uuids=[{"instance_uuid"=tomap({"292a79d6-7967-3284-6e19-31aecf9977f4"=0})"reserved_ip"=["10.101.1.41",]},]master-standalone-cluster-uuids=[]standalone-node-uuids=[]worker-standalone-cluster-uuids=[]Cluster Access ControlCommand NameUtilityassociate-workspaceAssociate cluster with a workspacesdissociate-workspaceDissociate cluster with a workspacelist-workspacesList all the Workspaces having access to a cluster.list-workspace-clustersList all the Clusters that have access to a workspace.search-workspace-clustersSearch all the Clusters that have access to a workspace.associate-workspaceyeeduclusterassociate-workspace-husage:associate-workspace[-h]--workspace_idWORKSPACE_ID--cluster_idCLUSTER_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--workspace_idWORKSPACE_IDProvideWorkspaceIdtoassociateitwithacluster.--cluster_idCLUSTER_IDProvideClusterIdtotoassociateitwithaworkspace.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)associate-workspace example with all the required arguments passed.yeeduclusterassociate-workspace--workspace_id=1--cluster_id=1Console output{"workspace_id":"1","cluster_id":"1","created_by_id":"1","modified_by_id":"1","last_update_date":"2023-09-29T12:24:29.358Z","from_date":"2023-09-29T12:24:29.358Z","to_date":null}dissociate-workspaceyeeduclusterdissociate-workspace-husage:dissociate-workspace[-h]--workspace_idWORKSPACE_ID--cluster_idCLUSTER_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--workspace_idWORKSPACE_IDProvideWorkspaceIdtodissociateitwithacluster.--cluster_idCLUSTER_IDProvideClusterIdtodissociateitwithaworkspace.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)dissociate-workspace example with all the required arguments passed.yeeduclustercreate-group-access--cluster_id=1--group_id=1--permission_id=1Console output{"auth_engine_cluster_instance_group_id":"1","cluster_instance_perm_id":1,"group_id":"1","created_by_id":"1","modified_by_id":"1","last_update_date":"2023-09-29T11:10:48.468Z","from_date":"2023-09-29T11:10:48.468Z","to_date":null}list-workspacesyeeduclusterlist-workspaces-husage:list-workspaces[-h]--cluster_idCLUSTER_ID[--page_numberPAGE_NUMBER][--limitLIMIT][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--cluster_idCLUSTER_IDProvideClusterIdtolistalltheassociatedworkspaces.--page_numberPAGE_NUMBERTolistClustersforaspecificpage_number.(default:1)--limitLIMITProvidelimittolistnumberofClusters.(default:100)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list-workspaces example with all the required argument passed.yeeduclusterlist-workspaces--cluster_id=1Console output{"data":[{"workspace":{"workspace_id":1,"name":"spark_jobs_test","description":"Test Spark Jobs"}"cluster_info":{"cluster_id":1,"name":"yeedu_cluster_instance","description":"Yeedu Instance","labels":{"env":"test","resource":"yeedu","vm":"yeedu_node","tenant_id":"1ea17e91-257b-4a6c-82aa-265568d31615"},"idle_timeout_ms":600000,"auto_shutdown":true,"cluster_status":"RUNNING","cluster_type":"YEEDU","compute_engine_id":3,"instance_size":1,"is_spot_instance":false,"enable_public_ip":true,"block_project_ssh_keys":true,"min_instances":1,"max_instances":1,"total_ycu":null,"bootstrap_shell_script":null,"spark_config_id":null,"cluster_conf":{"cluster_conf_id":1,"cluster_conf_name":"n1-standard-4","description":null,"machine_type_category":"general_purpose","machine_type":{"machine_type_id":64,"name":"n1-standard-4","vcpus":4,"memory":"15 GiB","has_cuda":false,"gpu_model":null,"gpus":null,"gpu_memory":null},"machine_volume_conf":{"volume_conf_id":1,"name":"volume_gcp_1","description":null,"encrypted":true,"size":375,"disk_machine_type":{"disk_machine_type_id":4,"cloud_provider_id":0,"name":"local-ssd","has_fixed_size":true,"min_size":375,"max_size":375},"machine_volume_num":1,"machine_volume_strip_num":1}},"cloud_env":{"cloud_env_id":1,"name":"gcp_cloud_env","description":"yeedu cloud environment","cloud_provider":{"cloud_provider_id":0,"name":"gcp"},"availabilty_zone":{"availabilty_zone_id":75,"name":"us-central1-a","cloud_provider_id":0,"region":"us-central1","description":"Council Bluffs, Iowa, North America"},"machine_network":{"machine_network_conf_id":1,"name":"yeedu_gcp_network","description":null,"network_project_id":"modak-yeedu","network_name":"modak-yeedu-spark-vpc","network_tags":["yeedu","iap-allow"],"subnet":"custom-subnet-modak-nabu","machine_network_availability_zone":{"availability_zone_id":75,"name":"us-central1-a","cloud_provider_id":0,"region":"us-central1","description":"Council Bluffs, Iowa, North America"}},"cloud_project":"modak-yeedu","credentials_config":{"credential_config_id":1,"name":"modaknabu-svc","description":null,"credential_type":{"credential_type_id":0,"name":"gcp","cloud_provider_id":0}},"boot_disk_image":{"boot_disk_image_id":1,"name":"gcp_boot_disk","description":"dev boot disk","cloud_provider_id":0,"linux_distro":{"linux_distro_id":0,"distro_name":"UBUNTU","distro_version":"20.04 LTS"},"boot_disk_image":"ubuntu-os-cloud/ubuntu-2004-lts"}},"hive_metastore_conf":{"hive_metastore_conf_id":null,"hive_metastore_conf_name":null},"spark_infra_version":{"spark_infra_version_id":2,"spark_version":"3.2.2","hive_version":"3.2.3","hadoop_version":"3.2.4","scala_version":"2.12.15","python_version":"3.9.5","notebook_support":true},"engine_cluster_spark_config":{"max_parallel_spark_job_execution_per_instance":5,"standalone_workers_number":null},"object_storage_manager":{"object_storage_manager_id":1,"name":"yeedu_osm","description":"test","credentials_config":{"credential_config_id":1,"name":"modakyeedu-svc","description":null,"credential_type_name":"gcp"},"object_storage_bucket_name":"modak-yeedu-nabu"},"workflow_job_instance_details":{"workflow_job_instance_status":{"workflow_job_instance_id":5,"workflow_job_id":5,"status":"EXECUTING","from_date":"2024-01-08T10:44:07.650245+00:00","to_date":"infinity"}},"tenant_id":"1ea17e91-257b-4a6c-82aa-265568d31615","created_by":{"user_id":1,"username":"YSU0000"},"modified_by":{"user_id":1,"username":"YSU0000"},"last_update_date":"2024-01-08T10:44:07.650245+00:00","from_date":"2024-01-08T10:44:07.650245+00:00","to_date":"infinity"}}],"result_set":{"current_page":1,"total_objects":1,"total_pages":1,"limit":100}}list-workspace-clustersyeeduclusterlist-workspace-clusters-husage:list-workspace-clusters[-h]--workspace_idWORKSPACE_ID[--cluster_status[CLUSTER_STATUS]][--job_type[{job,notebook}]][--page_numberPAGE_NUMBER][--limitLIMIT][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--workspace_idWORKSPACE_IDProvideWorkspaceIdtolistalltheassociatedclusters.--cluster_status[CLUSTER_STATUS]ProvideClusterInstanceStatusfrom["INITIATING","RUNNING","STOPPING","STOPPED","DESTROYING","DESTROYED","ERROR","RESIZING_UP","RESIZING_DOWN"]tolist,Forexample--cluster_status="RUNNING,DESTROYED".--job_type[{SPARK_JOB,SPARK_SQL,NOTEBOOK}]TolistClustersforaspecificjob_type.--page_numberPAGE_NUMBERTolistClustersforaspecificpage_number.(default:1)--limitLIMITProvidelimittolistnumberofClusters.(default:100)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list-workspace-clusters example with all the required arguments passed.yeeduclusterlist-workspace-clusters--workspace_id=1Console output{"data":[{"workspace":{"workspace_id":1,"name":"spark_jobs_test","description":"Test Spark Jobs"},"cluster_info":{"cluster_id":1,"name":"yeedu_cluster_instance","description":"Yeedu Instance","labels":{"env":"test","resource":"yeedu","vm":"yeedu_node","tenant_id":"1ea17e91-257b-4a6c-82aa-265568d31615"},"idle_timeout_ms":600000,"auto_shutdown":true,"cluster_status":"RUNNING","cluster_type":"YEEDU","compute_engine_id":3,"instance_size":1,"is_spot_instance":false,"enable_public_ip":true,"block_project_ssh_keys":true,"min_instances":1,"max_instances":1,"total_ycu":null,"bootstrap_shell_script":null,"spark_config_id":null,"cluster_conf":{"cluster_conf_id":1,"cluster_conf_name":"n1-standard-4","description":null,"machine_type_category":"general_purpose","machine_type":{"machine_type_id":64,"name":"n1-standard-4","vcpus":4,"memory":"15 GiB","has_cuda":false,"gpu_model":null,"gpus":null,"gpu_memory":null},"machine_volume_conf":{"volume_conf_id":1,"name":"volume_gcp_1","description":null,"encrypted":true,"size":375,"disk_machine_type":{"disk_machine_type_id":4,"cloud_provider_id":0,"name":"local-ssd","has_fixed_size":true,"min_size":375,"max_size":375},"machine_volume_num":1,"machine_volume_strip_num":1}},"cloud_env":{"cloud_env_id":1,"name":"gcp_cloud_env","description":"yeedu cloud environment","cloud_provider":{"cloud_provider_id":0,"name":"gcp"},"availabilty_zone":{"availabilty_zone_id":75,"name":"us-central1-a","cloud_provider_id":0,"region":"us-central1","description":"Council Bluffs, Iowa, North America"},"machine_network":{"machine_network_conf_id":1,"name":"yeedu_gcp_network","description":null,"network_project_id":"modak-yeedu","network_name":"modak-yeedu-spark-vpc","network_tags":["yeedu","iap-allow"],"subnet":"custom-subnet-modak-nabu","machine_network_availability_zone":{"availability_zone_id":75,"name":"us-central1-a","cloud_provider_id":0,"region":"us-central1","description":"Council Bluffs, Iowa, North America"}},"cloud_project":"modak-yeedu","credentials_config":{"credential_config_id":1,"name":"modaknabu-svc","description":null,"credential_type":{"credential_type_id":0,"name":"gcp","cloud_provider_id":0}},"boot_disk_image":{"boot_disk_image_id":1,"name":"gcp_boot_disk","description":"dev boot disk","cloud_provider_id":0,"linux_distro":{"linux_distro_id":0,"distro_name":"UBUNTU","distro_version":"20.04 LTS"},"boot_disk_image":"ubuntu-os-cloud/ubuntu-2004-lts"}},"hive_metastore_conf":{"hive_metastore_conf_id":null,"hive_metastore_conf_name":null},"spark_infra_version":{"spark_infra_version_id":2,"spark_version":"3.2.2","hive_version":"3.2.3","hadoop_version":"3.2.4","scala_version":"2.12.15","python_version":"3.9.5","notebook_support":true},"engine_cluster_spark_config":{"max_parallel_spark_job_execution_per_instance":5,"standalone_workers_number":null},"object_storage_manager":{"object_storage_manager_id":1,"name":"yeedu_osm","description":"test","credentials_config":{"credential_config_id":1,"name":"modakyeedu-svc","description":null,"credential_type_name":"gcp"},"object_storage_bucket_name":"modak-yeedu-nabu"},"workflow_job_instance_details":{"workflow_job_instance_status":{"workflow_job_instance_id":5,"workflow_job_id":5,"status":"EXECUTING","from_date":"2024-01-08T10:44:07.650245+00:00","to_date":"infinity"}},"tenant_id":"1ea17e91-257b-4a6c-82aa-265568d31615","created_by":{"user_id":1,"username":"YSU0000"},"modified_by":{"user_id":1,"username":"YSU0000"},"last_update_date":"2024-01-08T10:44:07.650245+00:00","from_date":"2024-01-08T10:44:07.650245+00:00","to_date":"infinity"}}],"result_set":{"current_page":1,"total_objects":1,"total_pages":1,"limit":100}}search-workspace-clustersyeeduclustersearch-workspace-clusters-husage:search-workspace-clusters[-h]--workspace_idWORKSPACE_ID[--cluster_name[CLUSTER_NAME]][--cluster_status[CLUSTER_STATUS]][--job_type[{SPARK_JOB,SPARK_SQL,NOTEBOOK}]][--page_numberPAGE_NUMBER][--limitLIMIT][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--workspace_idWORKSPACE_IDProvideworkspaceidtosearchalltheassociatedclusters.--cluster_name[CLUSTER_NAME]Provideclusternametosearchalltheassociatedworkspaceclusters.--cluster_status[CLUSTER_STATUS]Provideclusterinstancestatusfrom["INITIATING","RUNNING","STOPPING","STOPPED","DESTROYING","DESTROYED","ERROR","RESIZING_UP","RESIZING_DOWN"]tosearch,forexample--cluster_status="RUNNING,DESTROYED".--job_type[{SPARK_JOB,SPARK_SQL,NOTEBOOK}]Tosearchclustersofaspecificjob_type.--page_numberPAGE_NUMBERTosearchclustersforaspecificpage_number.(default:1)--limitLIMITProvidelimittosearchnumberofclusters.(default:100)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)search-confs example with required argument '--cluster_conf_name' passed.yeeduclustersearch-workspace-clusters--workspace_id=1--cluster_name="yeedu_"Console output{"data":[{"workspace":{"workspace_id":1,"name":"spark_jobs_test","description":"Test Spark Jobs"},"cluster_info":{"cluster_id":1,"name":"yeedu_cluster_instance","description":"Yeedu Instance","labels":{"env":"test","resource":"yeedu","vm":"yeedu_node","tenant_id":"1ea17e91-257b-4a6c-82aa-265568d31615"},"idle_timeout_ms":600000,"auto_shutdown":true,"cluster_status":"RUNNING","cluster_type":"YEEDU","compute_engine_id":3,"instance_size":1,"is_spot_instance":false,"enable_public_ip":true,"block_project_ssh_keys":true,"min_instances":1,"max_instances":1,"total_ycu":null,"bootstrap_shell_script":null,"spark_config_id":null,"cluster_conf":{"cluster_conf_id":1,"cluster_conf_name":"n1-standard-4","description":null,"machine_type_category":"general_purpose","machine_type":{"machine_type_id":64,"name":"n1-standard-4","vcpus":4,"memory":"15 GiB","has_cuda":false,"gpu_model":null,"gpus":null,"gpu_memory":null},"machine_volume_conf":{"volume_conf_id":1,"name":"volume_gcp_1","description":null,"encrypted":true,"size":375,"disk_machine_type":{"disk_machine_type_id":4,"cloud_provider_id":0,"name":"local-ssd","has_fixed_size":true,"min_size":375,"max_size":375},"machine_volume_num":1,"machine_volume_strip_num":1}},"cloud_env":{"cloud_env_id":1,"name":"gcp_cloud_env","description":"yeedu cloud environment","cloud_provider":{"cloud_provider_id":0,"name":"gcp"},"availabilty_zone":{"availabilty_zone_id":75,"name":"us-central1-a","cloud_provider_id":0,"region":"us-central1","description":"Council Bluffs, Iowa, North America"},"machine_network":{"machine_network_conf_id":1,"name":"yeedu_gcp_network","description":null,"network_project_id":"modak-yeedu","network_name":"modak-yeedu-spark-vpc","network_tags":["yeedu","iap-allow"],"subnet":"custom-subnet-modak-nabu","machine_network_availability_zone":{"availability_zone_id":75,"name":"us-central1-a","cloud_provider_id":0,"region":"us-central1","description":"Council Bluffs, Iowa, North America"}},"cloud_project":"modak-yeedu","credentials_config":{"credential_config_id":1,"name":"modaknabu-svc","description":null,"credential_type":{"credential_type_id":0,"name":"gcp","cloud_provider_id":0}},"boot_disk_image":{"boot_disk_image_id":1,"name":"gcp_boot_disk","description":"dev boot disk","cloud_provider_id":0,"linux_distro":{"linux_distro_id":0,"distro_name":"UBUNTU","distro_version":"20.04 LTS"},"boot_disk_image":"ubuntu-os-cloud/ubuntu-2004-lts"}},"hive_metastore_conf":{"hive_metastore_conf_id":null,"hive_metastore_conf_name":null},"spark_infra_version":{"spark_infra_version_id":2,"spark_version":"3.2.2","hive_version":"3.2.3","hadoop_version":"3.2.4","scala_version":"2.12.15","python_version":"3.9.5","notebook_support":true},"engine_cluster_spark_config":{"max_parallel_spark_job_execution_per_instance":5,"standalone_workers_number":null},"object_storage_manager":{"object_storage_manager_id":1,"name":"yeedu_osm","description":"test","credentials_config":{"credential_config_id":1,"name":"modakyeedu-svc","description":null,"credential_type_name":"gcp"},"object_storage_bucket_name":"modak-yeedu-nabu"},"workflow_job_instance_details":{"workflow_job_instance_status":{"workflow_job_instance_id":5,"workflow_job_id":5,"status":"EXECUTING","from_date":"2024-01-08T10:44:07.650245+00:00","to_date":"infinity"}},"tenant_id":"1ea17e91-257b-4a6c-82aa-265568d31615","created_by":{"user_id":1,"username":"YSU0000"},"modified_by":{"user_id":1,"username":"YSU0000"},"last_update_date":"2024-01-08T10:44:07.650245+00:00","from_date":"2024-01-08T10:44:07.650245+00:00","to_date":"infinity"}}],"result_set":{"current_page":1,"total_objects":1,"total_pages":1,"limit":100}}WorkspaceCommand NameUtilitycreateTo create a Workspace.listTo list all the Workspaces.searchTo search workspaces by workspace name.getTo get information about a specific Workspace.editTo edit a specific Workspace.enableTo enable a specific Workspace.disableTo disable a specific Workspace.createyeeduworkspacecreate-husage:create[-h][--nameNAME][--descriptionDESCRIPTION][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--nameNAMEProvidenametocreateworkspace.--descriptionDESCRIPTIONProvidedescriptiontocreateworkspace.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)create example with all the required arguments passed.yeeduworkspacecreate--name="spark_jobs_test"--description="Test Spark Jobs"Console output{"workspace_id":"1","name":"spark_jobs_test","description":"Test Spark Jobs","tenant_id":"e67f00ad-68aa-46d0-b32e-f3f8dac5427d","created_by_id":"1","modified_by_id":"1","last_update_date":"2024-01-08T12:01:56.508Z","from_date":"2024-01-08T12:01:56.508Z","to_date":null}listyeeduworkspacelist-husage:list[-h][--enable[{true,false}]][--page_numberPAGE_NUMBER][--limitLIMIT][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--enable[{true,false}]ProvideenableastrueorfalsetolistWorkspaces.--page_numberPAGE_NUMBERTolistWorkspacesforaspecificpage_number.(default:1)--limitLIMITProvidelimittolistnumberofWorkspaces.(default:100)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list example with optional arguments passed.yeeduworkspacelist--limit=1--page_number=2Console output{"data":[{"workspace_id":1,"name":"spark_jobs_test","description":"Test Spark Jobs","job_conf_count":0,"notebook_conf_count":0,"created_by":{"user_id":1,"username":"YSU0000"},"modified_by":{"user_id":1,"username":"YSU0000"},"active":true,"tenant_id":"e67f00ad-68aa-46d0-b32e-f3f8dac5427d","last_update_date":"2024-01-08T12:01:56.508Z","from_date":"2024-01-08T12:01:56.508Z","to_date":"infinity"}],"result_set":{"current_page":2,"total_objects":2,"total_pages":2,"limit":1,"previous_page":1}}searchyeeduworkspacesearch-husage:search[-h]--workspace_nameWORKSPACE_NAME[--enable[{true,false}]][--page_numberPAGE_NUMBER][--limitLIMIT][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--workspace_nameWORKSPACE_NAMEProvideworkspacenametosearchworkspaces.--enable[{true,false}]Provideenableastrueorfalsetosearchworkspaces.--page_numberPAGE_NUMBERTosearchworkspacesforaspecificpage_number.(default:1)--limitLIMITProvidelimittosearchnumberofworkspaces.(default:100)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)search example with the required argument passed.yeeduworkspacesearch--workspace_name="spark_"Console output{"data":[{"workspace_id":1,"name":"spark_jobs_test","description":"Test Spark Jobs","job_conf_count":9,"notebook_conf_count":1,"created_by":{"user_id":1,"username":"mandeep.singh@modak.com"},"modified_by":{"user_id":1,"username":"mandeep.singh@modak.com"},"active":true,"tenant_id":"1ea17e91-257b-4a6c-82aa-265568d31615","last_update_date":"2024-01-08T12:01:56.50868+00:00","from_date":"2024-01-08T12:01:56.50868+00:00","to_date":"infinity"}],"result_set":{"current_page":1,"total_objects":1,"total_pages":1,"limit":100}}getyeeduworkspaceget-husage:get[-h][--workspace_idWORKSPACE_ID][--workspace_nameWORKSPACE_NAME][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--workspace_idWORKSPACE_IDProvideworkspace_idtogetinformationaboutaspecificWorkspace.--workspace_nameWORKSPACE_NAMEProvideworkspace_nametogetinformationaboutaspecificWorkspace.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)get example with any one of the required argument passed.yeeduworkspaceget--workspace_id=1Console output{"workspace_id":1,"name":"spark_jobs_test","description":"Test Spark Jobs","job_conf_count":9,"notebook_conf_count":1,"created_by":{"user_id":1,"username":"mandeep.singh@modak.com"},"modified_by":{"user_id":1,"username":"mandeep.singh@modak.com"},"active":true,"tenant_id":"1ea17e91-257b-4a6c-82aa-265568d31615","last_update_date":"2024-01-08T12:01:56.50868+00:00","from_date":"2024-01-08T12:01:56.50868+00:00","to_date":"infinity"}edityeeduworkspaceedit-husage:edit[-h][--workspace_idWORKSPACE_ID][--workspace_nameWORKSPACE_NAME][--nameNAME][--descriptionDESCRIPTION][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--workspace_idWORKSPACE_IDProvideworkspace_idtoeditaspecificWorkspace.--workspace_nameWORKSPACE_NAMEProvideworkspace_nametoeditaspecificWorkspace.--nameNAMEProvidenametoeditaspecificWorkspace.--descriptionDESCRIPTIONProvidedescriptiontoeditaspecificWorkspace.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)edit example with any one of the required argument '--workspace_id' and other optional argument is passed which is to be updated.yeeduworkspaceedit--workspace_id=1--description="Test Spark Curation Jobs"Console output{"workspace_id":"1","name":"spark_jobs_test","description":"Test Spark Curation Jobs","tenant_id":"e67f00ad-68aa-46d0-b32e-f3f8dac5427d","created_by_id":"1","modified_by_id":"1","last_update_date":"2024-01-08T12:01:56.508Z","from_date":"2024-01-08T12:01:56.508Z","to_date":null}enableyeeduworkspaceenable-husage:enable[-h][--workspace_idWORKSPACE_ID][--workspace_nameWORKSPACE_NAME][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--workspace_idWORKSPACE_IDProvideworkspace_idtoenableaspecificWorkspace.--workspace_nameWORKSPACE_NAMEProvideworkspace_nametoenableaspecificWorkspace.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)enable example with any one of the required argument passed.yeeduworkspaceenable--workspace_id=1Console output{"workspace_id":"1","name":"spark_jobs_test","description":"Test Spark Jobs","tenant_id":"e67f00ad-68aa-46d0-b32e-f3f8dac5427d","created_by_id":"1","modified_by_id":"1","last_update_date":"2024-01-08T12:01:56.508Z","from_date":"2024-01-08T12:01:56.508Z","to_date":null}disableyeeduworkspacedisable-husage:disable[-h][--workspace_idWORKSPACE_ID][--workspace_nameWORKSPACE_NAME][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--workspace_idWORKSPACE_IDProvideworkspace_idtodisableaspecificWorkspace.--workspace_nameWORKSPACE_NAMEProvideworkspace_nametodisableaspecificWorkspace.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)disable example with any one of the required argument passed.yeeduworkspacedisable--workspace_id=1Console output{"workspace_id":"1","name":"spark_jobs_test","description":"Test Spark Jobs","tenant_id":"e67f00ad-68aa-46d0-b32e-f3f8dac5427d","created_by_id":"1","modified_by_id":"1","last_update_date":"2024-01-08T12:01:56.508Z","from_date":"2024-01-08T12:01:56.508Z","to_date":"2024-01-08T12:01:56.508Z"}Workspace Access ControlCommand NameUtilitycreate-user-accessAssign access to a user on a specific workspacecreate-group-accessAssign access to a group on a specific workspacedelete-user-accessDelete access of a user on a specific workspacedelete-group-accessDelete access of a group on a specific workspacelist-usersTo list all the users having access to a workspace.search-usersTo search the users having access to a workspace.match-userTo match the exact username having access to a workspace.list-groupsTo list all the groups having access to a workspace.search-groupsTo search the groups having access to a workspace.match-groupTo match the exact groupname having access to a workspace.get-user-accessTo get the permission of the user having access to a workspace.get-group-accessTo get the permission of the group having access to a workspace.list-users-accessTo list all the permissions of the users having access to a workspace.list-groups-accessTo list all the permissions of the groups having access to a workspace.create-user-accessyeeduworkspacecreate-user-access-husage:create-user-access[-h]--workspace_idWORKSPACE_ID--user_idUSER_ID--permission_idPERMISSION_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--workspace_idWORKSPACE_IDProvideWorkspaceIdtoassignuseraccessonaworkspace.--user_idUSER_IDProvideUserIdtoassignuseraccessonaworkspace.--permission_idPERMISSION_IDProvidePermissionIdtoassignuseraccessonaworkspace.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)create-user-access example with all the required arguments passed.yeeduworkspacecreate-user-access--workspace_id=1--user_id=1--permission_id=2Console output{"auth_workspace_user_id":"1","workspace_id":"1","auth_workspace_perm_id":2,"user_id":"1","created_by_id":"1","modified_by_id":"1","last_update_date":"2024-01-08T13:08:16.731Z","from_date":"2024-01-08T13:08:16.731Z","to_date":null}create-group-accessyeeduworkspacecreate-group-access-husage:create-group-access[-h]--workspace_idWORKSPACE_ID--group_idGROUP_ID--permission_idPERMISSION_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--workspace_idWORKSPACE_IDProvideWorkspaceIdtoassigngroupaccessonaworkspace.--group_idGROUP_IDProvidegroupIdtoassigngroupaccessonaworkspace.--permission_idPERMISSION_IDProvidePermissionIdtoassigngroupaccessonaworkspace.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)create-group-access example with optional arguments passed.yeeduworkspacecreate-group-access--workspace_id=1--group_id=1--permission_id=2Console output{"auth_workspace_group_id":"1","workspace_id":"1","auth_workspace_perm_id":2,"group_id":"1","created_by_id":"1","modified_by_id":"1","last_update_date":"2024-01-08T13:10:50.581Z","from_date":"2024-01-08T13:10:50.581Z","to_date":null}delete-user-accessyeeduworkspacedelete-user-access-husage:delete-user-access[-h]--workspace_idWORKSPACE_ID--user_idUSER_ID--permission_idPERMISSION_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--workspace_idWORKSPACE_IDProvideWorkspaceIdtodeleteuseraccessonaworkspace.--user_idUSER_IDProvideUserIdtodeleteuseraccessonaworkspace.--permission_idPERMISSION_IDProvidePermissionIdtodeleteuseraccessonaworkspace.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)delete-user-access example with the required argument passed.yeeduworkspacedelete-user-access--workspace_id=1--user_id=1--permission_id=2Console output{"message":"Deleted Permission successfully."}delete-group-accessyeeduworkspacedelete-group-access-husage:delete-group-access[-h]--workspace_idWORKSPACE_ID--group_idGROUP_ID--permission_idPERMISSION_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--workspace_idWORKSPACE_IDProvideWorkspaceIdtodeletegroupaccessonaworkspace.--group_idGROUP_IDProvidegroupIdtodeletegroupaccessonaworkspace.--permission_idPERMISSION_IDProvidePermissionIdtodeletegroupaccessonaworkspace.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)delete-group-access example with all the required arguments passed.yeeduworkspacedelete-group-access--workspace_id=1--group_id=1--permission_id=2Console output{"message":"Deleted Permission successfully."}list-usersyeeduworkspacelist-users-husage:list-users[-h]--workspace_idWORKSPACE_ID[--group_idGROUP_ID][--page_numberPAGE_NUMBER][--limitLIMIT][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--workspace_idWORKSPACE_IDProvideworkspace_idtolistalltheusers.--group_idGROUP_IDProvidegroup_idtolistalltheusers.--page_numberPAGE_NUMBERTolistusersforaspecificpage_number.(default:1)--limitLIMITProvidelimittolistnumberofusers.(default:100)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list-users example with the required argument '--workspace_id' passed.yeeduworkspacelist-users--workspace_id=1Console output{"data":[{"user_id":1,"username":"YSU0000","email":"ysu0000@modak.com"}],"result_set":{"current_page":1,"total_objects":1,"total_pages":1,"limit":100}}search-usersyeeduworkspacesearch-users-husage:search-users[-h]--workspace_idWORKSPACE_ID--usernameUSERNAME[--group_idGROUP_ID][--page_numberPAGE_NUMBER][--limitLIMIT][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--workspace_idWORKSPACE_IDProvideworkspaceidtosearchalltheusers.--usernameUSERNAMEProvideusernametosearchalltheusers.--group_idGROUP_IDProvidegroupidtosearchalltheusers.--page_numberPAGE_NUMBERTosearchusersforaspecificpage_number.(default:1)--limitLIMITProvidelimittosearchnumberofusers.(default:100)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)search example with the required argument passed.yeeduworkspacesearch-users--workspace_id=1--username="YSU"Console output{"data":[{"user_id":1,"username":"YSU0000","email":"ysu0000@modak.com"}],"result_set":{"current_page":1,"total_objects":1,"total_pages":1,"limit":100}}match-useryeeduworkspacematch-user-husage:match-user[-h]--workspace_idWORKSPACE_ID--usernameUSERNAME[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--workspace_idWORKSPACE_IDProvideworkspaceidtomatchalltheusers.--usernameUSERNAMEProvideusernametomatchalltheusers.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)match example with the required argument passed.yeeduworkspacematch-user--workspace_id=1--username="YSU0000"Console output{"user_id":1,"username":"YSU0000","email":"ysu0000@modak.com","from_date":"2023-12-28T14:01:50.367429+00:00","to_date":"infinity"}list-groupsyeeduworkspacelist-groups-husage:list-groups[-h]--workspace_idWORKSPACE_ID[--user_idUSER_ID][--page_numberPAGE_NUMBER][--limitLIMIT][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--workspace_idWORKSPACE_IDProvideworkspace_idtolistallthegroups.--user_idUSER_IDProvideauser_idtoretrievealistofallthegroupsassociatedwiththatuser.--page_numberPAGE_NUMBERTolistgroupsforaspecificpage_number.(default:1)--limitLIMITProvidelimittolistnumberofgroups.(default:100)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list-groups example with the required argument '--workspace_id' passed.yeeduworkspacelist-groups--workspace_id=1Console output{"data":[{"group_id":1,"group_name":"modak.com","group_type":"Unified","from_date":"2023-12-28T14:01:50.367429+00:00","to_date":"infinity"},{"group_id":2,"group_name":"Yeedu","group_type":"DynamicMembership","from_date":"2023-12-28T14:01:50.367429+00:00","to_date":"infinity"}],"result_set":{"current_page":1,"total_objects":13,"total_pages":7,"limit":2,"next_page":2}}search-groupsyeeduworkspacesearch-groups-husage:search-groups[-h]--workspace_idWORKSPACE_ID--groupnameGROUPNAME[--user_idUSER_ID][--page_numberPAGE_NUMBER][--limitLIMIT][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--workspace_idWORKSPACE_IDProvideworkspaceidtosearchallthegroups.--groupnameGROUPNAMEProvidegroupnametosearchallthegroups.--user_idUSER_IDProvideuseridtosearchallthegroups.--page_numberPAGE_NUMBERTosearchgroupsforaspecificpage_number.(default:1)--limitLIMITProvidelimittosearchnumberofgroups.(default:100)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)search example with the required argument passed.yeeduworkspacesearch-groups--workspace_id=1--groupname="Yeedu"Console output{"data":[{"group_id":7,"group_name":"Yeedu","group_type":null,"from_date":"2023-12-28T14:01:50.367429+00:00","to_date":"infinity"},{"group_id":11,"group_name":"Yeedu Dev_Team","group_type":null,"from_date":"2023-12-28T14:01:50.367429+00:00","to_date":"infinity"},{"group_id":25,"group_name":"Yeedu_Backend","group_type":null,"from_date":"2024-01-02T09:19:25.770823+00:00","to_date":"infinity"}],"result_set":{"current_page":1,"total_objects":3,"total_pages":1,"limit":100}}match-groupyeeduworkspacematch-group-husage:match-group[-h]--workspace_idWORKSPACE_ID--groupnameGROUPNAME[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--workspace_idWORKSPACE_IDProvideworkspaceidtomatchallthegroups.--groupnameGROUPNAMEProvidegroupnametomatchallthegroups.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)match example with the required argument passed.yeeduworkspacematch-group--workspace_id=1--groupname="Yeedu"Console output[{"group_id":8,"group_name":"Yeedu","group_type":"Unified","from_date":"2023-12-28T14:01:50.367429+00:00","to_date":"infinity"},{"group_id":7,"group_name":"Yeedu","group_type":null,"from_date":"2023-12-28T14:01:50.367429+00:00","to_date":"infinity"}]get-user-accessyeeduworkspaceget-user-access-husage:get-user-access[-h]--workspace_idWORKSPACE_ID--user_idUSER_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--workspace_idWORKSPACE_IDProvideWorkspaceIdtogetthepermissionofauser.--user_idUSER_IDProvideUserIdtogetthepermissionofauser.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)get-user-access example with all the required arguments passed.yeeduworkspaceget-user-access--workspace_id=1--user_id=1Console output{"user_id":"1","username":"YSU0000","workspace":{"workspace_id":"1","name":"spark_jobs_test","description":"Test Spark Curation Jobs"},"tenant_id":"e67f00ad-68aa-46d0-b32e-f3f8dac5427d","user_permission":{"auth_workspace_user_id":3,"permission":{"auth_workspace_perm_id":2,"name":"EDIT","description":"To list, run and edit a spark job configuration in a workspace"},"created_by":{"user_id":1,"username":"YSU0000"},"modified_by":{"user_id":1,"username":"YSU0000"},"last_update_date":"2024-01-08T13:08:16.731517+00:00","from_date":"2024-01-08T13:08:16.731517+00:00","to_date":"infinity"},"group_permission":[{"auth_workspace_group_id":1,"permission":{"auth_workspace_perm_id":2,"name":"EDIT","description":"To list, run and edit a spark job configuration in a workspace"},"group_id":1,"created_by":{"user_id":1,"username":"YSU0000"},"modified_by":{"user_id":1,"username":"YSU0000"},"last_update_date":"2024-01-08T13:08:16.731517+00:00","from_date":"2024-01-08T13:08:16.731517+00:00","to_date":"infinity"}]}get-group-accessyeeduworkspaceget-group-access-husage:get-group-access[-h]--workspace_idWORKSPACE_ID--group_idGROUP_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--workspace_idWORKSPACE_IDProvideWorkspaceIdtogetthepermissionofagroup.--group_idGROUP_IDProvideGroupIdtogetthepermissionofagroup.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)get-group-access example with all the required arguments passed.yeeduworkspaceget-group-access--workspace_id=1--group_id=1Console output{"group_id":"1","group_name":"yeedu-manager","workspace":{"workspace_id":"1","name":"spark_jobs_test","description":"Test Spark Curation Jobs"},"tenant_id":"e67f00ad-68aa-46d0-b32e-f3f8dac5427d","group_permission":{"auth_workspace_group_id":"1","permission":{"auth_workspace_perm_id":2,"name":"EDIT","description":"To list, run and edit a spark job configuration in a workspace"},"created_by":{"user_id":"1","username":"YSU0000"},"modified_by":{"user_id":"1","username":"YSU0000"},"last_update_date":"2024-01-08T14:00:26.953Z","from_date":"2024-01-08T14:00:26.953Z","to_date":null}}list-users-accessyeeduworkspacelist-users-access-husage:list-users-access[-h]--workspace_idWORKSPACE_ID--permission_idPERMISSION_ID[--page_numberPAGE_NUMBER][--limitLIMIT][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--workspace_idWORKSPACE_IDProvideWorkspaceIdtolistalltheusers.--permission_idPERMISSION_IDProvidePermissionIdtolistalltheusers.--page_numberPAGE_NUMBERTolistusersforaspecificpage_number.(default:1)--limitLIMITProvidelimittolistnumberofusers.(default:100)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list-users-access example with the required argument '--workspace_id' and '--permission_id' passed.Console output{"data":{"workspace_id":1,"workspace_name":"spark_jobs_test","description":"Test Spark Jobs","permission":{"permission_id":2,"name":"EDIT","description":"To list, run and edit a spark job configuration in a workspace","users":[{"user_id":1,"username":"YSU0000","email":"ysu0000@modak.com"}]}},"result_set":{"current_page":1,"total_objects":1,"total_pages":1,"limit":100}}list-groups-accessyeeduworkspacelist-groups-access-husage:list-groups-access[-h]--workspace_idWORKSPACE_ID--permission_idPERMISSION_ID[--page_numberPAGE_NUMBER][--limitLIMIT][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--workspace_idWORKSPACE_IDProvideWorkspaceIdtolistallthegroups.--permission_idPERMISSION_IDProvidePermissionIdtolistallthegroups.--page_numberPAGE_NUMBERTolistgroupsforaspecificpage_number.(default:1)--limitLIMITProvidelimittolistnumberofgroups.(default:100)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list-groups-access example with the required argument '--workspace_id' and '--permission_id' passed.yeeduworkspacelist-groups-access--workspace_id=1--permission_id=2Console output{"data":{"workspace_id":1,"workspace_name":"spark_jobs_test","description":"Test Spark Jobs","permission":{"permission_id":2,"name":"EDIT","description":"To list, run and edit a spark job configuration in a workspace","groups":[{"group_id":8,"group_name":"Yeedu","group_type":"Unified"}]}},"result_set":{"current_page":1,"total_objects":1,"total_pages":1,"limit":100}}JobSpark Job ConfigurationCommand NameUtilitycreate-confTo create the Spark Job Configuration.list-confsTo list all the available Job Configurations.search-confsTo search job configurations by job conf name in a workspace.get-confTo get the information about a specific Spark Job Configuration.edit-confTo edit the Spark Job Configuration.enable-confTo enable a specific Spark Job Configuration.disable-confTo disable a specific Spark Job Configuration.create-confyeedujobcreate-conf-husage:create-conf[-h][--cluster_idCLUSTER_ID][--cluster_nameCLUSTER_NAME]--workspace_idWORKSPACE_ID--nameNAME[--files[FILES]][--properties-file[PROPERTIES_FILE]][--confCONF[CONF...]][--packages[PACKAGES]][--repositories[REPOSITORIES]][--jars[JARS]][--archives[ARCHIVES]][--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]][--job-class-name[JOB_CLASS_NAME]][--job-command[JOB_COMMAND]][--job-arguments[JOB_ARGUMENTS]][--job-raw-scala-codeJOB_RAW_SCALA_CODE]--job-type{RawScala,Jar,Python3,SQL}[--max_concurrencyMAX_CONCURRENCY][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--cluster_idCLUSTER_IDProvidecluster_idtocreateaSparkJobConfiguration.--cluster_nameCLUSTER_NAMEProvidecluster_nametocreateaSparkJobConfiguration.--workspace_idWORKSPACE_IDProvideworkspace_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.--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.--job-class-name[JOB_CLASS_NAME]Providejob-class-nametocreateaSparkJobConfiguration.--job-command[JOB_COMMAND]Providejob-commandtocreateaSparkJobConfiguration.--job-arguments[JOB_ARGUMENTS]Providejob-argumentstocreateaSparkJobConfiguration.--job-raw-scala-codeJOB_RAW_SCALA_CODEProvidejob-raw-scala-codefilepathtocreateaSparkJobConfiguration.--job-type{RAW_SCALA,Jar,Python3,SQL}Providejob-typetocreateaSparkJobConfiguration.--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=1--workspace_id=1--name="spark_examples"--job-class-name="org.apache.spark.examples.SparkPi"--job-command="file:///yeedu/object-storage-manager/spark-examples_2.11-2.4.8.jar"--job-arguments=500--job-type=JarConsole output{"job_conf_id":"1","name":"spark_examples","cluster_id":"1","workspace_id":"1","spark_job_type_lang_id":1,"max_concurrency":"0","job_class_name":"org.apache.spark.examples.SparkPi","job_command":"file:///yeedu/object-storage-manager/spark-examples_2.11-2.4.8.jar","job_arguments":"500","job_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,"created_by_id":"1","modified_by_id":"1","last_update_date":"2024-01-08T14:56:51.539Z","from_date":"2024-01-08T14:56:51.539Z","to_date":null}list-confsyeedujoblist-confs-husage:list-confs[-h]--workspace_idWORKSPACE_ID[--enable[{true,false}]][--page_numberPAGE_NUMBER][--limitLIMIT][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--workspace_idWORKSPACE_IDTolistJobConfigurationsofaspecificworkspace.--enable[{true,false}]ProvideenableastrueorfalsetolistJobConfigurationsofaspecificworkspace.--page_numberPAGE_NUMBERTolistJobConfigurationsforaspecificpage_number.(default:1)--limitLIMITProvidelimittolistnumberofJobConfigurations.(default:100)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list-confs example with required and optional arguments passed.yeedujoblist-confs--workspace_id=1--limit=1Console output{"data":[{"job_conf_id":1,"name":"spark_examples","cluster_info":{"cluster_id":1,"name":"yeedu_instance","description":"Test yeedu instance","labels":{"test":"yeedu","resource":"yeedu","vm":"yeedu_node","tenant_id":"1ea17e91-257b-4a6c-82aa-265568d31615"},"idle_timeout_ms":600000,"auto_shutdown":true,"cluster_status":"RUNNING","cluster_type":"YEEDU","compute_engine_id":1,"instance_size":1,"is_spot_instance":false,"enable_public_ip":false,"block_project_ssh_keys":false,"min_instances":1,"max_instances":3,"total_ycu":null,"bootstrap_shell_script":null,"spark_config_id":null,"cluster_conf":{"cluster_conf_id":1,"cluster_conf_name":"n1-standard-4","description":null,"machine_type_category":"general_purpose","machine_type":{"machine_type_id":64,"name":"n1-standard-4","vcpus":4,"memory":"15 GiB","has_cuda":false,"gpu_model":null,"gpus":null,"gpu_memory":null},"machine_volume_conf":{"volume_conf_id":1,"name":"volume_gcp","description":null,"encrypted":true,"size":375,"disk_machine_type":{"disk_machine_type_id":4,"cloud_provider_id":0,"name":"local-ssd","has_fixed_size":true,"min_size":375,"max_size":375},"machine_volume_num":1,"machine_volume_strip_num":1}},"cloud_env":{"cloud_env_id":1,"name":"gcp_cloud_env","description":"yeedu cloud environment","cloud_provider":{"cloud_provider_id":0,"name":"gcp"},"availabilty_zone":{"availabilty_zone_id":75,"name":"us-central1-a","cloud_provider_id":0,"region":"us-central1","description":"Council Bluffs, Iowa, North America"},"machine_network":{"machine_network_conf_id":1,"name":"yeedu_gcp_network","description":null,"network_project_id":"modak-yeedu","network_name":"modak-yeedu-spark-vpc","network_tags":["yeedu","iap-allow"],"subnet":"custom-subnet-modak-yeedu","machine_network_availability_zone":{"availability_zone_id":75,"name":"us-central1-a","cloud_provider_id":0,"region":"us-central1","description":"Council Bluffs, Iowa, North America"}},"cloud_project":"modak-yeedu","credentials_config":{"credential_config_id":1,"name":"modakyeedu-svc","description":null,"credential_type":{"credential_type_id":0,"name":"gcp","cloud_provider_id":0}},"boot_disk_image":{"boot_disk_image_id":1,"name":"gcp_boot_disk","description":"dev boot disk","cloud_provider_id":0,"linux_distro":{"linux_distro_id":0,"distro_name":"UBUNTU","distro_version":"20.04 LTS"},"boot_disk_image":"ubuntu-os-cloud/ubuntu-2004-lts"}},"hive_metastore_conf":{"hive_metastore_conf_id":null,"hive_metastore_conf_name":null},"spark_infra_version":{"spark_infra_version_id":0,"spark_version":"3.2.2","hive_version":"3.2.3","hadoop_version":"3.2.4","scala_version":"2.12.15","python_version":"3.9.5","notebook_support":true},"engine_cluster_spark_config":{"max_parallel_spark_job_execution_per_instance":5,"standalone_workers_number":null},"object_storage_manager":{"object_storage_manager_id":1,"name":"yeedu_osm","description":null,"credentials_config":{"credential_config_id":1,"name":"modakyeedu-svc","description":null,"credential_type_name":"gcp"},"object_storage_bucket_name":"modak-yeedu-nabu"}},"workspace":{"workspace_id":1,"name":"spark_jobs_test","description":"Test Spark Jobs"},"job_count":0,"spark_job_type":{"job_type":"SPARK_JOB","language":"Jar"},"max_concurrency":0,"last_job_run":{"job_id":null,"job_status":null},"job_class_name":"org.apache.spark.examples.SparkPi","job_command":"file:///yeedu/object-storage-manager/spark-examples_2.11-2.4.8.jar","job_arguments":"500","job_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,"created_by":{"user_id":1,"username":"YSU0000"},"modified_by":{"user_id":1,"username":"YSU0000"},"active":true,"last_update_date":"2024-01-08T14:56:51.53996+00:00","from_date":"2024-01-08T14:56:51.53996+00:00","to_date":"infinity"}],"result_set":{"current_page":1,"total_objects":1,"total_pages":1,"limit":100}}search-confsyeedujobsearch-confs-husage:search-confs[-h]--workspace_idWORKSPACE_ID--job_conf_nameJOB_CONF_NAME[--enable[{true,false}]][--page_numberPAGE_NUMBER][--limitLIMIT][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--workspace_idWORKSPACE_IDProvideworkspace_idtosearchjobconfigurationsinit.--job_conf_nameJOB_CONF_NAMEProvidejob_conf_nametosearchjobconfigurations.--enable[{true,false}]Provideenableastrueorfalsetosearchjobconfigurations.--page_numberPAGE_NUMBERTosearchjobconfigurationsforaspecificpage_number.(default:1)--limitLIMITProvidelimittosearchnumberofjobconfigurations.(default:100)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)search-confs example with required and optional arguments passed.yeedujobsearch-confs--workspace_id=1--job_conf_name="spark_"--enable=true--limit=2Console output{"data":[{"job_conf_id":1,"name":"spark_examples","cluster_info":{"cluster_id":1,"name":"yeedu_instance","description":"Test yeedu instance","labels":{"test":"yeedu","resource":"yeedu","vm":"yeedu_node","tenant_id":"1ea17e91-257b-4a6c-82aa-265568d31615"},"idle_timeout_ms":600000,"auto_shutdown":true,"cluster_status":"RUNNING","cluster_type":"YEEDU","compute_engine_id":1,"instance_size":1,"is_spot_instance":false,"enable_public_ip":false,"block_project_ssh_keys":false,"min_instances":1,"max_instances":3,"total_ycu":null,"bootstrap_shell_script":null,"spark_config_id":null,"cluster_conf":{"cluster_conf_id":1,"cluster_conf_name":"n1-standard-4","description":null,"machine_type_category":"general_purpose","machine_type":{"machine_type_id":64,"name":"n1-standard-4","vcpus":4,"memory":"15 GiB","has_cuda":false,"gpu_model":null,"gpus":null,"gpu_memory":null},"machine_volume_conf":{"volume_conf_id":1,"name":"volume_gcp","description":null,"encrypted":true,"size":375,"disk_machine_type":{"disk_machine_type_id":4,"cloud_provider_id":0,"name":"local-ssd","has_fixed_size":true,"min_size":375,"max_size":375},"machine_volume_num":1,"machine_volume_strip_num":1}},"cloud_env":{"cloud_env_id":1,"name":"gcp_cloud_env","description":"yeedu cloud environment","cloud_provider":{"cloud_provider_id":0,"name":"gcp"},"availabilty_zone":{"availabilty_zone_id":75,"name":"us-central1-a","cloud_provider_id":0,"region":"us-central1","description":"Council Bluffs, Iowa, North America"},"machine_network":{"machine_network_conf_id":1,"name":"yeedu_gcp_network","description":null,"network_project_id":"modak-yeedu","network_name":"modak-yeedu-spark-vpc","network_tags":["yeedu","iap-allow"],"subnet":"custom-subnet-modak-yeedu","machine_network_availability_zone":{"availability_zone_id":75,"name":"us-central1-a","cloud_provider_id":0,"region":"us-central1","description":"Council Bluffs, Iowa, North America"}},"cloud_project":"modak-yeedu","credentials_config":{"credential_config_id":1,"name":"modakyeedu-svc","description":null,"credential_type":{"credential_type_id":0,"name":"gcp","cloud_provider_id":0}},"boot_disk_image":{"boot_disk_image_id":1,"name":"gcp_boot_disk","description":"dev boot disk","cloud_provider_id":0,"linux_distro":{"linux_distro_id":0,"distro_name":"UBUNTU","distro_version":"20.04 LTS"},"boot_disk_image":"ubuntu-os-cloud/ubuntu-2004-lts"}},"hive_metastore_conf":{"hive_metastore_conf_id":null,"hive_metastore_conf_name":null},"spark_infra_version":{"spark_infra_version_id":0,"spark_version":"3.2.2","hive_version":"3.2.3","hadoop_version":"3.2.4","scala_version":"2.12.15","python_version":"3.9.5","notebook_support":true},"engine_cluster_spark_config":{"max_parallel_spark_job_execution_per_instance":5,"standalone_workers_number":null},"object_storage_manager":{"object_storage_manager_id":1,"name":"yeedu_osm","description":null,"credentials_config":{"credential_config_id":1,"name":"modakyeedu-svc","description":null,"credential_type_name":"gcp"},"object_storage_bucket_name":"modak-yeedu-nabu"}},"workspace":{"workspace_id":1,"name":"spark_jobs_test","description":"Test Spark Jobs"},"job_count":0,"spark_job_type":{"job_type":"SPARK_JOB","language":"Jar"},"max_concurrency":0,"last_job_run":{"job_id":null,"job_status":null},"job_class_name":"org.apache.spark.examples.SparkPi","job_command":"file:///yeedu/object-storage-manager/spark-examples_2.11-2.4.8.jar","job_arguments":"500","job_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,"created_by":{"user_id":1,"username":"YSU0000"},"modified_by":{"user_id":1,"username":"YSU0000"},"active":true,"last_update_date":"2024-01-08T14:56:51.53996+00:00","from_date":"2024-01-08T14:56:51.53996+00:00","to_date":"infinity"}],"result_set":{"current_page":1,"total_objects":1,"total_pages":1,"limit":100}}get-confyeedujobget-conf-husage:get-conf[-h]--workspace_idWORKSPACE_ID[--job_conf_idJOB_CONF_ID][--job_conf_nameJOB_CONF_NAME][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--workspace_idWORKSPACE_IDProvideworkspaceidtogetinformationaboutaspecificSparkJobConfiguration.--job_conf_idJOB_CONF_IDProvideJobConfigIdtogetinformationaboutaspecificSparkJobConfiguration.--job_conf_nameJOB_CONF_NAMEProvideJobConfignametogetinformationaboutaspecificSparkJobConfiguration.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)get-conf example with the optional and required argument passed.yeedujobget-conf--workspace_id=1--job_conf_id=1Console output{"job_conf_id":1,"name":"spark_examples","cluster_info":{"cluster_id":1,"name":"yeedu_instance","description":"Test yeedu instance","labels":{"test":"yeedu","resource":"yeedu","vm":"yeedu_node","tenant_id":"1ea17e91-257b-4a6c-82aa-265568d31615"},"idle_timeout_ms":600000,"auto_shutdown":true,"cluster_status":"RUNNING","cluster_type":"YEEDU","compute_engine_id":1,"instance_size":1,"is_spot_instance":false,"enable_public_ip":false,"block_project_ssh_keys":false,"min_instances":1,"max_instances":3,"total_ycu":null,"bootstrap_shell_script":null,"spark_config_id":null,"cluster_conf":{"cluster_conf_id":1,"cluster_conf_name":"n1-standard-4","description":null,"machine_type_category":"general_purpose","machine_type":{"machine_type_id":64,"name":"n1-standard-4","vcpus":4,"memory":"15 GiB","has_cuda":false,"gpu_model":null,"gpus":null,"gpu_memory":null},"machine_volume_conf":{"volume_conf_id":1,"name":"volume_gcp","description":null,"encrypted":true,"size":375,"disk_machine_type":{"disk_machine_type_id":4,"cloud_provider_id":0,"name":"local-ssd","has_fixed_size":true,"min_size":375,"max_size":375},"machine_volume_num":1,"machine_volume_strip_num":1}},"cloud_env":{"cloud_env_id":1,"name":"gcp_cloud_env","description":"yeedu cloud environment","cloud_provider":{"cloud_provider_id":0,"name":"gcp"},"availabilty_zone":{"availabilty_zone_id":75,"name":"us-central1-a","cloud_provider_id":0,"region":"us-central1","description":"Council Bluffs, Iowa, North America"},"machine_network":{"machine_network_conf_id":1,"name":"yeedu_gcp_network","description":null,"network_project_id":"modak-yeedu","network_name":"modak-yeedu-spark-vpc","network_tags":["yeedu","iap-allow"],"subnet":"custom-subnet-modak-yeedu","machine_network_availability_zone":{"availability_zone_id":75,"name":"us-central1-a","cloud_provider_id":0,"region":"us-central1","description":"Council Bluffs, Iowa, North America"}},"cloud_project":"modak-yeedu","credentials_config":{"credential_config_id":1,"name":"modakyeedu-svc","description":null,"credential_type":{"credential_type_id":0,"name":"gcp","cloud_provider_id":0}},"boot_disk_image":{"boot_disk_image_id":1,"name":"gcp_boot_disk","description":"dev boot disk","cloud_provider_id":0,"linux_distro":{"linux_distro_id":0,"distro_name":"UBUNTU","distro_version":"20.04 LTS"},"boot_disk_image":"ubuntu-os-cloud/ubuntu-2004-lts"}},"hive_metastore_conf":{"hive_metastore_conf_id":null,"hive_metastore_conf_name":null},"spark_infra_version":{"spark_infra_version_id":0,"spark_version":"3.2.2","hive_version":"3.2.3","hadoop_version":"3.2.4","scala_version":"2.12.15","python_version":"3.9.5","notebook_support":true},"engine_cluster_spark_config":{"max_parallel_spark_job_execution_per_instance":5,"standalone_workers_number":null},"object_storage_manager":{"object_storage_manager_id":1,"name":"yeedu_osm","description":null,"credentials_config":{"credential_config_id":1,"name":"modakyeedu-svc","description":null,"credential_type_name":"gcp"},"object_storage_bucket_name":"modak-yeedu-nabu"}},"workspace":{"workspace_id":1,"name":"spark_jobs_test","description":"Test Spark Jobs"},"job_count":0,"spark_job_type":{"job_type":"SPARK_JOB","language":"Jar"},"max_concurrency":0,"last_job_run":{"job_id":null,"job_status":null},"job_class_name":"org.apache.spark.examples.SparkPi","job_command":"file:///yeedu/object-storage-manager/spark-examples_2.11-2.4.8.jar","job_arguments":"500","job_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,"created_by":{"user_id":1,"username":"YSU0000"},"modified_by":{"user_id":1,"username":"YSU0000"},"active":true,"last_update_date":"2024-01-08T14:56:51.53996+00:00","from_date":"2024-01-08T14:56:51.53996+00:00","to_date":"infinity"}edit-confyeedujobedit-conf-husage:edit-conf[-h]--workspace_idWORKSPACE_ID[--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]][--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]][--job-class-name[JOB_CLASS_NAME]][--name[NAME]][--job-command[JOB_COMMAND]][--job-arguments[JOB_ARGUMENTS]][--job-raw-scala-codeJOB_RAW_SCALA_CODE][--max_concurrencyMAX_CONCURRENCY][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--workspace_idWORKSPACE_IDProvideWorkspaceIdtoeditaSparkJobConfiguration.--job_conf_idJOB_CONF_IDProvideJobConfigIdtoeditaSparkJobConfiguration.--job_conf_nameJOB_CONF_NAMEProvideJobConfigNametoeditaSparkJobConfiguration.--cluster_idCLUSTER_IDProvidecluster_idtoeditaSparkJobConfiguration.--cluster_nameCLUSTER_NAMEProvidecluster_nametoeditaSparkJobConfiguration.--files[FILES]ProvidefilestoeditaSparkJobConfiguration.--properties-file[PROPERTIES_FILE]Provideproperties-filetoeditaSparkJobConfiguration.--confCONF[CONF...]ProvideconftoeditaSparkJobConfiguration.--packages[PACKAGES]ProvidepackagestoeditaSparkJobConfiguration.--repositories[REPOSITORIES]ProviderepositoriestoeditaSparkJobConfiguration.--jars[JARS]ProvidejarstoeditaSparkJobConfiguration.--archives[ARCHIVES]ProvidearchivestoeditaSparkJobConfiguration.--driver-memory[DRIVER_MEMORY]Providedriver-memorytoeditaSparkJobConfiguration.--driver-java-options[DRIVER_JAVA_OPTIONS]Providedriver-java-optionstoeditaSparkJobConfiguration.--driver-library-path[DRIVER_LIBRARY_PATH]Providedriver-library-pathtoeditaSparkJobConfiguration.--driver-class-path[DRIVER_CLASS_PATH]Providedriver-class-pathtoeditaSparkJobConfiguration.--executor-memory[EXECUTOR_MEMORY]Provideexecutor-memorytoeditaSparkJobConfiguration.--driver-cores[DRIVER_CORES]Providedriver-corestoeditaSparkJobConfiguration.--total-executor-cores[TOTAL_EXECUTOR_CORES]Providetotal-executor-corestoeditaSparkJobConfiguration.--executor-cores[EXECUTOR_CORES]Provideexecutor-corestoeditaSparkJobConfiguration.--num-executors[NUM_EXECUTORS]Providenum-executorstoeditaSparkJobConfiguration.--principal[PRINCIPAL]ProvideprincipaltoeditaSparkJobConfiguration.--keytab[KEYTAB]ProvidekeytabtoeditaSparkJobConfiguration.--queue[QUEUE]ProvidequeuetoeditaSparkJobConfiguration.--job-class-name[JOB_CLASS_NAME]Providejob-class-nametoeditaSparkJobConfiguration.--name[NAME]ProvidenametoeditaSparkJobConfiguration.--job-command[JOB_COMMAND]Providejob-commandtoeditaSparkJobConfiguration.--job-arguments[JOB_ARGUMENTS]Providejob-argumentstoeditaSparkJobConfiguration.--job-raw-scala-codeJOB_RAW_SCALA_CODEProvidejob-raw-scala-codefilepathtoeditaSparkJobConfiguration.--max_concurrencyMAX_CONCURRENCYProvidemax_concurrencynumbertolimitthenumberofjobssubmitted.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)edit-conf example with the required arguments and other optional arguments passed which is to be updated.yeedujobedit-conf--workspace_id=1--job_conf_name="spark_examples"--job-arguments=1000Console output{"job_conf_id":"1","name":"spark_examples","cluster_id":"1","workspace_id":"1","spark_job_type_lang_id":1,"max_concurrency":"0","job_class_name":"org.apache.spark.examples.SparkPi","job_command":"file:///yeedu/object-storage-manager/spark-examples_2.11-2.4.8.jar","job_arguments":"1000","job_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,"created_by_id":"1","modified_by_id":"1","last_update_date":"2024-01-08T15:37:55.738Z","from_date":"2024-01-08T14:56:51.539Z","to_date":null}enable-confyeedujobenable-conf-husage:enable-conf[-h]--workspace_idWORKSPACE_ID[--job_conf_idJOB_CONF_ID][--job_conf_nameJOB_CONF_NAME][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--workspace_idWORKSPACE_IDProvideWorkspaceIdtoenabletheSparkJobConfiguration.--job_conf_idJOB_CONF_IDProvideJobConfigIdtoenabletheSparkJobConfiguration.--job_conf_nameJOB_CONF_NAMEProvideJobConfigNametoenabletheSparkJobConfiguration.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)enable-conf example with the required arguments passed.yeedujobenable-conf--workspace_id=1--job_conf_id=1Console output{"job_conf_id":"1","name":"spark_examples","cluster_id":"1","workspace_id":"1","spark_job_type_lang_id":1,"max_concurrency":"0","job_class_name":"org.apache.spark.examples.SparkPi","job_command":"file:///yeedu/object-storage-manager/spark-examples_2.11-2.4.8.jar","job_arguments":"1000","job_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,"created_by_id":"1","modified_by_id":"1","last_update_date":"2024-01-08T15:45:35.462Z","from_date":"2024-01-08T14:56:51.539Z","to_date":null}disable-confyeedujobdisable-conf-husage:disable-conf[-h]--workspace_idWORKSPACE_ID[--job_conf_idJOB_CONF_ID][--job_conf_nameJOB_CONF_NAME][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--workspace_idWORKSPACE_IDProvideWorkspaceIdtodisabletheSparkJobConfiguration.--job_conf_idJOB_CONF_IDProvideJobConfigIdtodisabletheSparkJobConfiguration.--job_conf_nameJOB_CONF_NAMEProvideJobConfigNametodisabletheSparkJobConfiguration.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)disable-conf example with the required arguments passed.yeedujobdisable-conf--workspace_id=1--job_conf_id=1Console output{"job_conf_id":"1","name":"spark_examples","cluster_id":"1","workspace_id":"1","spark_job_type_lang_id":1,"max_concurrency":"0","job_class_name":"org.apache.spark.examples.SparkPi","job_command":"file:///yeedu/object-storage-manager/spark-examples_2.11-2.4.8.jar","job_arguments":"1000","job_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,"created_by_id":"1","modified_by_id":"1","last_update_date":"2024-01-08T15:45:24.088Z","from_date":"2024-01-08T14:56:51.539Z","to_date":"2024-01-08T15:45:24.088Z"}Spark Job InstanceCommand NameUtilitystartTo run a Spark Job Instance.listTo list all the available Spark Job Instances.searchTo search Spark Job Instances by similar job id.getTo get information about a specific Spark Job Instance.stopTo stop a specific Spark Job Instance.get-statusTo get all the status information about a specific Spark Job Instance.logsTo download Spark Job Instance logs by job id.startyeedujobstart-husage:start[-h][--job_conf_idJOB_CONF_ID][--job_conf_nameJOB_CONF_NAME]--workspace_idWORKSPACE_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--job_conf_idJOB_CONF_IDTorunaSparkJobInstance,enterjob_conf_id.--job_conf_nameJOB_CONF_NAMETorunaSparkJobInstance,enterjob_conf_name.--workspace_idWORKSPACE_IDTorunaSparkJobInstance,enterworkspace_id.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)start example with one of the required argument passed.yeedujobstart--workspace_id=1--job_conf_id=1Console output{"job_id":"1","job_conf_id":"1","cluster_id":"1","tenant_id":"1ea17e91-257b-4a6c-82aa-265568d31615","created_by_id":"1","modified_by_id":"1","last_update_date":"2024-01-09T07:06:00.301Z","from_date":"2024-01-09T07:06:00.301Z","to_date":null}listyeedujoblist-husage:list[-h]--workspace_idWORKSPACE_ID[--cluster_idCLUSTER_ID][--job_conf_idJOB_CONF_ID][--job_conf_nameJOB_CONF_NAME][--job_status{submitted,running,done,error,terminated,stopping,stopped}][--job_type{SPARK_JOB,SPARK_SQL,NOTEBOOK}][--page_numberPAGE_NUMBER][--limitLIMIT][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--workspace_idWORKSPACE_IDTolistSparkJobInstancesofaspecificworkspace_id.--cluster_idCLUSTER_IDTolistSparkJobInstancesofaspecificcluster_id.--job_conf_idJOB_CONF_IDTolistSparkJobInstancesofaspecificjob_conf_id.--job_conf_nameJOB_CONF_NAMETolistSparkJobInstancesofaspecificjob_conf_name.--job_status{submitted,running,done,error,terminated,stopping,stopped}TolistSparkJobInstancesofaspecificjob_status.--job_type{SPARK_JOB,SPARK_SQL,NOTEBOOK}TolistSparkJobInstancesofaspecificjob_type.--page_numberPAGE_NUMBERTolistSparkJobInstancesforaspecificpage_number.(default:1)--limitLIMITProvidelimittolistnumberofjobinstances.(default:100)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list example with required and optional arguments passed.yeedujoblist--workspace_id=1--limit=2Console output{"data":[{"job_id":3,"job_application_id":"app-20231004073629-0003","job_status":"SUBMITTED","total_job_time":185.698294,"job_conf":{"job_conf_id":1,"name":"spark_examples","cluster_info":{"cluster_id":1,"name":"yeedu_instance","description":"Test yeedu instance","labels":{"test":"yeedu","resource":"yeedu","vm":"yeedu_node","tenant_id":"1ea17e91-257b-4a6c-82aa-265568d31615"},"idle_timeout_ms":600000,"auto_shutdown":true,"cluster_status":"RUNNING","cluster_type":"YEEDU","compute_engine_id":1,"instance_size":1,"is_spot_instance":false,"enable_public_ip":false,"block_project_ssh_keys":false,"min_instances":1,"max_instances":3,"total_ycu":null,"bootstrap_shell_script":null,"spark_config_id":null,"cluster_conf":{"cluster_conf_id":1,"cluster_conf_name":"n1-standard-4","description":null,"machine_type_category":"general_purpose","machine_type":{"machine_type_id":64,"name":"n1-standard-4","vcpus":4,"memory":"15 GiB","has_cuda":false,"gpu_model":null,"gpus":null,"gpu_memory":null},"machine_volume_conf":{"volume_conf_id":1,"name":"volume_gcp_1","description":null,"encrypted":true,"size":375,"disk_machine_type":{"disk_machine_type_id":4,"cloud_provider_id":0,"name":"local-ssd","has_fixed_size":true,"min_size":375,"max_size":375},"machine_volume_num":1,"machine_volume_strip_num":1}},"cloud_env":{"cloud_env_id":1,"name":"gcp_cloud_env","description":"yeedu cloud environment","cloud_provider":{"cloud_provider_id":0,"name":"gcp"},"availabilty_zone":{"availabilty_zone_id":75,"name":"us-central1-a","cloud_provider_id":0,"region":"us-central1","description":"Council Bluffs, Iowa, North America"},"machine_network":{"machine_network_conf_id":1,"name":"yeedu_gcp_network","description":null,"network_project_id":"modak-yeedu","network_name":"modak-yeedu-spark-vpc","network_tags":["yeedu","iap-allow"],"subnet":"custom-subnet-modak-yeedu","machine_network_availability_zone":{"availability_zone_id":75,"name":"us-central1-a","cloud_provider_id":0,"region":"us-central1","description":"Council Bluffs, Iowa, North America"}},"cloud_project":"modak-yeedu","credentials_config":{"credential_config_id":1,"name":"modakyeedu-svc","description":null,"credential_type":{"credential_type_id":0,"name":"gcp","cloud_provider_id":0}},"boot_disk_image":{"boot_disk_image_id":1,"name":"gcp_boot_disk","description":"dev boot disk","cloud_provider_id":0,"linux_distro":{"linux_distro_id":0,"distro_name":"UBUNTU","distro_version":"20.04 LTS"},"boot_disk_image":"ubuntu-os-cloud/ubuntu-2004-lts"}},"hive_metastore_conf":{"hive_metastore_conf_id":null,"hive_metastore_conf_name":null},"spark_infra_version":{"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","python_version":"3.9.5","notebook_support":false},"engine_cluster_spark_config":{"max_parallel_spark_job_execution_per_instance":5,"standalone_workers_number":null},"object_storage_manager":{"object_storage_manager_id":1,"name":"yeedu_osm","description":"test","credentials_config":{"credential_config_id":1,"name":"modakyeedu-svc","description":null,"credential_type_name":"gcp"},"object_storage_bucket_name":"modak-yeedu-nabu"}},"workspace":{"workspace_id":1,"name":"spark_jobs_test","description":"Test Spark Jobs"},"spark_job_type":{"job_type":"SPARK_JOB","language":"Jar"},"max_concurrency":0,"job_class_name":"org.apache.spark.examples.SparkPi","job_command":"file:///yeedu/object-storage-manager/spark-examples_2.11-2.4.8.jar","job_arguments":"250","job_rawScalaCode":null,"files":null,"properties_file":null,"conf":null,"packages":null,"repositories":null,"jars":null,"archives":null,"driver_memory":null,"driver_java_options":"-Dderby.system.home=/yeedu/spark_metastores/1703774163-11129","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":6,"workflow_job_id":6,"status":"SENT","from_date":"2024-01-09T07:06:00.301753+00:00","to_date":"infinity"}},"tenant_id":"1ea17e91-257b-4a6c-82aa-265568d31615","created_by":{"user_id":1,"username":"YSU0000"},"modified_by":{"user_id":1,"username":"YSU0000"},"last_update_date":"2024-01-09T07:06:00.301753+00:00","from_date":"2024-01-09T07:06:00.301753+00:00","to_date":"infinity"},{"job_id":1,"job_application_id":"app-20231004073629-0002","job_status":"STOPPED","total_job_time":82.614248,"job_conf":{"job_conf_id":1,"name":"spark_examples","cluster_info":{"cluster_id":1,"name":"yeedu_instance","description":"Test yeedu instance","labels":{"test":"yeedu","resource":"yeedu","vm":"yeedu_node","tenant_id":"1ea17e91-257b-4a6c-82aa-265568d31615"},"idle_timeout_ms":600000,"auto_shutdown":true,"cluster_status":"RUNNING","cluster_type":"YEEDU","compute_engine_id":1,"instance_size":1,"is_spot_instance":false,"enable_public_ip":false,"block_project_ssh_keys":false,"min_instances":1,"max_instances":3,"total_ycu":null,"bootstrap_shell_script":null,"spark_config_id":null,"cluster_conf":{"cluster_conf_id":1,"cluster_conf_name":"n1-standard-4","description":null,"machine_type_category":"general_purpose","machine_type":{"machine_type_id":64,"name":"n1-standard-4","vcpus":4,"memory":"15 GiB","has_cuda":false,"gpu_model":null,"gpus":null,"gpu_memory":null},"machine_volume_conf":{"volume_conf_id":1,"name":"volume_gcp","description":null,"encrypted":true,"size":375,"disk_machine_type":{"disk_machine_type_id":4,"cloud_provider_id":0,"name":"local-ssd","has_fixed_size":true,"min_size":375,"max_size":375},"machine_volume_num":1,"machine_volume_strip_num":1}},"cloud_env":{"cloud_env_id":1,"name":"gcp_cloud_env","description":"yeedu cloud environment","cloud_provider":{"cloud_provider_id":0,"name":"gcp"},"availabilty_zone":{"availabilty_zone_id":75,"name":"us-central1-a","cloud_provider_id":0,"region":"us-central1","description":"Council Bluffs, Iowa, North America"},"machine_network":{"machine_network_conf_id":1,"name":"yeedu_gcp_network","description":null,"network_project_id":"modak-yeedu","network_name":"modak-yeedu-spark-vpc","network_tags":["yeedu","iap-allow"],"subnet":"custom-subnet-modak-yeedu","machine_network_availability_zone":{"availability_zone_id":75,"name":"us-central1-a","cloud_provider_id":0,"region":"us-central1","description":"Council Bluffs, Iowa, North America"}},"cloud_project":"modak-yeedu","credentials_config":{"credential_config_id":1,"name":"modakyeedu-svc","description":null,"credential_type":{"credential_type_id":0,"name":"gcp","cloud_provider_id":0}},"boot_disk_image":{"boot_disk_image_id":1,"name":"gcp_boot_disk","description":"dev boot disk","cloud_provider_id":0,"linux_distro":{"linux_distro_id":0,"distro_name":"UBUNTU","distro_version":"20.04 LTS"},"boot_disk_image":"ubuntu-os-cloud/ubuntu-2004-lts"}},"hive_metastore_conf":{"hive_metastore_conf_id":null,"hive_metastore_conf_name":null},"spark_infra_version":{"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","python_version":"3.9.5","notebook_support":false},"engine_cluster_spark_config":{"max_parallel_spark_job_execution_per_instance":5,"standalone_workers_number":null},"object_storage_manager":{"object_storage_manager_id":1,"name":"yeedu_osm","description":"test","credentials_config":{"credential_config_id":1,"name":"modakyeedu-svc","description":null,"credential_type_name":"gcp"},"object_storage_bucket_name":"modak-yeedu-nabu"}},"workspace":{"workspace_id":1,"name":"spark_jobs_test","description":"Test Spark Jobs"},"spark_job_type":{"job_type":"SPARK_JOB","language":"Jar"},"max_concurrency":0,"job_class_name":"org.apache.spark.examples.SparkPi","job_command":"file:///yeedu/object-storage-manager/spark-examples_2.11-2.4.8.jar","job_arguments":"250","job_rawScalaCode":null,"files":null,"properties_file":null,"conf":null,"packages":null,"repositories":null,"jars":null,"archives":null,"driver_memory":null,"driver_java_options":"-Dderby.system.home=/yeedu/spark_metastores/1703774163-11129","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":3,"workflow_job_id":3,"status":"DONE","from_date":"2023-12-28T14:43:19.941574+00:00","to_date":"2023-12-28T14:44:42.555822+00:00"}},"tenant_id":"1ea17e91-257b-4a6c-82aa-265568d31615","created_by":{"user_id":1,"username":"YSU0000"},"modified_by":{"user_id":1,"username":"YSU0000"},"last_update_date":"2023-12-28T14:43:19.941574+00:00","from_date":"2023-12-28T14:43:19.941574+00:00","to_date":"2023-12-28T14:44:42.555822+00:00"}],"result_set":{"current_page":1,"total_objects":2,"total_pages":1,"limit":100}}list example to list spark jobs of a particular workspace having specific spark job status.yeedujoblist--workspace_id=1--job_status=done--limit=1Console output{"data":[{"job_id":1,"job_application_id":"app-20231004073629-0002","job_status":"DONE","total_job_time":82.614248,"job_conf":{"job_conf_id":1,"name":"spark_examples","cluster_info":{"cluster_id":1,"name":"yeedu_instance","description":"Test yeedu instance","labels":{"test":"yeedu","resource":"yeedu","vm":"yeedu_node","tenant_id":"1ea17e91-257b-4a6c-82aa-265568d31615"},"idle_timeout_ms":600000,"auto_shutdown":true,"cluster_status":"RUNNING","cluster_type":"YEEDU","compute_engine_id":1,"instance_size":1,"is_spot_instance":false,"enable_public_ip":false,"block_project_ssh_keys":false,"min_instances":1,"max_instances":3,"total_ycu":null,"bootstrap_shell_script":null,"spark_config_id":null,"cluster_conf":{"cluster_conf_id":1,"cluster_conf_name":"n1-standard-4","description":null,"machine_type_category":"general_purpose","machine_type":{"machine_type_id":64,"name":"n1-standard-4","vcpus":4,"memory":"15 GiB","has_cuda":false,"gpu_model":null,"gpus":null,"gpu_memory":null},"machine_volume_conf":{"volume_conf_id":1,"name":"volume_gcp","description":null,"encrypted":true,"size":375,"disk_machine_type":{"disk_machine_type_id":4,"cloud_provider_id":0,"name":"local-ssd","has_fixed_size":true,"min_size":375,"max_size":375},"machine_volume_num":1,"machine_volume_strip_num":1}},"cloud_env":{"cloud_env_id":1,"name":"gcp_cloud_env","description":"yeedu cloud environment","cloud_provider":{"cloud_provider_id":0,"name":"gcp"},"availabilty_zone":{"availabilty_zone_id":75,"name":"us-central1-a","cloud_provider_id":0,"region":"us-central1","description":"Council Bluffs, Iowa, North America"},"machine_network":{"machine_network_conf_id":1,"name":"yeedu_gcp_network","description":null,"network_project_id":"modak-yeedu","network_name":"modak-yeedu-spark-vpc","network_tags":["yeedu","iap-allow"],"subnet":"custom-subnet-modak-yeedu","machine_network_availability_zone":{"availability_zone_id":75,"name":"us-central1-a","cloud_provider_id":0,"region":"us-central1","description":"Council Bluffs, Iowa, North America"}},"cloud_project":"modak-yeedu","credentials_config":{"credential_config_id":1,"name":"modakyeedu-svc","description":null,"credential_type":{"credential_type_id":0,"name":"gcp","cloud_provider_id":0}},"boot_disk_image":{"boot_disk_image_id":1,"name":"gcp_boot_disk","description":"dev boot disk","cloud_provider_id":0,"linux_distro":{"linux_distro_id":0,"distro_name":"UBUNTU","distro_version":"20.04 LTS"},"boot_disk_image":"ubuntu-os-cloud/ubuntu-2004-lts"}},"hive_metastore_conf":{"hive_metastore_conf_id":null,"hive_metastore_conf_name":null},"spark_infra_version":{"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","python_version":"3.9.5","notebook_support":false},"engine_cluster_spark_config":{"max_parallel_spark_job_execution_per_instance":5,"standalone_workers_number":null},"object_storage_manager":{"object_storage_manager_id":1,"name":"yeedu_osm","description":"test","credentials_config":{"credential_config_id":1,"name":"modakyeedu-svc","description":null,"credential_type_name":"gcp"},"object_storage_bucket_name":"modak-yeedu-nabu"}},"workspace":{"workspace_id":1,"name":"spark_jobs_test","description":"Test Spark Jobs"},"spark_job_type":{"job_type":"SPARK_JOB","language":"Jar"},"max_concurrency":0,"job_class_name":"org.apache.spark.examples.SparkPi","job_command":"file:///yeedu/object-storage-manager/spark-examples_2.11-2.4.8.jar","job_arguments":"250","job_rawScalaCode":null,"files":null,"properties_file":null,"conf":null,"packages":null,"repositories":null,"jars":null,"archives":null,"driver_memory":null,"driver_java_options":"-Dderby.system.home=/yeedu/spark_metastores/1703774163-11129","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":3,"workflow_job_id":3,"status":"DONE","from_date":"2023-12-28T14:43:19.941574+00:00","to_date":"2023-12-28T14:44:42.555822+00:00"}},"tenant_id":"1ea17e91-257b-4a6c-82aa-265568d31615","created_by":{"user_id":1,"username":"YSU0000"},"modified_by":{"user_id":1,"username":"YSU0000"},"last_update_date":"2023-12-28T14:43:19.941574+00:00","from_date":"2023-12-28T14:43:19.941574+00:00","to_date":"2023-12-28T14:44:42.555822+00:00"}],"result_set":{"current_page":1,"total_objects":20,"total_pages":20,"limit":1,"next_page":2}}searchyeedujobsearch-husage:search[-h]--workspace_idWORKSPACE_ID--job_conf_nameJOB_CONF_NAME[--cluster_idCLUSTER_ID][--job_status{submitted,running,done,error,terminated,stopping,stopped}][--job_type{SPARK_JOB,SPARK_SQL,NOTEBOOK}][--page_numberPAGE_NUMBER][--limitLIMIT][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--workspace_idWORKSPACE_IDProvideworkspaceidtosearchSparkJobInstancesinit.--job_conf_nameJOB_CONF_NAMETosearchSparkJobInstancesofaspecificjob_conf_name.--cluster_idCLUSTER_IDTosearchSparkJobInstancesofaspecificcluster_id.--job_status{submitted,running,done,error,terminated,stopping,stopped}TosearchSparkJobInstancesofaspecificjob_status.--job_type{SPARK_JOB,SPARK_SQL,NOTEBOOK}TosearchSparkJobInstancesofaspecificjob_type.--page_numberPAGE_NUMBERTosearchSparkJobInstancesforaspecificpage_number.(default:1)--limitLIMITProvidelimittosearchnumberofSparkJobInstances.(default:100)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)search example with required and optional arguments passed.yeedujobsearch--workspace_id=1--job_id=1--limit=1Console output{"data":[{"job_id":1,"job_application_id":"app-20231004073629-0002","job_status":"DONE","total_job_time":82.614248,"job_conf":{"job_conf_id":1,"name":"spark_examples","cluster_info":{"cluster_id":1,"name":"yeedu_instance","description":"Test yeedu instance","labels":{"test":"yeedu","resource":"yeedu","vm":"yeedu_node","tenant_id":"1ea17e91-257b-4a6c-82aa-265568d31615"},"idle_timeout_ms":600000,"auto_shutdown":true,"cluster_status":"RUNNING","cluster_type":"YEEDU","compute_engine_id":1,"instance_size":1,"is_spot_instance":false,"enable_public_ip":false,"block_project_ssh_keys":false,"min_instances":1,"max_instances":3,"total_ycu":null,"bootstrap_shell_script":null,"spark_config_id":null,"cluster_conf":{"cluster_conf_id":1,"cluster_conf_name":"n1-standard-4","description":null,"machine_type_category":"general_purpose","machine_type":{"machine_type_id":64,"name":"n1-standard-4","vcpus":4,"memory":"15 GiB","has_cuda":false,"gpu_model":null,"gpus":null,"gpu_memory":null},"machine_volume_conf":{"volume_conf_id":1,"name":"volume_gcp","description":null,"encrypted":true,"size":375,"disk_machine_type":{"disk_machine_type_id":4,"cloud_provider_id":0,"name":"local-ssd","has_fixed_size":true,"min_size":375,"max_size":375},"machine_volume_num":1,"machine_volume_strip_num":1}},"cloud_env":{"cloud_env_id":1,"name":"gcp_cloud_env","description":"yeedu cloud environment","cloud_provider":{"cloud_provider_id":0,"name":"gcp"},"availabilty_zone":{"availabilty_zone_id":75,"name":"us-central1-a","cloud_provider_id":0,"region":"us-central1","description":"Council Bluffs, Iowa, North America"},"machine_network":{"machine_network_conf_id":1,"name":"yeedu_gcp_network","description":null,"network_project_id":"modak-yeedu","network_name":"modak-yeedu-spark-vpc","network_tags":["yeedu","iap-allow"],"subnet":"custom-subnet-modak-yeedu","machine_network_availability_zone":{"availability_zone_id":75,"name":"us-central1-a","cloud_provider_id":0,"region":"us-central1","description":"Council Bluffs, Iowa, North America"}},"cloud_project":"modak-yeedu","credentials_config":{"credential_config_id":1,"name":"modakyeedu-svc","description":null,"credential_type":{"credential_type_id":0,"name":"gcp","cloud_provider_id":0}},"boot_disk_image":{"boot_disk_image_id":1,"name":"gcp_boot_disk","description":"dev boot disk","cloud_provider_id":0,"linux_distro":{"linux_distro_id":0,"distro_name":"UBUNTU","distro_version":"20.04 LTS"},"boot_disk_image":"ubuntu-os-cloud/ubuntu-2004-lts"}},"hive_metastore_conf":{"hive_metastore_conf_id":null,"hive_metastore_conf_name":null},"spark_infra_version":{"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","python_version":"3.9.5","notebook_support":false},"engine_cluster_spark_config":{"max_parallel_spark_job_execution_per_instance":5,"standalone_workers_number":null},"object_storage_manager":{"object_storage_manager_id":1,"name":"yeedu_osm","description":"test","credentials_config":{"credential_config_id":1,"name":"modakyeedu-svc","description":null,"credential_type_name":"gcp"},"object_storage_bucket_name":"modak-yeedu-nabu"}},"workspace":{"workspace_id":1,"name":"spark_jobs_test","description":"Test Spark Jobs"},"spark_job_type":{"job_type":"SPARK_JOB","language":"Jar"},"max_concurrency":0,"job_class_name":"org.apache.spark.examples.SparkPi","job_command":"file:///yeedu/object-storage-manager/spark-examples_2.11-2.4.8.jar","job_arguments":"250","job_rawScalaCode":null,"files":null,"properties_file":null,"conf":null,"packages":null,"repositories":null,"jars":null,"archives":null,"driver_memory":null,"driver_java_options":"-Dderby.system.home=/yeedu/spark_metastores/1703774163-11129","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":3,"workflow_job_id":3,"status":"DONE","from_date":"2023-12-28T14:43:19.941574+00:00","to_date":"2023-12-28T14:44:42.555822+00:00"}},"tenant_id":"1ea17e91-257b-4a6c-82aa-265568d31615","created_by":{"user_id":1,"username":"YSU0000"},"modified_by":{"user_id":1,"username":"YSU0000"},"last_update_date":"2023-12-28T14:43:19.941574+00:00","from_date":"2023-12-28T14:43:19.941574+00:00","to_date":"2023-12-28T14:44:42.555822+00:00"}],"result_set":{"current_page":1,"total_objects":1,"total_pages":1,"limit":1}}getyeedujobget-husage:get[-h]--job_idJOB_ID--workspace_idWORKSPACE_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--job_idJOB_IDProvidejob_idtogetinformationaboutaspecificSparkJobInstance.--workspace_idWORKSPACE_IDProvideworkspace_idtogetinformationaboutaspecificSparkJobInstance.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)get example with all the required arguments passed.yeedujobget--workspace_id=1--job_id=90Console output{"job_id":1,"job_application_id":"app-20231004073629-0002","job_status":"DONE","total_job_time":82.614248,"job_conf":{"job_conf_id":1,"name":"spark_examples","cluster_info":{"cluster_id":1,"name":"yeedu_instance","description":"Test yeedu instance","labels":{"test":"yeedu","resource":"yeedu","vm":"yeedu_node","tenant_id":"1ea17e91-257b-4a6c-82aa-265568d31615"},"idle_timeout_ms":600000,"auto_shutdown":true,"cluster_status":"RUNNING","cluster_type":"YEEDU","compute_engine_id":1,"instance_size":1,"is_spot_instance":false,"enable_public_ip":false,"block_project_ssh_keys":false,"min_instances":1,"max_instances":3,"total_ycu":null,"bootstrap_shell_script":null,"spark_config_id":null,"cluster_conf":{"cluster_conf_id":1,"cluster_conf_name":"n1-standard-4","description":null,"machine_type_category":"general_purpose","machine_type":{"machine_type_id":64,"name":"n1-standard-4","vcpus":4,"memory":"15 GiB","has_cuda":false,"gpu_model":null,"gpus":null,"gpu_memory":null},"machine_volume_conf":{"volume_conf_id":1,"name":"volume_gcp","description":null,"encrypted":true,"size":375,"disk_machine_type":{"disk_machine_type_id":4,"cloud_provider_id":0,"name":"local-ssd","has_fixed_size":true,"min_size":375,"max_size":375},"machine_volume_num":1,"machine_volume_strip_num":1}},"cloud_env":{"cloud_env_id":1,"name":"gcp_cloud_env","description":"yeedu cloud environment","cloud_provider":{"cloud_provider_id":0,"name":"gcp"},"availabilty_zone":{"availabilty_zone_id":75,"name":"us-central1-a","cloud_provider_id":0,"region":"us-central1","description":"Council Bluffs, Iowa, North America"},"machine_network":{"machine_network_conf_id":1,"name":"yeedu_gcp_network","description":null,"network_project_id":"modak-yeedu","network_name":"modak-yeedu-spark-vpc","network_tags":["yeedu","iap-allow"],"subnet":"custom-subnet-modak-yeedu","machine_network_availability_zone":{"availability_zone_id":75,"name":"us-central1-a","cloud_provider_id":0,"region":"us-central1","description":"Council Bluffs, Iowa, North America"}},"cloud_project":"modak-yeedu","credentials_config":{"credential_config_id":1,"name":"modakyeedu-svc","description":null,"credential_type":{"credential_type_id":0,"name":"gcp","cloud_provider_id":0}},"boot_disk_image":{"boot_disk_image_id":1,"name":"gcp_boot_disk","description":"dev boot disk","cloud_provider_id":0,"linux_distro":{"linux_distro_id":0,"distro_name":"UBUNTU","distro_version":"20.04 LTS"},"boot_disk_image":"ubuntu-os-cloud/ubuntu-2004-lts"}},"hive_metastore_conf":{"hive_metastore_conf_id":null,"hive_metastore_conf_name":null},"spark_infra_version":{"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","python_version":"3.9.5","notebook_support":false},"engine_cluster_spark_config":{"max_parallel_spark_job_execution_per_instance":5,"standalone_workers_number":null},"object_storage_manager":{"object_storage_manager_id":1,"name":"yeedu_osm","description":"test","credentials_config":{"credential_config_id":1,"name":"modakyeedu-svc","description":null,"credential_type_name":"gcp"},"object_storage_bucket_name":"modak-yeedu-nabu"}},"workspace":{"workspace_id":1,"name":"spark_jobs_test","description":"Test Spark Jobs"},"spark_job_type":{"job_type":"SPARK_JOB","language":"Jar"},"max_concurrency":0,"job_class_name":"org.apache.spark.examples.SparkPi","job_command":"file:///yeedu/object-storage-manager/spark-examples_2.11-2.4.8.jar","job_arguments":"250","job_rawScalaCode":null,"files":null,"properties_file":null,"conf":null,"packages":null,"repositories":null,"jars":null,"archives":null,"driver_memory":null,"driver_java_options":"-Dderby.system.home=/yeedu/spark_metastores/1703774163-11129","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":3,"workflow_job_id":3,"status":"DONE","from_date":"2023-12-28T14:43:19.941574+00:00","to_date":"2023-12-28T14:44:42.555822+00:00"}},"tenant_id":"1ea17e91-257b-4a6c-82aa-265568d31615","created_by":{"user_id":1,"username":"YSU0000"},"modified_by":{"user_id":1,"username":"YSU0000"},"last_update_date":"2023-12-28T14:43:19.941574+00:00","from_date":"2023-12-28T14:43:19.941574+00:00","to_date":"2023-12-28T14:44:42.555822+00:00"}stopyeedujobstop-husage:stop[-h]--job_idJOB_ID--workspace_idWORKSPACE_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--job_idJOB_IDProvidejob_idtostopaspecificSparkJobInstance.--workspace_idWORKSPACE_IDProvideworkspace_idtostopaspecificSparkJobInstance.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)stop example with all the required argument passed.yeedujobstop--workspace_id=1--job_id=8Console output{"SparkKill":{"workflow_job_id":8,"workflow_job_instance_id":8,"spark_job_instance_id":8,"spark_job_id":1,"compute_engine_id":1}}get-statusyeedujobget-status-husage:get-status[-h]--job_idJOB_ID--workspace_idWORKSPACE_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--job_idJOB_IDProvidejob_idtogetallthestatusinformationaboutaspecificSparkJobInstance.--workspace_idWORKSPACE_IDProvideworkspace_idtogetallthestatusinformationaboutaspecificSparkJobInstance.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)get-status example with all the required argument passed.yeedujobget-status--workspace_id=1--job_id=8Console output[{"job_status":"SUBMITTED","created_by":"YSU0000","start_time":"2023-12-28T14:43:19.941574+00:00","end_time":"2023-12-28T14:44:42.555822+00:00"},{"job_status":"RUNNING","created_by":null,"start_time":"2023-12-28T14:44:42.555822+00:00","end_time":"2023-12-28T14:44:42.555822+00:00"},{"job_status":"DONE","created_by":null,"start_time":"2023-12-28T14:44:42.555822+00:00","end_time":"infinity"}]logsyeedujoblogs-husage:logs[-h]--workspace_idWORKSPACE_ID--job_idJOB_ID[--log_type{stdout,stderr}][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--workspace_idWORKSPACE_IDProvideworkspace_idtodownloadSparkJobInstancelogrecords.--job_idJOB_IDProvidejob_idtodownloadSparkJobInstancelogrecords.--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 all the required arguments passed.yeedujoblogs--workspace_id=1--job_id=1Console outputPiisroughly3.141355706778534Workflow 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--workspace_idWORKSPACE_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--job_application_idJOB_APPLICATION_IDProvideajob_application_idtogetinformationaboutaspecificWorkflowJobInstance.--workspace_idWORKSPACE_IDProvideaworkspace_idtogetinformationaboutaspecificWorkflowJobInstance.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)get-workflow-job-instance example with all the required arguments passed.yeedujobget-workflow-job-instance--workspace_id=1--job_application_id="local-1696317971700"Console output{"job_id":5,"job_application_id":"local-1696317971700","job_status":"DONE","compute_engine":1,"cluster_id":"1","workflow_job_instance_details":{"workflow_job_instance_status":{"workflow_job_instance_id":7,"workflow_job_id":7,"status":"DONE","previous_status":["NONE","INIT","SENT","RECEIVED","EXECUTING"],"from_date":"2023-10-03T07:26:29.926692+00:00","to_date":"infinity"},"workflow_execution_process":{"machine_pid_number":"116","machine_hostname":"yeedu1-e0a10412-288a-449d-78d3-ea1726afb205","machine_id":"e0a10412-288a-449d-78d3-ea1726afb205","machine_pid_user":"root","machine_node_number":"0"}},"tenant_id":"cf1f945f-01ce-4ac6-a070-8c733f2fa791","created_by":{"user_id":1,"username":"YSU0000"},"modified_by":{"user_id":1,"username":"YSU0000"},"last_update_date":"2023-10-03T07:20:58.933317+00:00","from_date":"2023-10-03T07:20:58.933317+00:00","to_date":"2023-10-03T07:26:29.926692+00:00"}NotebookNotebook ConfigurationCommand NameUtilitycreate-confTo create a Notebook Configuration.list-confsTo list all the available Notebook Configurations.search-confsTo search Notebook Configurations by notebook name in a workspace.get-confTo get the information about a specific Notebook Configuration.edit-confTo edit the Notebook Configuration.enable-confTo enable a specific Notebook Configuration.disable-confTo disable a specific Notebook Configuration.create-confyeedunotebookcreate-conf-husage:create-conf[-h]--workspace_idWORKSPACE_ID[--cluster_idCLUSTER_ID][--cluster_nameCLUSTER_NAME]--notebook_nameNOTEBOOK_NAME--notebook_typepython3,scala[--confCONF[CONF...]][--files[FILES]][--jars[JARS]][--packages[PACKAGES]][--driver-memory[DRIVER_MEMORY]][--executor-memory[EXECUTOR_MEMORY]][--driver-cores[DRIVER_CORES]][--total-executor-cores[TOTAL_EXECUTOR_CORES]][--executor-cores[EXECUTOR_CORES]][--num-executors[NUM_EXECUTORS]][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--workspace_idWORKSPACE_IDProvideworkspace_idtocreateaNotebookConfiguration.--cluster_idCLUSTER_IDProvidecluster_idtocreateaNotebookConfiguration.--cluster_nameCLUSTER_NAMEProvidecluster_nametocreateaNotebookConfiguration.--notebook_nameNOTEBOOK_NAMEProvidenotebook_nametocreateaNotebookConfiguration.--notebook_typepython3,scalaProvidenotebooktypetocreateaNotebookConfiguration.--confCONF[CONF...]ProvideconftocreateaNotebookConfiguration.--files[FILES]ProvidefilestocreateaNotebookConfiguration.--jars[JARS]ProvidejarstocreateaNotebookConfiguration.--packages[PACKAGES]ProvidepackagestocreateaNotebookConfiguration.--driver-memory[DRIVER_MEMORY]Providedriver-memorytocreateaNotebookConfiguration.--executor-memory[EXECUTOR_MEMORY]Provideexecutor-memorytocreateaNotebookConfiguration.--driver-cores[DRIVER_CORES]Providedriver-corestocreateaNotebookConfiguration.--total-executor-cores[TOTAL_EXECUTOR_CORES]Providetotal-executor-corestocreateaNotebookConfiguration.--executor-cores[EXECUTOR_CORES]Provideexecutor-corestocreateaNotebookConfiguration.--num-executors[NUM_EXECUTORS]Providenum-executorstocreateaNotebookConfiguration.--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.yeedunotebookcreate-conf--cluster_id=1--workspace_id=1--notebook_name="test_notebook"--notebook_type="python3"Console output{"notebook_conf_id":"21","notebook_name":"test_notebook_01","cluster_id":"1","workspace_id":"1","spark_job_type_lang_id":3,"max_concurrency":"1","notebook_cells":{"cells":[{"cell_uuid":"3516b29f-13a3-427d-a466-fc0c85d7ad0e","order":0,"code":"","output":[],"runStatus":false,"executionCount":0,"isOutputError":false}]},"notebook_cells_auto_save":null,"conf":null,"packages":null,"jars":null,"files":null,"driver_memory":null,"executor_memory":null,"driver_cores":null,"total_executor_cores":null,"executor_cores":null,"num_executors":null,"created_by_id":"1","modified_by_id":"1","last_update_date":"2024-01-09T10:06:52.216Z","from_date":"2024-01-09T10:06:52.216Z","to_date":null}list-confsyeedunotebooklist-confs-husage:list-confs[-h]--workspace_idWORKSPACE_ID[--enable[{true,false}]][--page_numberPAGE_NUMBER][--limitLIMIT][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--workspace_idWORKSPACE_IDTolistNotebookConfigurationsofaspecificworkspace.--enable[{true,false}]ProvideenableastrueorfalsetolistNotebookConfigurationsofaspecificworkspace.--page_numberPAGE_NUMBERTolistNotebookConfigurationsforaspecificpage_number.(default:1)--limitLIMITProvidelimittolistnumberofNotebookConfigurations.(default:100)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list-confs example with required and optional arguments passed.yeedunotebooklist-confs--workspace_id=1--limit=1Console output{"data":[{"notebook_conf_id":21,"notebook_name":"test_notebook_01","cluster_info":{"cluster_id":1,"name":"yeedu_instance","description":"Test yeedu instance","labels":{"test":"yeedu","resource":"yeedu","vm":"yeedu_node","tenant_id":"1ea17e91-257b-4a6c-82aa-265568d31615"},"idle_timeout_ms":600000,"auto_shutdown":true,"cluster_status":"RUNNING","cluster_type":"YEEDU","compute_engine_id":1,"instance_size":1,"is_spot_instance":false,"enable_public_ip":false,"block_project_ssh_keys":false,"min_instances":1,"max_instances":3,"total_ycu":null,"bootstrap_shell_script":null,"spark_config_id":null,"cluster_conf":{"cluster_conf_id":1,"cluster_conf_name":"n1-standard-4","description":null,"machine_type_category":"general_purpose","machine_type":{"machine_type_id":64,"name":"n1-standard-4","vcpus":4,"memory":"15 GiB","has_cuda":false,"gpu_model":null,"gpus":null,"gpu_memory":null},"machine_volume_conf":{"volume_conf_id":1,"name":"volume_gcp","description":null,"encrypted":true,"size":375,"disk_machine_type":{"disk_machine_type_id":4,"cloud_provider_id":0,"name":"local-ssd","has_fixed_size":true,"min_size":375,"max_size":375},"machine_volume_num":1,"machine_volume_strip_num":1}},"cloud_env":{"cloud_env_id":1,"name":"gcp_cloud_env","description":"yeedu cloud environment","cloud_provider":{"cloud_provider_id":0,"name":"gcp"},"availabilty_zone":{"availabilty_zone_id":75,"name":"us-central1-a","cloud_provider_id":0,"region":"us-central1","description":"Council Bluffs, Iowa, North America"},"machine_network":{"machine_network_conf_id":1,"name":"yeedu_gcp_network","description":null,"network_project_id":"modak-yeedu","network_name":"modak-yeedu-spark-vpc","network_tags":["yeedu","iap-allow"],"subnet":"custom-subnet-modak-yeedu","machine_network_availability_zone":{"availability_zone_id":75,"name":"us-central1-a","cloud_provider_id":0,"region":"us-central1","description":"Council Bluffs, Iowa, North America"}},"cloud_project":"modak-yeedu","credentials_config":{"credential_config_id":1,"name":"modakyeed-svc","description":null,"credential_type":{"credential_type_id":0,"name":"gcp","cloud_provider_id":0}},"boot_disk_image":{"boot_disk_image_id":1,"name":"gcp_boot_disk","description":"dev boot disk","cloud_provider_id":0,"linux_distro":{"linux_distro_id":0,"distro_name":"UBUNTU","distro_version":"20.04 LTS"},"boot_disk_image":"ubuntu-os-cloud/ubuntu-2004-lts"}},"hive_metastore_conf":{"hive_metastore_conf_id":null,"hive_metastore_conf_name":null},"spark_infra_version":{"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","python_version":"3.9.5","notebook_support":true},"engine_cluster_spark_config":{"max_parallel_spark_job_execution_per_instance":5,"standalone_workers_number":null},"object_storage_manager":{"object_storage_manager_id":1,"name":"yeedu_osm","description":"test","credentials_config":{"credential_config_id":1,"name":"modakyeedu-svc","description":null,"credential_type_name":"gcp"},"object_storage_bucket_name":"modak-yeedu-nabu"}},"workspace":{"workspace_id":1,"name":"spark_jobs_test","description":"Test Spark Jobs"},"spark_job_type":{"job_type":"NOTEBOOK","language":"Python3"},"max_concurrency":1,"notebook_cells":{"cells":[{"cell_uuid":"3516b29f-13a3-427d-a466-fc0c85d7ad0e","order":0,"code":"","output":[],"runStatus":false,"executionCount":0,"isOutputError":false}]},"last_notebook_run":{"notebook_id":null,"notebook_status":null},"conf":null,"packages":null,"jars":null,"files":null,"driver_memory":null,"executor_memory":null,"driver_cores":null,"total_executor_cores":null,"executor_cores":null,"num_executors":null,"created_by":{"user_id":1,"username":"YSU0000"},"modified_by":{"user_id":1,"username":"YSU0000"},"active":true,"last_update_date":"2024-01-09T10:06:52.21698+00:00","from_date":"2024-01-09T10:06:52.21698+00:00","to_date":"infinity"}],"result_set":{"current_page":1,"total_objects":2,"total_pages":2,"limit":1,"next_page":2}}search-confsyeedunotebooksearch-confs-husage:search-confs[-h]--workspace_idWORKSPACE_ID--notebook_nameNOTEBOOK_NAME[--enable[{true,false}]][--page_numberPAGE_NUMBER][--limitLIMIT][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--workspace_idWORKSPACE_IDProvideworkspace_idtosearchNotebookConfigurationsinit.--notebook_nameNOTEBOOK_NAMEProvidenotebook_nametosearchNotebookConfigurations.--enable[{true,false}]ProvideenableastrueorfalsetosearchNotebookConfigurations.--page_numberPAGE_NUMBERTosearchNotebookConfigurationsforaspecificpage_number.(default:1)--limitLIMITProvidelimittosearchnumberofNotebookConfigurations.(default:100)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)search-confs example with required and optional arguments passed.yeedunotebooksearch-confs--workspace_id=1--notebook_name="test_"--enable=true--limit=1Console output{"data":[{"notebook_conf_id":21,"notebook_name":"test_notebook_01","cluster_info":{"cluster_id":1,"name":"yeedu_instance","description":"Test yeedu instance","labels":{"test":"yeedu","resource":"yeedu","vm":"yeedu_node","tenant_id":"1ea17e91-257b-4a6c-82aa-265568d31615"},"idle_timeout_ms":600000,"auto_shutdown":true,"cluster_status":"RUNNING","cluster_type":"YEEDU","compute_engine_id":1,"instance_size":1,"is_spot_instance":false,"enable_public_ip":false,"block_project_ssh_keys":false,"min_instances":1,"max_instances":3,"total_ycu":null,"bootstrap_shell_script":null,"spark_config_id":null,"cluster_conf":{"cluster_conf_id":1,"cluster_conf_name":"n1-standard-4","description":null,"machine_type_category":"general_purpose","machine_type":{"machine_type_id":64,"name":"n1-standard-4","vcpus":4,"memory":"15 GiB","has_cuda":false,"gpu_model":null,"gpus":null,"gpu_memory":null},"machine_volume_conf":{"volume_conf_id":1,"name":"volume_gcp","description":null,"encrypted":true,"size":375,"disk_machine_type":{"disk_machine_type_id":4,"cloud_provider_id":0,"name":"local-ssd","has_fixed_size":true,"min_size":375,"max_size":375},"machine_volume_num":1,"machine_volume_strip_num":1}},"cloud_env":{"cloud_env_id":1,"name":"gcp_cloud_env","description":"yeedu cloud environment","cloud_provider":{"cloud_provider_id":0,"name":"gcp"},"availabilty_zone":{"availabilty_zone_id":75,"name":"us-central1-a","cloud_provider_id":0,"region":"us-central1","description":"Council Bluffs, Iowa, North America"},"machine_network":{"machine_network_conf_id":1,"name":"yeedu_gcp_network","description":null,"network_project_id":"modak-yeedu","network_name":"modak-yeedu-spark-vpc","network_tags":["yeedu","iap-allow"],"subnet":"custom-subnet-modak-yeedu","machine_network_availability_zone":{"availability_zone_id":75,"name":"us-central1-a","cloud_provider_id":0,"region":"us-central1","description":"Council Bluffs, Iowa, North America"}},"cloud_project":"modak-yeedu","credentials_config":{"credential_config_id":1,"name":"modakyeed-svc","description":null,"credential_type":{"credential_type_id":0,"name":"gcp","cloud_provider_id":0}},"boot_disk_image":{"boot_disk_image_id":1,"name":"gcp_boot_disk","description":"dev boot disk","cloud_provider_id":0,"linux_distro":{"linux_distro_id":0,"distro_name":"UBUNTU","distro_version":"20.04 LTS"},"boot_disk_image":"ubuntu-os-cloud/ubuntu-2004-lts"}},"hive_metastore_conf":{"hive_metastore_conf_id":null,"hive_metastore_conf_name":null},"spark_infra_version":{"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","python_version":"3.9.5","notebook_support":true},"engine_cluster_spark_config":{"max_parallel_spark_job_execution_per_instance":5,"standalone_workers_number":null},"object_storage_manager":{"object_storage_manager_id":1,"name":"yeedu_osm","description":"test","credentials_config":{"credential_config_id":1,"name":"modakyeedu-svc","description":null,"credential_type_name":"gcp"},"object_storage_bucket_name":"modak-yeedu-nabu"}},"workspace":{"workspace_id":1,"name":"spark_jobs_test","description":"Test Spark Jobs"},"spark_job_type":{"job_type":"NOTEBOOK","language":"Python3"},"max_concurrency":1,"notebook_cells":{"cells":[{"cell_uuid":"3516b29f-13a3-427d-a466-fc0c85d7ad0e","order":0,"code":"","output":[],"runStatus":false,"executionCount":0,"isOutputError":false}]},"last_notebook_run":{"notebook_id":null,"notebook_status":null},"conf":null,"packages":null,"jars":null,"files":null,"driver_memory":null,"executor_memory":null,"driver_cores":null,"total_executor_cores":null,"executor_cores":null,"num_executors":null,"created_by":{"user_id":1,"username":"YSU0000"},"modified_by":{"user_id":1,"username":"YSU0000"},"active":true,"last_update_date":"2024-01-09T10:06:52.21698+00:00","from_date":"2024-01-09T10:06:52.21698+00:00","to_date":"infinity"}],"result_set":{"current_page":1,"total_objects":2,"total_pages":2,"limit":1,"next_page":2}}get-confyeedunotebookget-conf-husage:get-conf[-h]--workspace_idWORKSPACE_ID[--notebook_conf_idNOTEBOOK_CONF_ID][--notebook_nameNOTEBOOK_NAME][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--workspace_idWORKSPACE_IDProvideworkspaceidtogetinformationaboutaspecificNotebookConfiguration.--notebook_conf_idNOTEBOOK_CONF_IDProvideNotebookConfIdtogetinformationaboutaspecificNotebookConfiguration.--notebook_nameNOTEBOOK_NAMEProvideNotebookNametogetinformationaboutaspecificNotebookConfiguration.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)get-conf example with the optional and required arguments passed.yeedunotebookget-conf--workspace_id=1--notebook_conf_id=1Console output{"notebook_conf_id":1,"notebook_name":"test_notebook_01","cluster_info":{"cluster_id":1,"name":"yeedu_instance","description":"Test yeedu instance","labels":{"test":"yeedu","resource":"yeedu","vm":"yeedu_node","tenant_id":"1ea17e91-257b-4a6c-82aa-265568d31615"},"idle_timeout_ms":600000,"auto_shutdown":true,"cluster_status":"RUNNING","cluster_type":"YEEDU","compute_engine_id":1,"instance_size":1,"is_spot_instance":false,"enable_public_ip":false,"block_project_ssh_keys":false,"min_instances":1,"max_instances":3,"total_ycu":null,"bootstrap_shell_script":null,"spark_config_id":null,"cluster_conf":{"cluster_conf_id":1,"cluster_conf_name":"n1-standard-4","description":null,"machine_type_category":"general_purpose","machine_type":{"machine_type_id":64,"name":"n1-standard-4","vcpus":4,"memory":"15 GiB","has_cuda":false,"gpu_model":null,"gpus":null,"gpu_memory":null},"machine_volume_conf":{"volume_conf_id":1,"name":"volume_gcp","description":null,"encrypted":true,"size":375,"disk_machine_type":{"disk_machine_type_id":4,"cloud_provider_id":0,"name":"local-ssd","has_fixed_size":true,"min_size":375,"max_size":375},"machine_volume_num":1,"machine_volume_strip_num":1}},"cloud_env":{"cloud_env_id":1,"name":"gcp_cloud_env","description":"yeedu cloud environment","cloud_provider":{"cloud_provider_id":0,"name":"gcp"},"availabilty_zone":{"availabilty_zone_id":75,"name":"us-central1-a","cloud_provider_id":0,"region":"us-central1","description":"Council Bluffs, Iowa, North America"},"machine_network":{"machine_network_conf_id":1,"name":"yeedu_gcp_network","description":null,"network_project_id":"modak-yeedu","network_name":"modak-yeedu-spark-vpc","network_tags":["yeedu","iap-allow"],"subnet":"custom-subnet-modak-yeedu","machine_network_availability_zone":{"availability_zone_id":75,"name":"us-central1-a","cloud_provider_id":0,"region":"us-central1","description":"Council Bluffs, Iowa, North America"}},"cloud_project":"modak-yeedu","credentials_config":{"credential_config_id":1,"name":"modakyeed-svc","description":null,"credential_type":{"credential_type_id":0,"name":"gcp","cloud_provider_id":0}},"boot_disk_image":{"boot_disk_image_id":1,"name":"gcp_boot_disk","description":"dev boot disk","cloud_provider_id":0,"linux_distro":{"linux_distro_id":0,"distro_name":"UBUNTU","distro_version":"20.04 LTS"},"boot_disk_image":"ubuntu-os-cloud/ubuntu-2004-lts"}},"hive_metastore_conf":{"hive_metastore_conf_id":null,"hive_metastore_conf_name":null},"spark_infra_version":{"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","python_version":"3.9.5","notebook_support":true},"engine_cluster_spark_config":{"max_parallel_spark_job_execution_per_instance":5,"standalone_workers_number":null},"object_storage_manager":{"object_storage_manager_id":1,"name":"yeedu_osm","description":"test","credentials_config":{"credential_config_id":1,"name":"modakyeedu-svc","description":null,"credential_type_name":"gcp"},"object_storage_bucket_name":"modak-yeedu-nabu"}},"workspace":{"workspace_id":1,"name":"spark_jobs_test","description":"Test Spark Jobs"},"spark_job_type":{"job_type":"NOTEBOOK","language":"Python3"},"max_concurrency":1,"notebook_cells":{"cells":[{"cell_uuid":"3516b29f-13a3-427d-a466-fc0c85d7ad0e","order":0,"code":"","output":[],"runStatus":false,"executionCount":0,"isOutputError":false}]},"last_notebook_run":{"notebook_id":null,"notebook_status":null},"conf":null,"packages":null,"jars":null,"files":null,"driver_memory":null,"executor_memory":null,"driver_cores":null,"total_executor_cores":null,"executor_cores":null,"num_executors":null,"created_by":{"user_id":1,"username":"YSU0000"},"modified_by":{"user_id":1,"username":"YSU0000"},"active":true,"last_update_date":"2024-01-09T10:06:52.21698+00:00","from_date":"2024-01-09T10:06:52.21698+00:00","to_date":"infinity"}edit-confyeedunotebookedit-conf-husage:edit-conf[-h]--workspace_idWORKSPACE_ID[--notebook_conf_idNOTEBOOK_CONF_ID][--notebook_nameNOTEBOOK_NAME][--cluster_idCLUSTER_ID][--cluster_nameCLUSTER_NAME][--name[NAME]][--confCONF[CONF...]][--files[FILES]][--jars[JARS]][--packages[PACKAGES]][--driver-memory[DRIVER_MEMORY]][--executor-memory[EXECUTOR_MEMORY]][--driver-cores[DRIVER_CORES]][--total-executor-cores[TOTAL_EXECUTOR_CORES]][--executor-cores[EXECUTOR_CORES]][--num-executors[NUM_EXECUTORS]][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--workspace_idWORKSPACE_IDProvideWorkspaceIdtoeditaNotebookConfiguration.--notebook_conf_idNOTEBOOK_CONF_IDProvideNotbeookConfIdtoeditaNotebookConfiguration.--notebook_nameNOTEBOOK_NAMEProvideNotebookNametoeditaNotebookConfiguration.--cluster_idCLUSTER_IDProvidecluster_idtoeditaNotebookConfiguration.--cluster_nameCLUSTER_NAMEProvidecluster_nametoeditaNotebookConfiguration.--name[NAME]Providenametoeditnotebook_nameofaNotebookConfiguration.--confCONF[CONF...]ProvideconftoeditaNotebookConfiguration.--files[FILES]ProvidefilestoeditaNotebookConfiguration.--jars[JARS]ProvidejarstoeditaNotebookConfiguration.--packages[PACKAGES]ProvidepackagestoeditaNotebookConfiguration.--driver-memory[DRIVER_MEMORY]Providedriver-memorytoeditaNotebookConfiguration.--executor-memory[EXECUTOR_MEMORY]Provideexecutor-memorytoeditaNotebookConfiguration.--driver-cores[DRIVER_CORES]Providedriver-corestoeditaNotebookConfiguration.--total-executor-cores[TOTAL_EXECUTOR_CORES]Providetotal-executor-corestoeditaNotebookConfiguration.--executor-cores[EXECUTOR_CORES]Provideexecutor-corestoeditaNotebookConfiguration.--num-executors[NUM_EXECUTORS]Providenum-executorstoeditaNotebookConfiguration.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)edit-conf example with the required arguments and other optional arguments passed which is to be updated.yeedunotebookedit-conf--workspace_id=1--notebook_conf_id=21--name=Notebook_01Console output{"notebook_conf_id":"21","notebook_name":"Notebook_01","cluster_id":"1","workspace_id":"1","spark_job_type_lang_id":3,"max_concurrency":"1","notebook_cells":{"cells":[{"cell_uuid":"3516b29f-13a3-427d-a466-fc0c85d7ad0e","order":0,"code":"","output":[],"runStatus":false,"executionCount":0,"isOutputError":false}]},"notebook_cells_auto_save":null,"conf":null,"packages":null,"jars":null,"files":null,"driver_memory":null,"executor_memory":null,"driver_cores":null,"total_executor_cores":null,"executor_cores":null,"num_executors":null,"created_by_id":"1","modified_by_id":"1","last_update_date":"2024-01-09T10:15:19.396Z","from_date":"2024-01-09T10:06:52.216Z","to_date":null}enable-confyeedunotebookenable-conf-husage:enable-conf[-h]--workspace_idWORKSPACE_ID[--notebook_conf_idNOTEBOOK_CONF_ID][--notebook_nameNOTEBOOK_NAME][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--workspace_idWORKSPACE_IDProvideWorkspaceIdtoenabletheNotebookConfiguration.--notebook_conf_idNOTEBOOK_CONF_IDProvideNotebookConfIdtoenabletheNotebookConfiguration.--notebook_nameNOTEBOOK_NAMEProvideNotebookNametoenabletheNotebookConfiguration.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)enable-conf example with the required arguments passed.yeedunotebookenable-conf--workspace_id=1--notebook_conf_id=140Console output{"notebook_conf_id":"21","notebook_name":"Notebook_01","cluster_id":"1","workspace_id":"1","spark_job_type_lang_id":3,"max_concurrency":"1","notebook_cells":{"cells":[{"cell_uuid":"3516b29f-13a3-427d-a466-fc0c85d7ad0e","order":0,"code":"","output":[],"runStatus":false,"executionCount":0,"isOutputError":false}]},"notebook_cells_auto_save":null,"conf":null,"packages":null,"jars":null,"created_by_id":"1","modified_by_id":"1","last_update_date":"2024-01-09T10:23:13.631Z","from_date":"2024-01-09T10:06:52.216Z","to_date":null}disable-confyeedunotebookdisable-conf-husage:disable-conf[-h]--workspace_idWORKSPACE_ID[--notebook_conf_idNOTEBOOK_CONF_ID][--notebook_nameNOTEBOOK_NAME][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--workspace_idWORKSPACE_IDProvideWorkspaceIdtodisabletheNotebookConfiguration.--notebook_conf_idNOTEBOOK_CONF_IDProvideNotebookConfIdtodisabletheNotebookConfiguration.--notebook_nameNOTEBOOK_NAMEProvideNotebookNametodisabletheNotebookConfiguration.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)disable-conf example with the required arguments passed.yeedunotebookdisable-conf--workspace_id=1--notebook_conf_id=140Console output{"notebook_conf_id":"21","notebook_name":"Notebook_01","cluster_id":"1","workspace_id":"1","spark_job_type_lang_id":3,"max_concurrency":"1","notebook_cells":{"cells":[{"cell_uuid":"3516b29f-13a3-427d-a466-fc0c85d7ad0e","order":0,"code":"","output":[],"runStatus":false,"executionCount":0,"isOutputError":false}]},"notebook_cells_auto_save":null,"conf":null,"packages":null,"jars":null,"created_by_id":"1","modified_by_id":"1","last_update_date":"2024-01-09T10:22:42.399Z","from_date":"2024-01-09T10:06:52.216Z","to_date":"2024-01-09T10:22:42.399Z"}Notebook InstanceCommand NameUtilitystartTo start a Notebook Instance.kernel-startTo start a kernel of a Notebook Instance.kernel-interruptTo interrupt a kernel of a Notebook Instance.kernel-restartTo restart a kernel of a Notebook Instance.listTo list all the available Notebook Instances.searchTo search Notebook Instances by similar notebook name.getTo get information about a specific Notebook Instance.stopTo stop a specific Notebook Instance.logsTo download Notebook Instance logs.startyeedunotebookstart-husage:start[-h]--workspace_idWORKSPACE_ID[--notebook_conf_idNOTEBOOK_CONF_ID][--notebook_nameNOTEBOOK_NAME][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--workspace_idWORKSPACE_IDTostartaNotebookInstance,enterworkspace_id.--notebook_conf_idNOTEBOOK_CONF_IDTostartaNotebookInstance,enternotebook_conf_id.--notebook_nameNOTEBOOK_NAMETostartaNotebookInstance,enternotebook_name.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)start example with one of the required argument passed.yeedunotebookstart--workspace_id=1--notebook_conf_id=1Console output{"notebook_id":"4","notebook_conf_id":"21","cluster_id":"1","tenant_id":"1ea17e91-257b-4a6c-82aa-265568d31615","created_by_id":"1","modified_by_id":"1","last_update_date":"2024-01-09T11:39:06.698Z","from_date":"2024-01-09T11:39:06.698Z","to_date":null}kernel-startyeedunotebookkernel-start-husage:kernel-start[-h]--workspace_idWORKSPACE_ID--notebook_idNOTEBOOK_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--workspace_idWORKSPACE_IDTostartakernelofaNotebookInstance,enterworkspace_id.--notebook_idNOTEBOOK_IDTostartakernelofaNotebookInstance,enternotebookinstanceid.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)kernel-start example to with all the required arguments passed.yeedunotebookkernel-start--workspace_id=1--notebook_id=142Console output{"notebook_id":142,"kernel_info":{"kernel_id":"71e6acb5-d4d8-4311-a4a3-7f8a8d6a0291","kernel_status":"starting"}}kernel-interruptyeedunotebookkernel-interrupt-husage:kernel-interrupt[-h]--workspace_idWORKSPACE_ID--notebook_idNOTEBOOK_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--workspace_idWORKSPACE_IDTointerruptakernelofaNotebookInstance,enterworkspace_id.--notebook_idNOTEBOOK_IDTointerruptakernelofaNotebookInstance,enternotebookinstanceid.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)kernel-interrupt example to with required and optional arguments passed.yeedunotebookkernel-interrupt--workspace_id=1--notebook_id=142Console output{"notebook_id":142,"kernel_info":{"kernel_id":"71e6acb5-d4d8-4311-a4a3-7f8a8d6a0291","kernel_status":"starting"}}kernel-restartyeedunotebookkernel-restart-husage:kernel-restart[-h]--workspace_idWORKSPACE_ID--notebook_idNOTEBOOK_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--workspace_idWORKSPACE_IDTorestartakernelofaNotebookInstance,enterworkspace_id.--notebook_idNOTEBOOK_IDTorestartakernelofaNotebookInstance,enternotebookinstanceid.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)kernel-restart example with all the required arguments passed.yeedunotebookkernel-restart--workspace_id=1--notebook_id=142Console output{"notebook_id":142,"kernel_info":{"kernel_id":"71e6acb5-d4d8-4311-a4a3-7f8a8d6a0291","kernel_status":"idle"}}listyeedunotebooklist-husage:list[-h]--workspace_idWORKSPACE_ID[--cluster_idCLUSTER_ID][--notebook_conf_idNOTEBOOK_CONF_ID][--notebook_nameNOTEBOOK_NAME][--notebook_status{submitted,running,done,error,terminated,stopping,stopped}][--page_numberPAGE_NUMBER][--limitLIMIT][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--workspace_idWORKSPACE_IDTolistNotebookInstancesofaspecificworkspace_id.--cluster_idCLUSTER_IDTolistNotebookInstancesofaspecificcluster_id.--notebook_conf_idNOTEBOOK_CONF_IDTolistNotebookInstancesofaspecificnotebook_conf_id.--notebook_nameNOTEBOOK_NAMETolistNotebookInstancesofaspecificnotebook_name.--notebook_status{submitted,running,done,error,terminated,stopping,stopped}TolistNotebookInstancesofaspecificnotebook_status.--page_numberPAGE_NUMBERTolistNotebookInstancesforaspecificpage_number.(default:1)--limitLIMITProvidelimittolistnumberofjobinstances.(default:100)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list example with all the required and optional arguments passed.yeedunotebooklist--workspace_id=1--notebook_status=runningConsole output{"data":[{"notebook_id":2,"notebook_url":"http://yeedu3-87cdc71b-e8ad-cbda-15b3-ec4694e7826a.us-central1-a.c.modak-yeedu.internal:8888","notebook_status":"RUNNING","notebook_conf":{"notebook_conf_id":2,"notebook_name":"test_notebook","cluster_info":{"cluster_id":2,"name":"yeedu_instance","description":"Test yeedu instance","labels":{"test":"yeedu","resource":"yeedu","vm":"yeedu_node","tenant_id":"1ea17e91-257b-4a6c-82aa-265568d31615"},"idle_timeout_ms":1200000,"auto_shutdown":true,"cluster_status":"RUNNING","cluster_type":"YEEDU","compute_engine_id":2,"instance_size":1,"is_spot_instance":false,"enable_public_ip":false,"block_project_ssh_keys":false,"min_instances":1,"max_instances":3,"total_ycu":null,"bootstrap_shell_script":null,"spark_config_id":null,"cluster_conf":{"cluster_conf_id":1,"cluster_conf_name":"n1-standard-4","description":null,"machine_type_category":"general_purpose","machine_type":{"machine_type_id":64,"name":"n1-standard-4","vcpus":4,"memory":"15 GiB","has_cuda":false,"gpu_model":null,"gpus":null,"gpu_memory":null},"machine_volume_conf":{"volume_conf_id":1,"name":"volume_gcp","description":null,"encrypted":true,"size":375,"disk_machine_type":{"disk_machine_type_id":4,"cloud_provider_id":0,"name":"local-ssd","has_fixed_size":true,"min_size":375,"max_size":375},"machine_volume_num":1,"machine_volume_strip_num":1}},"cloud_env":{"cloud_env_id":1,"name":"gcp_cloud_env","description":"yeedu cloud environment","cloud_provider":{"cloud_provider_id":0,"name":"gcp"},"availabilty_zone":{"availabilty_zone_id":75,"name":"us-central1-a","cloud_provider_id":0,"region":"us-central1","description":"Council Bluffs, Iowa, North America"},"machine_network":{"machine_network_conf_id":1,"name":"yeedu_gcp_network","description":null,"network_project_id":"modak-yeedu","network_name":"modak-yeedu-spark-vpc","network_tags":["yeedu","iap-allow"],"subnet":"custom-subnet-modak-yeedu","machine_network_availability_zone":{"availability_zone_id":75,"name":"us-central1-a","cloud_provider_id":0,"region":"us-central1","description":"Council Bluffs, Iowa, North America"}},"cloud_project":"modak-yeedu","credentials_config":{"credential_config_id":1,"name":"modakyeedu-svc","description":null,"credential_type":{"credential_type_id":0,"name":"gcp","cloud_provider_id":0}},"boot_disk_image":{"boot_disk_image_id":1,"name":"gcp_boot_disk","description":"dev boot disk","cloud_provider_id":0,"linux_distro":{"linux_distro_id":0,"distro_name":"UBUNTU","distro_version":"20.04 LTS"},"boot_disk_image":"ubuntu-os-cloud/ubuntu-2004-lts"}},"hive_metastore_conf":{"hive_metastore_conf_id":null,"hive_metastore_conf_name":null},"spark_infra_version":{"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","python_version":"3.9.5","notebook_support":true},"engine_cluster_spark_config":{"max_parallel_spark_job_execution_per_instance":5,"standalone_workers_number":null},"object_storage_manager":{"object_storage_manager_id":1,"name":"yeedu_osm","description":"test","credentials_config":{"credential_config_id":1,"name":"modakyeedu-svc","description":null,"credential_type_name":"gcp"},"object_storage_bucket_name":"modak-yeedu-nabu"}},"workspace":{"workspace_id":1,"name":"spark_jobs_test","description":"Test Spark Jobs"},"notebook_job_type":{"job_type":"NOTEBOOK","language":"Python3"},"max_concurrency":1,"notebook_cells":{"cells":[{"cell_uuid":"70538495-aeb0-4df6-bb26-2b20f5663f0c","order":0,"code":"","output":[],"runStatus":false,"executionCount":0,"isOutputError":false}]},"notebook_cells_auto_save":null,"conf":null,"packages":null,"jars":null},"workflow_job_instance_details":{"workflow_job_instance_status":{"workflow_job_instance_id":4,"workflow_job_id":4,"status":"DONE","from_date":"2023-12-28T14:44:12.047802+00:00","to_date":"2023-12-28T14:44:59.648713+00:00"}},"tenant_id":"1ea17e91-257b-4a6c-82aa-265568d31615","created_by":{"user_id":1,"username":"YSU0000"},"modified_by":{"user_id":1,"username":"YSU0000"},"last_update_date":"2024-01-01T14:44:12.047802+00:00","from_date":"2024-01-01T14:44:12.047802+00:00","to_date":"2024-01-01T14:44:59.648713+00:00"}],"result_set":{"current_page":1,"total_objects":1,"total_pages":1,"limit":100}}searchyeedunotebooksearch-husage:search[-h]--workspace_idWORKSPACE_ID--notebook_nameNOTEBOOK_NAME[--page_numberPAGE_NUMBER][--limitLIMIT][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--workspace_idWORKSPACE_IDProvideworkspaceidtosearchNotebookInstancesinit.--notebook_nameNOTEBOOK_NAMEProvidenotebook_nametosearchNotebookInstances.--page_numberPAGE_NUMBERTosearchNotebookInstancesforaspecificpage_number.(default:1)--limitLIMITProvidelimittosearchnumberofNotebookInstances.(default:100)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)search example with all the required and optional arguments passed.yeedunotebooksearch--workspace_id=1--notebook_name="test_"--limit=1Console output{"data":[{"notebook_id":2,"notebook_url":"http://yeedu3-87cdc71b-e8ad-cbda-15b3-ec4694e7826a.us-central1-a.c.modak-yeedu.internal:8888","notebook_status":"RUNNING","notebook_conf":{"notebook_conf_id":2,"notebook_name":"test_notebook","cluster_info":{"cluster_id":2,"name":"yeedu_instance","description":"Test yeedu instance","labels":{"test":"yeedu","resource":"yeedu","vm":"yeedu_node","tenant_id":"1ea17e91-257b-4a6c-82aa-265568d31615"},"idle_timeout_ms":1200000,"auto_shutdown":true,"cluster_status":"RUNNING","cluster_type":"YEEDU","compute_engine_id":2,"instance_size":1,"is_spot_instance":false,"enable_public_ip":false,"block_project_ssh_keys":false,"min_instances":1,"max_instances":3,"total_ycu":null,"bootstrap_shell_script":null,"spark_config_id":null,"cluster_conf":{"cluster_conf_id":1,"cluster_conf_name":"n1-standard-4","description":null,"machine_type_category":"general_purpose","machine_type":{"machine_type_id":64,"name":"n1-standard-4","vcpus":4,"memory":"15 GiB","has_cuda":false,"gpu_model":null,"gpus":null,"gpu_memory":null},"machine_volume_conf":{"volume_conf_id":1,"name":"volume_gcp","description":null,"encrypted":true,"size":375,"disk_machine_type":{"disk_machine_type_id":4,"cloud_provider_id":0,"name":"local-ssd","has_fixed_size":true,"min_size":375,"max_size":375},"machine_volume_num":1,"machine_volume_strip_num":1}},"cloud_env":{"cloud_env_id":1,"name":"gcp_cloud_env","description":"yeedu cloud environment","cloud_provider":{"cloud_provider_id":0,"name":"gcp"},"availabilty_zone":{"availabilty_zone_id":75,"name":"us-central1-a","cloud_provider_id":0,"region":"us-central1","description":"Council Bluffs, Iowa, North America"},"machine_network":{"machine_network_conf_id":1,"name":"yeedu_gcp_network","description":null,"network_project_id":"modak-yeedu","network_name":"modak-yeedu-spark-vpc","network_tags":["yeedu","iap-allow"],"subnet":"custom-subnet-modak-yeedu","machine_network_availability_zone":{"availability_zone_id":75,"name":"us-central1-a","cloud_provider_id":0,"region":"us-central1","description":"Council Bluffs, Iowa, North America"}},"cloud_project":"modak-yeedu","credentials_config":{"credential_config_id":1,"name":"modakyeedu-svc","description":null,"credential_type":{"credential_type_id":0,"name":"gcp","cloud_provider_id":0}},"boot_disk_image":{"boot_disk_image_id":1,"name":"gcp_boot_disk","description":"dev boot disk","cloud_provider_id":0,"linux_distro":{"linux_distro_id":0,"distro_name":"UBUNTU","distro_version":"20.04 LTS"},"boot_disk_image":"ubuntu-os-cloud/ubuntu-2004-lts"}},"hive_metastore_conf":{"hive_metastore_conf_id":null,"hive_metastore_conf_name":null},"spark_infra_version":{"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","python_version":"3.9.5","notebook_support":true},"engine_cluster_spark_config":{"max_parallel_spark_job_execution_per_instance":5,"standalone_workers_number":null},"object_storage_manager":{"object_storage_manager_id":1,"name":"yeedu_osm","description":"test","credentials_config":{"credential_config_id":1,"name":"modakyeedu-svc","description":null,"credential_type_name":"gcp"},"object_storage_bucket_name":"modak-yeedu-nabu"}},"workspace":{"workspace_id":1,"name":"spark_jobs_test","description":"Test Spark Jobs"},"notebook_job_type":{"job_type":"NOTEBOOK","language":"Python3"},"max_concurrency":1,"notebook_cells":{"cells":[{"cell_uuid":"70538495-aeb0-4df6-bb26-2b20f5663f0c","order":0,"code":"","output":[],"runStatus":false,"executionCount":0,"isOutputError":false}]},"notebook_cells_auto_save":null,"conf":null,"packages":null,"jars":null},"workflow_job_instance_details":{"workflow_job_instance_status":{"workflow_job_instance_id":4,"workflow_job_id":4,"status":"DONE","from_date":"2023-12-28T14:44:12.047802+00:00","to_date":"2023-12-28T14:44:59.648713+00:00"}},"tenant_id":"1ea17e91-257b-4a6c-82aa-265568d31615","created_by":{"user_id":1,"username":"YSU0000"},"modified_by":{"user_id":1,"username":"YSU0000"},"last_update_date":"2024-01-01T14:44:12.047802+00:00","from_date":"2024-01-01T14:44:12.047802+00:00","to_date":"2024-01-01T14:44:59.648713+00:00"}],"result_set":{"current_page":1,"total_objects":1,"total_pages":1,"limit":100}}getyeedunotebookget-husage:get[-h]--workspace_idWORKSPACE_ID--notebook_idNOTEBOOK_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--workspace_idWORKSPACE_IDProvideworkspaceidtogetinformationaboutaspecificNotebookInstance.--notebook_idNOTEBOOK_IDProvidenotebookinstanceidtogetinformationaboutaspecificNotebookInstance.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)get example with all the required arguments passed.yeedunotebookget--workspace_id=1--notebook_id=142Console output{"notebook_id":2,"notebook_url":"http://yeedu3-87cdc71b-e8ad-cbda-15b3-ec4694e7826a.us-central1-a.c.modak-yeedu.internal:8888","notebook_status":"RUNNING","notebook_conf":{"notebook_conf_id":2,"notebook_name":"test_notebook","cluster_info":{"cluster_id":2,"name":"yeedu_instance","description":"Test yeedu instance","labels":{"test":"yeedu","resource":"yeedu","vm":"yeedu_node","tenant_id":"1ea17e91-257b-4a6c-82aa-265568d31615"},"idle_timeout_ms":1200000,"auto_shutdown":true,"cluster_status":"RUNNING","cluster_type":"YEEDU","compute_engine_id":2,"instance_size":1,"is_spot_instance":false,"enable_public_ip":false,"block_project_ssh_keys":false,"min_instances":1,"max_instances":3,"total_ycu":null,"bootstrap_shell_script":null,"spark_config_id":null,"cluster_conf":{"cluster_conf_id":1,"cluster_conf_name":"n1-standard-4","description":null,"machine_type_category":"general_purpose","machine_type":{"machine_type_id":64,"name":"n1-standard-4","vcpus":4,"memory":"15 GiB","has_cuda":false,"gpu_model":null,"gpus":null,"gpu_memory":null},"machine_volume_conf":{"volume_conf_id":1,"name":"volume_gcp","description":null,"encrypted":true,"size":375,"disk_machine_type":{"disk_machine_type_id":4,"cloud_provider_id":0,"name":"local-ssd","has_fixed_size":true,"min_size":375,"max_size":375},"machine_volume_num":1,"machine_volume_strip_num":1}},"cloud_env":{"cloud_env_id":1,"name":"gcp_cloud_env","description":"yeedu cloud environment","cloud_provider":{"cloud_provider_id":0,"name":"gcp"},"availabilty_zone":{"availabilty_zone_id":75,"name":"us-central1-a","cloud_provider_id":0,"region":"us-central1","description":"Council Bluffs, Iowa, North America"},"machine_network":{"machine_network_conf_id":1,"name":"yeedu_gcp_network","description":null,"network_project_id":"modak-yeedu","network_name":"modak-yeedu-spark-vpc","network_tags":["yeedu","iap-allow"],"subnet":"custom-subnet-modak-yeedu","machine_network_availability_zone":{"availability_zone_id":75,"name":"us-central1-a","cloud_provider_id":0,"region":"us-central1","description":"Council Bluffs, Iowa, North America"}},"cloud_project":"modak-yeedu","credentials_config":{"credential_config_id":1,"name":"modakyeedu-svc","description":null,"credential_type":{"credential_type_id":0,"name":"gcp","cloud_provider_id":0}},"boot_disk_image":{"boot_disk_image_id":1,"name":"gcp_boot_disk","description":"dev boot disk","cloud_provider_id":0,"linux_distro":{"linux_distro_id":0,"distro_name":"UBUNTU","distro_version":"20.04 LTS"},"boot_disk_image":"ubuntu-os-cloud/ubuntu-2004-lts"}},"hive_metastore_conf":{"hive_metastore_conf_id":null,"hive_metastore_conf_name":null},"spark_infra_version":{"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","python_version":"3.9.5","notebook_support":true},"engine_cluster_spark_config":{"max_parallel_spark_job_execution_per_instance":5,"standalone_workers_number":null},"object_storage_manager":{"object_storage_manager_id":1,"name":"yeedu_osm","description":"test","credentials_config":{"credential_config_id":1,"name":"modakyeedu-svc","description":null,"credential_type_name":"gcp"},"object_storage_bucket_name":"modak-yeedu-nabu"}},"workspace":{"workspace_id":1,"name":"spark_jobs_test","description":"Test Spark Jobs"},"notebook_job_type":{"job_type":"NOTEBOOK","language":"Python3"},"max_concurrency":1,"notebook_cells":{"cells":[{"cell_uuid":"70538495-aeb0-4df6-bb26-2b20f5663f0c","order":0,"code":"","output":[],"runStatus":false,"executionCount":0,"isOutputError":false}]},"notebook_cells_auto_save":null,"conf":null,"packages":null,"jars":null},"workflow_job_instance_details":{"workflow_job_instance_status":{"workflow_job_instance_id":4,"workflow_job_id":4,"status":"DONE","from_date":"2023-12-28T14:44:12.047802+00:00","to_date":"2023-12-28T14:44:59.648713+00:00"}},"tenant_id":"1ea17e91-257b-4a6c-82aa-265568d31615","created_by":{"user_id":1,"username":"YSU0000"},"modified_by":{"user_id":1,"username":"YSU0000"},"last_update_date":"2024-01-01T14:44:12.047802+00:00","from_date":"2024-01-01T14:44:12.047802+00:00","to_date":"2024-01-01T14:44:59.648713+00:00"}stopyeedunotebookstop-husage:stop[-h]--workspace_idWORKSPACE_ID--notebook_idNOTEBOOK_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--workspace_idWORKSPACE_IDProvideworkspaceidtostopaspecificNotebookInstance.--notebook_idNOTEBOOK_IDProvidenotebookinstanceidtostopaspecificNotebookInstance.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)stop example with all the required argument passed.yeedunotebookstop--workspace_id=1--notebook_id=139Console output{"SparkKill":{"workflow_job_id":275,"workflow_job_instance_id":275,"spark_job_instance_id":139,"spark_job_id":140,"compute_engine_id":3}}logsyeedunotebooklogs-husage:logs[-h]--workspace_idWORKSPACE_ID--notebook_idNOTEBOOK_ID[--log_type{stdout,stderr}][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--workspace_idWORKSPACE_IDProvideWorkspaceIdtodownloadNotebookInstancelogs.--notebook_idNOTEBOOK_IDProvideNotebookIdtodownloadNotebookInstancelogs.--log_type{stdout,stderr}ProvidelogtypetodownloadNotebookInstancelogs.(default:stdout)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)logs example with all the required arguments passed.yeedunotebooklogs--workspace_id=1--notebook_id=2--log_type="stderr"Console output[I2023-10-0411:15:25.902ServerApp]Packagenotebooktook0.0000stoimport[I2023-10-0411:15:25.912ServerApp]Packagejupyter_lsptook0.0092stoimport[W2023-10-0411:15:25.912ServerApp]A`_jupyter_server_extension_points`functionwasnotfoundinjupyter_lsp.Instead,a`_jupyter_server_extension_paths`functionwasfoundandwillbeusedfornow.ThisfunctionnamewillbedeprecatedinfuturereleasesofJupyterServer.[I2023-10-0411:15:25.917ServerApp]Packagejupyter_server_terminalstook0.0049stoimport[I2023-10-0411:15:25.918ServerApp]Packagejupyterlabtook0.0000stoimport[I2023-10-0411:15:25.943ServerApp]Packagenotebook_shimtook0.0000stoimport[W2023-10-0411:15:25.943ServerApp]A`_jupyter_server_extension_points`functionwasnotfoundinnotebook_shim.Instead,a`_jupyter_server_extension_paths`functionwasfoundandwillbeusedfornow.ThisfunctionnamewillbedeprecatedinfuturereleasesofJupyterServer.[I2023-10-0411:15:25.943ServerApp]jupyter_lsp|extensionwassuccessfullylinked.[I2023-10-0411:15:25.947ServerApp]jupyter_server_terminals|extensionwassuccessfullylinked.[I2023-10-0411:15:25.952ServerApp]jupyterlab|extensionwassuccessfullylinked.[I2023-10-0411:15:25.956ServerApp]notebook|extensionwassuccessfullylinked.[I2023-10-0411:15:26.143ServerApp]notebook_shim|extensionwassuccessfullylinked.[I2023-10-0411:15:26.164ServerApp]notebook_shim|extensionwassuccessfullyloaded.[I2023-10-0411:15:26.166ServerApp]jupyter_lsp|extensionwassuccessfullyloaded.[I2023-10-0411:15:26.167ServerApp]jupyter_server_terminals|extensionwassuccessfullyloaded.[I2023-10-0411:15:26.169LabApp]JupyterLabextensionloadedfrom/usr/local/lib/python3.9/dist-packages/jupyterlab[I2023-10-0411:15:26.169LabApp]JupyterLabapplicationdirectoryis/usr/local/share/jupyter/lab[I2023-10-0411:15:26.169LabApp]ExtensionManageris'pypi'.[I2023-10-0411:15:26.173ServerApp]jupyterlab|extensionwassuccessfullyloaded.[I2023-10-0411:15:26.175ServerApp]notebook|extensionwassuccessfullyloaded.[I2023-10-0411:15:26.184ServerApp]Servingnotebooksfromlocaldirectory:/opt/spark[I2023-10-0411:15:26.184ServerApp]JupyterServer2.7.2isrunningat:[I2023-10-0411:15:26.184ServerApp]http://yeedu3-87cdc71b-e8ad-cbda-15b3-ec4694e7826a.us-central1-a.c.modak-yeedu.internal:8888/tree?token=d192e22dbccc3245500f0a873020769534abc908be299686
...
...
...[I2023-10-0411:15:49.712ServerApp]Kernelstarted:71e6acb5-d4d8-4311-a4a3-7f8a8d6a0291[I2023-10-0411:18:24.166ServerApp]Kernelinterrupted:71e6acb5-d4d8-4311-a4a3-7f8a8d6a0291[I2023-10-0411:19:38.766ServerApp]Kernelrestarted:71e6acb5-d4d8-4311-a4a3-7f8a8d6a0291IAM (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 any optional arguments passed.yeeduiamget-user-infoConsole output{"user_id":"1","tenant_id":"6423f466-ff56-4ba4-8c2d-8229beb67e38","username":"USER","email":"user@yeedu.com","group_info":[{"group_id":1,"groupname":"yeedu-user"}],"from_date":"2024-01-01T15:49:50.399Z","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 any optional arguments passed.yeeduiamget-user-rolesConsole output{"user_id":2,"username":"RU0000","user_roles":["User"],"group_roles":[{"group_id":8,"group_name":"Yeedu","role_id":2,"group_role":"Admin"}]}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.search-usersTo search the users based on username.match-userTo match exactly the user for the given username.list-group-usersTo list all the Users for a specific Group.list-groupsTo list all the available Groups.search-groupsTo search the groups based on groupname.match-groupTo match exactly the group for the given groupname.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":"1","username":"USER","email":"user@yeedu.com","from_date":"2024-01-01T10: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"Console output{"group_id":"1","group_name":"yeedu","from_date":"2024-01-01T14:30:20.723Z","to_date":null}list-user-groupsyeeduiamlist-user-groups-husage:list-user-groups[-h]--user_idUSER_ID[--page_numberPAGE_NUMBER][--limitLIMIT][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--user_idUSER_IDProvideuser_idtolistallthegroupsforaspecificUser.--page_numberPAGE_NUMBERTolistgroupsforaspecificpage_number.(default:1)--limitLIMITProvidelimittolistnumberofgroups.(default:100)--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=1Console output{"data":[{"group_id":2,"group_name":"Yeedu","group_type":null,"from_date":"2024-01-01T14:01:50.367429+00:00","to_date":"infinity"},{"group_id":1,"group_name":"Modak Yeedu","group_type":"Unified","from_date":"2023-01-01T14:01:50.367429+00:00","to_date":"infinity"}],"result_set":{"current_page":1,"total_objects":2,"total_pages":1,"limit":100}}list-usersyeeduiamlist-users-husage:list-users[-h][--group_idGROUP_ID][--page_numberPAGE_NUMBER][--limitLIMIT][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--group_idGROUP_IDProvidegroup_idtolistalltheusersforaspecificgroup.--page_numberPAGE_NUMBERTolistusersforaspecificpage_number.(default:1)--limitLIMITProvidelimittolistnumberofusers.(default:100)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list-users example without any optional arguments passed.yeeduiamlist-usersConsole output{"data":[{"user_id":1,"username":"YSU0000","email":"ysu0000@modak.com"}],"result_set":{"current_page":1,"total_objects":1,"total_pages":1,"limit":100}}search-usersyeeduiamsearch-users-husage:search-users[-h]--usernameUSERNAME[--group_idGROUP_ID][--page_numberPAGE_NUMBER][--limitLIMIT][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--usernameUSERNAMEProvideusernametosearchusersmatchingusername.--group_idGROUP_IDProvidegroup_idtosearchalltheusersofaspecificgroup.--page_numberPAGE_NUMBERTosearchusersforaspecificpage_number.(default:1)--limitLIMITProvidelimittosearchnumberofusers.(default:100)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)search-users example with the required argument passed.yeeduiamsearch-users--username="Y"Console output{"data":[{"user_id":1,"username":"YSU0000","email":"ysu000@modak.com"}],"result_set":{"current_page":1,"total_objects":1,"total_pages":1,"limit":100}}match-useryeeduiammatch-user-husage:match-user[-h]--usernameUSERNAME[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--usernameUSERNAMEProvideusernametogetuserdetails.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)match-user example with the required argument passed.yeeduiammatch-user--username="YSU0000"Console output{"user_id":1,"username":"YSU0000","email":"ysu0000@modak.com","from_date":"2024-01-01T14:01:50.367429+00:00","to_date":"infinity"}list-group-usersyeeduiamlist-group-users-husage:list-group-users[-h]--group_idGROUP_ID[--page_numberPAGE_NUMBER][--limitLIMIT][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--group_idGROUP_IDProvidegroup_idtolistalltheusersforaspecificGroup.--page_numberPAGE_NUMBERTolistusersforaspecificpage_number.(default:1)--limitLIMITProvidelimittolistnumberofusers.(default:100)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list-group-users example with the required argument '--group_id' passed.yeeduiamlist-group-users--group_id=2Console output{"data":[{"user_id":1,"username":"YSU0000","email":"ysu0000@modak.com"}],"result_set":{"current_page":1,"total_objects":1,"total_pages":1,"limit":100}}list-groupsyeeduiamlist-groups-husage:list-groups[-h][--user_idUSER_ID][--page_numberPAGE_NUMBER][--limitLIMIT][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--user_idUSER_IDProvideuser_idtolistallthegroupsofaspecificuser.--page_numberPAGE_NUMBERTolistusersforaspecificpage_number.(default:1)--limitLIMITProvidelimittolistnumberofusers.(default:100)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list-groups example without any optional arguments passed.yeeduiamlist-groupsConsole output{"data":[{"group_id":1,"group_name":"modakanalytics.com","group_type":"Unified","from_date":"2023-12-28T14:01:50.367429+00:00","to_date":"infinity"},{"group_id":2,"group_name":"All Users","group_type":"DynamicMembership","from_date":"2023-12-28T14:01:50.367429+00:00","to_date":"infinity"},{"group_id":3,"group_name":"Spark and Scala- N","group_type":"Unified","from_date":"2023-12-28T14:01:50.367429+00:00","to_date":"infinity"},{"group_id":4,"group_name":"Team Training & KT","group_type":"Unified","from_date":"2023-12-28T14:01:50.367429+00:00","to_date":"infinity"},{"group_id":5,"group_name":"Modak_Executors","group_type":null,"from_date":"2023-12-28T14:01:50.367429+00:00","to_date":"infinity"},{"group_id":6,"group_name":"ModakitesIndia","group_type":null,"from_date":"2023-12-28T14:01:50.367429+00:00","to_date":"infinity"}],"result_set":{"current_page":1,"total_objects":6,"total_pages":1,"limit":100}}search-groupsyeeduiamsearch-groups-husage:search-groups[-h]--groupnameGROUPNAME[--user_idUSER_ID][--page_numberPAGE_NUMBER][--limitLIMIT][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--groupnameGROUPNAMETosearchallthegroupsmatchingprovidedgroupname.--user_idUSER_IDProvideuser_idtosearchallthegroupsofaspecificuser.--page_numberPAGE_NUMBERTosearchgroupsforaspecificpage_number.(default:1)--limitLIMITProvidelimittosearchnumberofgroups.(default:100)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)search-groups example with required argument passed.yeeduiamsearch-groups--groupname="Yeedu"Console output{"data":[{"group_id":7,"group_name":"Yeedu","group_type":null,"from_date":"2023-12-28T14:01:50.367429+00:00","to_date":"infinity"},{"group_id":8,"group_name":"Yeedu","group_type":"Unified","from_date":"2023-12-28T14:01:50.367429+00:00","to_date":"infinity"},{"group_id":9,"group_name":"G_Yeedu","group_type":null,"from_date":"2023-12-28T14:01:50.367429+00:00","to_date":"infinity"},{"group_id":10,"group_name":"Modak Yeedu","group_type":"Unified","from_date":"2023-12-28T14:01:50.367429+00:00","to_date":"infinity"},{"group_id":11,"group_name":"Yeedu Dev_Team","group_type":null,"from_date":"2023-12-28T14:01:50.367429+00:00","to_date":"infinity"},{"group_id":25,"group_name":"Yeedu_Backend","group_type":null,"from_date":"2024-01-02T09:19:25.770823+00:00","to_date":"infinity"}],"result_set":{"current_page":1,"total_objects":6,"total_pages":1,"limit":100}}match-groupyeeduiammatch-group-husage:match-group[-h]--groupnameGROUPNAME[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--groupnameGROUPNAMEProvidegroupnametogetinformationaboutmatchinggroups.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)match-group example with required argument passed.yeeduiammatch-group--groupname="Yeedu"Console output[{"group_id":8,"group_name":"Yeedu","group_type":"Unified","from_date":"2023-12-28T14:01:50.367429+00:00","to_date":"infinity"},{"group_id":7,"group_name":"Yeedu","group_type":null,"from_date":"2023-12-28T14:01:50.367429+00:00","to_date":"infinity"}]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 the output format.yeeduiamlist-resourcesConsole output[{"resource_id":0,"resource_path":"/api/v1/lookup_cloud_providers","from_date":"2023-09-29T15:47:59.340Z","to_date":null},{"resource_id":1,"resource_path":"/api/v1/lookup_cloud_providers/:cloud_provider_id","from_date":"2023-09-29T15:47:59.340Z","to_date":null},...{"resource_id":163,"resource_path":"/api/v1/cluster/confs/search/:cluster_conf_name","from_date":"2023-09-29T15:47:59.340Z","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/networks","from_date":"2023-09-29T15:47:59.340Z","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 the output format.yeeduiamlist-permissionsConsole output[{"permission_id":0,"permission":"GET","description":"To list a resource","from_date":"2023-09-29T15:47:59.339Z","to_date":null},...{"permission_id":3,"permission":"DELETE","description":"To delete a resource","from_date":"2023-09-29T15:47:59.339Z","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-09-29T15:47:59.339Z","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 any optional arguments passed.yeeduiamlist-rolesConsole output[{"role_id":0,"role":"User","description":"GET (Lookup, Volume Config, Network Config, Boot Disk Image Config, Credentials Config, Object Storage Manager, Object Storage Manager Files, Hive Metastore Config, Cluster Configuration, Cluster Instance, Cluster Access Control, Workspace, Workspace Access Control, Spark Job Config, Spark Job Instance, User) PUT (Spark Job Config, Workspace) POST (Object Storage Manager Files, Workspace, Workspace Access Control, Spark Job Config, Spark Job Instance) DELETE (Object Storage Manager Files, Workspace, Workspace Access Control, Spark Job Config)","from_date":"2023-10-18T12:28:01.369Z","to_date":null},{"role_id":1,"role":"Provider","description":"GET (Lookup, Volume Config, Network Config, Boot Disk Image Config, Credentials Config, Object Storage Manager, Object Storage Manager Files, Hive Metastore Config, Cluster Configuration, Cluster Instance, Cluster Access Control, Workspace, Workspace Access Control, Spark Job Config, Spark Job Instance, User) PUT (Cluster Instance, Spark Job Config, Workspace) POST (Cluster Instance, Cluster Access Control, Workspace, Workspace Access Control, Spark Job Config, Spark Job Instance) DELETE (Cluster Access Control, Workspace, Workspace Access Control, Spark Job Config)","from_date":"2023-10-18T12:28:01.369Z","to_date":null},{"role_id":2,"role":"Admin","description":"Can add and remove user and group roles and perform all actions within a tenant.","from_date":"2023-10-18T12:28:01.369Z","to_date":null},{"role_id":3,"role":"Platform Admin","description":"Can access and add or remove tenants across all tenants","from_date":"2023-10-18T12:28:01.369Z","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":"Provider","description":"GET (Lookup, Volume Config, Network Config, Boot Disk Image Config, Credentials Config, Object Storage Manager, Object Storage Manager Files, Hive Metastore Config, Cluster Configuration, Cluster Instance, Cluster Access Control, Workspace, Workspace Access Control, Spark Job Config, Spark Job Instance, User) PUT (Cluster Instance, Spark Job Config, Workspace) POST (Cluster Instance, Cluster Access Control, Workspace, Workspace Access Control, Spark Job Config, Spark Job Instance) DELETE (Cluster Access Control, Workspace, Workspace Access Control, Spark Job Config)","from_date":"2023-09-29T15:47:59.342Z","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 any optional arguments passed.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":"User","description":"GET (Lookup, Volume Config, Network Config, Boot Disk Image Config, Credentials Config, Object Storage Manager, Object Storage Manager Files, Hive Metastore Config, Cluster Configuration, Cluster Instance, Cluster Access Control, Workspace, Workspace Access Control, Spark Job Config, Spark Job Instance, User) PUT (Spark Job Config, Workspace) POST (Object Storage Manager Files, Workspace, Workspace Access Control, Spark Job Config, Spark Job Instance) DELETE (Object Storage Manager Files, Workspace, Workspace Access Control, Spark Job Config)"},"from_date":"2023-09-29T15:47:59.350Z","to_date":null},...{"rule_id":"629","permission_type":{"permission_id":0,"permission":"GET","description":"To list a resource"},"resource":{"resource_id":163,"resource_path":"/api/v1/cluster/confs/search/:cluster_conf_name"},"role":{"role_id":3,"role":"Platform Admin","description":"Can access everything across tenants and add or remove tenants."},"from_date":"2023-09-29T15:47:59.350Z","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":39,"resource_path":"/api/v1/cluster/stats"},"role":{"role_id":1,"role":"Provider","description":"GET (Lookup, Volume Config, Network Config, Boot Disk Image Config, Credentials Config, Object Storage Manager, Object Storage Manager Files, Hive Metastore Config, Cluster Configuration, Cluster Instance, Cluster Access Control, Workspace, Workspace Access Control, Spark Job Config, Spark Job Instance, User) PUT (Cluster Instance, Spark Job Config, Workspace) POST (Cluster Instance, Cluster Access Control, Workspace, Workspace Access Control, Spark Job Config, Spark Job Instance) DELETE (Cluster Access Control, Workspace, Workspace Access Control, Spark Job Config)"},"from_date":"2023-09-29T15:47:59.350Z","to_date":null}list-workspace-permissionsyeeduiamlist-workspace-permissions-husage:list-workspace-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-workspace-permissions example.yeeduiamlist-workspace-permissionsConsole output[{"permission_id":0,"name":"VIEW","description":"To list the jobs inside the workspace","from_date":"2024-01-17T08:22:15.874Z","to_date":null},{"permission_id":1,"name":"RUN","description":"To list and run the jobs within a workspace","from_date":"2024-01-17T08:22:15.874Z","to_date":null},{"permission_id":2,"name":"EDIT","description":"To list, run and edit a spark job configuration in a workspace","from_date":"2024-01-17T08:22:15.874Z","to_date":null},{"permission_id":3,"name":"MANAGE","description":"To list jobs, run jobs, edit Spark job configurations, and manage workspace access by adding or removing permissions","from_date":"2024-01-17T08:22:15.874Z","to_date":null}]get-workspace-permissionyeeduiamget-workspace-permission-husage:get-workspace-permission[-h]--permission_idPERMISSION_ID[--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--permission_idPERMISSION_IDProvidethepermission_idtogetinformationaboutaspecificWorkspaceAccessControlPermission.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)get-workspace-permission example with required argument '--permission_id' passed.yeeduiamget-workspace-permission--permission_id=108Console output{"permission_id":1,"name":"RUN","description":"To list and run the jobs within a workspace","from_date":"2024-01-17T08:22:15.874Z","to_date":null}Platform-AdminTenantCommand NameUtilitycreate-tenantTo create a Tenant.list-tenantsTo list all the available Tenants.search-tenantsTo search the tenants with the given name.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="tenant_01"--description="Yeedu Tenant-1"Console output{"tenant_id":"69bf9c44-7ec8-409c-8f48-a573eb7ca29b","name":"tenant1","description":"Yeedu Tenant-1","created_by_id":"1","modified_by_id":"1","last_update_date":"2024-01-09T14:38:09.865Z","from_date":"2024-01-09T14:38:09.865Z","to_date":null}list-tenantsyeeduplatform-adminlist-tenants-husage:list-tenants[-h][--page_numberPAGE_NUMBER][--limitLIMIT][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--page_numberPAGE_NUMBERTolisttenantsforaspecificpage_number.(default:1)--limitLIMITProvidelimittolistnumberoftenants.(default:100)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list-tenants example without any optional arguments passed.yeeduplatform-adminlist-tenantsConsole output{"data":[{"tenant_id":"69bf9c44-7ec8-409c-8f48-a573eb7ca29b","name":"tenant_01","description":"Yeedu Tenant-1","created_by":{"user_id":1,"username":"YSU0000"},"modified_by":{"user_id":1,"username":"YSU0000"},"last_update_date":"2024-01-09T14:38:09.865497+00:00","from_date":"2024-01-09T14:38:09.865497+00:00","to_date":"infinity"},{"tenant_id":"1ea17e91-257b-4a6c-82aa-265568d31615","name":"test","description":null,"created_by":{"user_id":1,"username":"YSU0000"},"modified_by":{"user_id":1,"username":"YSU0000"},"last_update_date":"2023-12-28T14:01:58.072463+00:00","from_date":"2023-12-28T14:01:58.072463+00:00","to_date":"infinity"}],"result_set":{"current_page":1,"total_objects":2,"total_pages":1,"limit":100}}search-tenantsyeeduplatform-adminsearch-tenants-husage:search-tenants[-h]--tenant_nameTENANT_NAME[--page_numberPAGE_NUMBER][--limitLIMIT][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--tenant_nameTENANT_NAMEProvidethetenantnametogetallthematchingtenants.--page_numberPAGE_NUMBERTosearchtenantsonaspecificpage_number.(default:1)--limitLIMITProvidelimittosearchnumberoftenants.(default:100)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)search-tenants example with required arguments passed.yeeduplatform-adminsearch-tenants--tenant_name="tenant"Console output{"data":[{"tenant_id":"69bf9c44-7ec8-409c-8f48-a573eb7ca29b","name":"tenant_01","description":"Yeedu Tenant-1","created_by":{"user_id":1,"username":"YSU0000"},"modified_by":{"user_id":1,"username":"YSU0000"},"last_update_date":"2024-01-09T14:38:09.865497+00:00","from_date":"2024-01-09T14:38:09.865497+00:00","to_date":"infinity"}],"result_set":{"current_page":1,"total_objects":1,"total_pages":1,"limit":100}}get-tenantyeeduplatform-adminget-tenant-husage:get-tenant[-h][--tenant_idTENANT_ID][--tenant_nameTENANT_NAME][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--tenant_idTENANT_IDProvidethetenant_idtogetinformationaboutaspecificTenant.--tenant_nameTENANT_NAMEProvidethetenant_nametogetinformationaboutaspecificTenant.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)get-tenant example with any one of the required argument passed.yeeduplatform-adminget-tenant--tenant_name="tenant_01"Console output{"tenant_id":"69bf9c44-7ec8-409c-8f48-a573eb7ca29b","name":"tenant_01","description":"Yeedu Tenant-1","created_by":{"user_id":1,"username":"YSU0000"},"modified_by":{"user_id":1,"username":"YSU0000"},"last_update_date":"2024-01-09T14:38:09.865497+00:00","from_date":"2024-01-09T14:38:09.865497+00:00","to_date":"infinity"}edit-tenantyeeduplatform-adminedit-tenant-husage:edit-tenant[-h][--tenant_idTENANT_ID][--tenant_nameTENANT_NAME][--name[NAME]][--description[DESCRIPTION]][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--tenant_idTENANT_IDProvideaspecifictenantIdtoedit-tenant.--tenant_nameTENANT_NAMEProvideaspecifictenantNametoedit-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 any one of the required arguments and other optional argument is passed which is to be updated.yeeduplatform-adminedit-tenant--tenant_id="69bf9c44-7ec8-409c-8f48-a573eb7ca29b"--description="Yeedu Tenant 1"Console output{"tenant_id":"69bf9c44-7ec8-409c-8f48-a573eb7ca29b","name":"tenant1","description":"Yeedu Tenant 1","created_by_id":"1","modified_by_id":"1","last_update_date":"2024-01-09T14:50:29.676Z","from_date":"2024-01-09T14:38:09.865Z","to_date":null}delete-tenantyeeduplatform-admindelete-tenant-husage:delete-tenant[-h][--tenant_idTENANT_ID][--tenant_nameTENANT_NAME][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--tenant_idTENANT_IDProvidethetenant_idtodeleteaspecificTenant.--tenant_nameTENANT_NAMEProvidethetenant_nametodeleteaspecificTenant.--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)delete-tenant example with any one of the required argument passed.yeeduplatform-admindelete-tenant--tenant_id="69bf9c44-7ec8-409c-8f48-a573eb7ca29b"Console output{"message":"Deleted Tenant Id: 69bf9c44-7ec8-409c-8f48-a573eb7ca29b"}UserCommand NameUtilitylist-user-tenantsTo list all the tenants associated to an user.list-tenant-usersTo list all the users present in a tenant.search-tenant-usersTo search 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[--page_numberPAGE_NUMBER][--limitLIMIT][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--user_idUSER_IDProvideUserIdtolistallthetenants.--page_numberPAGE_NUMBERTolisttenantsforaspecificpage_number.(default:1)--limitLIMITProvidelimittolistnumberoftenants.(default:100)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list-user-tenants example with the required argument passed.yeeduplatform-adminlist-user-tenants--user_id=1Console output{"data":[{"tenant_id":"6423f466-ff56-4ba4-8c2d-8229beb67e38","name":"tenant1","description":"Yeedu Tenant 1"},{"tenant_id":"cf1f945f-01ce-4ac6-a070-8c733f2fa791","name":"tenant3","description":"Yeedu Tenant 3"}],"result_set":{"current_page":1,"total_objects":2,"total_pages":1,"limit":100}}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 with required arguments passed.yeeduplatform-adminlist-tenant-users--tenant_id="6423f466-ff56-4ba4-8c2d-8229beb67e38"Console output{"data":{"tenant_id":"6423f466-ff56-4ba4-8c2d-8229beb67e38","users":[{"user_id":1,"username":"YSU0000","email":"YSU0000"}]},"result_set":{"current_page":1,"total_objects":1,"total_pages":1,"limit":100}}search-tenant-usersyeeduplatform-adminsearch-tenant-users-husage:search-tenant-users[-h]--usernameUSERNAME--tenant_idTENANT_ID[--page_numberPAGE_NUMBER][--limitLIMIT][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--usernameUSERNAMEProvideusernametosearchallthematchinguserspresentinit.--tenant_idTENANT_IDProvideTenantIdtosearchalltheuserspresentinit.--page_numberPAGE_NUMBERTosearchtenantusersforaspecificpage_number.(default:1)--limitLIMITProvidelimittosearchnumberoftenantusers.(default:100)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)search-tenant-users example with required arguments passed.yeeduplatform-adminsearch-tenant-users--tenant_id="6423f466-ff56-4ba4-8c2d-8229beb67e38"--username="YS"Console output{"data":{"tenant_id":"6423f466-ff56-4ba4-8c2d-8229beb67e38","users":[{"user_id":1,"username":"YSU0000","email":"YSU0000"}]},"result_set":{"current_page":1,"total_objects":1,"total_pages":1,"limit":100}}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 all the required arguments passed.yeeduplatform-adminget-tenant-user--tenant_id="6423f466-ff56-4ba4-8c2d-8229beb67e38"--user_id=1Console output{"user_id":1,"username":"USER","email":"user@yeedu.com","from_date":"2024-01-01T15:49:50.399852+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="6423f466-ff56-4ba4-8c2d-8229beb67e38"--user_id=1Console output{"user_id":1,"username":"YSU0000","user_roles":[{"role_id":3,"user_role":"Platform Admin"}],"group_roles":[{"group_id":8,"group_name":"Yeedu","role_id":2,"group_role":"Admin"}]}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 argument '--tenant_id' passed.yeeduplatform-adminlist-users-roles--tenant_id="6423f466-ff56-4ba4-8c2d-8229beb67e38"Console output{"data":[{"user_id":1,"username":"YSU0000","user_roles":["Platform Admin"],"group_roles":["Admin"]}],"result_set":{"current_page":1,"total_objects":1,"total_pages":1,"limit":100}}get-role-usersyeeduplatform-adminget-role-users-husage:get-role-users[-h]--tenant_idTENANT_ID--role_idROLE_ID[--page_numberPAGE_NUMBER][--limitLIMIT][--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="6423f466-ff56-4ba4-8c2d-8229beb67e38"--role_id=3Console output{"data":{"role_id":3,"users":[{"user_id":1,"username":"YSU0000","email":"YSU0000"}]},"result_set":{"current_page":1,"total_objects":1,"total_pages":1,"limit":100}}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="6423f466-ff56-4ba4-8c2d-8229beb67e38"--user_id=2--role_id=1Console output{"user_roles_id":"2","tenant_id":"6423f466-ff56-4ba4-8c2d-8229beb67e38","user_id":"2","role_id":1,"created_by_id":"1","modified_by_id":"1","last_update_date":"2023-10-05T12:50:27.826Z","from_date":"2023-10-05T12: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="6423f466-ff56-4ba4-8c2d-8229beb67e38"--user_id=2--role_id=1Console output{"message":"Deleted User Roles for the provided tenant_id: '6423f466-ff56-4ba4-8c2d-8229beb67e38', user_id: 2 and role_id: 1."}GroupCommand NameUtilitylist-tenant-groupsTo list all the groups present in a tenant.search-tenant-groupsTo search 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 with required and optional arguments passed.yeeduplatform-adminlist-tenant-groups--tenant_id="6423f466-ff56-4ba4-8c2d-8229beb67e38"Console output{"data":{"tenant_id":"6423f466-ff56-4ba4-8c2d-8229beb67e38","groups":[{"group_id":8,"group_name":"Yeedu","group_type":"Unified"}]},"result_set":{"current_page":1,"total_objects":1,"total_pages":1,"limit":100}}search-tenant-groupsyeeduplatform-adminsearch-tenant-groups-husage:search-tenant-groups[-h]--groupnameGROUPNAME--tenant_idTENANT_ID[--page_numberPAGE_NUMBER][--limitLIMIT][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--groupnameGROUPNAMEProvidegroupnametosearchallthematchinggroupspresentinit.--tenant_idTENANT_IDProvideTenantIdtosearchallthegroupspresentinit.--page_numberPAGE_NUMBERTosearchtenantgroupsforaspecificpage_number.(default:1)--limitLIMITProvidelimittosearchnumberoftenantgroups.(default:100)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)search-tenant-groups example with required and optional arguments passed.yeeduplatform-adminsearch-tenant-groups--tenant_id="6423f466-ff56-4ba4-8c2d-8229beb67e38"--groupname="Yeed"Console output{"data":[{"group_id":8,"group_name":"Yeedu","group_type":"Unified","roles":["Admin"]}],"result_set":{"current_page":1,"total_objects":1,"total_pages":1,"limit":100}}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 with required arguments passed.yeeduplatform-adminget-tenant-group--tenant_id="6423f466-ff56-4ba4-8c2d-8229beb67e38"--group_id=1Console output{"group_id":1,"group_name":"yeedu-manager","from_date":"2024-01-01T15:49:50.399852+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="6423f466-ff56-4ba4-8c2d-8229beb67e38"--group_id=1Console output{"group_id":1,"group_name":"Yeedu","group_type":"Unified","roles":["Admin"]}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="6423f466-ff56-4ba4-8c2d-8229beb67e38"--limit=2Console output{"data":[{"group_id":1,"group_name":"yeedu-manager","group_type":"Unified","roles":["Provider"]},{"group_id":3,"group_name":"yeedu-user","group_type":"Unified","roles":["User"]}],"result_set":{"current_page":1,"total_objects":2,"total_pages":1,"limit":100}}get-role-groupsyeeduplatform-adminget-role-groups-husage:get-role-groups[-h]--tenant_idTENANT_ID--role_idROLE_ID[--page_numberPAGE_NUMBER][--limitLIMIT][--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="6423f466-ff56-4ba4-8c2d-8229beb67e38"--role_id=2Console output{"data":{"role_id":2,"groups":[{"group_id":2,"group_name":"Yeedu","group_type":"Unified"}]},"result_set":{"current_page":1,"total_objects":1,"total_pages":1,"limit":100}}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="6423f466-ff56-4ba4-8c2d-8229beb67e38"--group_id=1--role_id=0Console output{"group_roles_id":"1","tenant_id":"6423f466-ff56-4ba4-8c2d-8229beb67e38","group_id":"1","role_id":0,"created_by_id":"1","modified_by_id":"1","last_update_date":"2024-01-01T13:10:15.840Z","from_date":"2023-01-01T13: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="6423f466-ff56-4ba4-8c2d-8229beb67e38"--group_id=1--role_id=0Console output{"message":"Deleted Group Role for the provided Tenant Id: '6423f466-ff56-4ba4-8c2d-8229beb67e38', Group Id: 1, and Role Id: 0"}AdminUserCommand NameUtilitylist-usersTo list all the users present in tenant.search-usersTo search 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][--page_numberPAGE_NUMBER][--limitLIMIT][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--page_numberPAGE_NUMBERTolistusersforaspecificpage_number.(default:1)--limitLIMITProvidelimittolistnumberofusers.(default:100)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list-users example with optional arguments passed.yeeduadminlist-users--limit=2Console output{"data":{"tenant_id":"6423f466-ff56-4ba4-8c2d-8229beb67e38","users":[{"user_id":1,"username":"YSU0000","email":"YSU0000"}]},"result_set":{"current_page":1,"total_objects":1,"total_pages":1,"limit":100}}search-usersyeeduadminsearch-users-husage:search-users[-h]--usernameUSERNAME[--page_numberPAGE_NUMBER][--limitLIMIT][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--usernameUSERNAMEProvideusernametosearchmatchingusers.--page_numberPAGE_NUMBERTosearchusersforaspecificpage_number.(default:1)--limitLIMITProvidelimittosearchnumberofusers.(default:100)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)search-users example with required and optional arguments passed.yeeduadminsearch-users--username="YS"Console output{"data":{"tenant_id":"6423f466-ff56-4ba4-8c2d-8229beb67e38","users":[{"user_id":1,"username":"YSU0000","email":"YSU0000"}]},"result_set":{"current_page":1,"total_objects":1,"total_pages":1,"limit":100}}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 with the required argument passed.yeeduadminget-user--user_id=1Console output{"user_id":1,"username":"YSU0000","email":"ysu0000@yeedu.com","from_date":"2024-01-01T15:49:50.399852+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":"YSU0000","user_roles":[{"role_id":3,"user_role":"Platform Admin"}],"group_roles":[{"group_id":8,"group_name":"Yeedu","role_id":2,"group_role":"Admin"}]}list-users-rolesyeeduadminlist-users-roles-husage:list-users-roles[-h][--page_numberPAGE_NUMBER][--limitLIMIT][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--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 optional arguments passed.yeeduadminlist-users-rolesConsole output{"data":[{"user_id":1,"username":"YSU0000","user_roles":["Platform Admin"],"group_roles":["Admin"]}],"result_set":{"current_page":1,"total_objects":1,"total_pages":1,"limit":100}}get-role-usersyeeduadminget-role-users-husage:get-role-users[-h]--role_idROLE_ID[--page_numberPAGE_NUMBER][--limitLIMIT][--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=3Console output{"data":{"role_id":3,"users":[{"user_id":1,"username":"YSU0000","email":"YSU0000"}]},"result_set":{"current_page":1,"total_objects":1,"total_pages":1,"limit":100}}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":"6423f466-ff56-4ba4-8c2d-8229beb67e38","user_id":"2","role_id":1,"created_by_id":"1","modified_by_id":"1","last_update_date":"2024-01-01T12:50:27.826Z","from_date":"2024-01-01T12: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.search-groupsTo search 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][--page_numberPAGE_NUMBER][--limitLIMIT][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--page_numberPAGE_NUMBERTolistgroupsforaspecificpage_number.(default:1)--limitLIMITProvidelimittolistnumberofgroups.(default:100)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)list-groups example with the optional argument passed.yeeduadminlist-groupsConsole output{"data":{"tenant_id":"6423f466-ff56-4ba4-8c2d-8229beb67e38","groups":[{"group_id":8,"group_name":"Yeedu","group_type":"Unified"}]},"result_set":{"current_page":1,"total_objects":1,"total_pages":1,"limit":100}}search-groupsyeeduadminsearch-groups-husage:search-groups[-h]--groupnameGROUPNAME[--page_numberPAGE_NUMBER][--limitLIMIT][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--groupnameGROUPNAMEProvidegroupnametosearchmatchinggroups.--page_numberPAGE_NUMBERTosearchgroupsforaspecificpage_number.(default:1)--limitLIMITProvidelimittosearchnumberofgroups.(default:100)--json-output[{pretty,default}]ProvidetheformatofJSONoutput.(default:pretty)--yaml-output[{true,false}]ProvidetruetogetoutputinYAMLformat.(default:false)search-groups example with required and optional arguments passed.yeeduadminsearch-groups--groupname="Yeed"Console output{"data":[{"group_id":8,"group_name":"Yeedu","group_type":"Unified","roles":["Admin"]}],"result_set":{"current_page":1,"total_objects":1,"total_pages":1,"limit":100}}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":"2024-01-01T15:49:50.399852+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,"group_name":"Yeedu","group_type":"Unified","roles":["Admin"]}list-groups-rolesyeeduadminlist-groups-roles-husage:list-groups-roles[-h][--page_numberPAGE_NUMBER][--limitLIMIT][--json-output[{pretty,default}]][--yaml-output[{true,false}]]options:-h,--helpshowthishelpmessageandexit--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 without any optional arguments passed.yeeduadminlist-groups-rolesConsole output{"data":[{"group_id":1,"group_name":"yeedu-manager","group_type":"Unified","roles":["Provider"]},{"group_id":3,"group_name":"yeedu-user","group_type":"Unified","roles":["User"]}],"result_set":{"current_page":1,"total_objects":2,"total_pages":1,"limit":100}}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=2Console output{"data":{"role_id":2,"groups":[{"group_id":2,"group_name":"Yeedu","group_type":"Unified"}]},"result_set":{"current_page":1,"total_objects":1,"total_pages":1,"limit":100}}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":"6423f466-ff56-4ba4-8c2d-8229beb67e38","group_id":"1","role_id":0,"created_by_id":"1","modified_by_id":"1","last_update_date":"2024-01-01T13:10:15.840Z","from_date":"2024-01-01T13: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 argument 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"}