APIs in Category: group-mapping | Vserver API version 1.21

group-mapping-create group-mapping-delete group-mapping-get-iter group-mapping-insert group-mapping-modify group-mapping-swap | This is an auto generated category.

NetApp Manage ONTAP

group-mapping-create | [top]

> Create a new group mapping for a Vserver.

> Input Name | Range | Type | Description
> direction |  | name-mapping-direction | Direction in which the group 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 group while searching for a group 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 group mapping in the list of group mappings for this Vserver.
> replacement |  | string | The group 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 group-mapping on successful creation. Default: false
> Output Name | Range | Type | Description
> result |  | group-mapping-info optional | The group-mapping created (keys or the entire object if requested)

> Errno | Description
> EINTERNALERROR |  |

group-mapping-delete | [top]

> Delete an existing group mapping entry.

> Input Name | Range | Type | Description
> direction |  | name-mapping-direction | Direction in which the group 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 group mapping in the list of group mappings for this Vserver.

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

group-mapping-get-iter | [top]

> Retrieve the list of group mappings in the cluster.

> Input Name | Range | Type | Description
> desired-attributes |  | group-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 |  | group-mapping-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the group-mapping object. All group-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 |  | group-mapping-info[] optional | The list of attributes of group-mapping objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more group-mapping objects to return.
> num-records | [0..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

group-mapping-insert | [top]

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

> Input Name | Range | Type | Description
> direction |  | name-mapping-direction | Direction of the group 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 group 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 |  |

group-mapping-modify | [top]

> Modify an existing group mapping entry.

> Input Name | Range | Type | Description
> direction |  | name-mapping-direction | Direction in which the group 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 group while searching for a group 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 group mapping in the list of group mappings for this Vserver.
> replacement |  | string optional | The group 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 |  |

group-mapping-swap | [top]

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

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

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

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

> group mapping configuration for Vservers. The possible sources of group 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 groups, UNIX user groups and Kerberos principal groups can be three disjoint sets of groups. A mechanism is needed to map groups from one set to another when presenting ACLs across multiprotocol clients. Each group mapping entry represents one such map in a given direction. group 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 to1412 :double backslash (\\) in 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 group 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 group while searching for a group 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 group mapping in the list of group mappings for this Vserver. Attributes: key, required-for-create, non-modifiable
> replacement |  | string optional | The group 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 group mapping. 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]