You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: messages/create.sandbox.md
+8-2Lines changed: 8 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,16 +6,22 @@ Create a sandbox org.
6
6
7
7
There are two ways to create a sandbox org: specify a definition file that contains the sandbox options or use the --name and --license-type flags to specify the two required options. If you want to set an option other than name or license type, such as apexClassId, you must use a definition file.
8
8
9
+
You can also use this command to clone an existing sandbox. Use the --clone flag to specify the existing sandbox name and the --name flag to the name of the new sandbox.
10
+
9
11
# examples
10
12
11
13
- Create a sandbox org using a definition file and give it the alias "MyDevSandbox". The production org that contains the sandbox license has the alias "prodOrg".
- Create a sandbox org by directly specifying its name and type of license (Developer) instead of using a definition file. Set the sandbox org as your default.
- Clone the existing sandbox with name "ExistingSandbox" and name the new sandbox "NewClonedSandbox". Set the new sandbox as your default org. Wait for 30 minutes for the sandbox creation to complete.
@@ -58,7 +64,7 @@ Name of the sandbox org to clone.
58
64
59
65
# flags.clone.description
60
66
61
-
The value of clone must be an existing sandbox in the same target-org.
67
+
The value of --clone must be an existing sandbox. The existing sandbox, and the new sandbox specified with the --name flag, must both be associated with the production org (--target-org) that contains the sandbox licenses.
Copy file name to clipboardExpand all lines: messages/refresh.sandbox.md
+15-27Lines changed: 15 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,58 +1,46 @@
1
1
# summary
2
2
3
-
Refresh (update) a sandbox org by the sandbox name.
3
+
Refresh a sandbox org using the sandbox name.
4
4
5
5
# description
6
6
7
-
Refresh (update) a sandbox org by the sandbox name, using a definition file for any `SandboxInfo` overrides.
7
+
Refreshing a sandbox copies the metadata, and optionally data, from your production org to the refreshed sandbox org. You can optionally specify a definition file if you want to change the configuration of the refreshed sandbox, such as its license type or template ID.
8
8
9
-
Note that changing a sandbox name during a refresh is not allowed. If changing the sandbox name is desired, instead delete the sandboxand recreate it.
9
+
You're not allowed to change the sandbox name when you refresh it with this command. If you want to change the sandbox name, first delete it with the "org delete sandbox" command. And then recreate it with the "org create sandbox" command and give it a new name.
10
10
11
11
# examples
12
12
13
13
- Refresh the sandbox named "devSbx1". The production org that contains the sandbox license has the alias "prodOrg".
- Refresh the sandbox named "devSbx2", overriding the SandboxInfo used when created with the properties in a definition file. The default target org is the production org, so specifying the `--target-org` flag is not necessary in this case.
17
+
- Refresh the sandbox named "devSbx2", and override the configuration of the refreshed sandbox with the properties in the specified defintion file. The default target org is the production org, so you don't need to specify the `--target-org` flag in this case.
[default: true] Activates the sandbox after successful refresh.
28
-
29
-
# flags.auto-activate.description
30
-
31
-
[default: true] Activates the sandbox after successful refresh.
27
+
Activates the sandbox after a successful refresh.
32
28
33
29
# flags.targetOrg.summary
34
30
35
31
Username or alias of the production org that contains the sandbox license.
36
32
37
-
# flags.targetOrg.description
38
-
39
-
When it refreshes the sandbox org, Salesforce copies the metadata, and optionally data, from your production org to the sandbox org.
40
-
41
33
# flags.definitionFile.summary
42
34
43
-
Path to a sandbox definition file used to override the configuration used when created.
35
+
Path to a sandbox definition file for overriding its configuration when you refresh it.
44
36
45
37
# flags.definitionFile.description
46
38
47
-
The sandbox definition file is a blueprint for the sandbox, and is used to change the configuration during a refresh. If no configuration changes from the sandbox creation are desired then simply target the sandbox org using the `--name` flag. See <https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_sandbox_definition.htm> for all the options you can specify in the definition file.
39
+
The sandbox definition file is a blueprint for the sandbox; use the file to change the sandbox configuration during a refresh. If you don't want to change the sandbox configuration when you refresh it, then simply use the --name flag to specify the sandbox and don't use this flag. See <https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_sandbox_definition.htm> for all the options you can specify in the definition file.
48
40
49
41
# flags.name.summary
50
42
51
-
Name of the existing sandbox org in your production org.
52
-
53
-
# flags.name.description
54
-
55
-
Name of the existing sandbox org in your production org.
43
+
Name of the existing sandbox org in your production org that you want to refresh.
56
44
57
45
# flags.wait.summary
58
46
@@ -76,23 +64,23 @@ The command immediately displays the job ID and returns control of the terminal
76
64
77
65
# flags.noPrompt.summary
78
66
79
-
Don't prompt for confirmation about the sandbox configuration.
67
+
Don't prompt for confirmation about the sandbox refresh.
80
68
81
69
# isConfigurationOk
82
70
83
71
Is the configuration correct?
84
72
85
73
# error.SandboxNameLength
86
74
87
-
The sandbox name "%s" should be 10 or fewer characters.
75
+
The sandbox name "%s" must be 10 or fewer characters.
88
76
89
77
# error.NoSandboxName
90
78
91
79
Must specify a sandbox name using the `--name` or `--definition-file` flag.
92
80
93
81
# warning.ConflictingSandboxNames
94
82
95
-
Different sandbox names were provided with the `--name` ('%s') and `--definition-file` flags ('%s'). Using the value provided by the `--name` flag. If you want to change the name of the sandbox, please delete and create using the new name.
83
+
Different sandbox names were provided with the `--name` ('%s') and `--definition-file` flags ('%s'). Using the value provided by the `--name` flag. If you want to change the name of the sandbox, first delete it and then create it again using the new name.
96
84
97
85
# error.SandboxNotFound
98
86
@@ -109,7 +97,7 @@ The sandbox request configuration isn't acceptable.
109
97
110
98
# error.pollIntervalGreaterThanWait
111
99
112
-
The poll interval (%d seconds) can't be larger that wait (%d in seconds)
100
+
The poll interval (%d seconds) can't be larger than the wait period (%d in seconds).
0 commit comments