enrol Command¶
Prompt user to supply an enrolment key to create or overwrite an existing profile.
Usage¶
enclave enrol [<VALUE>]
[--auth <VALUE>]
[--profile <VALUE>]
[--verbosity|-v <VALUE>]
[--force|-f]
Parameters¶
| Position | Name | Short Name | Description |
|---|---|---|---|
| 0 | Supply an enrolment key to request a certificate. Enrolment keys allow Enclave to request Certificates from the Enclave Certificate Authority. Enrolment keys are often created with restrictions on their use, for example an enrolment key may be constrained to use from a certain geographic location, or a specific set of network addresses. Enrolment keys may also be created for single or multiple uses and may carry further constraints such as restrictions on the lifetime of issued certificates, or how long the enrolment key is valid for. Without supplying a valid enrolment key, the Certificate Authority may reject your request for a certificate. This verb may be used in conjunction with the --profile option. | ||
| auth | Override the authority used by Enclave. (prod, preprod or local) | ||
| profile | Each Enclave requires a profile. A profile is the name of an Enclave network, and refers to a configuration file that contains settings and certificate of each Enclave network. Multiple Enclave instances can run simultaneously on a single system, each with its own profile, settings, network and connections. | ||
| verbosity | v | If specified, overrides the level of log verbosity defined in an Enclave Profile. 0 is the lowest level, no log output, and 5 is the highest which includes a hexadecimal dump of each packet passing through the fabric. Value range 0 to 5. If set to -1, the verbosity will be determined by the Profile configuration. (Use with caution) | |
| force | f | Flag to indicate that Enclave should ignore warnings, and proceed with the requested action. |
Parameter (Position 0)¶
Supply an enrolment key to request a certificate. Enrolment keys allow Enclave to request Certificates from the Enclave Certificate Authority. Enrolment keys are often created with restrictions on their use, for example an enrolment key may be constrained to use from a certain geographic location, or a specific set of network addresses. Enrolment keys may also be created for single or multiple uses and may carry further constraints such as restrictions on the lifetime of issued certificates, or how long the enrolment key is valid for. Without supplying a valid enrolment key, the Certificate Authority may reject your request for a certificate. This verb may be used in conjunction with the --profile option.
| Position: | 0 |
| Required: | No |
| Default value: |
auth Parameter¶
Override the authority used by Enclave. (prod, preprod or local)
| Name: | auth |
| Position: | Named parameter |
| Required: | No |
| Accepted values: | prod, preprod, staging, local |
| Default value: | prod |
profile Parameter¶
Each Enclave requires a profile. A profile is the name of an Enclave network, and refers to a configuration file that contains settings and certificate of each Enclave network. Multiple Enclave instances can run simultaneously on a single system, each with its own profile, settings, network and connections.
| Name: | profile |
| Position: | Named parameter |
| Required: | No |
| Default value: | None |
verbosity Parameter¶
If specified, overrides the level of log verbosity defined in an Enclave Profile. 0 is the lowest level, no log output, and 5 is the highest which includes a hexadecimal dump of each packet passing through the fabric. Value range 0 to 5. If set to -1, the verbosity will be determined by the Profile configuration. (Use with caution)
| Name: | verbosity |
| Short name: | v |
| Position: | Named parameter |
| Required: | No |
| Default value: | -1 |
force Parameter¶
Flag to indicate that Enclave should ignore warnings, and proceed with the requested action.
| Name: | force |
| Short name: | f |
| Position: | None (Switch Parameter) |
| Required: | No (Switch Parameter) |
| Default value: | false |
Documentation generated by MdDocs