APIs in Category: name-mapping | Vserver API version 1.20

name-mapping-create name-mapping-delete name-mapping-get-iter name-mapping-insert name-mapping-modify name-mapping-swap name-mapping-unix-group-add-user name-mapping-unix-group-create name-mapping-unix-group-delete-user name-mapping-unix-group-destroy name-mapping-unix-group-get name-mapping-unix-group-get-iter name-mapping-unix-group-modify name-mapping-unix-user-create name-mapping-unix-user-destroy name-mapping-unix-user-get name-mapping-unix-user-get-iter name-mapping-unix-user-modify | This set of APIs are used to manage name mappings between Kerberos users, Windows users and UNIX users. name-mapping-unix-user APIs are used to manage local UNIX users. name-mapping-unix-group APIs are used to manage local UNIX groups. When a NFS client wishes to access a file having NTFS style permission, name-mapping rule is applied to determine the Windows User that maps to the NFS Client user under consideration. When a CIFS client wishes to access a file having UNIX style permission name-mapping rule is applied to determine the UNIX user that maps to the CIFS user under consideration. When neither NIS nor LDAP is configured, credentials for the mapped UNIX user is obtained from the local database created using name-mapping-unix-user and name-mapping-unix-group APIs.

NetApp Manage ONTAP

name-mapping-create | [top]

> Create a new name mapping for a Vserver.

> Input Name | Range | Type | Description
> direction |  | name-mapping-direction | Direction in which the name mapping is applied. Possible values: "krb_unix" - Kerberos principal name to UNIX user name mapping, "win_unix" - Windows user name to UNIX user name mapping, "unix_win" - UNIX user name to Windows user name mapping
> pattern |  | string | Pattern to use to match the name while searching for a name that can be used as a replacement. The pattern is a UNIX-style regular expression. Regular expressions are case-insensitive when mapping from Windows to UNIX, and they are case-sensitive for mappings from Kerberos to UNIX and UNIX to Windows.
> position | [1..1024] | integer | Position of an existing name mapping in the list of name mappings for this Vserver.
> replacement |  | string | The name that is to be used as a replacement if the pattern associated with this entry matches. The replacement is a string containing escape sequences representing subexpressions from the pattern, as in the UNIX 'sed' program.
> return-record |  | boolean optional | If set to true, returns the name-mapping on successful creation. Default: false
> Output Name | Range | Type | Description
> result |  | name-mapping-info optional | The name-mapping created (keys or the entire object if requested)

> Errno | Description
> EINTERNALERROR |  |

name-mapping-delete | [top]

> Delete an existing name mapping entry.

> Input Name | Range | Type | Description
> direction |  | name-mapping-direction | Direction in which the name mapping is applied. Possible values: "krb_unix" - Kerberos principal name to UNIX user name mapping, "win_unix" - Windows user name to UNIX user name mapping, "unix_win" - UNIX user name to Windows user name mapping
> position | [1..1024] | integer | Position of an existing name mapping in the list of name mappings for this Vserver.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

name-mapping-get-iter | [top]

> Retrieve the list of name mappings in the cluster.

> Input Name | Range | Type | Description
> desired-attributes |  | name-mapping-info optional | Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
> max-records | [1..2^32-1] | integer optional | The maximum number of records to return in this call. Default: 20
> query |  | name-mapping-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the name-mapping object. All name-mapping objects matching this query up to 'max-records' will be returned.
> tag |  | string optional | Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
> Output Name | Range | Type | Description
> attributes-list |  | name-mapping-info[] optional | The list of attributes of name-mapping objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more name-mapping objects to return.
> num-records | [0..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

name-mapping-insert | [top]

> Insert a name mapping into the table at a specified position.

> Input Name | Range | Type | Description
> direction |  | name-mapping-direction | Direction of the name mapping to be inserted. Possible values: "krb_unix" - Kerberos principal name to UNIX user name mapping, "win_unix" - Windows user name to UNIX user name mapping, "unix_win" - UNIX user name to Windows user name mapping
> pattern |  | string | Pattern to use to match the name while searching for a name that can be used as a replacement. The pattern is a UNIX-style regular expression. Regular expressions are case-insensitive when mapping from Windows to UNIX, and they are case-sensitive for mappings from Kerberos to UNIX and UNIX to Windows.
> position | [1..1024] | integer | Position within the set of name mappings that this new mapping will take. If a mapping already exists at this position, it will be moved to the next position in the list.
> replacement |  | string | The name that is to be used as a replacement if the pattern associated with this entry matches. The replacement may be a string containing escape sequences representing subexpressions from the pattern, as in the UNIX 'sed' program.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

name-mapping-modify | [top]

> Modify an existing name mapping entry.

> Input Name | Range | Type | Description
> direction |  | name-mapping-direction | Direction in which the name mapping is applied. Possible values: "krb_unix" - Kerberos principal name to UNIX user name mapping, "win_unix" - Windows user name to UNIX user name mapping, "unix_win" - UNIX user name to Windows user name mapping
> pattern |  | string optional | Pattern to use to match the name while searching for a name that can be used as a replacement. The pattern is a UNIX-style regular expression. Regular expressions are case-insensitive when mapping from Windows to UNIX, and they are case-sensitive for mappings from Kerberos to UNIX and UNIX to Windows.
> position | [1..1024] | integer | Position of an existing name mapping in the list of name mappings for this Vserver.
> replacement |  | string optional | The name that is to be used as a replacement if the pattern associated with this entry matches. The replacement is a string containing escape sequences representing subexpressions from the pattern, as in the UNIX 'sed' program.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

name-mapping-swap | [top]

> Swap the position of one name mapping with another. The position is the place in the sequence of name mappings in which the mappings are applied.

> Input Name | Range | Type | Description
> direction |  | string | Direction in which the name mapping is applied.
> position |  | integer | Position of an existing name mapping in the list of name mappings for this Vserver.
> with-position |  | integer | Position of an existing name mapping entry in the list of name mappings for this Vserver. This entry will be swapped with the entry at 'position'.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

name-mapping-unix-group-add-user | [top]

> Add a user to a UNIX group

> Input Name | Range | Type | Description
> group-name |  | string | Specifies UNIX group name.
> user-name |  | string | Specifies user's UNIX account name.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EVSERVERNTFOUND |  |
> EINTERNALERROR |  |

name-mapping-unix-group-create | [top]

> Create a new UNIX group.

> Input Name | Range | Type | Description
> group-id | [0..2^32-1] | integer | Specifies an identification number for the UNIX group.
> group-name |  | string | Specifies UNIX group name.
> return-record |  | boolean optional | If set to true, returns the UNIX group information on successful creation. Default: false
> Output Name | Range | Type | Description
> result |  | unix-group-info optional | The UNIX group information created (keys or the entire object if requested)

> Errno | Description
> EOBJECTNOTFOUND |  |
> EVSERVERNTFOUND |  |
> EINVALIDINPUTERROR |  |
> EINTERNALERROR |  |

name-mapping-unix-group-delete-user | [top]

> Delete a user from a UNIX group

> Input Name | Range | Type | Description
> group-name |  | string | Specifies UNIX group name.
> user-name |  | string | Specifies user's UNIX account name.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EVSERVERNTFOUND |  |
> EINTERNALERROR |  |

name-mapping-unix-group-destroy | [top]

> Destroy an existing UNIX group.

> Input Name | Range | Type | Description
> group-name |  | string | Specifies UNIX group name.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EVSERVERNTFOUND |  |
> EINTERNALERROR |  |

name-mapping-unix-group-get | [top]

> Get the attributes of a UNIX group.

> Input Name | Range | Type | Description
> desired-attributes |  | unix-group-info optional | Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
> group-name |  | string | Specifies UNIX group name.
> Output Name | Range | Type | Description
> attributes |  | unix-group-info | The attributes of the UNIX group information.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EVSERVERNTFOUND |  |
> EINTERNALERROR |  |

name-mapping-unix-group-get-iter | [top]

> Iterate over a list of UNIX groups.

> Input Name | Range | Type | Description
> desired-attributes |  | unix-group-info optional | Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
> max-records | [1..2^32-1] | integer optional | The maximum number of records to return in this call. Default: 20
> query |  | unix-group-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the UNIX group information object. All UNIX group information objects matching this query up to 'max-records' will be returned.
> tag |  | string optional | Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
> Output Name | Range | Type | Description
> attributes-list |  | unix-group-info[] optional | The list of attributes of UNIX group information objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more UNIX group information objects to return.
> num-records | [0..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |
> EINVALIDINPUTERROR |  |
> EVSERVERNTFOUND |  |

name-mapping-unix-group-modify | [top]

> Modify the attributes of a UNIX group.

> Input Name | Range | Type | Description
> group-id | [0..2^32-1] | integer optional | Specifies an identification number for the UNIX group.
> group-name |  | string | Specifies UNIX group name.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EVSERVERNTFOUND |  |
> EINVALIDINPUTERROR |  |
> EINTERNALERROR |  |

name-mapping-unix-user-create | [top]

> Create a new UNIX user.

> Input Name | Range | Type | Description
> full-name |  | string optional | Specifies the full name of the UNIX user.
> group-id | [0..2^32-1] | integer | Specifies the primary group identification number for the UNIX user.
> return-record |  | boolean optional | If set to true, returns the UNIX user information on successful creation. Default: false
> user-id | [0..2^32-1] | integer | Specifies an identification number for the UNIX user.
> user-name |  | string | Specifies user's UNIX account name.
> Output Name | Range | Type | Description
> result |  | unix-user-info optional | The UNIX user information created (keys or the entire object if requested)

> Errno | Description
> EOBJECTNOTFOUND |  |
> EVSERVERNTFOUND |  |
> EINVALIDINPUTERROR |  |
> EINTERNALERROR |  |

name-mapping-unix-user-destroy | [top]

> Destroy an existing UNIX user.

> Input Name | Range | Type | Description
> user-name |  | string | Specifies user's UNIX account name.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EVSERVERNTFOUND |  |
> EINTERNALERROR |  |

name-mapping-unix-user-get | [top]

> Get the attributes of a UNIX user.

> Input Name | Range | Type | Description
> desired-attributes |  | unix-user-info optional | Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
> user-name |  | string | Specifies user's UNIX account name.
> Output Name | Range | Type | Description
> attributes |  | unix-user-info | The attributes of the UNIX user information.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EVSERVERNTFOUND |  |
> EINTERNALERROR |  |

name-mapping-unix-user-get-iter | [top]

> Iterate over a list of UNIX users.

> Input Name | Range | Type | Description
> desired-attributes |  | unix-user-info optional | Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
> max-records | [1..2^32-1] | integer optional | The maximum number of records to return in this call. Default: 20
> query |  | unix-user-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the UNIX user information object. All UNIX user information objects matching this query up to 'max-records' will be returned.
> tag |  | string optional | Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
> Output Name | Range | Type | Description
> attributes-list |  | unix-user-info[] optional | The list of attributes of UNIX user information objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more UNIX user information objects to return.
> num-records | [0..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |
> EINVALIDINPUTERROR |  |
> EVSERVERNTFOUND |  |

name-mapping-unix-user-modify | [top]

> Modify the attributes of a UNIX user.

> Input Name | Range | Type | Description
> full-name |  | string optional | Specifies the full name of the UNIX user.
> group-id | [0..2^32-1] | integer optional | Specifies the primary group identification number for the UNIX user.
> user-id | [0..2^32-1] | integer optional | Specifies an identification number for the UNIX user.
> user-name |  | string | Specifies user's UNIX account name.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EVSERVERNTFOUND |  |
> EINVALIDINPUTERROR |  |
> EINTERNALERROR |  |

Element definition: name-mapping-direction | [top]

> Direction of the name mapping. Possible values: "krb_unix" - Kerberos principal name to UNIX user name mapping, "win_unix" - Windows user name to UNIX user name mapping, "unix_win" - UNIX user name to Windows user name mapping

> [none]

Element definition: name-mapping-info | [top]

> Name mapping configuration for Vservers. The possible sources of name mapping information and the order in which they are searched is determined by the Vserver's 'name-mapping-switch' option. If the 'name-mapping-switch' is set to 'file', the rules in this table are used to determine the mapping. Windows user names, UNIX user names and Kerberos principal names can be three disjoint sets of names. A mechanism is needed to map users from one set to another when performing authorization checks. Each name mapping entry represents one such map in a given direction. Name mappings are done using standard UNIX style regular expressions for pattern replacement. For example if a configuration is required to convert any Windows user in the Windows domain name 'EXAMPLE' into a UNIX user with the same name in NIS, the direction entry should be set to 'win-unix', the pattern string should be set to 'EXAMPLE\\(.+)' and the replacement string should be set to '\1'. The double backs1293 :n the pattern matches a single backslash in the source name. The parentheses denote a subexpression but do not match any characters themselves. The 'period' matches any single character. The 'plus' matches one or more characters of the previous expression. The pattern 'EXAMPLE\\(.+)' matches 'EXAMPLE\' followed by one or more of any character. In the replacement, '\1' refers to the string that the first subexpression matched. Assuming the Windows user 'EXAMPLE\user1', the replacement evaluates to 'user1'. If a mapping is required from Windows to UNIX and none of the name mapping entries match, the domain name is stripped from the the username and it is directly mapped to the UNIX user of the same name. Similarly if a mapping is required from a UNIX user to a Windows user and none of the name mapping entries match, the domain name is prefixed to the username and it is directly mapped to a Windows user of the same name. When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

> Name | Range | Type | Description
> direction |  | name-mapping-direction optional | Direction in which the name mapping is applied. Attributes: key, required-for-create, non-modifiable Possible values: "krb_unix" - Kerberos principal name to UNIX user name mapping, "win_unix" - Windows user name to UNIX user name mapping, "unix_win" - UNIX user name to Windows user name mapping
> pattern |  | string optional | Pattern to use to match the name while searching for a name that can be used as a replacement. The pattern is a UNIX-style regular expression. Regular expressions are case-insensitive when mapping from Windows to UNIX, and they are case-sensitive for mappings from Kerberos to UNIX and UNIX to Windows. Attributes: required-for-create, modifiable
> position | [1..1024] | integer optional | Position of an existing name mapping in the list of name mappings for this Vserver. Attributes: key, required-for-create, non-modifiable
> replacement |  | string optional | The name that is to be used as a replacement if the pattern associated with this entry matches. The replacement is a string containing escape sequences representing subexpressions from the pattern, as in the UNIX 'sed' program. Attributes: required-for-create, modifiable
> vserver |  | string optional | Specifies the Vserver for the name mapping. Attributes: key, non-creatable, non-modifiable

Element definition: unix-group-info | [top]

> UNIX group information When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

> Name | Range | Type | Description
> group-id | [0..2^32-1] | integer optional | Specifies an identification number for the UNIX group. Attributes: required-for-create, modifiable
> group-name |  | string optional | Specifies UNIX group name. Attributes: key, required-for-create, non-modifiable
> users |  | unix-user-name[] optional | Specifies the list of UNIX users that belong to the UNIX group.
> vserver |  | string optional | Specifies the Vserver for the group. Attributes: key, non-creatable, non-modifiable

Element definition: unix-user-info | [top]

> UNIX user information When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

> Name | Range | Type | Description
> full-name |  | string optional | Specifies the full name of the UNIX user. Attributes: optional-for-create, modifiable
> group-id | [0..2^32-1] | integer optional | Specifies the primary group identification number for the UNIX user. Attributes: required-for-create, modifiable
> user-id | [0..2^32-1] | integer optional | Specifies an identification number for the UNIX user. Attributes: required-for-create, modifiable
> user-name |  | string optional | Specifies user's UNIX account name. Attributes: key, required-for-create, non-modifiable
> vserver |  | string optional | Specifies the Vserver for the UNIX user. Attributes: key, non-creatable, non-modifiable

Element definition: name-mapping-direction | [top]

> Direction of the name mapping. Possible values: "krb_unix" - Kerberos principal name to UNIX user name mapping, "win_unix" - Windows user name to UNIX user name mapping, "unix_win" - UNIX user name to Windows user name mapping

> [none]

Element definition: unix-user-name | [top]

> Specifies user name information.

> Name | Range | Type | Description
> user-name |  | string optional | Specifies user's UNIX account name. Attributes: non-creatable, non-modifiable