|
|
The file ProfileAdmin.idl contains the following interface:
The ProfileAdmin module provides an interfaces that allows users to create, delete, get, and modify groups and profiles.
The Profile structure represents either a service, provision, or task profile.
profile_id—a string that uniquely identifies a profile
profile_type—the profile type; currently, SERVICE, PROVISION and TASK profiles are supported
content—the XML-encoded string
Each profile is uniquely identified by a profile_id. The content of each profile is an XML-encoded string. The profile type would determine the syntax of that XML string.
The ProfileHeader structure contains the header information of the Profile structure.
profile_id—a string that uniquely identifies a profile.
profile_type—the profile type; currently BAC supports SERVICE, PROVISION and TASK profiles.
This structure is essentially the same as Profile structure, but it does not contain the content attribute. It allows for fast retrieval of profile information.
The ProfileHeaderSeq structure represents a list of ProfileHeader structures.
Conceptually, profiles are organized into a hierarchy similar to the UNIX file system. At the top of the hierarchy (tree) is the root node (a conceptual group which contains all other groups and/or profiles). A group can contain either sub-groups and/or profiles. Profiles are leaf nodes. In the file system analogy, the profiles are files and groups are directories.
The full path of a group/profile delineates the actual path starting from the root that will lead to the group or profile under consideration. For example, if we have a group grp1 under root, and a subgroup grp11 under grp1 and a profile pf1 under grp11 then the full path of pf1 is "/grp1/grp11/pf1". Full path of root group is "/".
The ProfileMgr interface provides IDL operations which allow the manipulation of these profiles.
Associates a service profile (sourceProfilePath) to a list of provision profiles (assoc_profiles_path).
source_profile_id—profile path of the source
assoc_profiles_path—list of profile's paths to be associated with the source_profile_id
ResultInfo—result information structure which indicates the result of the call. If successful, the return code is CCNSC_OK; otherwise, the return code will be one of the error code defined in the spm_errors.idl file.
This API does not raise any exception.
Only service profile is allowed to associate with provision profiles. The operation is either success to associate all profiles or failure in which no partial association occurred. If an association already existed, the operation will ignore that, only new ones are added.
Creates a new group that can contain profiles or sub-groups.
group_path—full path name of the group
ResultInfo—result information structure which indicates the result of the call. If successful, the return code is CCNSC_OK; otherwise, the return code will be one of the error code defined in the spm_errors.idl file.
This API does not raise any exception.
ResultInfo—result information structure which indicates the result of the call. If successful, the return code is CCNSC_OK; otherwise, the return code will be one of the error code defined in the spm_errors.idl file.
This API does not raise any exception.
The input argument pf is a structure whose members are profile_id : full path of the new profile profile_type : Type of profile (service / provision etc.) content : xml coded profile content within a group, profile id is unique.
Deassociates a set of profiles assocProfilesPath from the sourceProfilePath.
source_profile_id—profile path to the source
assoc_profiles_path—list of profile's paths to be de-associated
ResultInfo—result information structure which indicates the result of the call. If successful, the return code is CCNSC_OK; otherwise, the return code will be one of the error code defined in the spm_errors.idl file.
This API does not raise any exception.
Note: this operation only removes the association relations between the source and the profiles in the assocProfilesPath, but it does not remove the profiles.
Deletes the group group_path (full path).
group_path—full path name of the group to be deleted
delete_children_flag— if true, then recursively deletes all chidlren; if false, then deletes the group only if it is empty
ResultInfo—result information structure which indicates the result of the call. If successful, the return code is CCNSC_OK; otherwise, the return code will be one of the error code defined in the spm_errors.idl file.
This API does not raise any exception.
If the argument delete_children_flag == TRUE, then delete the children of the group (for example the sub-groups and profiles under it) first and then delete the group it self. Else delete the group group_path only if it is a leaf nodefor example has no children.
This API first removes all association in which this profile is involved then deletes the profile identified by the full path profilePath argument.
profile_path—full path name of the profile
ResultInfo—result information structure which indicates the result of the call. If successful, the return code is CCNSC_OK; otherwise, the return code will be one of the error code defined in the spm_errors.idl file.
This API does not raise any exception.
Returns the set of profiles associated with the profile identified by the profilePath.
assoc_profiles_path—list of profile's paths associated with the profile
ResultInfo—result information structure which indicates the result of the call. If successful, the return code is CCNSC_OK; otherwise, the return code will be one of the error code defined in the spm_errors.idl file.
This API does not raise any exception.
If no associated profile is found, then the returned sequence will be empty.
Retrieves the content and profile type of the profile identified by the input argument profilePath (full path).
profile_id—a string that uniquely itendifies a profile
ResultInfo—result info structure which indicates the result of the call. If successful, the return code is CCNSC_OK; otherwise the return code will be one of the error code defined in the spm_errors.idl file.
This API does not raise any exception.
Lists all profile header information within a group identified by the full path group_path.
group_path—full path name of the group
profile_header_seq—list of profile headers returned
ResultInfo—result info structure which indicates the result of the call. If successful, the return code is CCNSC_OK; otherwise the return code will be one of the error code defined in the spm_errors.idl file.
This API does not raise any exception.
The out argument is a sequence of ProfileHeader structures. If no profile found, returned sequence will be empty.
Returns a list of subgroups (their full path names) under the specified parent group. descr Returns the full path list of (sub)groups under the
parent_group_path—full path name of the parent group
group_list—list of subgroups returned from the call
ResultInfo—result information structure which indicates the result of the call. If successful, the return code is CCNSC_OK; otherwise, the return code will be one of the error code defined in the spm_errors.idl file.
This API does not raise any exception.
parent group (group_path - is the full path of parent group). To get the top sub-groups, use "/" for parentGroupPath. If no sub-group is found, then the the returned sequence will be empty.
ResultInfo—result information structure which indicates the result of the call. If successful, the return code is CCNSC_OK; otherwise, the return code will be one of the error code defined in the spm_errors.idl file.
This API does not raise any exception.
The input argument pf is a structure whose members are profile_id : full path of the existing profile profile_type : Type of profile (service / provision etc.) content : xml coded profile content within a group, profile id is unique. Currently, only modification of profile content is allowed.
Posted: Wed May 21 08:23:38 PDT 2003
All contents are Copyright © 1992--2003 Cisco Systems, Inc. All rights reserved.
Important Notices and Privacy Statement.