Catalog.Kerberos.Principals

URI: http://soap.zeus.com/zxtm/1.0/Catalog/Kerberos/Principals/

The Catalog.Kerberos.Principal interface allows management of Kerberos Principals. Using this interface, you can create, delete and rename Kerberos principals, and manage their configuration.

Methods

addKDCs( principal_names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Add a host/port pair to the lists of KDCs, for each of the named principals

void addKDCs(

String[] principal_names

String[][] values

)

addKDCsByLocation( location, principal_names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Add a host/port pair to the lists of KDCs, for each of the named principals This is a location specific function, any action will operate on the specified location.

void addKDCsByLocation(

String location

String[] principal_names

String[][] values

)

addPrincipal( principal_names, principal_parameters ) throws InvalidObjectName, InvalidInput, ObjectAlreadyExists, DeploymentError, LicenseError

Add new Kerberos principals.

void addPrincipal(

String[] principal_names

Catalog.Kerberos.Principals.PrincipalParameter[] principal_parameters

)

copyPrincipal( principal_names, new_names ) throws ObjectAlreadyExists, InvalidObjectName, ObjectDoesNotExist, DeploymentError, LicenseError

Copy the named Kerberos principals.

void copyPrincipal(

String[] principal_names

String[] new_names

)

deletePrincipal( principal_names ) throws ObjectDoesNotExist, ObjectInUse, DeploymentError, LicenseError

Delete the named Kerberos principals.

void deletePrincipal(

String[] principal_names

)

getKDCs( principal_names ) throws ObjectDoesNotExist, LicenseError

Get the explicit list of Kerberos KDCs, for each of the named principals

String[][] getKDCs(

String[] principal_names

)

getKDCsByLocation( location, principal_names ) throws ObjectDoesNotExist, LicenseError

Get the explicit list of Kerberos KDCs, for each of the named principals This is a location specific function, any action will operate on the specified location.

String[][] getKDCsByLocation(

String location

String[] principal_names

)

getKRB5Conf( principal_names ) throws ObjectDoesNotExist, LicenseError

Get the name of the optional Kerberos configuration file

String[] getKRB5Conf(

String[] principal_names

)

getKRB5ConfByLocation( location, principal_names ) throws ObjectDoesNotExist, LicenseError

Get the name of the optional Kerberos configuration file This is a location specific function, any action will operate on the specified location.

String[] getKRB5ConfByLocation(

String location

String[] principal_names

)

getKeytab( principal_names ) throws ObjectDoesNotExist, LicenseError

Get the name of the associated Kerberos keytab file

String[] getKeytab(

String[] principal_names

)

getKeytabByLocation( location, principal_names ) throws ObjectDoesNotExist, LicenseError

Get the name of the associated Kerberos keytab file This is a location specific function, any action will operate on the specified location.

String[] getKeytabByLocation(

String location

String[] principal_names

)

getPrincipalNames()

Get the names of all the configured Kerberos principals.

String[] getPrincipalNames()

getRealm( principal_names ) throws ObjectDoesNotExist, LicenseError

Get the Kerberos realm

String[] getRealm(

String[] principal_names

)

getRealmByLocation( location, principal_names ) throws ObjectDoesNotExist, LicenseError

Get the Kerberos realm This is a location specific function, any action will operate on the specified location.

String[] getRealmByLocation(

String location

String[] principal_names

)

getService( principal_names ) throws ObjectDoesNotExist, LicenseError

Get the service name aspect of the Kerberos principal name the traffic manager should use to authenticate itself

String[] getService(

String[] principal_names

)

getServiceByLocation( location, principal_names ) throws ObjectDoesNotExist, LicenseError

Get the service name aspect of the Kerberos principal name the traffic manager should use to authenticate itself This is a location specific function, any action will operate on the specified location.

String[] getServiceByLocation(

String location

String[] principal_names

)

removeKDCs( principal_names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Remove a host/port pair from the lists of KDCs, for each of the named principals

void removeKDCs(

String[] principal_names

String[][] values

)

removeKDCsByLocation( location, principal_names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Remove a host/port pair from the lists of KDCs, for each of the named principals This is a location specific function, any action will operate on the specified location.

void removeKDCsByLocation(

String location

String[] principal_names

String[][] values

)

renamePrincipal( principal_names, new_names ) throws ObjectAlreadyExists, ObjectDoesNotExist, InvalidObjectName, InvalidOperation, DeploymentError, LicenseError

Rename the named Kerberos principals.

void renamePrincipal(

String[] principal_names

String[] new_names

)

setKDCs( principal_names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Set the explicit list of Kerberos KDCs, for each of the named principals

void setKDCs(

String[] principal_names

String[][] values

)

setKDCsByLocation( location, principal_names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Set the explicit list of Kerberos KDCs, for each of the named principals This is a location specific function, any action will operate on the specified location.

void setKDCsByLocation(

String location

String[] principal_names

String[][] values

)

setKRB5Conf( principal_names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Set the name of the optional Kerberos configuration file

void setKRB5Conf(

String[] principal_names

String[] values

)

setKRB5ConfByLocation( location, principal_names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Set the name of the optional Kerberos configuration file This is a location specific function, any action will operate on the specified location.

void setKRB5ConfByLocation(

String location

String[] principal_names

String[] values

)

setKeytab( principal_names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Set the name of the associated Kerberos keytab file

void setKeytab(

String[] principal_names

String[] values

)

setKeytabByLocation( location, principal_names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Set the name of the associated Kerberos keytab file This is a location specific function, any action will operate on the specified location.

void setKeytabByLocation(

String location

String[] principal_names

String[] values

)

setRealm( principal_names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Set the Kerberos realm

void setRealm(

String[] principal_names

String[] values

)

setRealmByLocation( location, principal_names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Set the Kerberos realm This is a location specific function, any action will operate on the specified location.

void setRealmByLocation(

String location

String[] principal_names

String[] values

)

setService( principal_names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Set the service name aspect of the Kerberos principal name the traffic manager should use to authenticate itself

void setService(

String[] principal_names

String[] values

)

setServiceByLocation( location, principal_names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Set the service name aspect of the Kerberos principal name the traffic manager should use to authenticate itself This is a location specific function, any action will operate on the specified location.

void setServiceByLocation(

String location

String[] principal_names

String[] values

)

Structures

Catalog.Kerberos.Principals.PrincipalParameter

This structure contains the required configuration values for a Kerberos principal.

struct Catalog.Kerberos.Principals.PrincipalParameter {

# The service name part of the Kerberos principal name the traffic manager

# should use to authenticate itself.

String service;

# The Kerberos realm where the principal belongs.

String realm;

# The name of the Kerberos keytab file containing suitable credentials to

# authenticate as the specified Kerberos principal.

String keytab;

}