APIs in Category: gpo | Vserver API version 1.20

gpo-applied-info-get-iter gpo-get-iter gpo-gpresult-info-get-iter gpo-modify gpo-update | Group Policy Object (GPO) configuration APIs. Group Policy is a central component of Microsoft's change and configuration strategy for Win2K. With Group Policy, you can define users' environments and system configurations from one location. It is implemented by associating a Group Policy Object (GPO) with an Active Directory container. A GPO is a collection of attribute settings that govern a user or a computer's configuration. These APIs enable user to obtain the values associated with the following GPO entities: 1. Vserver GPO gpresult Information: The resultant GPO information. This api displays RSoP(Resultant Set of Policy) that is defined on Active Directory for a CIFS-enabled VServer. 2. Vserver Applied GPO Information: The applied GPO Information. This api displays the set of GPO policy that has been applied on a CIFS-enabled Vserver.

NetApp Manage ONTAP

gpo-applied-info-get-iter | [top]

> Get the list of entries of the applied GPO rules, organized on a per-Vserver basis.

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

> Errno | Description
> EINTERNALERROR |  |

gpo-get-iter | [top]

> Retrieve the Vserver's group policy configuration.

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

> Errno | Description
> EINTERNALERROR |  |

gpo-gpresult-info-get-iter | [top]

> Get a list of entries of the GPO RSoP(Resultant Set of Policy) data, organized on a per-Vserver basis.

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

> Errno | Description
> EINTERNALERROR |  |

gpo-modify | [top]

> Change the Vserver's group policy configuration.

> Input Name | Range | Type | Description
> is-gpo-enabled |  | boolean optional | Group Policy Zapi Status.

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

gpo-update | [top]

> Download and apply the latest version of the group policy defined in Active Directory.

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

Element definition: gpo-applied-info | [top]

> GPO information that is currently applied on a CIFS-enabled Vserver. 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
> dspath |  | string optional | LDAP DN path. Attributes: non-creatable, non-modifiable
> extension |  | string[] optional | List of the GPO extensions. Attributes: non-creatable, non-modifiable Possible values: "registry" - Registry Setting, "diskquota" - Disk Quota, "scripts" - Scripts, "security" - Security, "efsrecovery" - EFS Recovery, "ipsecurity" - IP Security, "unsupport" - Unsupported Feature
> filesyspath |  | string optional | File System Path of a GPO policy file. Attributes: non-creatable, non-modifiable
> gpo-index | [0..2^32-1] | integer optional | The index of the GPO in the GPO list of a Vserver. Attributes: key, non-creatable, non-modifiable
> gpo-name |  | string optional | GPO name in text format. Attributes: non-creatable, non-modifiable
> gpo-status |  | string optional | GPO status for each listed GPO: enabled or disabled. Attributes: non-creatable, non-modifiable
> gpo-uuid |  | string optional | GPO name in UUID format. Attributes: non-creatable, non-modifiable
> link |  | string optional | Type of the GPO. Attributes: non-creatable, non-modifiable Possible values: "local" - Local, "site" - Site, "domain" - Domain, "organizationalunit" - Organizational Unit
> registry-hash-publication |  | hash-publication-mode optional | Hash Publication for BranchCache. Attributes: non-creatable, non-modifiable Possible values: "per_share" - Allow hash publication only for shared folders on which BranchCache is enabled., "disabled" - Disallow hash publication on all shared folders., "all_shares" - Allow hash publication for all shared folder.
> registry-hash-version |  | hash-version-type optional | Hash Version Support for BranchCache. Attributes: non-creatable, non-modifiable Possible values: "all_versions" - Version 1 and 2 (V1 and V2)., "version1" - Version 1 (V1)., "version2" - Version 2 (V2).
> registry-refresh-interval | [0..2^32-1] | integer optional | Registry refreshint time interval. Attributes: non-creatable, non-modifiable
> registry-refresh-random-offset | [0..2^32-1] | integer optional | Registry refreshing time random offset. Attributes: non-creatable, non-modifiable
> security-kerberos-clock-skew | [0..2^32-1] | integer optional | Kerberos maximum clock skew; Maximum tolerance for computer clock synchronization. Attributes: non-creatable, non-modifiable
> security-kerberos-renewal-age | [0..2^32-1] | integer optional | Kerberos maximum lifetime for user ticket renewal. Attributes: non-creatable, non-modifiable
> security-kerberos-ticket-age | [0..2^32-1] | integer optional | Kerberos maximum lifetime for user ticket. Attributes: non-creatable, non-modifiable
> security-privilege-take-ownership |  | string optional | Privilege rights: Take Ownership. Attributes: non-creatable, non-modifiable
> version | [0..2^32-1] | integer optional | The individual GPO's update version. Attributes: non-creatable, non-modifiable
> vserver |  | string optional | Vserver display name. Attributes: key, non-creatable, non-modifiable

Element definition: gpo-config | [top]

> Group Policy configuration for Vservers. 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
> is-gpo-enabled |  | boolean optional | Group Policy Zapi Status. Attributes: non-creatable, modifiable
> vserver |  | vserver-name optional | The name of the Vserver associated with this group-policy. Attributes: key, non-creatable, non-modifiable

Element definition: gpo-gpresult-info | [top]

> GPO RSoP(Resultant Set of Policy) that is currently defined on the Active Directory for a CIFS-enabled Vserver. 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
> dspath |  | string optional | LDAP DN path. Attributes: non-creatable, non-modifiable
> extension |  | string[] optional | List of the GPO extensions. Attributes: non-creatable, non-modifiable Possible values: "registry" - Registry Setting, "diskquota" - Disk Quota, "scripts" - Scripts, "security" - Security, "efsrecovery" - EFS Recovery, "ipsecurity" - IP Security, "unsupport" - Unsupported Feature
> filesyspath |  | string optional | File System Path of a GPO policy file. Attributes: non-creatable, non-modifiable
> gpo-index | [0..2^32-1] | integer optional | The index of the GPO in the GPO list of a Vserver. Attributes: key, non-creatable, non-modifiable
> gpo-name |  | string optional | GPO name in text format. Attributes: non-creatable, non-modifiable
> gpo-status |  | string optional | GPO status for each listed GPO: enabled or disabled. Attributes: non-creatable, non-modifiable
> gpo-uuid |  | string optional | GPO name in UUID format. Attributes: non-creatable, non-modifiable
> link |  | string optional | Type of the GPO. Attributes: non-creatable, non-modifiable Possible values: "local" - Local, "site" - Site, "domain" - Domain, "organizationalunit" - Organizational Unit
> registry-hash-publication |  | hash-publication-mode optional | Hash Publication for BranchCache. Attributes: non-creatable, non-modifiable Possible values: "per_share" - Allow hash publication only for shared folders on which BranchCache is enabled., "disabled" - Disallow hash publication on all shared folders., "all_shares" - Allow hash publication for all shared folder.
> registry-hash-version |  | hash-version-type optional | Hash Version Support for BranchCache. Attributes: non-creatable, non-modifiable Possible values: "all_versions" - Version 1 and 2 (V1 and V2)., "version1" - Version 1 (V1)., "version2" - Version 2 (V2).
> registry-refresh-interval | [0..2^32-1] | integer optional | Registry refreshint time interval. Attributes: non-creatable, non-modifiable
> registry-refresh-random-offset | [0..2^32-1] | integer optional | Registry refreshing time random offset. Attributes: non-creatable, non-modifiable
> security-kerberos-clock-skew | [0..2^32-1] | integer optional | Kerberos maximum clock skew; Maximum tolerance for computer clock synchronization. Attributes: non-creatable, non-modifiable
> security-kerberos-renewal-age | [0..2^32-1] | integer optional | Kerberos maximum lifetime for user ticket renewal. Attributes: non-creatable, non-modifiable
> security-kerberos-ticket-age | [0..2^32-1] | integer optional | Kerberos maximum lifetime for user ticket. Attributes: non-creatable, non-modifiable
> security-privilege-take-ownership |  | string optional | Privilege rights: Take Ownership. Attributes: non-creatable, non-modifiable
> version | [0..2^32-1] | integer optional | The individual GPO's update version. Attributes: non-creatable, non-modifiable
> vserver |  | string optional | Vserver display name. Attributes: key, non-creatable, non-modifiable

Element definition: hash-publication-mode | [top]

> Hash Support Possible values: "per_share" - Allow hash publication only for shared folders on which BranchCache is enabled., "disabled" - Disallow hash publication on all shared folders., "all_shares" - Allow hash publication for all shared folder.

> [none]

Element definition: hash-version-type | [top]

> Hash Version Possible values: "all_versions" - Version 1 and 2 (V1 and V2)., "version1" - Version 1 (V1)., "version2" - Version 2 (V2).

> [none]

Element definition: vserver-name | [top]

> The name of the Vserver.

> [none]