HP Operations Manager for Windows

 

IOvPmdPolicyGroup Interface Reference

Policy Group interface. More...

import "pmad.idl";

Inheritance diagram for IOvPmdPolicyGroup:

IOvPmdPolicyGroup2 IOvPmdPolicyGroup80 List of all members.

Public Member Functions
HRESULT  GetId ([out, retval]BSTR *psGroupID)
HRESULT  GetName ([out, retval]BSTR *psName)
HRESULT  GetPolicyList ([out, retval] SAFEARRAY(IDispatch *)*ppPolicies)
HRESULT  GetParentGroup ([out, retval]IOvPmdPolicyGroup **ppParent)
HRESULT  GetChildGroupList ([out, retval]SAFEARRAY(IDispatch *)*ppGroups)
HRESULT  GetChildGroup ([in]BSTR sGroupName,[out, retval]IOvPmdPolicyGroup **ppChildGroup)
HRESULT  ExportToFile ([in]BSTR sPathName,[in]VARIANT_BOOL bRecursive)
HRESULT  AddPolicyToGroup ([in]IOvPmdLogicalPolicy *pPolicy)
HRESULT  AddChildGroup ([in]BSTR sGroupName,[out, retval]IOvPmdPolicyGroup **ppGroup)
HRESULT  AddChildGroupById ([in]BSTR sNewGroupId,[in]BSTR sGroupName,[out, retval]IOvPmdPolicyGroup **ppGroup)
HRESULT  Rename ([in]BSTR sName)
HRESULT  Copy ([in] IOvPmdPolicyGroup *pParent,[in]BSTR sNewName,[out, retval] IOvPmdPolicyGroup **ppGroup)
HRESULT  Move ([in]IOvPmdPolicyGroup *pNewParent)
HRESULT  Remove ()
HRESULT  RemovePolicyFromGroup ([in]IOvPmdLogicalPolicy *pPolicy)
HRESULT  DeployOnNodes ([in]VARIANT vNodeIDs,[in]VARIANT_BOOL bCheckVersion,[in]VARIANT_BOOL bEnable)
HRESULT  DeployOnNodeGroup ([in]BSTR sNodeGroup,[in]VARIANT_BOOL bCheckVersion,[in]VARIANT_BOOL bEnable)

Detailed Description

The interface IOvPmdPolicyGroup represents a policy groups.
Since:
6.x

Member Function Documentation

HRESULT IOvPmdPolicyGroup::AddChildGroup (  [in] BSTR  sGroupName,
[out, retval] IOvPmdPolicyGroup **  ppGroup
) 
 
Semantics:
Creates a new group with the specified name and this policy group as parent. A new GUID is created by PMAD. The group name must be unique. Otherwise, the method returns S_FALSE.
Parameters:
sGroupName  - Name of the group to be added. If the group already exists, an interface to this group is returned. The maximal length of the group name is 64 characters.
ppGroup  - Interface pointer to the policy group which was added.
Possible errors:
Database communication errors
Since:
6.x
HRESULT IOvPmdPolicyGroup::AddChildGroupById (  [in] BSTR  sNewGroupId,
[in] BSTR  sGroupName,
[out, retval] IOvPmdPolicyGroup **  ppGroup
) 
 
Semantics:
Creates a new group with the specified name, ID, and this group as parent. The operation fails if there is already a group with the same name but different ID. The group name must be unique. Otherwise, the method returns S_FALSE.
Parameters:
sNewGroupId  - ID (GUID as a string without brackets) of the new group. The length must be 36 characters.
sGroupName  - Name of the policy group to be added. The maximal length is 64 characters.
ppGroup  - Interface pointer to the policy group that was added. Can be NULL if operation has failed.
Possible errors:
Group with same name and parent, but different ID, already exists
Database communication errors
Since:
6.x
HRESULT IOvPmdPolicyGroup::AddPolicyToGroup (  [in] IOvPmdLogicalPolicy *  pPolicy  ) 
 
Semantics:
Adds a policy to the group. If another policy with the same logical ID is already in this group, it is replaced.
Parameters:
pPolicy  - Interface pointer to the policy version to be added.
Possible errors:
Database communication errors
Since:
6.x
HRESULT IOvPmdPolicyGroup::Copy (  [in] IOvPmdPolicyGroup *  pParent,
[in] BSTR  sNewName,
[out, retval] IOvPmdPolicyGroup **  ppGroup
) 
 
Semantics:
Copies the group to another parent, and changes its name to the specified new name. If a group with the specified name already exists, an error is returned.
Parameters:
pParent  - Interface pointer to the parent group of the new group. Can be NULL if the new group should become a top-level group. If the new group name already exists, the method returns S_FALSE.
sNewName  - Name of the new group. The maximal length is 64 characters.
ppGroup  - Interface pointer to the new group.
Possible errors:
Parent of the new group is a child or equal to this instance
Group with the specified name already exists as a child of the new parent
Database communication errors
Since:
6.x
HRESULT IOvPmdPolicyGroup::ExportToFile (  [in] BSTR  sPathName,
[in] VARIANT_BOOL  bRecursive
) 
 
Semantics:
Exports all policies that are part of this group and, if the recursive flag is set to VARIANT_TRUE, its child groups to external files in the specified directory. In addition, a configuration file ("config.mm") is exported. It can be used to upload the policy group with all its child groups inclusive all assigned policy versions on another or the same server.
Parameters:
sPathName  - Name of the directory where the exported files should be created.
bRecursive  - If TRUE, child groups is exported as well.
Possible errors:
See IOvPmdLogicalPolicy::ExportToFile(...) for possible errors
Database communication errors
Since:
6.x
HRESULT IOvPmdPolicyGroup::GetChildGroup (  [in] BSTR  sGroupName,
[out, retval] IOvPmdPolicyGroup **  ppChildGroup
) 
 
Semantics:
Returns the child group with the specific name.
Parameters:
sGroupName  - Name of the child group.
ppChildGroup  - Interface pointer to the policy group with the given name. Can be NULL, if it does not exist.
Possible errors:
Database communication errors
Since:
6.x
HRESULT IOvPmdPolicyGroup::GetChildGroupList (  [out, retval] SAFEARRAY(IDispatch *)*  ppGroups  ) 
 
Semantics:
Return an array of all policy groups that have this group as parent group.
Parameters:
ppGroups  - SAFEARRAY of IDispatch interface pointers to the policy groups. Use the method "IOvPmdPolicyManager::CVar(...)" to access the elements of the array within a VB script.
Possible errors:
Database communication errors
Since:
6.x
HRESULT IOvPmdPolicyGroup::GetId (  [out, retval] BSTR *  psGroupID  ) 
 
Semantics:
Returns the ID (GUID as a string without brackets) of this policy group.
Parameters:
psGroupID  - ID of the policy group.
Possible errors:
Since:
6.x
HRESULT IOvPmdPolicyGroup::GetName (  [out, retval] BSTR *  psName  ) 
 
Semantics:
Returns the name for this policy group. This name does not include the names of the parent groups.
Parameters:
psName  - Name of the policy group.
Possible errors:
Since:
6.x
HRESULT IOvPmdPolicyGroup::GetParentGroup (  [out, retval] IOvPmdPolicyGroup **  ppParent  ) 
 
Semantics:
Returns the parent of this group. The return value may be NULL if this group has no parent group (top-level group).
Parameters:
ppParent  - Interface pointer to the parent policy group. Can be NULL.
Possible errors:
Database communication errors
Since:
6.x
HRESULT IOvPmdPolicyGroup::GetPolicyList (  [out, retval] SAFEARRAY(IDispatch *)*  ppPolicies  ) 
 
Semantics:
Returns the list of policies that are part of this policy group. It does not include the policies that are part of subgroups.
Parameters:
ppPolicies  - SAFEARRAY of IDispatch interface pointers to the policy versions. Use the method "IOvPmdPolicyManager::CVar(...)" to access the elements of the array within a VB script.
Possible errors:
Database communication errors
Since:
6.x
HRESULT IOvPmdPolicyGroup::Move (  [in] IOvPmdPolicyGroup *  pNewParent  ) 
 
Semantics:
Moves this group to a new parent. If a group with the specified name already exists, an error is returned.
Parameters:
pNewParent  - IOvPmdPolicyGroup interface pointer to the new parent group.
Possible errors:
New parent group is a child or equal to this instance
Group with the specified name already exists as a child of the new parent
Database communication errors
Since:
6.x
HRESULT IOvPmdPolicyGroup::Remove (   ) 
 
Semantics:
Removes the group and all its child groups. Policies that are part of these groups are not removed from the system. Only their policy group assignment is deleted.
Possible errors:
Database communication errors
Since:
6.x
HRESULT IOvPmdPolicyGroup::RemovePolicyFromGroup (  [in] IOvPmdLogicalPolicy *  pPolicy  ) 
 
Semantics:
Removes the reference of the specified policy from the group. If the policy is not a member of the group, nothing happens.
Parameters:
pPolicy  - Policy version that should be removed from the group.
Possible errors:
Database communication errors
Since:
6.x
HRESULT IOvPmdPolicyGroup::Rename (  [in] BSTR  sName  ) 
 
Semantics:
Changes the name of the group. The group name must be unique. Otherwise, the method returns S_FALSE.
Parameters:
sName  - New name of the group. The maximal length is 64 characters.
Possible errors:
Group with the specified name already exists
Database communication errors
Since:
6.x