blob: 1c731533395a1aea22dc05c258b59148c54fdcba [file] [log] [blame]
Vinay Vishal7c4c4fc2019-01-28 12:01:04 +05301type=page
2status=published
3title=import-sync-bundle
4next=install-node.html
5prev=get-health.html
6~~~~~~
David Matějček17fd4612021-12-18 21:14:28 +01007
David Matějčekdbccabf2021-12-20 14:06:31 +01008= import-sync-bundle
Vinay Vishal7c4c4fc2019-01-28 12:01:04 +05309
10[[import-sync-bundle-1]][[GSRFM00142]][[import-sync-bundle]]
11
David Matějčekdbccabf2021-12-20 14:06:31 +010012== import-sync-bundle
Vinay Vishal7c4c4fc2019-01-28 12:01:04 +053013
David Matějček17fd4612021-12-18 21:14:28 +010014Imports the configuration data of a clustered instance or standalone
Vinay Vishal7c4c4fc2019-01-28 12:01:04 +053015instance from an archive file
16
17[[sthref1243]]
18
David Matějček17fd4612021-12-18 21:14:28 +010019=== Synopsis
Vinay Vishal7c4c4fc2019-01-28 12:01:04 +053020
David Matějček17fd4612021-12-18 21:14:28 +010021[source]
Vinay Vishal7c4c4fc2019-01-28 12:01:04 +053022----
23asadmin [asadmin-options] import-sync-bundle [--help]
David Matějček9d73d042021-12-20 13:03:32 +010024--instance instance-name
Vinay Vishal7c4c4fc2019-01-28 12:01:04 +053025[--nodedir node-dir] [--node node-name]
26file-name
27----
28
29[[sthref1244]]
30
David Matějček17fd4612021-12-18 21:14:28 +010031=== Description
Vinay Vishal7c4c4fc2019-01-28 12:01:04 +053032
33The `import-sync-bundle` subcommand imports the configuration data of a
34clustered instance or standalone instance from an archive file that was
35created by the
36link:export-sync-bundle.html#export-sync-bundle-1[`export-sync-bundle`(1)]
37subcommand.
38
39You must run this subcommand on the host where the instance resides. To
40contact the domain administration server (DAS), this subcommand requires
41the name of the host where the DAS is running. If a nondefault port is
42used for administration, this subcommand also requires the port number.
43You must provide this information through the `--host` option and the
44`--port` option of the link:asadmin.html#asadmin-1m[`asadmin`(1M)]
45utility.
46
47Importing an instance's configuration data transfers the data to a host
48for an instance without the need for the instance to be able to
49communicate with the DAS. Importing an instance's configuration data is
50typically required for the following reasons:
51
52* To reestablish the instance after an upgrade
53* To synchronize the instance manually with the domain administration
54server (DAS) when the instance cannot contact the DAS
55
56The subcommand imports an instance's configuration data by performing
57the following operations:
58
59* Creating or updating the instance's files and directories
60* Attempting to register the instance with the DAS
61
62If the attempt to register the instance with the DAS fails, the
63subcommand does not fail. Instead, the subcommand displays a warning
64that the attempt failed. The warning contains the command to run to
65register the instance with the DAS.
66
67The `import-sync-bundle` subcommand does not contact the DAS to
68determine the node on which the instance resides. If the node is not
69specified as an option of the subcommand, the subcommand determines the
70node from the DAS configuration in the archive file.
71
72This subcommand is supported in local mode only.
73
74[[sthref1245]]
75
David Matějček17fd4612021-12-18 21:14:28 +010076=== Options
Vinay Vishal7c4c4fc2019-01-28 12:01:04 +053077
78asadmin-options::
79 Options for the `asadmin` utility. For information about these
80 options, see the link:asadmin.html#asadmin-1m[`asadmin`(1M)] help page.
81`--help`::
82`-?`::
83 Displays the help text for the subcommand.
84`--instance`::
85 The instance for which configuration data is being imported. The
86 instance must already exist in the DAS configuration. The archive file
87 from which the data is being imported must contain data for the
88 specified instance.
89`--nodedir`::
90 The directory that contains the instance's node directory. The
91 instance's files are stored in the instance's node directory. The
David Matějček6c58c142021-12-20 20:22:31 +010092 default is as-install``/nodes``.
Vinay Vishal7c4c4fc2019-01-28 12:01:04 +053093`--node`::
94 The node on which the instance resides. If this option is omitted, the
95 subcommand determines the node from the DAS configuration in the
96 archive file.
97
98[[sthref1246]]
99
David Matějček17fd4612021-12-18 21:14:28 +0100100=== Operands
Vinay Vishal7c4c4fc2019-01-28 12:01:04 +0530101
102file-name::
103 The name of the file, including the path, that contains the archive
104 file to import. This operand is required.
105
106[[sthref1247]]
107
David Matějček17fd4612021-12-18 21:14:28 +0100108=== Examples
Vinay Vishal7c4c4fc2019-01-28 12:01:04 +0530109
110[[GSRFM624]][[sthref1248]]
111
David Matějček17fd4612021-12-18 21:14:28 +0100112==== Example 1   Importing Configuration Data for a Clustered Instance
Vinay Vishal7c4c4fc2019-01-28 12:01:04 +0530113
114This example imports the configuration for the clustered instance
115`ymli2` on the node `sj02` from the archive file
David Matějček65f20922021-12-19 19:44:29 +0100116`/export/glassfish7/glassfish/domains/domain1/sync/ymlcluster-sync-bundle.zip`.
Vinay Vishal7c4c4fc2019-01-28 12:01:04 +0530117
118The command is run on the host `sj02`, which is the host that the node
119`sj02` represents. The DAS is running on the host `sr04` and uses the
120default HTTP port for administration.
121
David Matějček17fd4612021-12-18 21:14:28 +0100122[source]
Vinay Vishal7c4c4fc2019-01-28 12:01:04 +0530123----
David Matějček9d73d042021-12-20 13:03:32 +0100124sj02# asadmin --host sr04 import-sync-bundle --node sj02 --instance ymli2
David Matějček65f20922021-12-19 19:44:29 +0100125/export/glassfish7/glassfish/domains/domain1/sync/ymlcluster-sync-bundle.zip
Vinay Vishal7c4c4fc2019-01-28 12:01:04 +0530126Command import-sync-bundle executed successfully.
127----
128
129[[sthref1249]]
130
David Matějček17fd4612021-12-18 21:14:28 +0100131=== Exit Status
Vinay Vishal7c4c4fc2019-01-28 12:01:04 +0530132
1330::
134 command executed successfully
1351::
136 error in executing the command
137
138[[sthref1250]]
139
David Matějček17fd4612021-12-18 21:14:28 +0100140=== See Also
Vinay Vishal7c4c4fc2019-01-28 12:01:04 +0530141
142link:asadmin.html#asadmin-1m[`asadmin`(1M)]
143
144link:export-sync-bundle.html#export-sync-bundle-1[`export-sync-bundle`(1)]
145
146