addFile Element attributes (N1 Service Provisioning System 4.1 Reference Guide)

N1 Service Provisioning System 4.1 Reference Guide

addFile Element attributes

Note –

Values can be multibyte character strings.

Name	Type	Required	Configurable	Description
path	String	Yes	Yes	The pathname of a file or directory on the filesystem of the target host.
ownership	One of: SET_SELF ADD_SELF ADD_TEMP	No	No	The ownership option for the captured file, as described below.
filter	One of: DIRECTORIES FILES BOTH	No	No	When the pathname refers to a directory, this attribute is used to indicate whether the directory itself, the files it contains, or both should be captured. If unspecified, BOTH is used by default. If the pathname is not a directory, this attribute is ignored and the file is captured directly.
recursive	Boolean	No	No	When the pathname refers to a directory, this attribute is used to indicate whether subdirectories should be recursively captured using the current filter settings. If unspecified, true is used by default. If the pathname is not a directory, this attribute is ignored and the file is captured directly.
displayName	String	No	Yes	Text to be included in the display when this snapshot entry is compared against another.

addFile ownership attribute

The “ownership” attribute of the <addFile> element specifies the ownership option for the captured file. If unspecified, SET_SELF is used by default.

One aspect of the installed state that is captured by the snapshot is file and directory ownership. This is not the same as UNIX permissions; it is more closely tied to the notion of reference counts. Specifically, a file or directory can be captured as being owned by one or more snapshots. If the file owner later changes as a result of another component installation, this can be recognized and reported when the file is compared against its initial state. This facilitates tracking down differences that result from one component unintentionally overwriting files associated with another component. Snapshot ownership information is captured in a repository on the target host known as the owners table.

The values of the ownership attribute have the following semantics:

If the ownership value is SET_SELF, then the owners table should be updated so that it contains a single entry for the associated file or directory. That entry lists the executing installed component and snapshot as owners. It also lists the capture area ID of the captured contents of the file or directory.
If the ownership value is ADD_SELF, then the installed component and snapshot should be added as additional owners, sharing the existing capture area ID as the previous owners.
The ownership value ADD_TEMP is like ADD_SELF except that a new capture is always created and its ID is always used for the new entry rather than sharing the one of the other owners.