The following table describes the ose command-line interface scripts.
| Script | Description |
|---|---|
| ose | Returns details about the ose command-line utility. |
| ose --version | Returns the version of VMware Cloud Director Object Storage Extension that you run. |
| ose show | Returns all VMware Cloud Director Object Storage Extension configuration details. You can optionally add the --with-secret argument and the system returns the passwords that you set during installation and configuration. |
| SSL Certificate Management Scripts | |
| ose cert gen | Generates a new self-signed SSL certificate for the VMware Cloud Director Object Storage Extension service. The --cn and --secret arguments are required. The --cn argument value, must be the common name of the VMware Cloud Director Object Storage Extension host. The --secret argument value must be the password of the keystore. |
| ose cert import | Imports an externally signed SSL certificate. The --path and --secret arguments are required. The --path argument value must be the full path to the .p12 certificate file. The --secret argument value must be the password of the keystore. You can optionally add the --force argument to avoid the password validation. |
| ose cert show | Returns details about the SSL certificate that VMware Cloud Director Object Storage Extension uses. You can optionally add the --with-secret argument to get the password of the keystore. |
| Database Configuration Scripts | |
| ose db set | Configures a connection between your database instance and VMware Cloud Director Object Storage Extension. The --url, --user, and --secret arguments are required. The --url argument value must be the URL of your database instance. The --user and --secret arguments values must be the credentials of the database user. You can use the --ssl-mode parameter to set the SSL mode of the database. You can use the --ssl-cert-path to set the SSL certificate filepath for the database instance. You can optionally add the --force argument to avoid the password validation. |
| ose db show | Returns details about the database configuration. You can optionally add the --with-secret argument to get the password of the database user. |
| VMware Cloud Director Configuration Scripts | |
| ose director set | Configures a connection between VMware Cloud Director and VMware Cloud Director Object Storage Extension. The --url, --user, and --secret arguments are required. The --url argument value must be the URL of your VMware Cloud Director instance. The --user and --secret arguments values must be the credentials of a VMware Cloud Director system administrator. You can optionally add the --force argument to avoid the password validation. You can also use --api token to configure connection to VMware Cloud Director, instead of the --user and --secret pair. |
| ose director show | Returns details about the VMware Cloud Director configuration. You can optionally add the --with-secret argument to get the password of the VMware Cloud Director user account. |
| ose endpoint set | Sets the URL and the region name for the VMware Cloud Director Object Storage Extension endpoint. |
| ose ui install | Installs the VMware Cloud Director Object Storage Extension user interface plug-in for VMware Cloud Director. |
| ose ui uninstall | Uninstalls the VMware Cloud Director Object Storage Extension user interface plug-in for VMware Cloud Director. |
| ose ui show | Returns details about the configuration of the VMware Cloud Director Object Storage Extension user interface plug-in for VMware Cloud Director. |
| Storage Platform Configuration Scripts | |
| ose platforms enable | Allows VMware Cloud Director Object Storage Extension to work with either Cloudian or ECS storage platforms. To activate the Cloudian storage platform, run the ose platforms enable cloudian script. To activate the ECS storage platform, run the ose platforms enable ecs script. To activate the AWS S3 storage service, run the ose platforms enable amazon script. To activate the Object Storage Interoperability Service, run the ose platforms enable osis script. The --name argument is required and defines a unique name for the Object Storage Interoperability Service instance. |
| ose platforms show | Returns details about the platform that is configured for use in VMware Cloud Director Object Storage Extension. |
| AWS S3 Configuration Scripts | |
| ose amazon set | Configures the connection to AWS S3. The --region, --access-key, and --secret-key arguments are required. The --region argument value must be the region of the AWS payer account. The --access-key and --secret-key values must be the access and secret keys of the AWS payer account. |
| ose amazon show | Returns details about the AWS S3 configuration. You can optionally add the --with-secret argument to get the secret key of the AWS payer account. |
| Cloudian Configuration Scripts | |
| ose cloudian admin set | Configures a connection between the Cloudian Admin service and VMware Cloud Director Object Storage Extension. The --url, --user, and --secret arguments are required. The --url argument value must be the URL of the Cloudian Admin service. The --user and --secret arguments values must be the credentials of a Cloudian Admin service administrator user. You can optionally add the --force argument to avoid the password validation. |
| ose cloudian s3 set | Configures a connection between the Cloudian S3 service and VMware Cloud Director Object Storage Extension. The --url argument is required and the value must be the FQDN or the IP address of the S3 service. If you use the FQDN, make sure that you correctly configure the S3 Service domain in the Cloudian HyperStore cluster. Also, make sure that your DNS server can route all bucket requests from the virtual to the actual S3 Service host. For example, from bucket-name.hyper-store-s3-host to hyper-store-s3-host. If you use the IP address of the S3 Service, no domain and virtual host route settings are required. |
| ose cloudian iam set | Configures a connection between the Cloudian IAM service and VMware Cloud Director Object Storage Extension. The --url argument is required and the value must be the URL of the Cloudian IAM service. |
| ose cloudian console set | Configures the connection between the Cloudian Management Console and VMware Cloud Director Object Storage Extension. The --url, --user, and --secret arguments are required. The --url argument value must be the URL of the Cloudian Management Console. The --user argument value must be the user name of a Cloudian system administrator. The --secret argument value must be the single sign-on shared key that is configured in the Cloudian Management Console. You can optionally add the --force argument to avoid the password validation. |
| ose cloudian show | Returns details about the configuration of Cloudian components. You can optionally add the --with-secret argument to get the passwords of the Cloudian user accounts. |
| ECS Configuration Scripts | |
| ose ecs admin set | Configures a connection between the ECS Admin service and VMware Cloud Director Object Storage Extension. The --url, --user, and --secret arguments are required. The --url argument value must be the URL of the ECS Admin service. The --user and --secret arguments values must be the credentials of an ECS Admin service administrator user. You can optionally add the --force argument to avoid the password validation. |
| ose ecs s3 set | Configures a connection between the ECS S3 service and VMware Cloud Director Object Storage Extension. The --url argument is required. The argument value must be the FQDN or the IP address of the S3 service. Make sure that your DNS server can route all bucket requests from the virtual to the actual S3 service host. For example, from bucket-name.hyper-store-s3-host to hyper-store-s3-host. If you use the IP address of the S3 service, no domain and virtual host route settings are required. |
| ose ecs console set | Configures a connection between the ECS Management Console and VMware Cloud Director Object Storage Extension. The --url, --user, and --secret arguments are required. The --url argument value must be the URL of the ECS Management Console. The --user and --secret arguments values must be the credentials of an ECS administrator user. You can optionally add the --force argument to avoid the password validation. |
| ose ecs show | Returns details about the configuration of ECS components. You can optionally add the --with-secret argument to get the passwords of the ECS user accounts. |
| Object Storage Interoperability Service Configuration Scripts | |
| ose osis admin set | Configures a connection between VMware Cloud Director Object Storage Extension and the admin service of the Object Storage Interoperability Service instance. The --name, --url, --user, and --secret arguments are required. The --name argument value must be the name of the Object Storage Interoperability Service instance. The --url argument value must be the URL of the Object Storage Interoperability Service admin service. The --user and --secret arguments values must be the credentials of an Object Storage Interoperability Service admin service administrator user. You can optionally add the --force argument to avoid the password validation. |
| ose osis s3 set | Configures a connection between the Object Storage Interoperability Service S3 service and VMware Cloud Director Object Storage Extension. The --name argument is required and the value must be the name of the Object Storage Interoperability Service instance. The --url argument is required and the value must be the FQDN or the IP address of the S3 service. |
| VMware Cloud Director Object Storage Extension Service Configuration Scripts | |
| ose args set | Sets VMware Cloud Director Object Storage Extension service arguments. Service arguments are a key-value pair. Use the --k and --v arguments to define the key and value. The --k argument value must be the key and the --v argument value must be the value. |
| ose args get | Returns details about a VMware Cloud Director Object Storage Extension service argument. Use the --k argument to retrieve service arguments by their key. |
| ose args del | Deletes VMware Cloud Director Object Storage Extension service arguments. Use the --k argument to delete service arguments by their key. |
| ose args show | Returns details about all VMware Cloud Director Object Storage Extension service argument. |
| ose service start | Starts the VMware Cloud Director Object Storage Extension service. You can optionally add the --debug argument to change the service logging level to debug. |
| ose service stop | Stops the VMware Cloud Director Object Storage Extension service. |
| ose service restart | Restarts the VMware Cloud Director Object Storage Extension service. You can optionally add the --debug argument to change the service logging level to debug. |
| ose service show | Returns the VMware Cloud Director Object Storage Extension service status and configuration. |
| Data Migration Scripts | |
| ose migration start | Starts data migration from VMware Cloud Director Object Storage Extension version 1.0 to version 1.0.1 or from version 1.0 to version 1.5. To restart the process, rerun the script with the --force argument. |
| ose migration show | Returns details about the migration progress. |
| Configuration Scripts | |
| ose config validate | Validates the configuration of VMware Cloud Director Object Storage Extension. |
| ose config export | Exports the configuration of VMware Cloud Director Object Storage Extension to a JSON file. The --file and --secret arguments are required. The --file argument value must be the export filename. The --secret argument value must be the password of a VMware Cloud Director system administrator. |
| ose config import | Imports the configuration of VMware Cloud Director Object Storage Extension from a JSON file. The --path and --secret arguments are required. The --file argument value must be the source directory for the import. The --secret argument value must be the password of a VMware Cloud Director system administrator. |
| Administration Scripts | |
| ose support | Generates a support bundle. The --start argument is optional and defines the start time for the logs to be collected. The default value is 2018-01-01. The --end argument is optional and defines the end time for the logs to be collected. If not specified, the end date is the current date. For the --start and the --end arguments values, enter the date in the YYYY-MM-DD format. |
| Java Virtual Machine (JVM) Configuration Scripts | |
| ose jvmargs set | Configures the JVM arguments. Use the -v argument to define the JVM arguments. For example, to set an HTTP proxy, run the following command: |
| ose jvmargs delete | Deletes the JVM arguments configuration. |
| ose jvmargs show | Returns details about the JVM arguments configuration. |
