UNPKG

@salesforce/plugin-org

Version:

Commands to interact with Salesforce orgs

github.com/salesforcecli/plugin-org

salesforcecli/plugin-org

72 lines (36 loc) • 2.22 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
# summary Check the status of a sandbox creation, and log in to it if it's ready. # description Sandbox creation can take a long time. If the original "<%= config.bin %> org create sandbox" command either times out, or you specified the --async flag, the command displays a job ID. Use this job ID to check whether the sandbox creation is complete, and if it is, the command then logs into it. You can also use the sandbox name to check the status or the --use-most-recent flag to use the job ID of the most recent sandbox creation. # examples - Check the status of a sandbox creation using its name and specify a production org with alias "prodOrg": <%= config.bin %> <%= command.id %> --name mysandbox --target-org prodOrg - Check the status using the job ID: <%= config.bin %> <%= command.id %> --job-id 0GRxxxxxxxx - Check the status of the most recent sandbox create request: <%= config.bin %> <%= command.id %> --use-most-recent # flags.id.summary Job ID of the incomplete sandbox creation that you want to check the status of. # flags.id.description The job ID is valid for 24 hours after you start the sandbox creation. # flags.targetOrg.summary Username or alias of the production org that contains the sandbox license. # flags.targetOrg.description When it creates the sandbox org, Salesforce copies the metadata, and optionally data, from your production org to the new sandbox org. # flags.name.summary Name of the sandbox org. # flags.wait.summary Number of minutes to wait for the sandbox org to be ready. # flags.wait.description If the command continues to run after the wait period, the CLI returns control of the terminal window to you and returns the job ID. To resume checking the sandbox creation, rerun this command. # flags.use-most-recent.summary Use the most recent sandbox create request. # error.NoSandboxNameOrJobId No sandbox name or job ID were provided. # error.LatestSandboxRequestNotFound Retry the command using either the --name or --job-id flags. # error.NoSandboxRequestFound Couldn't find a sandbox creation request using the provided sandbox name or job ID. # error.SandboxNameLength The sandbox name "%s" should be 10 or fewer characters.