10 Interface definition

28.3113GPPPolicy management for Network Function Virtualization (NFV) based mobile networksRelease 16TS

10.1 Class diagram

Figure 10.1: Class Diagram

10.2 PolicyManagementIRPOperations_Interface (M)

10.2.1 Operation createPolicy (M)

10.2.1.1 Input parameters

Parameter Name

Qualifier

Matching Information

Comment

designer

M

Policy.designer

See clause 9.5.1 (definitions and legal values).

name

M

Policy.name

See clause 9.5.1 (definitions and legal values).

policyPriority

M

Policy.policyPriority

See clause 9.5.1 (definitions and legal values).

policyStatus

M

Policy.policyStatus

See clause 9.5.1 (definitions and legal values).

policyType

M

Policy.policyType

See clause 9.5.1 (definitions and legal values).

policyContent

M

Policy.policyContent

See clause 9.5.1 (definitions and legal values).

10.2.1.2 Output parameters

Parameter Name

Qualifier

Matching Information

Comment

designer

M

Policy.designer

See clause 9.5.1 (definitions and legal values).

name

M

Policy.name

See clause 9.5.1 (definitions and legal values).

policyId

M

Policy.policyId

See clause 9.5.1 (definitions and legal values).

policyPriority

M

Policy.policyPriority

See clause 9.5.1 (definitions and legal values).

policyStatus

M

Policy.policyStatus

See clause 9.5.1 (definitions and legal values).

policyType

M

Policy.policyType

See clause 9.5.1 (definitions and legal values).

policyContent

M

Policy.policyContent

See clause 9.5.1 (definitions and legal values).

10.2.1.3 Results

In case of success, the corresponding policy information is created by the EM (IRP Agent). In case of failure, appropriate error information is returned.

10.2.2 Operation deletePolicy (M)

10.2.2.1 Input parameters

Parameter Name

Qualifier

Matching Information

Comment

policyId

M

Policy.policyId

See clause 9.5.1 (definitions and legal values).

10.2.2.2 Output parameters

Parameter Name

Qualifier

Matching Information

Comment

designer

M

Policy.designer

See clause 9.5.1 (definitions and legal values).

name

M

Policy.name

See clause 9.5.1 (definitions and legal values).

policyId

M

Policy.policyId

The policyId of the deleted policy. See clause 9.5.1 (definitions and legal values).

policyPriority

M

Policy.policyPriority

See clause 9.5.1 (definitions and legal values).

policyStatus

M

Policy.policyStatus

See clause 9.5.1 (definitions and legal values).

policyType

M

Policy.policyType

See clause 9.5.1 (definitions and legal values).

policyContent

M

Policy.policyContent

See clause 9.5.1 (definitions and legal values).

10.2.2.3 Results

In case of success, the policy information are deleted by the EM (IRP Agent), and the corresponding deleted policy information is returned to the NM (IRP Manager). In case of failure, appropriate error information is returned.

10.2.3 Operation updatePolicy (M)

10.2.3.1 Input parameters

Parameter Name

Qualifier

Matching Information

Comment

designer

O

Policy.designer

See clause 9.5.1 (definitions and legal values).

name

O

Policy.name

See clause 9.5.1 (definitions and legal values).

policyId

M

Policy.policyId

See clause 9.5.1 (definitions and legal values).This parameter’s value is not allowed to be updated.

policyPriority

O

Policy.policyPriority

See clause 9.5.1 (definitions and legal values). This parameter’s value is allowed to be updated.

policyStatus

M

Policy.policyStatus

See clause 9.5.1 (definitions and legal values). This parameter’s value is allowed to be updated.

policyType

O

Policy.policyType

See clause 9.5.1 (definitions and legal values). This parameter’s value is allowed to be updated.

policyContent

O

Policy.policyContent

See clause 9.5.1 (definitions and legal values). This parameter’s value is allowed to be updated.

10.2.2.2 Output parameters

Parameter Name

Qualifier

Matching Information

Comment

designer

M

Policy.designer

See clause 9.5.1 (definitions and legal values).

name

M

Policy.name

See clause 9.5.1 (definitions and legal values).

policyId

M

Policy.policyId

The policyId of the deleted policy. See clause 9.5.1 (definitions and legal values).

policyPriority

M

Policy.policyPriority

See clause 9.5.1 (definitions and legal values).

policyStatus

M

Policy.policyStatus

See clause 9.5.1 (definitions and legal values).

policyType

M

Policy.policyType

See clause 9.5.1 (definitions and legal values).

policyContent

M

Policy.policyContent

See clause 9.5.1 (definitions and legal values).

10.2.2.3 Results

In case of success, the corresponding policy information is updated by the EM (IRP Agent). In case of failure, appropriate error information is returned.

10.2.4 Operation queryPolicy (M)

10.2.4.1 Input parameters

Parameter Name

Qualifier

Matching Information

Comment

policyId

M

Policy.policyId

See clause 9.5.1 (definitions and legal values).

10.2.4.2 Output parameters

Parameter Name

Qualifier

Matching Information

Comment

designer

M

Policy.designer

See clause 9.5.1 (definitions and legal values).

name

M

Policy.name

See clause 9.5.1 (definitions and legal values).

policyId

M

Policy.policyId

The policyId of the deleted policy. See clause 9.5.1 (definitions and legal values).

policyPriority

M

Policy.policyPriority

See clause 9.5.1 (definitions and legal values).

policyStatus

M

Policy.policyStatus

See clause 9.5.1 (definitions and legal values).

policyType

M

Policy.policyType

See clause 9.5.1 (definitions and legal values).

policyContent

M

Policy.policyContent

See clause 9.5.1 (definitions and legal values).

10.2.4.3 Results

In case of success, the corresponding policy information is returned by the EM (IRP Agent). In case of failure, appropriate error information is returned.

10.2.5 Operation activatePolicy (M)

10.2.5.1 Input parameters

Parameter Name

Qualifier

Matching Information

Comment

policyId

M

Policy.policyId

See clause 9.5.1 (definitions and legal values).

10.3.5.2 Output parameters

Parameter Name

Qualifier

Matching Information

Comment

designer

M

Policy.designer

See clause 9.5.1 (definitions and legal values).

name

M

Policy.name

See clause 9.5.1 (definitions and legal values).

PolicyId

M

Policy.policyId

See clause 9.5.1 (definitions and legal values). Identifier of the activated Policy.

policyPriority

M

Policy.policyPriority

See clause 9.5.1 (definitions and legal values).

policyStatus

M

Policy.policyStatus

See clause 9.5.1 (definitions and legal values).

policyType

M

Policy.policyType

See clause 9.5.1 (definitions and legal values).

policyContent

M

Policy.policyContent

See clause 9.5.1 (definitions and legal values).

10.3.5.3 Results

In case of success, the policy(ies) information are activated by the EM (IRP Agent) , and the activated policy information is returned to the NM (IRP Manager). In case of failure, appropriate error information is returned.

10.2.6 Operation deactivatePolicy (M)

10.2.6.1 Input parameters

Parameter Name

Qualifier

Matching Information

Comment

policyId

M

Policy. policyId

See clause 9.5.1 (definitions and legal values).

10.2.6.2 Output parameters

Parameter Name

Qualifier

Matching Information

Comment

designer

M

Policy.designer

See clause 9.5.1 (definitions and legal values).

name

M

Policy.name

See clause 9.5.1 (definitions and legal values).

PolicyId

M

Policy. policyId

See clause 9.5.1 (definitions and legal values). Identifier of the activated Policy.

policyPriority

M

Policy. policyPriority

See clause 9.5.1 (definitions and legal values).

policyStatus

M

Policy. policyStatus

See clause 9.5.1 (definitions and legal values).

policyType

M

Policy. policyType

See clause 9.5.1 (definitions and legal values).

policyContent

M

Policy. policyContent

See clause 9.5.1 (definitions and legal values).

10.2.6.3 Results

In case of success, the policy(ies) information are deactivated by the EM (IRP Agent), and the deactivated policy information is returned to the NM (IRP Manager). In case of failure, appropriate error information is returned.

10.2.7 Operation queryPolicyList (M)

10.2.7.1 Input parameters

Parameter Name

Qualifier

Matching Information

Comment

policyListId

M

PolicyList.policyListId

See clause 9.5.1 (definitions and legal values).

10.2.7.2 Output parameters

Parameter Name

Qualifier

Matching Information

Comment

policyListId

M

PolicyList.policyListId

See clause 9.5.1 (definitions and legal values).

policyIdList

M

PolicyList.policyIdList

See clause 9.5.1 (definitions and legal values).

10.2.7.3 Results

In case of success, the EM (IRP Agent) returns the corresponding policy information. In case of failure, appropriate error information is returned.

10.3 PolicyManagementIRPNotification_Interface (M)

10.3.1 policyConflictNotification

10.3.1.1 Input parameters

Parameter Name

Qualifier

Matching Information

Comment

activatedPolicyList

M

List of <PolicyList.policyListId> and their corresponding policy is activated.

See clause 9.5.1 (definitions and legal values). Identifier(s) of the activated Policy.

10.3.1.2 Triggering Event

10.3.1.2.1 From-state

internalProblem

Assertion Name

Definition

internalProblem

Because of a network policy conflict’s problem, PolicyManagementIRP Agent decides that it no longer can maintain the policy in any policyStatus but "deactivated".

10.3.1.2.2 To-state

policyConflictNotification

Assertion Name

Definition

policyConflictNotification

There is network policyconflict(s).