zonecfg Modes
The concept of a scope is used for the user interface. The
scope can be either global or resource specific. The default scope is global.
In the global scope, the add subcommand and the select subcommand are used to
select a specific resource. The scope then changes to that resource type.
For the add subcommand, the end or cancel subcommands are used to complete the resource specification.
For the select subcommand, the end or cancel subcommands are used to complete the resource modification.
The scope then reverts back to global.
Certain subcommands, such as add, remove, and set, have different semantics
in each scope.
zonecfg Interactive Mode
In interactive mode, the following subcommands are supported. For detailed information about semantics
and options used with the subcommands, see the zonecfg(1M) man page for options.
For any subcommand that could result in destructive actions or loss of
work, the system requests user confirmation before proceeding. You can use the -F
(force) option to bypass this confirmation.
- help
Print general help, or display help about a given resource.
zonecfg:my-zone:inherit-pkg-dir> help
- create
Begin configuring an in-memory configuration for the specified new zone for one of these purposes:
To apply the Sun default settings to a new configuration. This method is the default.
With the -t template option, to create a configuration that is identical to the specified template. The zone name is changed from the template name to the new zone name.
With the -F option, to overwrite an existing configuration.
With the -b option, to create a blank configuration in which nothing is set.
- export
Print the configuration to standard output, or to the output file specified, in a form that can be used in a command file.
- add
In the global scope, add the specified resource type to the configuration.
In the resource scope, add a property of the given name with the given value.
See How to Configure the Zone and the zonecfg(1M) man page for more information.
- set
Set a given property name to the given property value. Note that some properties, such as zonepath, are global, while others are resource specific. Thus, this command is applicable in both the global and resource scopes.
- select
Applicable only in the global scope. Select the resource of the given type that matches the given property name-property value pair criteria for modification. The scope is changed to that resource type. You must specify a sufficient number of property name-value pairs for the resource to be uniquely identified.
- clear
Clear the value for optional settings. Required settings cannot be cleared. However, some required settings can be changed by assigning a new value.
- remove
In the global scope, remove the specified resource type. You must specify a sufficient number of property name-value pairs for the resource type to be uniquely identified. If no property name-value pairs are specified, all instances will be removed. If more than one exists, a confirmation is required unless the -F option is used.
In the resource scope, remove the specified property name-property value from the current resource.
- end
Applicable only in the resource scope. End the resource specification.
The zonecfg command then verifies that the current resource is fully specified.
If the resource is fully specified, it is added to the in-memory configuration and the scope will revert back to global.
If the specification is incomplete, the system displays an error message that describes what needs to be done.
- cancel
Applicable only in the resource scope. End the resource specification and reset the scope to global. Any partially specified resources are not retained.
- delete
Destroy the specified configuration. Delete the configuration both from memory and from stable storage. You must use the -F (force) option with delete.
Caution - This action is instantaneous. No commit is required, and a deleted zone cannot be reverted.
- info
Display information about the current configuration or the global resource properties zonepath, autoboot, and pool. If a resource type is specified, display information only about resources of that type. In the resource scope, this subcommand applies only to the resource being added or modified.
- verify
Verify current configuration for correctness. Ensure that all resources have all of their required properties specified.
- commit
Commit current configuration from memory to stable storage. Until the in-memory configuration is committed, changes can be removed with the revert subcommand. A configuration must be committed to be used by zoneadm. This operation is attempted automatically when you complete a zonecfg session. Because only a correct configuration can be committed, the commit operation automatically does a verify.
- revert
Revert configuration back to the last committed state.
- exit
Exit the zonecfg session. You can use the -F (force) option with exit.
A commit is automatically attempted if needed. Note that an EOF character can also be used to exit the session.
zonecfg Command-File Mode
In command-file mode, input is taken from a file. The export subcommand described
in zonecfg Interactive Mode is used to produce this file. The configuration can be printed
to standard output, or the -f option can be used to specify an
output file.