blob: 21f2694ef5a3661bc9a105ad570eeb3946cf8b41 [file] [log] [blame]
type=page
status=published
title=attach
next=backup-domain.html
prev=apply-http-lb-changes.html
~~~~~~
= attach
[[attach-1]][[GSRFM825]][[attach]]
== attach
Attaches to subcommands that were started using `asadmin --detach` or
that contain progress information
[[sthref32]]
=== Synopsis
[source]
----
asadmin [asadmin-options] attach [--help]
job_id
----
[[sthref33]]
=== Description
The `attach` subcommand attaches to subcommands that were started using
the `asadmin` utility option `--detach` or that contain progress
information. The `--detach` option detaches long-running subcommands and
executes them in the background in detach mode.
Job IDs are assigned to the subcommands (jobs), and can be used to view
the status of a job and its output. Use the
link:list-jobs.html#list-jobs-1[`list-jobs`(1)] subcommand to view the
jobs and their job IDs, and the
link:configure-managed-jobs.html#configure-managed-jobs-1[`configure-managed-jobs`(1)]
subcommand to configure how long information about the jobs is kept.
This subcommand is supported in remote mode only.
[[sthref34]]
=== Options
asadmin-options::
Options for the `asadmin` utility. For information about these
options, see the link:asadmin.html#asadmin-1m[`asadmin`(1M)] help page.
`--help`::
`-?`::
Displays the help text for the subcommand.
[[sthref35]]
=== Operands
job_id::
The ID of the job for which you want to view status and output.
[[sthref36]]
=== Examples
[[GSRFM826]][[CBHDFEGB]]
==== Example 1   Attaching to a Subcommand and Checking Its Status
This example attaches to the `deploy` subcommand with a job ID of `20`
and shows that the job is finished. If a subcommand is still in
progress, the output displays the current status, for example,
`64%: Uploading bits`.
[source]
----
asadmin> attach 20
Finished execution of deploy
Command attach executed successfully.
----
[[sthref37]]
=== Exit Status
0::
subcommand executed successfully
1::
error in executing the subcommand
[[sthref38]]
=== See Also
link:asadmin.html#asadmin-1m[`asadmin`(1M)]
link:configure-managed-jobs.html#configure-managed-jobs-1[`configure-managed-jobs`(1)],
link:list-jobs.html#list-jobs-1[`list-jobs`(1)]