Last active
August 29, 2015 14:20
-
-
Save lancearlaus/3676624f0314b94e0f97 to your computer and use it in GitHub Desktop.
OpenAM ssoadm commands meta-data extraction
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
@GrabResolver(name='maven.forgerock.org-releases', root='http://maven.forgerock.org/repo/releases') | |
@GrabResolver(name='maven.forgerock.org-dependencies', root='http://maven.forgerock.org/repo/openam-dependencies') | |
@Grapes([ | |
@Grab(group='org.yaml', module='snakeyaml', version='1.15'), | |
@Grab('org.forgerock.openam:openam-cli-definitions:11.0.0'), | |
//@Grab('org.forgerock.openam:openam-cli-impl:11.0.0'), // Uncomment to gain access to implementation class (implClassName) | |
]) | |
import org.yaml.snakeyaml.Yaml | |
import com.sun.identity.cli.annotation.SubCommandInfo | |
import com.sun.identity.cli.definition.AccessManager | |
// Note: The following list of classes comes from the ssoadm command line definitionFiles property | |
definitionClassNames = [ | |
"com.sun.identity.cli.definition.AccessManager", | |
"com.sun.identity.federation.cli.definition.FederationManager", | |
] | |
definitionClasses = definitionClassNames.collect { Class.forName(it) } | |
optionTypeMap = [ | |
"s": "string", | |
"m": "list", | |
"u": "flag" | |
] | |
def parseOption(option, required) { | |
def parts = option.tokenize("|") | |
assert optionTypeMap.containsKey(parts[2]), "unknown option type code ${parts[2]}" | |
[ required: required, long: parts[0], short: parts[1], type: optionTypeMap[parts[2]], description: parts[3] ] | |
} | |
def parseOptions(annotation) { | |
def parsed = [] | |
parsed += annotation.mandatoryOptions().collect { parseOption(it, true) } | |
parsed += annotation.optionalOptions().collect { parseOption(it, false) } | |
def result = [:] | |
parsed.each { result[it.long] = it } | |
result | |
} | |
def parseSubCommandInfo(annotation) { | |
def parsed = [ description: annotation.description() ] | |
if (annotation.mandatoryOptions() || annotation.optionalOptions()) parsed['options'] = parseOptions(annotation) | |
parsed | |
} | |
commands = definitionClasses.collect { | |
it.declaredFields.findAll { | |
it.isAnnotationPresent(SubCommandInfo.class) | |
}.collectEntries { | |
[ it.name, parseSubCommandInfo(it.getAnnotation(SubCommandInfo.class)) ] | |
} | |
} | |
println new Yaml().dump(commands) | |
count = commands.inject(0) { c, m -> c += m.size() } | |
System.err << "Successfully dumped $count commands" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- do_batch: | |
description: Do multiple requests in one command. | |
options: | |
batchfile: {required: true, long: batchfile, short: Z, type: string, description: Name of file that contains commands and options.} | |
batchstatus: {required: false, long: batchstatus, short: b, type: string, description: Name of status file.} | |
continue: {required: false, long: continue, short: c, type: flag, description: Continue processing the rest of the request when preceeding request was erroneous.} | |
list_sessions: | |
description: List Sessions. | |
options: | |
host: {required: true, long: host, short: t, type: string, description: Host Name.} | |
filter: {required: false, long: filter, short: x, type: string, description: Filter (Pattern).} | |
quiet: {required: false, long: quiet, short: q, type: flag, description: Do not prompt for session invalidation.} | |
add_res_bundle: | |
description: Add resource bundle to data store. | |
options: | |
bundlename: {required: true, long: bundlename, short: b, type: string, description: Resource Bundle Name.} | |
bundlefilename: {required: true, long: bundlefilename, short: B, type: string, | |
description: Resource bundle physical file name.} | |
bundlelocale: {required: false, long: bundlelocale, short: o, type: string, | |
description: Locale of the resource bundle.} | |
list_res_bundle: | |
description: List resource bundle in data store. | |
options: | |
bundlename: {required: true, long: bundlename, short: b, type: string, description: Resource Bundle Name.} | |
bundlelocale: {required: false, long: bundlelocale, short: o, type: string, | |
description: Locale of the resource bundle.} | |
remove_res_bundle: | |
description: Remove resource bundle from data store. | |
options: | |
bundlename: {required: true, long: bundlename, short: b, type: string, description: Resource Bundle Name.} | |
bundlelocale: {required: false, long: bundlelocale, short: o, type: string, | |
description: Locale of the resource bundle.} | |
create_svc: | |
description: Create a new service in server. | |
options: | |
xmlfile: {required: true, long: xmlfile, short: X, type: list, description: XML file(s) that contains schema.} | |
continue: {required: false, long: continue, short: c, type: flag, description: Continue adding service if one or more previous service cannot be added.} | |
delete_svc: | |
description: Delete service from the server. | |
options: | |
servicename: {required: true, long: servicename, short: s, type: list, description: Service Name(s).} | |
continue: {required: false, long: continue, short: c, type: flag, description: Continue deleting service if one or more previous services cannot be deleted.} | |
deletepolicyrule: {required: false, long: deletepolicyrule, short: r, type: flag, | |
description: Delete policy rule.} | |
update_svc: | |
description: Update service. | |
options: | |
xmlfile: {required: true, long: xmlfile, short: X, type: list, description: XML file(s) that contains schema.} | |
continue: {required: false, long: continue, short: c, type: flag, description: Continue updating service if one or more previous services cannot be updated.} | |
add_attrs: | |
description: Add attribute schema to an existing service. | |
options: | |
servicename: {required: true, long: servicename, short: s, type: string, description: Service Name.} | |
schematype: {required: true, long: schematype, short: t, type: string, description: Schema Type.} | |
attributeschemafile: {required: true, long: attributeschemafile, short: F, type: list, | |
description: XML file containing attribute schema definition.} | |
subschemaname: {required: false, long: subschemaname, short: c, type: string, | |
description: Name of sub schema.} | |
do_migration70: | |
description: Migrate organization to realm. | |
options: | |
entrydn: {required: true, long: entrydn, short: e, type: string, description: Distinguished name of organization to be migrated.} | |
create_realm: | |
description: Create realm. | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm to be created.} | |
delete_realm: | |
description: Delete realm. | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm to be deleted.} | |
recursive: {required: false, long: recursive, short: r, type: flag, description: Delete descendent realms recursively.} | |
list_realms: | |
description: List realms by name. | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm where search begins.} | |
filter: {required: false, long: filter, short: x, type: string, description: Filter (Pattern).} | |
recursive: {required: false, long: recursive, short: r, type: flag, description: Search recursively} | |
add_svc_realm: | |
description: Add service to a realm. | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
servicename: {required: true, long: servicename, short: s, type: string, description: Service Name.} | |
attributevalues: {required: false, long: attributevalues, short: a, type: list, | |
description: Attribute values e.g. homeaddress=here.} | |
datafile: {required: false, long: datafile, short: D, type: string, description: Name of file that contains attribute values data.} | |
show_realm_svcs: | |
description: Show services in a realm. | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
mandatory: {required: false, long: mandatory, short: y, type: flag, description: Include Mandatory services.} | |
list_realm_assignable_svcs: | |
description: List the assignable services to a realm. | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
remove_svc_realm: | |
description: Remove service from a realm. | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
servicename: {required: true, long: servicename, short: s, type: string, description: Name of service to be removed.} | |
get_realm: | |
description: Get realm property values. | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
servicename: {required: true, long: servicename, short: s, type: string, description: Name of service.} | |
get_realm_svc_attrs: | |
description: Get realm's service attribute values. | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
servicename: {required: true, long: servicename, short: s, type: string, description: Name of service.} | |
delete_realm_attr: | |
description: Delete attribute from a realm. | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
servicename: {required: true, long: servicename, short: s, type: string, description: Name of service.} | |
attributename: {required: true, long: attributename, short: a, type: string, | |
description: Name of attribute to be removed.} | |
set_svc_attrs: | |
description: Set service attribute values in a realm. | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
servicename: {required: true, long: servicename, short: s, type: string, description: Name of service.} | |
attributevalues: {required: false, long: attributevalues, short: a, type: list, | |
description: Attribute values e.g. homeaddress=here.} | |
datafile: {required: false, long: datafile, short: D, type: string, description: Name of file that contains attribute values data.} | |
remove_svc_attrs: | |
description: Remove service attribute values in a realm. | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
servicename: {required: true, long: servicename, short: s, type: string, description: Name of service.} | |
attributevalues: {required: false, long: attributevalues, short: a, type: list, | |
description: Attribute values to be removed e.g. homeaddress=here.} | |
datafile: {required: false, long: datafile, short: D, type: string, description: Name of file that contains attribute values to be removed.} | |
add_svc_attrs: | |
description: Add service attribute values in a realm. | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
servicename: {required: true, long: servicename, short: s, type: string, description: Name of service.} | |
attributevalues: {required: false, long: attributevalues, short: a, type: list, | |
description: Attribute values to be added e.g. homeaddress=here.} | |
datafile: {required: false, long: datafile, short: D, type: string, description: Name of file that contains attribute values to be added.} | |
set_realm_svc_attrs: | |
description: Set attribute values of a service that is assigned to a realm. | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
servicename: {required: true, long: servicename, short: s, type: string, description: Name of service.} | |
append: {required: false, long: append, short: p, type: flag, description: Set this flag to append the values to existing ones.} | |
attributevalues: {required: false, long: attributevalues, short: a, type: list, | |
description: Attribute values e.g. homeaddress=here.} | |
datafile: {required: false, long: datafile, short: D, type: string, description: Name of file that contains attribute values data.} | |
set_realm_attrs: | |
description: Set attribute values of a realm. | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
servicename: {required: true, long: servicename, short: s, type: string, description: Name of service.} | |
append: {required: false, long: append, short: p, type: flag, description: Set this flag to append the values to existing ones.} | |
attributevalues: {required: false, long: attributevalues, short: a, type: list, | |
description: Attribute values e.g. homeaddress=here.} | |
datafile: {required: false, long: datafile, short: D, type: string, description: Name of file that contains attribute values data.} | |
create_policies: | |
description: Create policies in a realm. | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
xmlfile: {required: true, long: xmlfile, short: X, type: string, description: Name of file that contains policy XML definition.} | |
delete_policies: | |
description: Delete policies from a realm. | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
policynames: {required: false, long: policynames, short: p, type: list, description: Names of policy to be deleted.} | |
file: {required: false, long: file, short: D, type: string, description: Name of file that contains the policy names to be deleted.} | |
update_policies: | |
description: Update policies in a realm. | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
xmlfile: {required: true, long: xmlfile, short: X, type: string, description: Name of file that contains policy XML definition.} | |
list_policies: | |
description: List policy definitions in a realm. | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
policynames: {required: false, long: policynames, short: p, type: list, description: Names of policy. This can be an wildcard. All policy definition in the realm will be returned if this option is not provided.} | |
outfile: {required: false, long: outfile, short: o, type: string, description: Filename where policy definition will be printed to. Definition will be printed in standard output if this option is not provided.} | |
namesonly: {required: false, long: namesonly, short: n, type: flag, description: Returns only names of matching policies. Policies are not returned.} | |
remove_attr_defs: | |
description: Remove default attribute values in schema. | |
options: | |
servicename: {required: true, long: servicename, short: s, type: string, description: Name of service.} | |
schematype: {required: true, long: schematype, short: t, type: string, description: Type of schema.} | |
attributenames: {required: true, long: attributenames, short: a, type: list, | |
description: Attribute name(s).} | |
subschemaname: {required: false, long: subschemaname, short: c, type: string, | |
description: Name of sub schema.} | |
add_attr_defs: | |
description: Add default attribute values in schema. | |
options: | |
servicename: {required: true, long: servicename, short: s, type: string, description: Name of service.} | |
schematype: {required: true, long: schematype, short: t, type: string, description: Type of schema.} | |
attributevalues: {required: false, long: attributevalues, short: a, type: list, | |
description: Attribute values e.g. homeaddress=here.} | |
datafile: {required: false, long: datafile, short: D, type: string, description: Name of file that contains attribute values data.} | |
subschemaname: {required: false, long: subschemaname, short: c, type: string, | |
description: Name of sub schema.} | |
get_attr_defs: | |
description: Get default attribute values in schema. | |
options: | |
servicename: {required: true, long: servicename, short: s, type: string, description: Name of service.} | |
schematype: {required: true, long: schematype, short: t, type: string, description: 'Type | |
of schema. One of dynamic, global, or organization (meaning realm).'} | |
subschemaname: {required: false, long: subschemaname, short: c, type: string, | |
description: Name of sub schema.} | |
attributenames: {required: false, long: attributenames, short: a, type: list, | |
description: Attribute name(s).} | |
set_attr_defs: | |
description: Set default attribute values in schema. | |
options: | |
servicename: {required: true, long: servicename, short: s, type: string, description: Name of service.} | |
schematype: {required: true, long: schematype, short: t, type: string, description: Type of schema.} | |
subschemaname: {required: false, long: subschemaname, short: c, type: string, | |
description: Name of sub schema.} | |
attributevalues: {required: false, long: attributevalues, short: a, type: list, | |
description: Attribute values e.g. homeaddress=here.} | |
datafile: {required: false, long: datafile, short: D, type: string, description: Name of file that contains attribute values data.} | |
get_attr_choicevals: | |
description: Get choice values of attribute schema. | |
options: | |
servicename: {required: true, long: servicename, short: s, type: string, description: Name of service.} | |
schematype: {required: true, long: schematype, short: t, type: string, description: Type of schema.} | |
attributename: {required: true, long: attributename, short: a, type: string, | |
description: Name of attribute.} | |
subschemaname: {required: false, long: subschemaname, short: c, type: string, | |
description: Name of sub schema.} | |
set_attr_choicevals: | |
description: Set choice values of attribute schema. | |
options: | |
servicename: {required: true, long: servicename, short: s, type: string, description: Name of service.} | |
schematype: {required: true, long: schematype, short: t, type: string, description: Type of schema.} | |
attributename: {required: true, long: attributename, short: a, type: string, | |
description: Name of attribute.} | |
add: {required: false, long: add, short: p, type: flag, description: Set this flag to append the choice values to existing ones.} | |
subschemaname: {required: false, long: subschemaname, short: c, type: string, | |
description: Name of sub schema.} | |
datafile: {required: false, long: datafile, short: D, type: string, description: Name of file that contains attribute values data.} | |
choicevalues: {required: false, long: choicevalues, short: k, type: list, description: Choice value e.g. o102=Inactive.} | |
set_attr_bool_values: | |
description: Set boolean values of attribute schema. | |
options: | |
servicename: {required: true, long: servicename, short: s, type: string, description: Name of service.} | |
schematype: {required: true, long: schematype, short: t, type: string, description: Type of schema.} | |
attributename: {required: true, long: attributename, short: a, type: string, | |
description: Name of attribute.} | |
truevalue: {required: true, long: truevalue, short: e, type: string, description: Value for true.} | |
truei18nkey: {required: true, long: truei18nkey, short: k, type: string, description: Internationalization key for true value.} | |
falsevalue: {required: true, long: falsevalue, short: z, type: string, description: Value for false.} | |
falsei18nkey: {required: true, long: falsei18nkey, short: j, type: string, description: Internationalization key for false value.} | |
subschemaname: {required: false, long: subschemaname, short: c, type: string, | |
description: Name of sub schema.} | |
remove_attr_choicevals: | |
description: Remove choice values from attribute schema. | |
options: | |
servicename: {required: true, long: servicename, short: s, type: string, description: Name of service.} | |
schematype: {required: true, long: schematype, short: t, type: string, description: Type of schema.} | |
attributename: {required: true, long: attributename, short: a, type: string, | |
description: Name of attribute.} | |
choicevalues: {required: true, long: choicevalues, short: k, type: list, description: Choice values e.g. Inactive} | |
subschemaname: {required: false, long: subschemaname, short: c, type: string, | |
description: Name of sub schema.} | |
set_attr_type: | |
description: Set type member of attribute schema. | |
options: | |
servicename: {required: true, long: servicename, short: s, type: string, description: Name of service.} | |
schematype: {required: true, long: schematype, short: t, type: string, description: Type of schema.} | |
attributeschema: {required: true, long: attributeschema, short: a, type: string, | |
description: Name of attribute schema} | |
type: {required: true, long: type, short: p, type: string, description: Attribute Schema Type} | |
subschemaname: {required: false, long: subschemaname, short: c, type: string, | |
description: Name of sub schema.} | |
set_attr_ui_type: | |
description: Set UI type member of attribute schema. | |
options: | |
servicename: {required: true, long: servicename, short: s, type: string, description: Name of service.} | |
schematype: {required: true, long: schematype, short: t, type: string, description: Type of schema.} | |
attributeschema: {required: true, long: attributeschema, short: a, type: string, | |
description: Name of attribute schema} | |
uitype: {required: true, long: uitype, short: p, type: string, description: Attribute Schema UI Type} | |
subschemaname: {required: false, long: subschemaname, short: c, type: string, | |
description: Name of sub schema.} | |
set_attr_syntax: | |
description: Set syntax member of attribute schema. | |
options: | |
servicename: {required: true, long: servicename, short: s, type: string, description: Name of service.} | |
schematype: {required: true, long: schematype, short: t, type: string, description: Type of schema.} | |
attributeschema: {required: true, long: attributeschema, short: a, type: string, | |
description: Name of attribute schema} | |
syntax: {required: true, long: syntax, short: x, type: string, description: Attribute Schema Syntax} | |
subschemaname: {required: false, long: subschemaname, short: c, type: string, | |
description: Name of sub schema.} | |
set_attr_i18n_key: | |
description: Set i18nKey member of attribute schema. | |
options: | |
servicename: {required: true, long: servicename, short: s, type: string, description: Name of service.} | |
schematype: {required: true, long: schematype, short: t, type: string, description: Type of schema.} | |
attributeschema: {required: true, long: attributeschema, short: a, type: string, | |
description: Name of attribute schema} | |
i18nkey: {required: true, long: i18nkey, short: k, type: string, description: Attribute Schema I18n Key} | |
subschemaname: {required: false, long: subschemaname, short: c, type: string, | |
description: Name of sub schema.} | |
set_attr_view_bean_url: | |
description: Set properties view bean URL member of attribute schema. | |
options: | |
servicename: {required: true, long: servicename, short: s, type: string, description: Name of service.} | |
schematype: {required: true, long: schematype, short: t, type: string, description: Type of schema.} | |
attributeschema: {required: true, long: attributeschema, short: a, type: string, | |
description: Name of attribute schema} | |
url: {required: true, long: url, short: r, type: string, description: Attribute Schema Properties View Bean URL} | |
subschemaname: {required: false, long: subschemaname, short: c, type: string, | |
description: Name of sub schema.} | |
set_attr_any: | |
description: Set any member of attribute schema. | |
options: | |
servicename: {required: true, long: servicename, short: s, type: string, description: Name of service.} | |
schematype: {required: true, long: schematype, short: t, type: string, description: Type of schema.} | |
attributeschema: {required: true, long: attributeschema, short: a, type: string, | |
description: Name of attribute schema} | |
any: {required: true, long: any, short: y, type: string, description: Attribute Schema Any value} | |
subschemaname: {required: false, long: subschemaname, short: c, type: string, | |
description: Name of sub schema.} | |
delete_attr_def_values: | |
description: Delete attribute schema default values. | |
options: | |
servicename: {required: true, long: servicename, short: s, type: string, description: Name of service.} | |
schematype: {required: true, long: schematype, short: t, type: string, description: Type of schema.} | |
attributeschema: {required: true, long: attributeschema, short: a, type: string, | |
description: Name of attribute schema} | |
defaultvalues: {required: true, long: defaultvalues, short: e, type: list, description: Default value(s) to be deleted} | |
subschemaname: {required: false, long: subschemaname, short: c, type: string, | |
description: Name of sub schema.} | |
set_attr_validator: | |
description: Set attribute schema validator. | |
options: | |
servicename: {required: true, long: servicename, short: s, type: string, description: Name of service.} | |
schematype: {required: true, long: schematype, short: t, type: string, description: Type of schema.} | |
attributeschema: {required: true, long: attributeschema, short: a, type: string, | |
description: Name of attribute schema} | |
validator: {required: true, long: validator, short: r, type: string, description: validator class name} | |
subschemaname: {required: false, long: subschemaname, short: c, type: string, | |
description: Name of sub schema.} | |
set_attr_start_range: | |
description: Set attribute schema start range. | |
options: | |
servicename: {required: true, long: servicename, short: s, type: string, description: Name of service.} | |
schematype: {required: true, long: schematype, short: t, type: string, description: Type of schema.} | |
attributeschema: {required: true, long: attributeschema, short: a, type: string, | |
description: Name of attribute schema} | |
range: {required: true, long: range, short: r, type: string, description: Start range} | |
subschemaname: {required: false, long: subschemaname, short: c, type: string, | |
description: Name of sub schema.} | |
set_attr_end_range: | |
description: Set attribute schema end range. | |
options: | |
servicename: {required: true, long: servicename, short: s, type: string, description: Name of service.} | |
schematype: {required: true, long: schematype, short: t, type: string, description: Type of schema.} | |
attributeschema: {required: true, long: attributeschema, short: a, type: string, | |
description: Name of attribute schema} | |
range: {required: true, long: range, short: r, type: string, description: End range} | |
subschemaname: {required: false, long: subschemaname, short: c, type: string, | |
description: Name of sub schema.} | |
delete_attr: | |
description: Delete attribute schemas from a service | |
options: | |
servicename: {required: true, long: servicename, short: s, type: string, description: Name of service.} | |
schematype: {required: true, long: schematype, short: t, type: string, description: Type of schema.} | |
attributeschema: {required: true, long: attributeschema, short: a, type: list, | |
description: Name of attribute schema to be removed.} | |
subschemaname: {required: false, long: subschemaname, short: c, type: string, | |
description: Name of sub schema.} | |
set_svc_i18n_key: | |
description: Set service schema i18n key. | |
options: | |
servicename: {required: true, long: servicename, short: s, type: string, description: Name of service.} | |
i18nkey: {required: true, long: i18nkey, short: k, type: string, description: I18n Key.} | |
set_svc_view_bean_url: | |
description: Set service schema properties view bean URL. | |
options: | |
servicename: {required: true, long: servicename, short: s, type: string, description: Name of service.} | |
url: {required: true, long: url, short: r, type: string, description: Service Schema Properties View Bean URL} | |
set_revision_number: | |
description: Set service schema revision number. | |
options: | |
servicename: {required: true, long: servicename, short: s, type: string, description: Name of service.} | |
revisionnumber: {required: true, long: revisionnumber, short: r, type: string, | |
description: Revision Number} | |
get_revision_number: | |
description: Get service schema revision number. | |
options: | |
servicename: {required: true, long: servicename, short: s, type: string, description: Name of service.} | |
create_sub_cfg: | |
description: Create a new sub configuration. | |
options: | |
servicename: {required: true, long: servicename, short: s, type: string, description: Name of service.} | |
subconfigname: {required: true, long: subconfigname, short: g, type: string, | |
description: Name of sub configuration.} | |
attributevalues: {required: false, long: attributevalues, short: a, type: list, | |
description: Attribute values e.g. homeaddress=here.} | |
datafile: {required: false, long: datafile, short: D, type: string, description: Name of file that contains attribute values data.} | |
realm: {required: false, long: realm, short: e, type: string, description: Name of realm (Sub Configuration shall be added to global configuration if this option is not provided).} | |
subconfigid: {required: false, long: subconfigid, short: b, type: string, description: ID of parent configuration(Sub Configuration shall be added to root configuration if this option is not provided).} | |
priority: {required: false, long: priority, short: p, type: string, description: Priority of the sub configuration.} | |
delete_sub_cfg: | |
description: Remove Sub Configuration. | |
options: | |
servicename: {required: true, long: servicename, short: s, type: string, description: Name of service.} | |
subconfigname: {required: true, long: subconfigname, short: g, type: string, | |
description: Name of sub configuration.} | |
realm: {required: false, long: realm, short: e, type: string, description: Name of realm (Sub Configuration shall be added to global configuration if this option is not provided).} | |
get_sub_cfg: | |
description: Get sub configuration. | |
options: | |
servicename: {required: true, long: servicename, short: s, type: string, description: Name of service.} | |
subconfigname: {required: true, long: subconfigname, short: g, type: string, | |
description: Name of sub configuration.} | |
realm: {required: false, long: realm, short: e, type: string, description: Name of realm (Sub Configuration shall be added to global configuration if this option is not provided).} | |
set_sub_cfg: | |
description: Set sub configuration. | |
options: | |
servicename: {required: true, long: servicename, short: s, type: string, description: Name of service.} | |
subconfigname: {required: true, long: subconfigname, short: g, type: string, | |
description: Name of sub configuration.} | |
operation: {required: true, long: operation, short: o, type: string, description: Operation (either add/set/modify) to be performed on the sub configuration.} | |
attributevalues: {required: false, long: attributevalues, short: a, type: list, | |
description: Attribute values e.g. homeaddress=here.} | |
datafile: {required: false, long: datafile, short: D, type: string, description: Name of file that contains attribute values data.} | |
realm: {required: false, long: realm, short: e, type: string, description: Name of realm (Sub Configuration shall be added to global configuration if this option is not provided).} | |
add_sub_schema: | |
description: Add sub schema. | |
options: | |
servicename: {required: true, long: servicename, short: s, type: string, description: Name of service.} | |
schematype: {required: true, long: schematype, short: t, type: string, description: Type of schema.} | |
filename: {required: true, long: filename, short: F, type: string, description: Name of file that contains the schema} | |
subschemaname: {required: false, long: subschemaname, short: c, type: string, | |
description: Name of sub schema.} | |
remove_sub_schema: | |
description: Remove sub schema. | |
options: | |
servicename: {required: true, long: servicename, short: s, type: string, description: Name of service.} | |
schematype: {required: true, long: schematype, short: t, type: string, description: Type of schema.} | |
subschemanames: {required: true, long: subschemanames, short: a, type: list, | |
description: Name(s) of sub schema to be removed.} | |
subschemaname: {required: false, long: subschemaname, short: c, type: string, | |
description: Name of parent sub schema.} | |
set_inheritance: | |
description: Set Inheritance value of Sub Schema. | |
options: | |
servicename: {required: true, long: servicename, short: s, type: string, description: Name of service.} | |
schematype: {required: true, long: schematype, short: t, type: string, description: Type of schema.} | |
subschemaname: {required: true, long: subschemaname, short: c, type: string, | |
description: Name of sub schema.} | |
inheritance: {required: true, long: inheritance, short: r, type: string, description: Value of Inheritance.} | |
add_plugin_interface: | |
description: Add Plug-in interface to service. | |
options: | |
servicename: {required: true, long: servicename, short: s, type: string, description: Name of service.} | |
interfacename: {required: true, long: interfacename, short: i, type: string, | |
description: Name of interface.} | |
pluginname: {required: true, long: pluginname, short: g, type: string, description: Name of Plug-in.} | |
i18nkey: {required: true, long: i18nkey, short: k, type: string, description: Plug-in I18n Key.} | |
add_plugin_schema: | |
description: Add Plug-in schema to service. | |
options: | |
servicename: {required: true, long: servicename, short: s, type: string, description: Name of service.} | |
interfacename: {required: true, long: interfacename, short: i, type: string, | |
description: Name of interface.} | |
pluginname: {required: true, long: pluginname, short: g, type: string, description: Name of Plug-in.} | |
i18nkey: {required: true, long: i18nkey, short: k, type: string, description: Plug-in I18n Key.} | |
i18nname: {required: true, long: i18nname, short: n, type: string, description: Plug-in I18n Name.} | |
classname: {required: true, long: classname, short: c, type: string, description: Name of the Plugin Schema class implementation} | |
remove_plugin_schema: | |
description: Add Plug-in interface to service. | |
options: | |
servicename: {required: true, long: servicename, short: s, type: string, description: Name of service.} | |
interfacename: {required: true, long: interfacename, short: i, type: string, | |
description: Name of interface.} | |
pluginname: {required: true, long: pluginname, short: g, type: string, description: Name of Plug-in.} | |
set_plugin_viewbean_url: | |
description: Set properties view bean URL of plug-in schema. | |
options: | |
servicename: {required: true, long: servicename, short: s, type: string, description: Name of service.} | |
interfacename: {required: true, long: interfacename, short: i, type: string, | |
description: Name of interface.} | |
pluginname: {required: true, long: pluginname, short: g, type: string, description: Name of Plug-in.} | |
url: {required: true, long: url, short: r, type: string, description: Properties view bean URL.} | |
create_identity: | |
description: Create identity in a realm | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
idname: {required: true, long: idname, short: i, type: string, description: Name of identity.} | |
idtype: {required: true, long: idtype, short: t, type: string, description: 'Type | |
of Identity such as User, Role and Group.'} | |
attributevalues: {required: false, long: attributevalues, short: a, type: list, | |
description: Attribute values e.g. sunIdentityServerDeviceStatus=Active.} | |
datafile: {required: false, long: datafile, short: D, type: string, description: Name of file that contains attribute values data.} | |
delete_identities: | |
description: Delete identities in a realm | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
idtype: {required: true, long: idtype, short: t, type: string, description: 'Type | |
of Identity such as User, Role and Group.'} | |
idnames: {required: false, long: idnames, short: i, type: list, description: Names of identites.} | |
file: {required: false, long: file, short: D, type: string, description: Name of file that contains the identity names to be deleted.} | |
list_identities: | |
description: List identities in a realm | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
filter: {required: true, long: filter, short: x, type: string, description: Filter (Pattern).} | |
idtype: {required: true, long: idtype, short: t, type: string, description: 'Type | |
of Identity such as User, Role and Group.'} | |
show_identity_ops: | |
description: Show the allowed operations of an identity a realm | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
idtype: {required: true, long: idtype, short: t, type: string, description: 'Type | |
of Identity such as User, Role and Group.'} | |
show_data_types: {description: Show the supported data type in the system.} | |
show_identity_types: | |
description: Show the supported identity type in a realm | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
list_identity_assignable_svcs: | |
description: List the assignable service to an identity | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
idname: {required: true, long: idname, short: i, type: string, description: Name of identity.} | |
idtype: {required: true, long: idtype, short: t, type: string, description: 'Type | |
of Identity such as User, Role and Group.'} | |
get_identity_svcs: | |
description: Get the service in an identity | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
idname: {required: true, long: idname, short: i, type: string, description: Name of identity.} | |
idtype: {required: true, long: idtype, short: t, type: string, description: 'Type | |
of Identity such as User, Role and Group.'} | |
show_identity_svc_attrs: | |
description: Show the service attribute values of an identity | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
idname: {required: true, long: idname, short: i, type: string, description: Name of identity.} | |
idtype: {required: true, long: idtype, short: t, type: string, description: 'Type | |
of Identity such as User, Role and Group.'} | |
servicename: {required: true, long: servicename, short: s, type: string, description: Name of service.} | |
get_identity: | |
description: Get identity property values | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
idname: {required: true, long: idname, short: i, type: string, description: Name of identity.} | |
idtype: {required: true, long: idtype, short: t, type: string, description: 'Type | |
of Identity such as User, Role and Group.'} | |
attributenames: {required: false, long: attributenames, short: a, type: list, | |
description: Attribute name(s). All attribute values shall be returned if the option is not provided.} | |
show_memberships: | |
description: Show the memberships of an identity. For sample show the memberships of an user. | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
idname: {required: true, long: idname, short: i, type: string, description: Name of identity.} | |
idtype: {required: true, long: idtype, short: t, type: string, description: 'Type | |
of Identity such as User, Role and Group.'} | |
membershipidtype: {required: true, long: membershipidtype, short: m, type: string, | |
description: Membership identity type.} | |
show_members: | |
description: Show the members of an identity. For example show the members of a role | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
idname: {required: true, long: idname, short: i, type: string, description: Name of identity.} | |
idtype: {required: true, long: idtype, short: t, type: string, description: 'Type | |
of Identity such as User, Role and Group.'} | |
membershipidtype: {required: true, long: membershipidtype, short: m, type: string, | |
description: Membership identity type.} | |
add_member: | |
description: Add an identity as member of another identity | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
memberidname: {required: true, long: memberidname, short: m, type: string, description: Name of identity that is member.} | |
memberidtype: {required: true, long: memberidtype, short: y, type: string, description: 'Type | |
of Identity of member such as User, Role and Group.'} | |
idname: {required: true, long: idname, short: i, type: string, description: Name of identity.} | |
idtype: {required: true, long: idtype, short: t, type: string, description: Type of Identity} | |
remove_member: | |
description: Remove membership of identity from another identity | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
memberidname: {required: true, long: memberidname, short: m, type: string, description: Name of identity that is member.} | |
memberidtype: {required: true, long: memberidtype, short: y, type: string, description: 'Type | |
of Identity of member such as User, Role and Group.'} | |
idname: {required: true, long: idname, short: i, type: string, description: Name of identity.} | |
idtype: {required: true, long: idtype, short: t, type: string, description: Type of Identity} | |
add_svc_identity: | |
description: Add Service to an identity | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
idname: {required: true, long: idname, short: i, type: string, description: Name of identity.} | |
idtype: {required: true, long: idtype, short: t, type: string, description: 'Type | |
of Identity such as User, Role and Group.'} | |
servicename: {required: true, long: servicename, short: s, type: string, description: Name of service.} | |
attributevalues: {required: false, long: attributevalues, short: a, type: list, | |
description: Attribute values e.g. homeaddress=here.} | |
datafile: {required: false, long: datafile, short: D, type: string, description: Name of file that contains attribute values data.} | |
remove_svc_identity: | |
description: Remove Service from an identity | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
idname: {required: true, long: idname, short: i, type: string, description: Name of identity.} | |
idtype: {required: true, long: idtype, short: t, type: string, description: 'Type | |
of Identity such as User, Role and Group.'} | |
servicename: {required: true, long: servicename, short: s, type: string, description: Name of service.} | |
set_identity_svc_attrs: | |
description: Set service attribute values of an identity | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
idname: {required: true, long: idname, short: i, type: string, description: Name of identity.} | |
idtype: {required: true, long: idtype, short: t, type: string, description: 'Type | |
of Identity such as User, Role and Group.'} | |
servicename: {required: true, long: servicename, short: s, type: string, description: Name of service.} | |
attributevalues: {required: false, long: attributevalues, short: a, type: list, | |
description: Attribute values e.g. homeaddress=here.} | |
datafile: {required: false, long: datafile, short: D, type: string, description: Name of file that contains attribute values data.} | |
set_identity_attrs: | |
description: Set attribute values of an identity | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
idname: {required: true, long: idname, short: i, type: string, description: Name of identity.} | |
idtype: {required: true, long: idtype, short: t, type: string, description: 'Type | |
of Identity such as User, Role and Group.'} | |
attributevalues: {required: false, long: attributevalues, short: a, type: list, | |
description: Attribute values e.g. homeaddress=here.} | |
datafile: {required: false, long: datafile, short: D, type: string, description: Name of file that contains attribute values data.} | |
show_privileges: | |
description: Show privileges assigned to an identity | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
idname: {required: true, long: idname, short: i, type: string, description: Name of identity.} | |
idtype: {required: true, long: idtype, short: t, type: string, description: Type of Identity such Role and Group.} | |
add_privileges: | |
description: Add privileges to an identity. To add a privilege to all authenticated users, use the "All Authenticated Users" idname with "role" idtype. | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
idname: {required: true, long: idname, short: i, type: string, description: Name of identity.} | |
idtype: {required: true, long: idtype, short: t, type: string, description: Type of Identity such as Role and Group.} | |
privileges: {required: true, long: privileges, short: g, type: list, description: 'Name | |
of privileges to be added. Privilege names are AgentAdmin, EntitlementRestAccess, | |
FederationAdmin, LogAdmin, LogRead, LogWrite, PolicyAdmin, PrivilegeRestAccess, | |
PrivilegeRestReadAccess, RealmAdmin.'} | |
remove_privileges: | |
description: Remove privileges from an identity | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
idname: {required: true, long: idname, short: i, type: string, description: Name of identity.} | |
idtype: {required: true, long: idtype, short: t, type: string, description: Type of Identity such as Role and Group.} | |
privileges: {required: true, long: privileges, short: g, type: list, description: 'Name | |
of privileges to be removed. Privilege names are AgentAdmin, EntitlementRestAccess, | |
FederationAdmin, LogAdmin, LogRead, LogWrite, PolicyAdmin, PrivilegeRestAccess, | |
PrivilegeRestReadAccess, RealmAdmin.'} | |
list_auth_instances: | |
description: List authentication instances | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
create_auth_instance: | |
description: Create authentication instance | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
name: {required: true, long: name, short: m, type: string, description: Name of authentication instance.} | |
authtype: {required: true, long: authtype, short: t, type: string, description: 'Type | |
of authentication instance e.g. LDAP, DataStore.'} | |
delete_auth_instances: | |
description: Delete authentication instances | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
names: {required: true, long: names, short: m, type: list, description: Name of authentication instances.} | |
update_auth_instance: | |
description: Update authentication instance values | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
name: {required: true, long: name, short: m, type: string, description: Name of authentication instance.} | |
attributevalues: {required: false, long: attributevalues, short: a, type: list, | |
description: Attribute values e.g. homeaddress=here.} | |
datafile: {required: false, long: datafile, short: D, type: string, description: Name of file that contains attribute values data.} | |
get_auth_instance: | |
description: Get authentication instance values | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
name: {required: true, long: name, short: m, type: string, description: Name of authentication instance.} | |
list_auth_cfgs: | |
description: List authentication configurations | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
create_auth_cfg: | |
description: Create authentication configuration | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
name: {required: true, long: name, short: m, type: string, description: Name of authentication configuration.} | |
delete_auth_cfgs: | |
description: Delete authentication configurations | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
names: {required: true, long: names, short: m, type: list, description: Name of authentication configurations.} | |
get_auth_cfg_entr: | |
description: Get authentication configuration entries | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
name: {required: true, long: name, short: m, type: string, description: Name of authentication configuration.} | |
add_auth_cfg_entr: | |
description: Add authentication configuration entry | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
name: {required: true, long: name, short: m, type: string, description: Name of authentication configuration.} | |
modulename: {required: true, long: modulename, short: o, type: string, description: Module Name.} | |
criteria: {required: true, long: criteria, short: c, type: string, description: 'Criteria | |
for this entry. Possible values are REQUIRED, OPTIONAL, SUFFICIENT, REQUISITE'} | |
options: {required: false, long: options, short: t, type: string, description: Options for this entry.} | |
position: {required: false, long: position, short: p, type: string, description: 'Position | |
where the new entry is to be added. This is option is not set, entry shall | |
be added to the end of the list. If value of this option is 0, it will be | |
inserted to the front of the list. If value is greater of the length of | |
the list, entry shall be added to the end of the list.'} | |
update_auth_cfg_entr: | |
description: Set authentication configuration entries | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
name: {required: true, long: name, short: m, type: string, description: Name of authentication configuration.} | |
entries: {required: false, long: entries, short: a, type: list, description: 'formatted | |
authentication configuration entries in this format name&pipe;flag&pipe;options. | |
option can be REQUIRED, OPTIONAL, SUFFICIENT, REQUISITE. e.g. myauthmodule&pipe;REQUIRED&pipe;my | |
options.'} | |
datafile: {required: false, long: datafile, short: D, type: string, description: 'Name | |
of file that contains formatted authentication configuration entries in | |
this format name&pipe;flag&pipe;options. option can be REQUIRED, OPTIONAL, | |
SUFFICIENT, REQUISITE. e.g. myauthmodule&pipe;REQUIRED&pipe;my options.'} | |
update_auth_cfg_props: | |
description: Set authentication configuration properties | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
name: {required: true, long: name, short: m, type: string, description: Name of authentication configuration.} | |
attributevalues: {required: false, long: attributevalues, short: a, type: list, | |
description: 'authentication configuration properties, valid configuration | |
keys are: iplanet-am-auth-login-failure-url, iplanet-am-auth-login-success-url | |
and iplanet-am-auth-post-login-process-class.'} | |
datafile: {required: false, long: datafile, short: D, type: string, description: Name of file that contains authentication configuration properties.} | |
list_datastore_types: {description: List the supported data store types} | |
list_datastores: | |
description: List data stores under a realm | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
add_amsdk_idrepo_plugin: | |
description: Create AMSDK IdRepo Plug-in | |
options: | |
directory-servers: {required: true, long: directory-servers, short: s, type: list, | |
description: 'directory servers <protocol>://<hostname>:<port>. Can have multiple | |
entries.'} | |
binddn: {required: true, long: binddn, short: e, type: string, description: Directory Server bind distinguished name.} | |
bind-password-file: {required: true, long: bind-password-file, short: m, type: string, | |
description: File that contains password of bind password.} | |
basedn: {required: true, long: basedn, short: b, type: string, description: Directory Server base distinguished name.} | |
dsame-password-file: {required: true, long: dsame-password-file, short: x, type: string, | |
description: File that contains password of the dsameuser} | |
puser-password-file: {required: true, long: puser-password-file, short: p, type: string, | |
description: File that contains password of the puser} | |
user: {required: false, long: user, short: a, type: string, description: User objects naming attribute (defaults to 'uid')} | |
org: {required: false, long: org, short: o, type: string, description: Organization objects naming attribute (defaults to 'o')} | |
create_datastore: | |
description: Create data store under a realm | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
name: {required: true, long: name, short: m, type: string, description: Name of datastore.} | |
datatype: {required: true, long: datatype, short: t, type: string, description: Type of datastore. Use the list-datastore-types subcommand to get a list of supported datastore types.} | |
attributevalues: {required: false, long: attributevalues, short: a, type: list, | |
description: Attribute values e.g. sunIdRepoClass=com.sun.identity.idm.plugins.files.FilesRepo.} | |
datafile: {required: false, long: datafile, short: D, type: string, description: Name of file that contains attribute values data.} | |
delete_datastores: | |
description: Delete data stores under a realm | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
names: {required: true, long: names, short: m, type: list, description: Names of datastore.} | |
update_datastore: | |
description: Update data store profile. | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
name: {required: true, long: name, short: m, type: string, description: Name of datastore.} | |
attributevalues: {required: false, long: attributevalues, short: a, type: list, | |
description: Attribute values e.g. sunIdRepoClass=com.sun.identity.idm.plugins.files.FilesRepo.} | |
datafile: {required: false, long: datafile, short: D, type: string, description: Name of file that contains attribute values data.} | |
show_datastore: | |
description: Show data store profile. | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
name: {required: true, long: name, short: m, type: string, description: Name of datastore.} | |
export_svc_cfg: | |
description: Export service configuration. | |
options: | |
encryptsecret: {required: true, long: encryptsecret, short: e, type: string, | |
description: Secret key for encrypting password.} | |
outfile: {required: false, long: outfile, short: o, type: string, description: Filename where configuration was written.} | |
import_svc_cfg: | |
description: Import service configuration. | |
options: | |
encryptsecret: {required: true, long: encryptsecret, short: e, type: string, | |
description: Secret key for decrypting password.} | |
xmlfile: {required: true, long: xmlfile, short: X, type: string, description: XML file that contains configuration data.} | |
create_svrcfg_xml: | |
description: Create serverconfig.xml file. No options are required for flat file configuration data store. | |
options: | |
dshost: {required: false, long: dshost, short: t, type: string, description: Directory Server host name} | |
dsport: {required: false, long: dsport, short: p, type: string, description: Directory Server port number} | |
basedn: {required: false, long: basedn, short: b, type: string, description: Directory Server base distinguished name.} | |
dsadmin: {required: false, long: dsadmin, short: a, type: string, description: Directory Server administrator distinguished name} | |
dspassword-file: {required: false, long: dspassword-file, short: x, type: string, | |
description: File that contains Directory Server administrator password} | |
outfile: {required: false, long: outfile, short: o, type: string, description: File name where serverconfig XML is written.} | |
get_svrcfg_xml: | |
description: Get server configuration XML from centralized data store | |
options: | |
servername: {required: true, long: servername, short: s, type: string, description: 'Server | |
name, e.g. http://www.example.com:8080/fam'} | |
outfile: {required: false, long: outfile, short: o, type: string, description: File name where serverconfig XML is written.} | |
set_svrcfg_xml: | |
description: Set server configuration XML to centralized data store | |
options: | |
servername: {required: true, long: servername, short: s, type: string, description: 'Server | |
name, e.g. http://www.example.com:8080/fam'} | |
xmlfile: {required: true, long: xmlfile, short: X, type: list, description: XML file that contains configuration.} | |
create_agent: | |
description: Create a new agent configuration. | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
agentname: {required: true, long: agentname, short: b, type: string, description: Name of agent.} | |
agenttype: {required: true, long: agenttype, short: t, type: string, description: 'Type | |
of agent. Possible values: J2EEAgent, WebAgent, WSCAgent, WSPAgent, STSAgent, | |
DiscoveryAgent, 2.2_Agent, SharedAgent, OAuth2Client'} | |
serverurl: {required: false, long: serverurl, short: s, type: string, description: 'Server | |
URL. e.g. http://www.example.com:58080/openam. This option is valid for | |
J2EEAgent and WebAgent. This parameter is required if the agent is created | |
without datafile/attributes.'} | |
agenturl: {required: false, long: agenturl, short: g, type: string, description: 'Agent | |
URL. e.g. http://www.agent.example:8080/agent. WebAgent does not take URL | |
with path. e.g. http://www.agent.example:8080. This option is valid for | |
J2EEAgent and WebAgent. This parameter is required if the agent is created | |
without datafile/attributes.'} | |
attributevalues: {required: false, long: attributevalues, short: a, type: list, | |
description: 'Properties e.g. sunIdentityServerDeviceKeyValue=https://agent.example.com:443/'} | |
datafile: {required: false, long: datafile, short: D, type: string, description: Name of file that contains properties.} | |
delete_agents: | |
description: Delete agent configurations. | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
agentnames: {required: false, long: agentnames, short: s, type: list, description: Separate multiple agent names with spaces.} | |
file: {required: false, long: file, short: D, type: string, description: 'File | |
containing agent names, with multiple agent names separated by spaces.'} | |
update_agent: | |
description: Update agent configuration. | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
agentname: {required: true, long: agentname, short: b, type: string, description: Name of agent.} | |
set: {required: false, long: set, short: s, type: flag, description: Set this flag to overwrite properties values.} | |
attributevalues: {required: false, long: attributevalues, short: a, type: list, | |
description: Properties e.g. homeaddress=here.} | |
datafile: {required: false, long: datafile, short: D, type: string, description: Name of file that contains properties.} | |
agent_remove_props: | |
description: Remove agent's properties. | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
agentname: {required: true, long: agentname, short: b, type: string, description: Name of agent.} | |
attributenames: {required: true, long: attributenames, short: a, type: list, | |
description: properties name(s).} | |
list_agents: | |
description: List agent configurations. | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
filter: {required: false, long: filter, short: x, type: string, description: Filter (Pattern).} | |
agenttype: {required: false, long: agenttype, short: t, type: string, description: 'Type | |
of agent. e.g. J2EEAgent, WebAgent'} | |
show_agent: | |
description: Show agent profile. | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
agentname: {required: true, long: agentname, short: b, type: string, description: Name of agent.} | |
outfile: {required: false, long: outfile, short: o, type: string, description: Filename where configuration is written to.} | |
inherit: {required: false, long: inherit, short: i, type: flag, description: Set this to inherit properties from parent group.} | |
show_agent_types: {description: Show agent types.} | |
show_agent_grp: | |
description: Show agent group profile. | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
agentgroupname: {required: true, long: agentgroupname, short: b, type: string, | |
description: Name of agent group.} | |
outfile: {required: false, long: outfile, short: o, type: string, description: Filename where configuration is written to.} | |
create_agent_grp: | |
description: Create a new agent group. | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
agentgroupname: {required: true, long: agentgroupname, short: b, type: string, | |
description: Name of agent group.} | |
agenttype: {required: true, long: agenttype, short: t, type: string, description: 'Type | |
of agent group. e.g. J2EEAgent, WebAgent'} | |
serverurl: {required: false, long: serverurl, short: s, type: string, description: 'Server | |
URL. e.g. http://www.example.com:58080/openam. This option is valid for | |
J2EEAgent and WebAgent.'} | |
attributevalues: {required: false, long: attributevalues, short: a, type: list, | |
description: Properties e.g. homeaddress=here.} | |
datafile: {required: false, long: datafile, short: D, type: string, description: Name of file that contains properties.} | |
delete_agent_grps: | |
description: Delete agent groups. | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
agentgroupnames: {required: false, long: agentgroupnames, short: s, type: list, | |
description: Separate multiple agent group names with spaces.} | |
file: {required: false, long: file, short: D, type: string, description: 'File | |
containing agent group names, with multiple group names separated by spaces.'} | |
list_agent_grps: | |
description: List agent groups. | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
filter: {required: false, long: filter, short: x, type: string, description: Filter (Pattern).} | |
agenttype: {required: false, long: agenttype, short: t, type: string, description: 'Type | |
of agent. e.g. J2EEAgent, WebAgent'} | |
list_agent_grp_members: | |
description: List agents in agent group. | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
agentgroupname: {required: true, long: agentgroupname, short: b, type: string, | |
description: Name of agent group.} | |
filter: {required: false, long: filter, short: x, type: string, description: Filter (Pattern).} | |
show_agent_membership: | |
description: List agent's membership. | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
agentname: {required: true, long: agentname, short: b, type: string, description: Name of agent.} | |
add_agent_to_grp: | |
description: Add agents to a agent group. | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
agentgroupname: {required: true, long: agentgroupname, short: b, type: string, | |
description: Name of agent group.} | |
agentnames: {required: true, long: agentnames, short: s, type: list, description: Names of agents.} | |
remove_agent_from_grp: | |
description: Remove agents from a agent group. | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
agentgroupname: {required: true, long: agentgroupname, short: b, type: string, | |
description: Name of agent group.} | |
agentnames: {required: true, long: agentnames, short: s, type: list, description: Names of agents.} | |
update_agent_grp: | |
description: Update agent group configuration. | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
agentgroupname: {required: true, long: agentgroupname, short: b, type: string, | |
description: Name of agent group.} | |
set: {required: false, long: set, short: s, type: flag, description: Set this flag to overwrite properties values.} | |
attributevalues: {required: false, long: attributevalues, short: a, type: list, | |
description: Properties e.g. homeaddress=here.} | |
datafile: {required: false, long: datafile, short: D, type: string, description: Name of file that contains properties.} | |
list_server_cfg: | |
description: List server configuration. | |
options: | |
servername: {required: true, long: servername, short: s, type: string, description: 'Server | |
name, e.g. http://www.example.com:8080/fam or enter default to list default | |
server configuration.'} | |
withdefaults: {required: false, long: withdefaults, short: w, type: flag, description: Set this flag to get default configuration.} | |
update_server_cfg: | |
description: Update server configuration. | |
options: | |
servername: {required: true, long: servername, short: s, type: string, description: 'Server | |
name, e.g. http://www.example.com:8080/fam or enter default to update default | |
server configuration.'} | |
attributevalues: {required: false, long: attributevalues, short: a, type: list, | |
description: Attribute values e.g. homeaddress=here.} | |
datafile: {required: false, long: datafile, short: D, type: string, description: Name of file that contains attribute values data.} | |
remove_server_cfg: | |
description: Remove server configuration. | |
options: | |
servername: {required: true, long: servername, short: s, type: string, description: 'Server | |
name, e.g. http://www.example.com:8080/fam or enter default to remove default | |
server configuration.'} | |
propertynames: {required: true, long: propertynames, short: a, type: list, description: Name of properties to be removed.} | |
create_server: | |
description: Create a server instance. | |
options: | |
servername: {required: true, long: servername, short: s, type: string, description: 'Server | |
name, e.g. http://www.example.com:8080/fam'} | |
serverconfigxml: {required: true, long: serverconfigxml, short: X, type: string, | |
description: Server Configuration XML file name.} | |
attributevalues: {required: false, long: attributevalues, short: a, type: list, | |
description: Attribute values e.g. homeaddress=here.} | |
datafile: {required: false, long: datafile, short: D, type: string, description: Name of file that contains attribute values data.} | |
delete_server: | |
description: Delete a server instance. | |
options: | |
servername: {required: true, long: servername, short: s, type: string, description: 'Server | |
name, e.g. http://www.example.com:8080/fam'} | |
list_servers: {description: List all server instances.} | |
embedded_status: | |
description: Status of embedded store. | |
options: | |
port: {required: true, long: port, short: p, type: string, description: Embedded store port} | |
password: {required: false, long: password, short: w, type: string, description: Embedded store password} | |
create_site: | |
description: Create a site. | |
options: | |
sitename: {required: true, long: sitename, short: s, type: string, description: 'Site | |
name, e.g. mysite'} | |
siteurl: {required: true, long: siteurl, short: i, type: string, description: 'Site''s | |
primary URL, e.g. http://www.example.com:8080'} | |
secondaryurls: {required: false, long: secondaryurls, short: a, type: list, | |
description: Secondary URLs} | |
delete_site: | |
description: Delete a site. | |
options: | |
sitename: {required: true, long: sitename, short: s, type: string, description: 'Site | |
name, e.g. mysite'} | |
list_sites: {description: List all sites.} | |
show_site_members: | |
description: Display members of a site. | |
options: | |
sitename: {required: true, long: sitename, short: s, type: string, description: 'Site | |
name, e.g. mysite'} | |
add_site_members: | |
description: Add members to a site. | |
options: | |
sitename: {required: true, long: sitename, short: s, type: string, description: 'Site | |
name, e.g. mysite'} | |
servernames: {required: true, long: servernames, short: e, type: list, description: 'Server | |
names, e.g. http://www.example.com:8080/fam'} | |
remove_site_members: | |
description: Remove members from a site. | |
options: | |
sitename: {required: true, long: sitename, short: s, type: string, description: 'Site | |
name, e.g. mysite'} | |
servernames: {required: true, long: servernames, short: e, type: list, description: 'Server | |
names, e.g. http://www.example.com:8080/fam'} | |
set_site_id: | |
description: Set the ID of a site. | |
options: | |
sitename: {required: true, long: sitename, short: s, type: string, description: 'Site | |
name, e.g. mysite'} | |
siteid: {required: true, long: siteid, short: i, type: string, description: 'Site''s | |
ID, e.g. 10'} | |
set_site_pri_url: | |
description: Set the primary URL of a site. | |
options: | |
sitename: {required: true, long: sitename, short: s, type: string, description: 'Site | |
name, e.g. mysite'} | |
siteurl: {required: true, long: siteurl, short: i, type: string, description: 'Site''s | |
primary URL, e.g. http://site.www.example.com:8080'} | |
show_site: | |
description: Show site profile. | |
options: | |
sitename: {required: true, long: sitename, short: s, type: string, description: 'Site | |
name, e.g. mysite'} | |
set_site_sec_urls: | |
description: Set Site Secondary URLs. | |
options: | |
sitename: {required: true, long: sitename, short: s, type: string, description: 'Site | |
name, e.g. mysite'} | |
secondaryurls: {required: true, long: secondaryurls, short: a, type: list, description: Secondary URLs} | |
add_site_sec_urls: | |
description: Add Site Secondary URLs. | |
options: | |
sitename: {required: true, long: sitename, short: s, type: string, description: 'Site | |
name, e.g. mysite'} | |
secondaryurls: {required: true, long: secondaryurls, short: a, type: list, description: Secondary URLs} | |
remove_site_sec_urls: | |
description: Remove Site Secondary URLs. | |
options: | |
sitename: {required: true, long: sitename, short: s, type: string, description: 'Site | |
name, e.g. mysite'} | |
secondaryurls: {required: true, long: secondaryurls, short: a, type: list, description: Secondary URLs} | |
clone_server: | |
description: Clone a server instance. | |
options: | |
servername: {required: true, long: servername, short: s, type: string, description: Server name} | |
cloneservername: {required: true, long: cloneservername, short: o, type: string, | |
description: Clone server name} | |
export_server: | |
description: Export a server instance. | |
options: | |
servername: {required: true, long: servername, short: s, type: string, description: Server name} | |
outfile: {required: false, long: outfile, short: o, type: string, description: Filename where configuration was written.} | |
import_server: | |
description: Import a server instance. | |
options: | |
servername: {required: true, long: servername, short: s, type: string, description: Server name} | |
xmlfile: {required: true, long: xmlfile, short: X, type: list, description: XML file that contains configuration.} | |
show_auth_modules: {description: Show the supported authentication modules in the system.} | |
register_auth_module: | |
description: Registers authentication module. | |
options: | |
authmodule: {required: true, long: authmodule, short: a, type: string, description: Java class name of authentication module.} | |
unregister_auth_module: | |
description: Unregisters authentication module. | |
options: | |
authmodule: {required: true, long: authmodule, short: a, type: string, description: Java class name of authentication module.} | |
create_appl: | |
description: Create application. | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Realm name} | |
applicationtype: {required: true, long: applicationtype, short: t, type: string, | |
description: Application type name} | |
name: {required: true, long: name, short: m, type: string, description: Application name} | |
attributevalues: {required: false, long: attributevalues, short: a, type: list, | |
description: Attribute values e.g. applicationType=iPlanetAMWebAgentService.} | |
datafile: {required: false, long: datafile, short: D, type: string, description: 'Name | |
of file that contains attribute values data. Mandatory attributes are resources, | |
subjects, conditions and entitlementCombiner. Optional ones are actions, | |
searchIndexImpl, saveIndexImpl, resourceComparator, subjectAttributeNames.'} | |
list_appl_types: {description: List application types.} | |
show_appl_type: | |
description: Show application type details. | |
options: | |
name: {required: true, long: name, short: m, type: string, description: Application Type name} | |
delete_appl_types: | |
description: Delete application types. | |
options: | |
names: {required: true, long: names, short: m, type: list, description: Application Type names} | |
create_appl_type: | |
description: Create application type. | |
options: | |
name: {required: true, long: name, short: m, type: string, description: Application Type name} | |
attributevalues: {required: false, long: attributevalues, short: a, type: list, | |
description: Application Type attribute values e.g. actions=enabled=true.} | |
datafile: {required: false, long: datafile, short: D, type: string, description: 'Name | |
of file that contains attribute type values data. Mandatory attributes are | |
actions, searchIndexImpl and saveIndexImpl. Optional are resourceComparator.'} | |
list_appls: | |
description: List applications in a realm. | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Realm name} | |
show_appl: | |
description: Show application attributes. | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Realm name} | |
name: {required: true, long: name, short: m, type: string, description: Application name} | |
set_appl: | |
description: Set application attributes. | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Realm name} | |
name: {required: true, long: name, short: m, type: string, description: Application name} | |
attributevalues: {required: false, long: attributevalues, short: a, type: list, | |
description: Attribute values e.g. applicationType=iPlanetAMWebAgentService.} | |
datafile: {required: false, long: datafile, short: D, type: string, description: 'Name | |
of file that contains attribute values data. Possible attributes are resources, | |
subjects, conditions, actions, searchIndexImpl, saveIndexImpl, resourceComparator, | |
subjectAttributeNames and entitlementCombiner.'} | |
delete_appls: | |
description: Delete applications. | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Realm name} | |
names: {required: true, long: names, short: m, type: list, description: Application names} | |
show_entitlement_conf: {description: Display entitlements service configuration} | |
set_entitlement_conf: | |
description: Set entitlements service configuration | |
options: | |
attributevalues: {required: false, long: attributevalues, short: a, type: list, | |
description: Attribute values e.g. evalThreadSize=4.} | |
datafile: {required: false, long: datafile, short: D, type: string, description: 'Name | |
of file that contains attribute values data. Possible attributes are evalThreadSize, | |
searchThreadSize, policyCacheSize and indexCacheSize.'} | |
add_app_priv: | |
description: Add an application privilege to delegate resources of a given application. | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Realm name} | |
name: {required: true, long: name, short: m, type: string, description: Name for the this delegation} | |
application: {required: true, long: application, short: t, type: string, description: Application name} | |
actions: {required: true, long: actions, short: a, type: string, description: 'Possible | |
values are READ, MODIFY, DELEGATE, ALL'} | |
subjecttype: {required: true, long: subjecttype, short: b, type: string, description: Possible values are User or Group} | |
subjects: {required: true, long: subjects, short: s, type: list, description: Subject name} | |
description: {required: false, long: description, short: p, type: string, description: Description for the this delegation.} | |
resources: {required: false, long: resources, short: r, type: list, description: 'Resources | |
to delegate, All resources in the applications will be delegated if this | |
option is absent.'} | |
remove_app_privs: | |
description: Remove an application privileges. | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Realm name} | |
names: {required: true, long: names, short: m, type: list, description: Names of application privilege to be removed} | |
show_app_priv: | |
description: Show application privilege. | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Realm name} | |
name: {required: true, long: name, short: m, type: string, description: Name of application privilege} | |
list_app_privs: | |
description: List application privileges in a realm. | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Realm name} | |
update_app_priv: | |
description: Update an application privilege. | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Realm name} | |
name: {required: true, long: name, short: m, type: string, description: Name for the this delegation} | |
actions: {required: false, long: actions, short: a, type: string, description: 'Possible | |
values are READ, MODIFY, DELEGATE, ALL'} | |
description: {required: false, long: description, short: p, type: string, description: Description for the this delegation.} | |
update_app_priv_subjects: | |
description: Set application privilege subjects. | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Realm name} | |
name: {required: true, long: name, short: m, type: string, description: Name for the this delegation} | |
subjecttype: {required: true, long: subjecttype, short: b, type: string, description: Possible values are User or Group} | |
subjects: {required: true, long: subjects, short: s, type: list, description: Subject name} | |
add: {required: false, long: add, short: p, type: flag, description: 'Subjects | |
are added to this application if this option is set. Otherwise, subjects | |
in the current application privilege will be overwritten.'} | |
update_app_priv_resources: | |
description: Set application privilege resources. | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Realm name} | |
name: {required: true, long: name, short: m, type: string, description: Name for the this delegation} | |
application: {required: true, long: application, short: t, type: string, description: Application name} | |
add: {required: false, long: add, short: p, type: flag, description: 'Resources | |
are added to this application if this option is set. Otherwise, resources | |
in the current application privilege will be overwritten.'} | |
resources: {required: false, long: resources, short: r, type: list, description: 'Resources | |
to delegate, All resources in the applications will be delegated if this | |
option is absent.'} | |
remove_app_priv_subjects: | |
description: Remove application privilege subjects. | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Realm name} | |
name: {required: true, long: name, short: m, type: string, description: Name for the this delegation} | |
subjecttype: {required: true, long: subjecttype, short: b, type: string, description: Possible values are User or Group} | |
subjects: {required: true, long: subjects, short: s, type: list, description: Subject name} | |
remove_app_priv_resources: | |
description: Remove application privilege resources. | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Realm name} | |
name: {required: true, long: name, short: m, type: string, description: Name for the this delegation} | |
application: {required: true, long: application, short: t, type: string, description: Application name} | |
resources: {required: false, long: resources, short: r, type: list, description: 'Resources | |
to removed, All resources in the applications will be removed if this option | |
is absent.'} | |
list_xacml: | |
description: export policies in realm as XACML. | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
policynames: {required: false, long: policynames, short: p, type: list, description: Names of policy. This can be a wildcard. All policy definition in the realm will be returned if this option is not provided.} | |
outfile: {required: false, long: outfile, short: o, type: string, description: Filename where policy definition will be printed to. Definition will be printed in standard output if this option is not provided.} | |
namesonly: {required: false, long: namesonly, short: n, type: flag, description: Returns only names of matching policies. Policies are not returned.} | |
create_xacml: | |
description: Create policies in a realm with XACML input. | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
xmlfile: {required: true, long: xmlfile, short: X, type: string, description: Name of file that contains policy XACML definition.} | |
delete_xacml: | |
description: Delete XACML policies from a realm. | |
options: | |
realm: {required: true, long: realm, short: e, type: string, description: Name of realm.} | |
policynames: {required: false, long: policynames, short: p, type: list, description: Names of policy to be deleted.} | |
file: {required: false, long: file, short: D, type: string, description: Name of file that contains the policy names to be deleted.} | |
- create_metadata_templ: | |
description: Create new metadata template. | |
options: | |
entityid: {required: true, long: entityid, short: y, type: string, description: Entity ID} | |
meta-data-file: {required: false, long: meta-data-file, short: m, type: string, | |
description: c} | |
extended-data-file: {required: false, long: extended-data-file, short: x, type: string, | |
description: c} | |
serviceprovider: {required: false, long: serviceprovider, short: s, type: string, | |
description: Specify metaAlias for hosted service provider to be created. The format must be <realm name>/<identifier>.} | |
identityprovider: {required: false, long: identityprovider, short: i, type: string, | |
description: Specify metaAlias for hosted identity provider to be created. The format must be <realm name>/<identifier>.} | |
attrqueryprovider: {required: false, long: attrqueryprovider, short: S, type: string, | |
description: i} | |
attrauthority: {required: false, long: attrauthority, short: I, type: string, | |
description: i} | |
authnauthority: {required: false, long: authnauthority, short: C, type: string, | |
description: i} | |
xacmlpep: {required: false, long: xacmlpep, short: e, type: string, description: Specify metaAlias for policy enforcement point to be created. The format must be <realm name>/<identifier>.} | |
xacmlpdp: {required: false, long: xacmlpdp, short: p, type: string, description: Specify metaAlias for policy decision point to be created. The format must be <realm name>/<identifier>.} | |
affiliation: {required: false, long: affiliation, short: F, type: string, description: i} | |
affiownerid: {required: false, long: affiownerid, short: N, type: string, description: i} | |
affimembers: {required: false, long: affimembers, short: M, type: list, description: Affiliation members} | |
spscertalias: {required: false, long: spscertalias, short: a, type: string, | |
description: Service provider signing certificate alias} | |
idpscertalias: {required: false, long: idpscertalias, short: b, type: string, | |
description: Identity provider signing certificate alias} | |
attrqscertalias: {required: false, long: attrqscertalias, short: A, type: string, | |
description: i} | |
attrascertalias: {required: false, long: attrascertalias, short: B, type: string, | |
description: i} | |
authnascertalias: {required: false, long: authnascertalias, short: D, type: string, | |
description: i} | |
affiscertalias: {required: false, long: affiscertalias, short: J, type: string, | |
description: i} | |
xacmlpdpscertalias: {required: false, long: xacmlpdpscertalias, short: t, type: string, | |
description: Policy decision point signing certificate alias} | |
xacmlpepscertalias: {required: false, long: xacmlpepscertalias, short: k, type: string, | |
description: Policy enforcement point signing certificate alias} | |
specertalias: {required: false, long: specertalias, short: r, type: string, | |
description: Service provider encryption certificate alias} | |
idpecertalias: {required: false, long: idpecertalias, short: g, type: string, | |
description: Identity provider encryption certificate alias.} | |
attrqecertalias: {required: false, long: attrqecertalias, short: R, type: string, | |
description: i} | |
attraecertalias: {required: false, long: attraecertalias, short: G, type: string, | |
description: i} | |
authnaecertalias: {required: false, long: authnaecertalias, short: E, type: string, | |
description: i} | |
affiecertalias: {required: false, long: affiecertalias, short: K, type: string, | |
description: i} | |
xacmlpdpecertalias: {required: false, long: xacmlpdpecertalias, short: j, type: string, | |
description: Policy decision point encryption certificate alias} | |
xacmlpepecertalias: {required: false, long: xacmlpepecertalias, short: z, type: string, | |
description: Policy enforcement point encryption certificate alias} | |
spec: {required: false, long: spec, short: c, type: string, description: 'Specify | |
metadata specification, either wsfed, idff or saml2, defaults to saml2'} | |
update_entity_keyinfo: | |
description: Update XML signing and encryption key information in hosted entity metadata. | |
options: | |
entityid: {required: true, long: entityid, short: y, type: string, description: Entity ID} | |
realm: {required: false, long: realm, short: e, type: string, description: Realm where entity resides.} | |
spscertalias: {required: false, long: spscertalias, short: a, type: string, | |
description: Service provider signing certificate alias} | |
idpscertalias: {required: false, long: idpscertalias, short: b, type: string, | |
description: Identity provider signing certificate alias} | |
specertalias: {required: false, long: specertalias, short: r, type: string, | |
description: Service provider encryption certificate alias} | |
idpecertalias: {required: false, long: idpecertalias, short: g, type: string, | |
description: Identity provider encryption certificate alias.} | |
spec: {required: false, long: spec, short: c, type: string, description: 'Specify | |
metadata specification, either wsfed, idff or saml2, defaults to saml2'} | |
import_entity: | |
description: Import entity. | |
options: | |
realm: {required: false, long: realm, short: e, type: string, description: Realm where entity resides.} | |
meta-data-file: {required: false, long: meta-data-file, short: m, type: string, | |
description: t} | |
extended-data-file: {required: false, long: extended-data-file, short: x, type: string, | |
description: t} | |
cot: {required: false, long: cot, short: t, type: string, description: Specify name of the Circle of Trust this entity belongs.} | |
spec: {required: false, long: spec, short: c, type: string, description: 'Specify | |
metadata specification, either wsfed, idff or saml2, defaults to saml2'} | |
export_entity: | |
description: Export entity. | |
options: | |
entityid: {required: true, long: entityid, short: y, type: string, description: Entity ID} | |
realm: {required: false, long: realm, short: e, type: string, description: Realm where data resides} | |
sign: {required: false, long: sign, short: g, type: flag, description: Set this flag to sign the metadata} | |
meta-data-file: {required: false, long: meta-data-file, short: m, type: string, | |
description: c} | |
extended-data-file: {required: false, long: extended-data-file, short: x, type: string, | |
description: c} | |
spec: {required: false, long: spec, short: c, type: string, description: 'Specify | |
metadata specification, either wsfed, idff or saml2, defaults to saml2'} | |
delete_entity: | |
description: Delete entity. | |
options: | |
entityid: {required: true, long: entityid, short: y, type: string, description: Entity ID} | |
realm: {required: false, long: realm, short: e, type: string, description: Realm where data resides} | |
extendedonly: {required: false, long: extendedonly, short: x, type: flag, description: Set to flag to delete only extended data.} | |
spec: {required: false, long: spec, short: c, type: string, description: 'Specify | |
metadata specification, either wsfed, idff or saml2, defaults to saml2'} | |
list_entities: | |
description: List entities under a realm. | |
options: | |
realm: {required: false, long: realm, short: e, type: string, description: Realm where entities reside.} | |
spec: {required: false, long: spec, short: c, type: string, description: 'Specify | |
metadata specification, either wsfed, idff or saml2, defaults to saml2'} | |
create_cot: | |
description: Create circle of trust. | |
options: | |
cot: {required: true, long: cot, short: t, type: string, description: Circle of Trust} | |
realm: {required: false, long: realm, short: e, type: string, description: Realm where circle of trust resides} | |
trustedproviders: {required: false, long: trustedproviders, short: k, type: list, | |
description: Trusted Providers} | |
prefix: {required: false, long: prefix, short: p, type: string, description: Prefix URL for idp discovery reader and writer URL.} | |
delete_cot: | |
description: Delete circle of trust. | |
options: | |
cot: {required: true, long: cot, short: t, type: string, description: Circle of Trust} | |
realm: {required: false, long: realm, short: e, type: string, description: Realm where circle of trust resides} | |
list_cots: | |
description: List circles of trust. | |
options: | |
realm: {required: false, long: realm, short: e, type: string, description: Realm where circle of trusts reside} | |
list_cot_members: | |
description: List the members in a circle of trust. | |
options: | |
cot: {required: true, long: cot, short: t, type: string, description: Circle of Trust} | |
realm: {required: false, long: realm, short: e, type: string, description: Realm where circle of trust resides} | |
spec: {required: false, long: spec, short: c, type: string, description: 'Specify | |
metadata specification, either wsfed, idff or saml2, defaults to saml2'} | |
remove_cot_member: | |
description: Remove a member from a circle of trust. | |
options: | |
cot: {required: true, long: cot, short: t, type: string, description: Circle of Trust} | |
entityid: {required: true, long: entityid, short: y, type: string, description: Entity ID} | |
realm: {required: false, long: realm, short: e, type: string, description: Realm where circle of trust resides} | |
spec: {required: false, long: spec, short: c, type: string, description: 'Specify | |
metadata specification, either wsfed, idff or saml2, defaults to saml2'} | |
add_cot_member: | |
description: Add a member to a circle of trust. | |
options: | |
cot: {required: true, long: cot, short: t, type: string, description: Circle of Trust} | |
entityid: {required: true, long: entityid, short: y, type: string, description: Entity ID} | |
realm: {required: false, long: realm, short: e, type: string, description: Realm where circle of trust resides} | |
spec: {required: false, long: spec, short: c, type: string, description: 'Specify | |
metadata specification, either wsfed, idff or saml2, defaults to saml2'} | |
do_bulk_federation: | |
description: Perform bulk federation. | |
options: | |
metaalias: {required: true, long: metaalias, short: m, type: string, description: Specify metaAlias for local provider.} | |
remoteentityid: {required: true, long: remoteentityid, short: r, type: string, | |
description: Remote entity Id} | |
useridmapping: {required: true, long: useridmapping, short: g, type: string, | |
description: File name of local to remote user Id mapping. Format <local-user-id>&pipe;<remote-user-id>} | |
nameidmapping: {required: true, long: nameidmapping, short: e, type: string, | |
description: Name of file that will be created by this sub command. It contains remote user Id to name identifier. It shall be used by remote provider to update user profile.} | |
spec: {required: false, long: spec, short: c, type: string, description: 'Specify | |
metadata specification, either idff or saml2, defaults to saml2'} | |
import_bulk_fed_data: | |
description: Import bulk federation data which is generated by 'do-bulk-federation' sub command. | |
options: | |
metaalias: {required: true, long: metaalias, short: m, type: string, description: Specify metaAlias for local provider.} | |
bulk-data-file: {required: true, long: bulk-data-file, short: g, type: string, | |
description: File name of bulk federation data which is generated by 'do-bulk-federation' sub command.} | |
spec: {required: false, long: spec, short: c, type: string, description: 'Specify | |
metadata specification, either idff or saml2, defaults to saml2'} | |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment