# filesystem.chown

Change owner or group of file at path.

uid and gid specify new owner of the file. If either key is absent or None, then existing value on the file is not changed.

user and group alternatively allow specifying a uid gid by user name or group name.

recursive performs action recursively, but does not traverse filesystem mount points.

If traverse and recursive are specified, then the chown operation will traverse filesystem mount points.

This method is a job.

Type: object

##

Type: array
No Additional Items

#### Tuple Validation

##### Parameter 1: filesystem_chown

#### filesystem_chown

Type: object

FilesystemChownArgs parameters.

No Additional Properties

##

#### Path

Type: string

Filesystem path to modify.

Must be at least `1` characters long

##

#### Uid

Default: null

Numeric user ID to set as owner. `null` to leave unchanged.

## Any of

Type: integer

Value must be greater or equal to `-1` and lesser or equal to `2147483647`

Type: null

##

#### User

Default: null

Username to set as owner. `null` to leave unchanged.

## Any of

Type: string

Must be at least `1` characters long

Type: null

##

#### Gid

Default: null

Numeric group ID to set as group owner. `null` to leave unchanged.

## Any of

Type: integer

Value must be greater or equal to `-1` and lesser or equal to `2147483647`

Type: null

##

#### Group

Default: null

Group name to set as group owner. `null` to leave unchanged.

## Any of

Type: string

Must be at least `1` characters long

Type: null

##

#### FilesystemChownOptions

Type: object Default: {"recursive": false, "traverse": false}

Additional options for the ownership change operation.

No Additional Properties

##

#### Recursive

Type: boolean Default: false

Whether to apply the operation recursively to subdirectories.

##

#### Traverse

Type: boolean Default: false

If set do not limit to single dataset / filesystem.

##

#### Result

Type: null

Returns `null` when the ownership change is successfully completed.

Required roles: FILESYSTEM_ATTRS_WRITE