Fields on the Add-Ons page

Fields used in the Add-Ons page of the console are defined to help you manage your add-ons in the catalog.

The Add-Ons page of the console consists of several groups of fields and options.

The Add-Ons list

The Add-Ons page displays the list of add-ons currently available in the catalog, including the set of default add-ons provided with the product and any additional add-ons that you or other users have created. The list is displayed in a table format, providing some basic details about each add-on.

The following functions are located above the table for you to work with the list of add-ons:

Refresh: Refreshes the status of the add-ons and updates the fields on the Add-Ons page.
Create New: Creates a new add-on. A dialog is opened where you can import an add-on package file containing the information about your new add-on.
Filter: Enter a term to filter the add-ons that display on the page. For example, you can enter the text string NIC to display only the add-ons that have that string in the name.
Entire Domain: Click Entire Domain to view all add-ons that you have permission to view across all systems in a multisystem management domain. The Locations column displays the number of systems in the domain that contain each add-on. Click the number in the column to view the systems that contain the add-on in the Locations window.
Note: Only applies to external (LDAP) users.
Subdomain Only: Click Subdomain Only to view all add-ons that you have permission to view across the systems in a multisystem deployment subdomain. The Locations column displays the number of systems in the subdomain that contain each add-on. Click the number in the column to view the systems that contain the add-on in the Locations window.
Note: Only applies to external (LDAP) users.
Local Only: Click Local Only to view all add-ons that you have permission to view on this system.
Note: Only applies to external (LDAP) users.

To work with an add-on, select it by clicking the name in the list, or click Show Details in the Actions column. Details about the selected add-on are displayed in a slide-out pane.

Icons in the Actions column

The Actions column in the table on the Add-Ons page includes the following additional icons for each add-on:

Clone: Creates a copy of the add-on, even a locked (read-only) add-on, that can be edited.
Lock: Displayed if the add-on is in Draft status. Configures the add-on as read-only and locks it to prevent further editing.
Export: Exports the add-on for use on another system.
Show Details: Shows the details for the add-on in a slide-out page.

Details for the selected add-on

Selecting an add-on (either by clicking the name link of the add-on or by clicking Show Details in the Actions column) opens a slide-out pane that displays the name of the add-on in the toolbar at the top of the pane, and details about the add-on in the following fields:

Locations

Shows the location of copies for the add-on on other systems for the external (LDAP) user in a multisystem environment. The following functions are available for you to work with the copies:

Copy to location: Copies the artifact to a remote system.
Sync changes: Synchronizes the artifact on the system with the local system.

The absence of either function indicates that the artifacts at two locations are identical and synchronized, or that the add-on does not contain an add-on package file.

Note: The attributes that are compared to determine whether there are differences between add-ons at different locations are license status and the access control list.

Description

A text description of the add-on. You can edit this description to provide meaningful information about the add-on.

Version

The version of the selected add-on.

Type

The add-on can be one of the following types:

Disk
NIC
User
Network Attached Storage
None

The type of add-on is defined in the package file for the add-on. You cannot edit this field.

Created on

The date and time that the add-on was created. This value is stored internally as the number of seconds since midnight January 1, 1970 UTC. This value is displayed as the equivalent date and time in the local timezone.

Add-on package file

The name of the package file that is defined for each type of add-on.

You can use the Export function to export the add-on package file to your local system. From there you can examine the contents or modify it to create a custom package file that you can import as a new add-on.

To replace an existing compressed file in the add-on, complete the following steps:

Click Browse in the field and go to the location of your compressed file and select it. The name of the compressed file is displayed in the Add-on package file field.
Click Upload to upload the selected compressed file into the add-on.

Note: When you replace the compressed file for an add-on, if the name or version in the new compressed file do not match the current add-on name and version, a warning is displayed. You can proceed with the import or cancel. If you proceed, the existing name and version are kept, and the name and version in the new archive are ignored.

Current status

The status of the add-on can be one of the following status types:

Draft: You can modify the add-on.
Read-only: The add-on is locked and cannot be modified.

Updated on

The date and time that the add-on was last updated. This value is stored internally as the number of seconds since midnight, January 1, 1970 UTC. The value is displayed as the equivalent date and time in the local timezone.

Environment

One or more add-on keys and their default values. Depending on the type of add-on you are displaying, this field manages the environment variables in different ways:

If you are creating a new add-on, you can define one or more environment variables for the add-on:
1. In the Add variable fields, specify the key name and the value for the environment variable.
2. Click Add to add the key and value pair to the add-on.
Repeat this process to add additional environment variables to the add-on.

If you have environment variables defined that you want to remove, click Remove next to the key and value pair.
If you are viewing an add-on that is read-only, any environment variables that have been defined are displayed, but cannot be modified.

Note: The Default configure NIC add-on is a special add-on that does not have any associated environment variables. It is used internally in the system.

Working directory

The directory, on the virtual machine, into which files for this add-on package are to be placed.

This directory is specified in the add-on package file and is typically in the form of /tmp/<addon_name>, where <addon_name> is similar to the name of the add-on. For example, the directory for the Default add user add-on is /tmp/defaultadduser. You can modify this value as needed.

Logging directory

The directory, on the virtual machine, that is to contain the log files generated by the add-on. Similar to the working directory, you can modify this value as needed.

Executable

The command to be run for this add-on package. You can specify any command on the virtual machine (for example, wsadmin, tar, ant, or another system command). You can also provide your own script to be run as part of the script package.

Note: The Default configure NIC add-on is a special add-on that does not have an executable script. It is used internally in the system.

Arguments

One or more parameters that are passed to the executable command. You can optionally specify environment variables and other valid command-line syntax. You can also access the environment by using standard techniques (for example, shell or ant).

Timeout

The maximum amount of time, in milliseconds, to wait for the add-on to finish running on a virtual machine. This value is initially specified in the imported add-on package. You can modify this file as needed. Specify the timeout as the number of milliseconds to wait, or 0 to wait indefinitely for the add-on to complete.

Included in patterns

Lists the patterns that are currently associated with the add-on.

In the cloud now

Lists the patterns that are currently associated with the add-on, and that are currently deployed in a cloud environment.

Access granted to

The access control list for this add-on. Users or groups who have access to this add-on are listed in this field as links. If you have permission, use the Add more entry field to provide access for more users or groups of users. For each user or group of users in this list, you can specify whether they have read, write or all access by clicking the link next to the user or group name. Click remove to remove the user or group from the access list.