Sun N1 Service Provisioning System 5.2 Command-Line Interface Reference Manual

Chapter 6 `fdb`: CLI Commands for Folder Maintenance

This chapter describes the commands that manage folders.

Overview of the `fdb` Commands

The following table summarizes the CLI commands for managing folders.

Table 6–1 Summary of the fdb Commands


Command	Description
`fdb.f.add`	Create a folder.
`fdb.f.mod`	Modify a folder.
`fdb.f.mv`	Move or rename a folder.
`fdb.f.del`	Delete a folder.
`fdb.f.la`	List all folders.
`fdb.f.lo`	List the details about one folder.
`fdb.f.co`	Change the owner group of a folder.
`fdb.f.mp`	Change the permissions for a folder.

`fdb.f.add`

This command created a folder.

Table 6–2 Arguments and Result for the fdb.f.add Command


Argument/Result		Syntax	Description
fullname	Required	String	The full name of the folder, which is the path to the folder and the folder name
desc	Optional	String	The description of the folder
parents	[0]	Boolean	Whether nonexistent parent folders are created. The default is false.
result		Folder	The new folder

`fdb.f.mod`

This command modifies the specified folder.

Table 6–3 Arguments and Result for the fdb.f.mod Command


Argument/Result		Syntax	Description
ID	Required	FolderID	The folder instance ID
desc	Optional	String	The description of the folder
result		Folder	The modified folder

`fdb.f.mv`

This command moves or renames a folder. The contents of the folder are moved, as well.

Table 6–4 Arguments for the fdb.f.mv Command


Argument		Syntax	Description
ID	Required	FolderID	The ID of the folder to move or rename
fullname	Required	String	The new full name of the folder, which is the path to the folder and the folder name

`fdb.f.del`

This command deletes a folder and its contents.

Table 6–5 Argument and Result for the fdb.f.del Command


Argument/Result		Syntax	Description
ID	Required	FolderID	The ID of the folder to delete
result		none

`fdb.f.la`

This command lists all folders.

Table 6–6 Arguments for the fdb.f.la Command


Argument		Syntax	Description
folderID	Optional	FolderID	The parent folder ID; default is the root folder, (NM:/)
flatView	Optional	Boolean	Should the results be listed in flat view (recursively from parent); defaults to true
result		FolderArray	The list of folders

`fdb.f.lo`

This command lists the details of one folder.

Table 6–7 Argument and Result for the fdb.f.lo Command


Argument/Result		Syntax	Description
ID	Required	FolderID	The ID of the folder
result		Folder	The folder

`fdb.f.co`

This command changes the owner group of a folder.

Table 6–8 Arguments and Result for the fdb.f.co Command


Argument/Result		Syntax	Description
ID	Required	FolderID	The folder ID
groupID	Required	GroupID	The group ID
result		Folder	The modified folder

`fdb.f.mp`

This command changes the permissions of a folder.

Table 6–9 Arguments and Result for the fdb.f.mp Command


Argument/Result		Syntax	Description
ID	Required	FolderID	The folder ID
groupID	Required	GroupID	The group ID
write	Optional	Boolean	Whether the group has `write` permissions on the folder. Default is false. If set to true, `checkin-current` and `autorun` permissions are also set to true.
checkin-current	Optional	Boolean	Whether the group has `checkin-current` permission on the folder. Default value equals `write` permission value. If unspecified while updating a group's permissions, value reverts to default.
autorun	Optional	Boolean	Whether the group has `autorun` permissions on the folder. Default value equals the `write` permissions value. If unspecified while updating a group's permissions, value reverts to default.
execute	Optional	HostSetID	The hostSetID for which the `execute` permission is to be applied. An empty value will remove the `execute` permission on any hostsets. To set this permission for ``all'' hostsets, clients use the ```allhosts`'' sentinel value. (Note that this sentinel value is rendered as ``universal set'' in the browser interface.)
delete-history	Optional	HostSetID	The host set ID for which the delete-history permission is to be applied. An empty value will remove the delete-history permission on any host set. To set this permission for "all" host sets, clients use the "allhosts" sentinel value.
result		Folder	The modified folder

Chapter 6 fdb: CLI Commands for Folder Maintenance

Overview of the fdb Commands

fdb.f.add

fdb.f.mod

fdb.f.mv

fdb.f.del

fdb.f.la

fdb.f.lo

fdb.f.co

fdb.f.mp