CLI グループ メソッド
ここでは、CLI グループ メソッドについて説明します。
casso127jpjp
ここでは、CLI グループ メソッドについて説明します。
Add メソッド - エージェント、レスポンス、ルール、ネストされたグループ オブジェクトをグループに追加
Add メソッドは、エージェント、レスポンス、ルールまたはネストされたグループ オブジェクトをグループに追加します。
構文
Add メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtGroup->Add(newMember)
[Parameters]
Add メソッドは以下のパラメータを受け入れます。
- newMember(objectType)グループに追加するメンバを指定します。objectTypeは、以下のいずれかになります。
- PolicyMgtAgent
- PolicyMgtResponse
- PolicyMgtRule
- PolicyMgtGroup
戻り値
Add メソッドは以下のいずれかの値を返します。
- 成功の場合は 0
- コールに失敗した場合は、-1
Contains メソッド - 指定されたエージェント、レスポンス、ルール、またはネストされたグループ オブジェクトがグループに含まれるかどうかを判定
Contains メソッドは、グループに指定されたエージェント、レスポンス、ルールまたはネストされたグループ オブジェクトが含まれるかどうかを判定します。
構文
Contains メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtGroup->Contains(object)
[Parameters]
Contains メソッドは以下のパラメータを受け入れます。
- object(objectType)確認するオブジェクトを指定します。objectTypeは、以下のいずれかになります。
- PolicyMgtAgent
- PolicyMgtResponse
- PolicyMgtRule
- PolicyMgtGroup
戻り値
Contains メソッドは以下のいずれかの値を返します。
- グループに指定されたオブジェクトが含まれる場合は、1
- グループに指定されたオブジェクトが含まれない場合は、0
- コールに失敗した場合は、undef
Description メソッド - グループ オブジェクトの説明を設定または取得
Description メソッドは、グループ オブジェクトの説明を設定または取得します。
構文
Description メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtGroup->Description([Description])
[Parameters]
Description メソッドは以下のパラメータを受け入れます。
- Description(文字列)(オプション)設定する説明を指定します。
戻り値
Description メソッドは以下のいずれかの値を返します。
- 新規または既存の説明
- コールに失敗した場合は、空の文字列
GetAgent メソッド - 指定されたエージェント オブジェクトをグループから取得
GetAgent メソッドは、グループから指定されたエージェント オブジェクトを取得します。
構文
GetAgent メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtGroup->GetAgent(agentName)
[Parameters]
GetAgent メソッドは以下のパラメータを受け入れます。
- agentName(文字列)取得するエージェントの名前を指定します。
戻り値
GetAgent メソッドは以下のいずれかの値を返します。
- PolicyMgtAgent オブジェクト
- そのようなエージェントが見つからない場合、グループに別のタイプのオブジェクトが含まれる場合、またはコールが失敗した場合は、undef
GetAgentGroup メソッド - グループ内のネストされたエージェント グループ オブジェクトを取得
GetAgentGroup メソッドは、グループ内のネストされたエージェント グループ オブジェクトを取得します。
構文
GetAgentGroup メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtGroup->GetAgentGroup(groupName)
[Parameters]
GetAgentGroup メソッドは以下のパラメータを受け入れます。
- groupName(文字列)取得するエージェント グループの名前を指定します。
戻り値
GetAgentGroup メソッドは以下のいずれかの値を返します。
- PolicyMgtGroup オブジェクト
- コールに失敗した場合またはグループが存在しない場合は、undef
GetAgentType メソッド - グループに含まれているエージェント オブジェクトのタイプを取得
GetAgentType メソッドは、グループに含まれているエージェント オブジェクトのタイプを取得します(たとえば、Web エージェント)。
構文
GetAgentType メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtGroup->GetAgentType( )
[Parameters]
GetAgentType メソッドは、パラメータを受け入れません。
戻り値
GetAgentType メソッドは以下のいずれかの値を返します。
- PolicyMgtAgentType オブジェクト
- コールに失敗した場合は、undef
GetAllAgentGroups メソッド - グループ内のネストされたすべてのエージェント グループ オブジェクトを取得
GetAllAgentGroups メソッドは、グループ内のネストされたすべてのエージェント グループ オブジェクトを取得します。
構文
GetAllAgentGroups メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtGroup->GetAllAgentGroups( ) (returnCode)
[Parameters]
GetAllAgentGroups メソッドは、以下のパラメータを受け入れます。
- returnCode(int)関数コールの戻り時に取り込まれる出力変数。コールが成功した場合に取り込まれる値は 0 です。コールが失敗した場合に取り込まれる値は、ポリシー管理 API エラー コードに対応する負の数です。
戻り値
GetAllAgentGroups メソッドは以下の値を返します。
- PolicyMgtGroup オブジェクトの配列
GetAllAgents メソッド - グループ内のすべてのエージェント オブジェクトを取得
GetAllAgents メソッドは、グループ内のすべてのエージェント オブジェクトを取得します。
構文
GetAllAgents メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtGroup->GetAllAgents( ) (returnCode)
[Parameters]
GetAllAgents メソッドは、以下のパラメータを受け入れます。
- returnCode(int)関数コールの戻り時に取り込まれる出力変数。コールが成功した場合に取り込まれる値は 0 です。コールが失敗した場合に取り込まれる値は、ポリシー管理 API エラー コードに対応する負の数です。
戻り値
GetAllAgents メソッドは以下の値を返します。
- PolicyMgtAgent オブジェクトの配列
GetAllResponseGroups メソッド - グループ内のネストされたすべてのレスポンス グループ オブジェクトを取得
GetAllResponseGroups メソッドは、グループ内のネストされたすべてのレスポンス グループ オブジェクトを取得します。
構文
GetAllResponseGroups メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtGroup->GetAllResponseGroups( ) (returnCode)
[Parameters]
GetAllResponseGroups メソッドは、以下のパラメータを受け入れます。
- returnCode(int)関数コールの戻り時に取り込まれる出力変数。コールが成功した場合に取り込まれる値は 0 です。コールが失敗した場合に取り込まれる値は、ポリシー管理 API エラー コードに対応する負の数です。
戻り値
GetAllResponseGroups メソッドは以下の値を返します。
- PolicyMgtGroup オブジェクトの配列
GetAllResponses メソッド - グループ内のすべてのレスポンス オブジェクトを取得
GetAllResponses メソッドは、グループ内のすべてのレスポンス オブジェクトを取得します。
構文
GetAllResponses メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtGroup->GetAllResponses( ) (returnCode)
[Parameters]
GetAllResponses メソッドは、以下のパラメータを受け入れます。
- returnCode(int)関数コールの戻り時に取り込まれる出力変数。コールが成功した場合に取り込まれる値は 0 です。コールが失敗した場合に取り込まれる値は、ポリシー管理 API エラー コードに対応する負の数です。
戻り値
GetAllResponses メソッドは以下の値を返します。
- PolicyMgtResponse オブジェクトの配列
GetAllRuleGroups メソッド - グループ内のネストされたすべてのルール グループ オブジェクトを取得
GetAllRuleGroups メソッドは、グループ内のネストされたすべてのルール グループ オブジェクトを取得します。
構文
GetAllRuleGroups メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtGroup->GetAllRuleGroups( ) (returnCode)
[Parameters]
GetAllRuleGroups メソッドは、以下のパラメータを受け入れます。
- returnCode(int)関数コールの戻り時に取り込まれる出力変数。コールが成功した場合に取り込まれる値は 0 です。コールが失敗した場合に取り込まれる値は、ポリシー管理 API エラー コードに対応する負の数です。
戻り値
GetAllRuleGroups メソッドは以下の値を返します。
- PolicyMgtGroup オブジェクトの配列
GetAllRules メソッド - グループ内のすべてのルール オブジェクトを取得
GetAllRules メソッドは、グループ内のすべてのルール オブジェクトを取得します。
構文
GetAllRules メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtGroup->GetAllRules( ) (returnCode)
[Parameters]
GetAllRules メソッドは、以下のパラメータを受け入れます。
- returnCode(int)関数コールの戻り時に取り込まれる出力変数。コールが成功した場合に取り込まれる値は 0 です。コールが失敗した場合に取り込まれる値は、ポリシー管理 API エラー コードに対応する負の数です。
戻り値
GetAllRules メソッドは以下の値を返します。
- PolicyMgtRule オブジェクトの配列
GetResponse メソッド - 指定されたレスポンス オブジェクトをグループから取得
GetResponse メソッドは、グループから指定されたレスポンス オブジェクトを取得します。
構文
GetResponse メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtGroup->GetResponse(responseName)
[Parameters]
GetResponse メソッドは以下のパラメータを受け入れます。
- responseName(タイプ)取得するレスポンスの名前を指定します。
戻り値
GetResponse メソッドは以下のいずれかの値を返します。
- PolicyMgtResponse オブジェクト
- そのようなレスポンスが見つからない場合、グループに別のタイプのオブジェクトが含まれる場合、またはコールが失敗した場合は、undef
GetResponseGroup メソッド - グループ内のネストされたレスポンス グループ オブジェクトを取得
GetResponseGroup メソッドは、グループ内のネストされたレスポンス グループ オブジェクトを取得します。
構文
GetResponseGroup メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtGroup->GetResponseGroup(groupName)
[Parameters]
GetResponseGroup メソッドは以下のパラメータを受け入れます。
- groupName(文字列)取得するレスポンス グループの名前を指定します。
戻り値
GetResponseGroup メソッドは以下のいずれかの値を返します。
- PolicyMgtGroup オブジェクト
- グループが存在しない場合またはコールに失敗する場合は、undef
GetRule メソッド - 指定されたルール オブジェクトをグループから取得
GetRule メソッドは、グループから指定されたルール オブジェクトを取得します。
構文
GetRule メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtGroup->GetRule(ruleName)
[Parameters]
GetRule メソッドは以下のパラメータを受け入れます。
- ruleName(文字列)取得するルールの名前を指定します。
戻り値
GetRule メソッドは以下のいずれかの値を返します。
- PolicyMgtRule オブジェクト
- そのようなルールが見つからない場合、グループに別のタイプのオブジェクトが含まれる場合、またはコールが失敗した場合は、undef
GetRuleGroup メソッド - グループ内のネストされたルール グループ オブジェクトを取得
GetRuleGroup メソッドは、グループ内のネストされたルール グループ オブジェクトを取得します。
構文
GetRuleGroup メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtGroup->GetRuleGroup(groupName)
[Parameters]
GetRuleGroup メソッドは以下のパラメータを受け入れます。
- groupName(文字列)取得するルール グループの名前を指定します。
戻り値
GetRuleGroup メソッドは以下のいずれかの値を返します。
- PolicyMgtGroup オブジェクト
- グループが存在しない場合またはコールに失敗する場合は、undef
Name メソッド - グループ オブジェクトの名前を設定または取得
Name メソッドは、グループ オブジェクトの名前を設定または取得します。
構文
Name メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtGroup->Name([Name])
[Parameters]
Name メソッドは以下のパラメータを受け入れます。
- Name(文字列)(オプション)設定する名前を指定します。
戻り値
Name メソッドは以下のいずれかの値を返します。
- 新規または既存の名前
- コールに失敗した場合は、undef
Remove メソッド - 指定されたグループ メンバをグループから削除します。
Remove メソッドは、グループから指定されたグループ メンバを削除します。
構文
Remove メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtGroup->Remove(member)
[Parameters]
Remove メソッドは、以下のパラメータを受け入れます。
- member(objectType)以下のいずれかのオブジェクト タイプである削除対象のグループ メンバを指定します。
- PolicyMgtAgent
- PolicyMgtResponse
- PolicyMgtRule
- PolicyMgtGroup
戻り値
Remove メソッドは以下のいずれかの値を返します。
- 成功の場合は 0
- コールに失敗した場合は、undef