NAME

rpcprofile  — A dcecp object that manages an RPC profile entry in CDS

SYNOPSIS

rpcprofile add profile_name_list member member_name_list  {interface interface_id | priority priority | annotation annotation | default  }

rpcprofile create profile_name_list

rpcprofile delete profile_name_list

rpcprofile help  [operation | verbose  ]

rpcprofile import profile_name_list interface interface_id  [object object_uuid]  [max integer]  [noupdate ]

rpcprofile list profile_name_list  [member member_name_list]  [noupdate ]

rpcprofile operations

rpcprofile remove profile_name_list  {default  | member member_name | interface interface_id | annotation annotation | priority priority }

rpcprofile show profile_name_list  {default  | member member_name | interface interface_id | version versions | priority priority | annotation annotation | noupdate  }

Arguments

operationThe name of the rpcprofile  operation for which to display help information. 

profile_name_list
Specifies a list of one or more names of the RPC profile entries to be operated on.

Description

The rpcprofile  object represents a remote procedure call (RPC) profile entry in the Cell Directory Service (CDS).  Each operation described below, except help  and operation, takes as an argument a list of one or more names of RPC profiles to be operate on.  An RPC profile consists of members (also known as elements in other DCE documentation). A member can be either RPC server entries, RPC groups, or other RPC profiles; therefore each member of a profile has a name in the DCE namespace.  Each profile can also have one default member (called the default profile element). 

A profile entry contains no attributes, but does contain information about each member that is not contained in the member itself.  The information stored for each member includes up to four fields of information consisting of interface and version, a member name, a priority (0 through 7), and an annotation.  For example:

{d46113d0-a848-11cb-b863-08001e046aa5 2.0}
 /.../my_cell.goodcompany.com/sec 0 rs_bind}

Various rpcprofile  operations have options that correspond to the fields of information contained in profile members.  Specifically, the options are interface , member , priority , and annotation . 

Data Structures

interface_id
The interface identifier of an RPC interface.  The interface identifier takes the following form:

interface-uuid,major-version.minor-version  

The version numbers are optional, but if you omit a version number, the value defaults to 0.  The UUID is a hexadecimal string and the version numbers are decimal strings.  For example:

-interface ec1eeb60-5943-11c9-a309-08002b102989,3.11  

Leading zeros in version numbers are ignored. 

Alternatively, you can use dcecp  string syntax in the following form:

{interface-UUID major-version.minor-version}

For example:

-interface {458ffcbe-98c1-11cd-bd93-0000c08adf56 1.0}  

object_uuid
The UUID of an object.  The UUID is a hexadecimal string, for example:

-object 3c6b8f60-5945-11c9-a236-08002b102989  

Alternatively, you can use dcecp  string syntax.  For example:

-object {3c6b8f60-5945-11c9-a236-08002b102989}  

host_address
An RPC string binding that describes a host’s location.  The binding information contains an RPC protocol and the host’s network address.  Any specific host’s network address can be obtained by using the getip  command. 

annotationAn informational text string that helps you to identify the purpose of the endpoint.  Use single or double quotation marks around the annotation field of endpoints to include internal spaces in an annotation, for example:

-annotation "Bulletin Board Server, Version 1.3a"  

Alternatively, you can use dcecp  string syntax.  For example:

-annotation {Bulletin Board Server, Version 1.3a}  

versionSpecifies which interface version numbers to return with a show operation.  Specify versions by using one of the following values for the version  option:

allThe interface version is ignored. 

exactBoth the major and minor versions must match the specified versions. 

compatible
The major version must match the specified version, and the minor version must be greater than or equal to the specified version.

major_only
The major version must match the specified version; the minor version is ignored.

uptoThe major version must be less than or equal to that specified.  If the major versions are equal, the minor version must be less than or equal to that specified. 

If the version  option is absent, the command shows compatible version numbers. 

Errors

A representative list of errors that might be returned is not shown here.  Refer to the OSF DCE Problem Determination Guide for complete descriptions of all error messages. 

Operations

rpcprofile add

Adds a member to the specified profile entry in CDS.  The syntax is as follows:

rpcprofile add profile_name_list member  member_name_list
 {interface  interface_id [priority  priority] [annotation  annotation] |
default }

Options

member  member_name_list
This required option declares the name of a member to be added to the specified profile entry.  The member_name_list argument is a list of names of one or more members to be added to all of the specified profiles. 

See Data Structures for the format of the interface identifier. 

interface  interface_id
Required when the default  option is not used, this option declares the interface identifier of an RPC interface.  The add operation operates on only one interface_id. 

priority  priority
Defines a search priority for the new profile element.  The priority value is in the range 0 to 7 with zero having the highest priority. By default, a nondefault element is assigned a priority value of zero.

annotation  annotation
Defines an annotation string for the profile element.  You can include internal spaces in an annotation by enclosing the string in quotation marks.

defaultPerforms the operation on the default profile member.  When you use the default  option, all of the other options except member  are illegal. 

The add operation adds a member to the specified profile entry in CDS.  The profile_name_list argument is a list of names of RPC profiles to have members added to.  The value of the required member  option is a list of names which are references to an RPC entry, RPC group, or RPC profile (that is, they do not have to actually exist). 

The operation accepts the interface , priority , and annotation  options with one value (not a list) each.  All members are added to each profile identified in the argument list.  It also accepts a default  option to indicate that the member being added is the default profile member.  (If you specify the default  option, the only other option that can be supplied is member .)  This operation returns an empty string on success.  If member_name_list contains the names of duplicate or existing members, the duplicates are ignored, and no errors are generated. 

Privileges Required

You need i (insert) permission to the parent directory.  You also need both r (read) permission and w (write) permission to the CDS object entry (the target profile entry). 

Examples

The following command adds an element to the cell profile, /.:/cell-profile, in the local cell:

dcecp> rpcprofile add /.:/cell-profile
> -member /.:/Calendar_profile   
> -interface ec1eeb60-5943-11c9-a309-08002b102989,1.1   
> -annotation RefersToCalendarGroups
dcecp>

The following commands set up a user profile associated with the cell profile as its default element and add a user-specific element for the Calendar V1.1 interface:

dcecp> rpcprofile add /.:/LandS/anthro/molly_o_profile -default /.:/cell-profile
dcecp>
 dcecp> rpcprofile add /.:/LandS/anthro/molly_o_profile
> -member {/.:/LandS/anthro/Calendar_group}
> -interface {ec1eeb60-5943-11c9-a309-08002b102989 1.1}
> -annotation {Calendar_Version 1.1_Interface}
dcecp>

The added profile element contains the global name of the member (specified by using its cell-relative name, /.:/LandS/anthro/Calendar_group) and the RPC interface identifier for the Calendar Version 1.1 interface. 

rpcprofile create

Creates a new profile entry in CDS.  The syntax is as follows:

rpcprofile create profile_name_list

The create  operation creates a new (empty) profile entry in CDS.  Since an empty profile is the same as an empty RPC entry or RPC group, calling rpcprofile create  is the same as calling rpcentry create  or rpcgroup create .  The profile_name_list argument is a list of names of RPC profiles to be created.  This operation returns an empty string on success.  If the RPC profile already exists, an error is returned. 

Privileges Required

You need i (insert) permission to the parent directory.  You also need both r (read) permission and w (write) permission to the CDS object entry (the target profile entry). 

Examples

dcecp> rpcprofile create /.:/users/wards_profile
dcecp>

rpcprofile delete

Deletes the specified profile from CDS.  The syntax is as follows:

rpcprofile delete profile_name_list

The delete  operation deletes the specified profile from CDS.  The profile_name_list argument is a list of names of RPC profiles to be deleted.  This operation returns an empty string on success.  If the RPC profile does not exist, an error is generated. 

Privileges Required

You need w (write) permission to the CDS object entry (the target profile entry). 

Examples

The following command deletes the profile named /.:/LandS/anthro/molly_o_profile:

dcecp> rpcprofile delete /.:/LandS/anthro/molly_o_profile
dcecp>

rpcprofile help

Returns help information about the rpcprofile  object and its operations.  The syntax is as follows:

rpcprofile help [operation | verbose ]

Options

verboseDisplays information about the rpcprofile  object. 

Used without an argument or option, the rpcprofile help  command returns brief information about each rpcprofile  operation.  The optional operation argument is the name of an operation about which you want detailed information.  Alternatively, you can use the verbose  option for more detailed information about the rpcprofile  object itself. 

Privileges Required

No special privileges are needed to use the rpcprofile help command. 

Examples

dcecp> rpcprofile help
add                 Adds members to a list of RPC profiles.
create              Creates a list of empty RPC profiles.
delete              Deletes a list of RPC profiles.
import              Returns the bindings from a list of RPC profiles.
list                Returns the names of members of a list of RPC profiles.
remove              Removes members from a list of RPC profiles.
show                Returns the attributes of a list of RPC profiles.
help                Prints a summary of command-line options.
operations          Returns a list of the valid operations for this command.
dcecp>

rpcprofile import

Returns a string binding from the specified RPC profile.  The syntax is as follows:

rpcprofile import profile_name_list interface  interface_id
 [object  object_uuid]  [max  integer] [noupdate ]

Options

interface  interface_id
Declares the interface identifier of an RPC interface.  The import  operation allows you to specify only one interface_id, not a list. 

See Data Structures for the format of the interface identifier. 

object  object_uuid_list
Declares the UUID of an object.  Each import  operation accepts a list of up to 32 object UUIDs.  The UUID is a hexadecimal string. 

max  integer
Specifies the maximum number of string bindings to return.  A value greater than 1 returns a list containing up to the number of bindings specified by the value.

noupdateNormally, name service data is cached locally on each machine in a cell.  If a name service inquiry can be satisfied by data in the local CDS cache, this cached data is returned.  However, locally cached copies of name service data might not include a recent CDS update.  If the noupdate  option is not specified, dcecp goes to a CDS server to retrieve the required data, updating the local CDS cache.  Use the noupdate option to avoid taking the time to update the local cache when you have reason to believe that the local cache is up to date. 

The import  operation returns a string binding from the specified RPC profile.  The profile_name_list argument is a list of names of RPC profiles to import from.  Use the interface  and object options to specify matching bindings.  Each of these options takes only one value, not a list of values.  The import  operation also accepts the max option to specify a number of string bindings to return.  If the value is greater than 1, a list of as many matching bindings less than or equal to the value is returned.  The order of bindings returned is arbitrary. 

Privileges Required

You need r (read) permission to the specified CDS object entry (the starting name service entry) and to any CDS object entry in the resulting search path. 

Examples

The following example imports a binding:

dcecp> rpcprofile import /.:/cell-profile
> -interface {458ffcbe-98c1-11cd-bd93-0000c08adf56 1.0}
{ncadg_ip_udp 15.22.48.25}
{ncadg_ip_udp 15.22.50.213}
{ncacn_ip_tcp 15.22.48.25}
{ncacn_ip_tcp 15.22.50.213}
dcecp> 

rpcprofile list

Returns a list of the names of all members of the specified profile.  The syntax is as follows:

rpcprofile list profile_name_list [member  member_name_list] [noupdate ]

Options

member  member_name_list
Declares the names of members of the specified profile entry.  The member_name_list argument is a list of names of one or more members to be listed. 

noupdateUse this option to avoid taking the time to update the local cache.  See rpcprofile import  for more information. 

The list  operation returns a list of the names of all members of the specified profile.  The names returned are fully qualified and are returned in an arbitrary order.  The profile_name_list argument is a list of names of RPC profiles whose members’ names are to be returned.  The members are concatenated on output into one list. 

Privileges Required

You need r (read) permission to the CDS object entry (the target profile entry). 

Examples

The following command lists entries in the cell profile /.:/cell-profile in the local cell:

dcecp> rpcprofile list /.:/cell-profile
/.../my_cell.goodcompany.com/sec
/.../my_cell.goodcompany.com/sec-v1
/.../my_cell.goodcompany.com/sec
/.../my_cell.goodcompany.com/sec
/.../my_cell.goodcompany.com/lan-profile
/.../my_cell.goodcompany.com/fs
/.../my_cell.goodcompany.com/subsys/dce/dfs/bak
dcecp>

rpcprofile operations

Returns a list of the operations supported by the rpcprofile object.  The syntax is as follows:

rpcprofile operations

The list of available operations is in alphabetical order except for help  and operations, which are listed last. 

Privileges Required

No special privileges are needed to use the rpcprofile operations command. 

Examples

dcecp> rpcprofile operations
add create delete import list remove show help operations
dcecp> 

rpcprofile remove

Removes one or more members from the specified profile.  The syntax is as follows:

rpcprofile remove profile_name_list
 {default  | member  member_name interface  interface_id |
annotation  annotation | priority  priority}

Options

defaultPerforms the remove operation on the default profile element.  When you use the default  option, all of the other options are illegal. 

member  member_name
Required when the default  option is not used, this option lets you specify the name a member to be removed from all profiles named in the profile_name_list argument.  The value of the member  option is a single name of an RPC entry, RPC group, or RPC profile; the name is only a reference stored in the RPC profile and need not exist outside of the profile.  The specified member is removed from all RPC profiles specified in the argument. 

interface  interface_id
Declares the interface identifier of an RPC interface.  The remove operation allows you to specify only one interface_id. 

annotation  annotation
Defines an annotation string for the profile element to be removed. You can include internal spaces in an annotation by enclosing the string in quotation marks (or by using other dcecp  quoting mechanisms). 

priority  priority
Defines a search priority for the profile element you want to see.  The priority value is in the range 0 to 7, with 0 having the highest priority.  By default, a nondefault element is assigned a priority value of 0.

See Data Structures for the format of the interface identifier. 

The remove operation removes one member from the specified profiles.  The profile_name_list argument is a list of names of RPC profiles from which the member is to be removed.  The member to be removed must match the values given in the following options: member , interface , and annotation .  These options are all single-valued; they are not lists.  The matching member is removed from all RPC profiles specified in the argument.   Also accepts a default  option, in which case the above options are illegal and the default profile member is removed.  This operation returns an empty string on success.  If the specified member does not exist in an RPC, profile an error is returned. 

Privileges Required

You need r (read) and w (write) permission to the CDS object entry (the target profile entry). 

Examples

The following example removes the member /.:/subsys/applications/infobases with interface {baf8c319-998f-11cd-ac7b-0000c08adf56 1.0} from the RPC profile entry /.:/users/admin_profile:

dcecp> rpcprofile remove /.:/users/admin_profile  
> -member /.:/subsys/applications/infobases  
> -interface {baf8c319-998f-11cd-ac7b-0000c08adf56 1.0}
dcecp>        

rpcprofile show

Returns a list of all members of one or more profiles.  The syntax is as follows:

rpcprofile show profile_name_list
 {default  | [member  member_name] [interface  interface_id]
 [version  versions] [priority  priority] [annotation  annotation] [noupdate ]}

Options

defaultPerforms the show  operation on the default profile element.  When you use the default  option, all of the other options are illegal. 

member  member_name
Specifies one member name for which to return profile information.

See Data Structures for the format of the interface identifier. 

interface  interface_id
Declares the interface identifier of an RPC interface.  The show  operation allows you to specify only one interface_id. 

version  versions
Specifies interface version numbers to be returned.  This option must be used with the interface  option. 

See Data Structures for the exact behavior of the version values. 

priority  priority
Defines a search priority for the profile element you want to see.  The priority value is in the range 0 to 7, with 0 having the highest priority.  By default, a nondefault element is assigned a priority value of 0.

annotation  annotation
Defines an annotation string for the profile element.  You can include internal spaces in an annotation by enclosing the string in quotation marks (or by using other dcecp  quoting mechanisms). 

noupdateUse this option to avoid taking the time to update the local cache.  See rpcprofile import  for more information. 

The show  operation returns a list of all members of one or more profiles.  The profile_name_list argument is a list of names of RPC profiles to have members of returned.  An attribute list is returned for each member with all of the entered information.  The list is in the following order: interface, member, priority, annotation.  If any of the items is not given, they are not included in the output, that is, no place holder is included. 

Only those members that match the values specified by the given options are returned. Each option may have only one value (that is, the value may not be a list).  Also accepts a default  option, in which case the above options are ignored and the default profile member is returned. 

Privileges Required

You need r (read) permission to the CDS object entry (the target profile entry). 

Examples

The following example uses no options to show all the members of a profile:

dcecp> rpcprofile show /.:/users/temp_profile
{{458ffcbe-98c1-11cd-bd93-0000c08adf56 1.0} /.../cell.co.com/subsys/appls/infobases 0}
{{00000000-0000-0000-0000-000000000000 0.0} /.../cell.co.com/cell-profile 0}
{{baf8c319-998f-11cd-ac7b-0000c08adf56 1.0} /.../cell.co.com/subsys/appls/infobases 0}
dcecp> 

The following example uses the interface  option to show a single member of a profile. 

dcecp> rpcprofile show /.:/users/temp_profile  
> -interface {baf8c319-998f-11cd-ac7b-0000c08adf56 1.0}
{{baf8c319-998f-11cd-ac7b-0000c08adf56 1.0} /.../cell.co.com/subsys/appls/infobases 0}

Related Information

Commands: endpoint(8dce), rpcentry(8dce), rpcgroup(8dce).